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

🐛 remove disableMachineCreate annotation from new machinesets during rolling machine deployment reconciliation #11415

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Patryk-Stefanski
Copy link

What this PR does / why we need it:

  1. Create a cluster with rolling machine deployment.
  2. Change to onDelete machine deployment
  3. Make some change to generate new machineSet
  4. DisableMachineCreateAnnotation is set on old machineSet, while new machineSet scales up
  5. Switch back to rolling machine deployment
  6. Removing the change made in step 3 will try to use the old machineSet but new machines wont be created because of the annotation.

The flow above prevents machines from being created with the following error Automatic creation of new machines disabled for machine set . We should remove this annotation during the machine deployment rolling reconciliation.

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 #

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 13, 2024
@Patryk-Stefanski
Copy link
Author

/area machinedeployment

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign neolit123 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 do-not-merge/needs-area PR is missing an area label label Nov 13, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @Patryk-Stefanski!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. 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-sigs/cluster-api 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/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 13, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @Patryk-Stefanski. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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 area/machinedeployment Issues or PRs related to machinedeployments and removed do-not-merge/needs-area PR is missing an area label labels Nov 13, 2024
@Patryk-Stefanski Patryk-Stefanski force-pushed the cleanup-disable-machine-create-annotation-rolling-machine-deployment branch 2 times, most recently from 05a906d to b7f875b Compare November 13, 2024 17:59
@Patryk-Stefanski Patryk-Stefanski changed the title 🐛 remove disableMachineCreate annotation from old machinesets during rolling machine deployment reconciliation 🐛 remove disableMachineCreate annotation from new machinesets during rolling machine deployment reconciliation Nov 13, 2024
@enxebre
Copy link
Member

enxebre commented Nov 18, 2024

/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 Nov 18, 2024
@Patryk-Stefanski Patryk-Stefanski force-pushed the cleanup-disable-machine-create-annotation-rolling-machine-deployment branch 2 times, most recently from bd6d544 to 5810d7b Compare November 22, 2024 10:39
func (r *Reconciler) cleanupDisableMachineCreateAnnotation(ctx context.Context, newMS *clusterv1.MachineSet) (*clusterv1.MachineSet, error) {
log := ctrl.LoggerFrom(ctx)

if newMS.Annotations != nil {
Copy link
Member

Choose a reason for hiding this comment

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

this duplicates the removal code. Also it would run twice in the onDelete case so we should be able to remove it there.

Maybe also move it to the top of this function.

Caveat: with doing this it won't be possible (anymore) to manually set this annotation on a MS if it is the new machineset for the normal rollout type. But IMHO this should be okay, because the MD controller owns the MS.

Copy link
Author

Choose a reason for hiding this comment

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

It will never fully run twice since its checking the annotation on the MS if one run removes it the second one shouldn't run because the annotation isn't there. I can add a check before calling the function to check the annotation exists if that helps?

Copy link
Member

Choose a reason for hiding this comment

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

my point is: I think we don't need it at ondelete anymore / we only need this code once :-)

Copy link
Author

Choose a reason for hiding this comment

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

I think we do need it if a user updates the MD and it creates a new MS the old one gets the annotation added. If the user undoes his changes the controller will attempt to use the old MS with the annotation that will prevent machines from coming up. So I think we need logic for the removal of this annotation in both onDelete and Rolling.

Please correct me if my understanding is wrong.

Copy link
Member

@chrischdi chrischdi left a comment

Choose a reason for hiding this comment

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

Could we also add some test coverage for this?

@Patryk-Stefanski Patryk-Stefanski force-pushed the cleanup-disable-machine-create-annotation-rolling-machine-deployment branch from 5810d7b to 052ff50 Compare November 28, 2024 11:06
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 28, 2024
@Patryk-Stefanski Patryk-Stefanski force-pushed the cleanup-disable-machine-create-annotation-rolling-machine-deployment branch from 052ff50 to 6597ce7 Compare November 28, 2024 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/machinedeployment Issues or PRs related to machinedeployments cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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