Skip to content

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

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

Merged

Conversation

tomasaschan
Copy link
Member

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 k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 22, 2021
@k8s-ci-robot
Copy link
Contributor

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. 😃

@k8s-ci-robot
Copy link
Contributor

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot 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 Oct 22, 2021
@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 22, 2021
@rajansandeep
Copy link
Contributor

/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 Oct 29, 2021
if owner.GetNamespace() != "" && owner.GetNamespace() != o.Namespace {
// a namespaced object can only own objects within the same namespace, not objects in other namespaces or cluster-scoped objects
// for any other combination, skip setting owner reference here, to allow declarative.SourceAsOwner to be used for the
// subset of objects that make up a supported combination
Copy link
Contributor

Choose a reason for hiding this comment

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

This condition should be logged like above.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree we should alert, but I've been thinking about who we are alerting for. I think the answer is that we are alerting for the addon operator developer, but not the addon operator user. There's actually a whole set of these, particularly as we improve the functionality (e.g. reuse of the RESTMapper), which include recommended but not required code changes.

I think I'm going to merge this PR as-is therefore, but then try to implement a "developer notification" mode.

Copy link
Member Author

Choose a reason for hiding this comment

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

@justinsb I'm happy to amend this PR with logging if you'd like, but we currently have a rather ugly workaround with a custom declarative.WithObjectTransform that would be nice to get rid of, so if merging this and then adding new logging mechanism can be done in separate step's I'll be happy about it :)

@justinsb
Copy link
Contributor

justinsb commented Nov 8, 2021

/approve
/lgtm

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

[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:

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 Nov 8, 2021
@k8s-ci-robot k8s-ci-robot merged commit 5866b12 into kubernetes-sigs:master Nov 8, 2021
@tomasaschan tomasaschan deleted the fix-source-as-owner branch November 9, 2021 13:43
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. 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. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Latest kubebuilder-declarative-pattern version stuck on endless reconcile loop for guestbook-operator
5 participants