🌱 Ensure finalizers are resilient on reconciliation #9471

adityabhatia · 2023-09-20T16:23:08Z

What this PR does / why we need it: Cluster API objects contain finalizers which must be resilient in the event of deletion. The deletion of finalizers can happen due to a diverse events like by mistake or system attacks. In such an event the deleted finalizers should be added back to ClusterAPI objects on reconciliation.

Which issue(s) this PR fixes:
Fixes #9434

/area e2e-testing

linux-foundation-easycla · 2023-09-20T16:23:12Z

The committers listed above are authorized under a signed CLA.

✅ login: adityabhatia / name: Aditya Bhatia (5126180)

k8s-ci-robot · 2023-09-20T16:23:16Z

Welcome @adityabhatia!

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 · 2023-09-20T16:23:17Z

Hi @adityabhatia. 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/test-infra repository.

killianmuldoon

Thanks for picking this up!

/ok-to-test

adityabhatia · 2023-09-20T17:29:41Z

/area e2e-testing

killianmuldoon · 2023-09-20T17:53:19Z

/test

k8s-ci-robot · 2023-09-20T17:53:22Z

@killianmuldoon: The /test command needs one or more targets.
The following commands are available to trigger required jobs:

/test pull-cluster-api-build-main
/test pull-cluster-api-e2e-full-dualstack-and-ipv6-main
/test pull-cluster-api-e2e-full-main
/test pull-cluster-api-e2e-main
/test pull-cluster-api-e2e-mink8s-main
/test pull-cluster-api-e2e-workload-upgrade-1-28-latest-main
/test pull-cluster-api-test-main
/test pull-cluster-api-test-mink8s-main
/test pull-cluster-api-verify-main

The following commands are available to trigger optional jobs:

/test pull-cluster-api-apidiff-main
/test pull-cluster-api-e2e-scale-main-experimental

Use /test all to run the following jobs that were automatically triggered:

pull-cluster-api-apidiff-main
pull-cluster-api-build-main
pull-cluster-api-e2e-main
pull-cluster-api-test-main
pull-cluster-api-verify-main

In response to this:

/test

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/test-infra repository.

killianmuldoon · 2023-09-20T17:53:29Z

/test pull-cluster-api-e2e-full-main

adityabhatia · 2023-09-20T19:26:27Z

/test pull-cluster-api-e2e-full-main

chrischdi · 2023-10-05T12:44:03Z

/test pull-cluster-api-e2e-full-main

killianmuldoon

Let's remember to monitor these tests and merge them into the ordinary quickstart as a follow-up. That'll help reduce the overall number of tests we're running.

killianmuldoon

Mostly nits and one question:

Could this be simplified by make it more similar to the OwnerGraph test? i.e. we don't have to compare the current state to the initial state, we only have to compare the current state to a map of types -> finalizers. WDYT?

test/e2e/quick_start_test.go

test/framework/finalizers_helpers.go

adityabhatia · 2023-10-12T10:44:46Z

Mostly nits and one question:

Could this be simplified by make it more similar to the OwnerGraph test? i.e. we don't have to compare the current state to the initial state, we only have to compare the current state to a map of types -> finalizers. WDYT?

I introduced the initialObjsWithFinalizers check to ensure that we test Finalizers not only by resource types, but also by resource names. E.g. MachineDeployment (not topology owned) will never get a Finalizer, although the MachineDeployment type is on the resource map.

killianmuldoon

/approve

Thanks for working on this - really good to have this in place.

cmd/clusterctl/client/cluster/ownergraph.go

test/framework/finalizers_helpers.go

sbueringer · 2023-10-20T17:18:42Z

Sorry didn't get to it today, will review again on Monday

sbueringer · 2023-10-23T11:43:03Z

Thank you!

/lgtm
/approve

k8s-ci-robot · 2023-10-23T11:43:11Z

LGTM label has been added.

Git tree hash: 992eb26547cd1258e632db6d78d0772794b0b708

k8s-ci-robot · 2023-10-23T11:43:12Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: killianmuldoon, sbueringer

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:

~~OWNERS~~ [killianmuldoon,sbueringer]

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 added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 20, 2023

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 20, 2023

k8s-ci-robot requested review from elmiko and richardcase September 20, 2023 16:23

k8s-ci-robot added the do-not-merge/needs-area PR is missing an area label label Sep 20, 2023

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 20, 2023

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 20, 2023

killianmuldoon reviewed Sep 20, 2023

View reviewed changes

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 Sep 20, 2023

adityabhatia force-pushed the addFinalizerTests branch from f0daa7d to 886cdbd Compare September 20, 2023 16:36

k8s-ci-robot added 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 Sep 20, 2023

adityabhatia changed the title ~~[WIP] ensure finalizers are resilient on reconciliation~~ [WIP] 🌱 ensure finalizers are resilient on reconciliation Sep 20, 2023

adityabhatia changed the title ~~[WIP] 🌱 ensure finalizers are resilient on reconciliation~~ 🌱 ensure finalizers are resilient on reconciliation Sep 20, 2023

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 20, 2023

adityabhatia changed the title ~~🌱 ensure finalizers are resilient on reconciliation~~ 🌱 Ensure finalizers are resilient on reconciliation Sep 20, 2023

k8s-ci-robot added area/e2e-testing Issues or PRs related to e2e testing and removed do-not-merge/needs-area PR is missing an area label labels Sep 20, 2023

adityabhatia force-pushed the addFinalizerTests branch from 219eb8f to 6d916d2 Compare September 20, 2023 19:11

adityabhatia force-pushed the addFinalizerTests branch 2 times, most recently from 89eefd1 to d40e02b Compare September 20, 2023 22:22

adityabhatia requested a review from killianmuldoon October 5, 2023 07:29

killianmuldoon reviewed Oct 5, 2023

View reviewed changes

This was referenced Oct 5, 2023

Ensure finalizers are re-reconciled in CAPV kubernetes-sigs/cluster-api-provider-vsphere#2357

Closed

Watch for Cluster resource in topology owned MachineDeployment controller #9532

Closed

killianmuldoon reviewed Oct 12, 2023

View reviewed changes

adityabhatia force-pushed the addFinalizerTests branch from 2f3e62a to 0b911b0 Compare October 12, 2023 10:48

adityabhatia requested a review from killianmuldoon October 12, 2023 11:41

killianmuldoon reviewed Oct 12, 2023

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 12, 2023

sbueringer reviewed Oct 19, 2023

View reviewed changes

adityabhatia force-pushed the addFinalizerTests branch 4 times, most recently from f56b644 to 7d805d1 Compare October 19, 2023 19:15

adityabhatia requested a review from sbueringer October 20, 2023 11:04

adityabhatia force-pushed the addFinalizerTests branch from 7d805d1 to 593ab3d Compare October 20, 2023 21:14

ensure finalizers are resilient on reconciliation

5126180

adityabhatia force-pushed the addFinalizerTests branch from 593ab3d to 5126180 Compare October 20, 2023 21:16

k8s-ci-robot assigned sbueringer Oct 23, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 23, 2023

k8s-ci-robot merged commit ac5e546 into kubernetes-sigs:main Oct 23, 2023
19 checks passed

k8s-ci-robot added this to the v1.6 milestone Oct 23, 2023

killianmuldoon mentioned this pull request Oct 30, 2023

Merge finalizer tests with default quick start tests #9636

Closed

adityabhatia mentioned this pull request Jan 26, 2024

REQUEST: New membership for adityabhatia kubernetes/org#4724

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 Ensure finalizers are resilient on reconciliation #9471

🌱 Ensure finalizers are resilient on reconciliation #9471

adityabhatia commented Sep 20, 2023 •

edited by killianmuldoon

linux-foundation-easycla bot commented Sep 20, 2023 •

edited

k8s-ci-robot commented Sep 20, 2023

k8s-ci-robot commented Sep 20, 2023

killianmuldoon left a comment

adityabhatia commented Sep 20, 2023

killianmuldoon commented Sep 20, 2023

k8s-ci-robot commented Sep 20, 2023

killianmuldoon commented Sep 20, 2023

adityabhatia commented Sep 20, 2023

chrischdi commented Oct 5, 2023

killianmuldoon left a comment

killianmuldoon left a comment

adityabhatia commented Oct 12, 2023

killianmuldoon left a comment

sbueringer commented Oct 20, 2023

sbueringer commented Oct 23, 2023

k8s-ci-robot commented Oct 23, 2023

k8s-ci-robot commented Oct 23, 2023

🌱 Ensure finalizers are resilient on reconciliation #9471

🌱 Ensure finalizers are resilient on reconciliation #9471

Conversation

adityabhatia commented Sep 20, 2023 • edited by killianmuldoon

linux-foundation-easycla bot commented Sep 20, 2023 • edited

k8s-ci-robot commented Sep 20, 2023

k8s-ci-robot commented Sep 20, 2023

killianmuldoon left a comment

Choose a reason for hiding this comment

adityabhatia commented Sep 20, 2023

killianmuldoon commented Sep 20, 2023

k8s-ci-robot commented Sep 20, 2023

killianmuldoon commented Sep 20, 2023

adityabhatia commented Sep 20, 2023

chrischdi commented Oct 5, 2023

killianmuldoon left a comment

Choose a reason for hiding this comment

killianmuldoon left a comment

Choose a reason for hiding this comment

adityabhatia commented Oct 12, 2023

killianmuldoon left a comment

Choose a reason for hiding this comment

sbueringer commented Oct 20, 2023

sbueringer commented Oct 23, 2023

k8s-ci-robot commented Oct 23, 2023

k8s-ci-robot commented Oct 23, 2023

adityabhatia commented Sep 20, 2023 •

edited by killianmuldoon

linux-foundation-easycla bot commented Sep 20, 2023 •

edited