Skip to content

Conversation

@furkatgofurov7
Copy link
Contributor

@furkatgofurov7 furkatgofurov7 commented May 13, 2025

What this PR does / why we need it:
This PR introduces a new boolean field, gzipUserData, in the RKE2ConfigSpec, allowing users to enable gzip compression for cloud-init user data in the RKE2 bootstrap process. This change is based on this commit, where gzip compression was controlled via a custom annotation. The difference is, this solution utilizes a simpler approach based on new boolean field.

The new gzipUserData field allows users to enable gzip compression for user data optionally. Few things to highlight:

  • Users can now opt in to gzip compression based on their infrastructure requirements. This is controlled via the new gzipUserData boolean field in the RKE2ConfigSpec.
  • By default, gzipUserData is set to false, ensuring existing configurations are not affected unless explicitly enabled by the user.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #639

Special notes for your reviewer:

Checklist:

  • squashed commits into logical changes
  • includes documentation
  • adds unit tests
  • adds or updates e2e tests

@furkatgofurov7 furkatgofurov7 added area/bootstrap Indicates an issue or PR related to the bootstrap provider kind/feature labels May 13, 2025
@furkatgofurov7 furkatgofurov7 force-pushed the support-gzip-user-data branch 2 times, most recently from 625a518 to 3adebe0 Compare May 14, 2025 08:59
@zioc
Copy link

zioc commented May 14, 2025

Thanks for accepting this feature request and taking care of the implementation.

Could you also add support for compression on ignition-based system as discussed in the issue: #639 (comment)

@furkatgofurov7 furkatgofurov7 force-pushed the support-gzip-user-data branch 2 times, most recently from 4a5be12 to 31b8cb1 Compare May 14, 2025 13:49
@furkatgofurov7 furkatgofurov7 force-pushed the support-gzip-user-data branch 2 times, most recently from b6d73a2 to 3737458 Compare May 23, 2025 11:08
@furkatgofurov7 furkatgofurov7 force-pushed the support-gzip-user-data branch 4 times, most recently from 6f840e4 to f7c3b80 Compare June 2, 2025 10:17
@furkatgofurov7 furkatgofurov7 force-pushed the support-gzip-user-data branch 4 times, most recently from 8ce2dab to 10fc55c Compare July 2, 2025 14:07
@furkatgofurov7 furkatgofurov7 force-pushed the support-gzip-user-data branch from 10fc55c to 099492e Compare July 2, 2025 15:13
@furkatgofurov7 furkatgofurov7 marked this pull request as ready for review July 2, 2025 18:31
@furkatgofurov7 furkatgofurov7 requested a review from a team as a code owner July 2, 2025 18:31
@furkatgofurov7 furkatgofurov7 changed the title Add Gzip Compression Option for User Data ✨ Add Gzip Compression Option for User Data Jul 2, 2025
@furkatgofurov7 furkatgofurov7 moved this to PR to be reviewed in CAPI / Turtles Jul 2, 2025
anmazzotti
anmazzotti previously approved these changes Jul 3, 2025
Copy link
Contributor

@anmazzotti anmazzotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpicking the default value for the new field, but rest looks all good. Nice work and thank you for adding the documentation as well!

@alexander-demicev
Copy link
Member

Please open a follow-up issue about tests improvement we discussed yesterday

@alexander-demicev alexander-demicev added this pull request to the merge queue Jul 3, 2025
Merged via the queue into rancher:main with commit a5c04ad Jul 3, 2025
5 checks passed
@alexander-demicev alexander-demicev deleted the support-gzip-user-data branch July 3, 2025 10:27
@github-project-automation github-project-automation bot moved this from PR to be reviewed to Done in CAPI / Turtles Jul 3, 2025
@furkatgofurov7
Copy link
Contributor Author

furkatgofurov7 commented Jul 3, 2025

Please open a follow-up issue about tests improvement we discussed yesterday

@alexander-demicev filed #693 to track it.

@furkatgofurov7 furkatgofurov7 self-assigned this Jul 4, 2025
furkatgofurov7 added a commit to furkatgofurov7/cluster-api-provider-rke2 that referenced this pull request Aug 22, 2025
…ld in templates

New version of CAPRKE2 (v0.19.0) is out, hence we can now remove previous version
template introduced in rancher#649
to workaround e2e complications.

Signed-off-by: Furkat Gofurov <[email protected]>
furkatgofurov7 added a commit to furkatgofurov7/cluster-api-provider-rke2 that referenced this pull request Aug 26, 2025
…ld in templates

New version of CAPRKE2 (v0.19.0) is out, hence we can now remove previous version
template introduced in rancher#649
to workaround e2e complications.

Signed-off-by: Furkat Gofurov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/bootstrap Indicates an issue or PR related to the bootstrap provider kind/feature

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Consider adding an option to gzip user-data

6 participants