kubernetes-sigs / kubebuilder-declarative-pattern

A toolkit for building declarative operators with kubebuilder
Apache License 2.0
255 stars 84 forks source link

Skip setting owner refs for objects that don't support it #184

Closed tomasaschan closed 2 years ago

tomasaschan commented 2 years ago

What this PR does / why we need it:

Before this fix, a declarative controller using declarative.WithOwner(declarative.SourceAsOwner) will end up in an infinite reconciliation loop if any of the manifests in the package do not support having the declarative object as its owner.

For example, consider a namespaced declarative object foo/foo of type Foo, installing a package that adds a few objects (say, two Bars) in the same namespace plus another object (say, a Baz) in a fixed namespace qux. With the old behavior of this reconciler, the following happens:

  1. The reconciler creates all objects in the package, setting owner references to an object with the same group, version, kind and name as the declarative object, and the same namespace as each respective object from the package. In other words, we get two Bars in foo owned by foo/foo, and a Baz in qux owned by qux/foo.

  2. Since qux/foo does not exist, the API server decides that it must have been deleted, and that means qux/baz should also be deleted (its owner no longer exists).

  3. The reconciler is notified, and determines that qux/baz is missing, re-adding it again with an owner reference to qux/foo.

  4. Go back to step 2.

With the change in this PR, the reconciler will instead skip setting an owner reference on qux/foo, avoiding the infinite loop at the cost of qux/foo now being a "dangling" object; if/when the declarative object foo/foo is deleted, qux/foo will be left untouched in the cluster.

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

k8s-ci-robot commented 2 years ago

Welcome @tomasaschan!

It looks like this is your first PR to kubernetes-sigs/kubebuilder-declarative-pattern 🎉. 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/kubebuilder-declarative-pattern 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. :smiley:

k8s-ci-robot commented 2 years ago

Hi @tomasaschan. 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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
rajansandeep commented 2 years ago

/ok-to-test

justinsb commented 2 years ago

/approve /lgtm

k8s-ci-robot commented 2 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: justinsb, tomasaschan

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](https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/blob/master/OWNERS)~~ [justinsb] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment