Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix the random order of block_device_mappings render #17180

Conversation

AldoFusterTurpin
Copy link
Contributor

@AldoFusterTurpin AldoFusterTurpin commented Jan 7, 2025

What this PR does

Includes a new function to get the keys of the map used for block_device_mappings to access elements in deterministic order to avoid false changes in terraform diff.

Why we need it ?

When we render the terraform in kops, sometimes we get a diff like this
image

stating that there are changes in the block_device_mappings, but the only thing that changes is the order of those devices, and this happens randomly because we use a map to store those here, here and here.

The solution

Simply sort the keys of the map and always access the maps using a deterministic order to avoid getting false changes shown in the terraform diff.

Additional notes

I have used generics for simplicity and included a unit test for the new function.

The only thing that changes is that now we do not iterate the maps directly using a "for" construct but instead iterate over the keys of the map in order and access the values of the maps using the keys. This change does not affect the behavior, just ensures that we always iterate over the devices in the same order.

Copy link

linux-foundation-easycla bot commented Jan 7, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: AldoFusterTurpin / name: Aldo Fuster Turpin (ba0a94f)

@k8s-ci-robot k8s-ci-robot added the area/provider/aws Issues or PRs related to aws provider label Jan 7, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @AldoFusterTurpin!

It looks like this is your first PR to kubernetes/kops 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kops has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 7, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @AldoFusterTurpin. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 7, 2025
@hakman
Copy link
Member

hakman commented Jan 7, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 7, 2025
@AldoFusterTurpin
Copy link
Contributor Author

/retest

Copy link
Member

@hakman hakman left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @AldoFusterTurpin. There are a few nits that should be addressed before merging the PR.

@AldoFusterTurpin
Copy link
Contributor Author

Thanks for the PR @AldoFusterTurpin. There are a few nits that should be addressed before merging the PR.

Thanks for the review! Checking now. 👌

@AldoFusterTurpin AldoFusterTurpin force-pushed the fix/block_device_mappings_render_order branch from abf65db to 90b1027 Compare January 8, 2025 11:15
Include a new function to get the keys of the map used for block_device_mappings to access elements in deterministic order.
@AldoFusterTurpin AldoFusterTurpin force-pushed the fix/block_device_mappings_render_order branch from 90b1027 to ba0a94f Compare January 8, 2025 14:41
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 8, 2025
@hakman
Copy link
Member

hakman commented Jan 8, 2025

Thanks @AldoFusterTurpin!
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 8, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rifelpet

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/provider/aws Issues or PRs related to aws provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants