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

📖 Add a guide describing ownerReference usage in CAPI #9150

Merged

Conversation

killianmuldoon
Copy link
Contributor

This guide caps of work done on ownerReferences in Cluster API over the last ~12 months. It sets out a set of heuristics for using ownerReferences in Cluster API which may be useful for related projects as a reference.

It also documents in a simple way the current state of ownership relationships in Cluster API.

Related: #8256,

Fixes #5487

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 8, 2023
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 8, 2023
Copy link
Contributor Author

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

There's still a gap here related to controller references: #4014

I'd prefer to keep that as a seperate issue here. We should probably add those references as part of the test and this doc simultaneously.

Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

Thx for taking care of this one. Overall lgtm

test/framework/ownerreference_helpers.go Outdated Show resolved Hide resolved
test/framework/ownerreference_helpers.go Outdated Show resolved Hide resolved
docs/book/src/reference/owner_references.md Outdated Show resolved Hide resolved
docs/book/src/reference/owner_references.md Outdated Show resolved Hide resolved
docs/book/src/reference/owner_references.md Outdated Show resolved Hide resolved
docs/book/src/reference/owner_references.md Outdated Show resolved Hide resolved
docs/book/src/reference/owner_references.md Show resolved Hide resolved
Signed-off-by: killianmuldoon <kmuldoon@vmware.com>
@sbueringer
Copy link
Member

Thx!

/lgtm
/approve

/hold
up to you

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 9, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 9, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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:

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
Copy link
Contributor

LGTM label has been added.

Git tree hash: fb92eed94e172585e51a968e7efc83378de7ed57

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 9, 2023
@killianmuldoon
Copy link
Contributor Author

/hold cancel

I think this might be a bit of a WIP - e.g. #9153 - but happy with the current state for now.

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 9, 2023
@sbueringer
Copy link
Member

Yup definitely a reasonable first version that we can merge!

@killianmuldoon
Copy link
Contributor Author

/cherry-pick release-1.5

@k8s-infra-cherrypick-robot

@killianmuldoon: once the present PR merges, I will cherry-pick it on top of release-1.5 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.5

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
Copy link
Contributor Author

/cherry-pick release-1.4

@k8s-infra-cherrypick-robot

@killianmuldoon: once the present PR merges, I will cherry-pick it on top of release-1.4 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.4

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 merged commit 98643e0 into kubernetes-sigs:main Aug 9, 2023
19 of 20 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.6 milestone Aug 9, 2023
@k8s-infra-cherrypick-robot

@killianmuldoon: new pull request created: #9154

In response to this:

/cherry-pick release-1.5

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-infra-cherrypick-robot

@killianmuldoon: new pull request created: #9155

In response to this:

/cherry-pick release-1.4

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.

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

Document CRs ownership
4 participants