Document that ParentRefs require ReferencePolicy. #974
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Consistent use of ReferencePolicy across the API makes it more predictable and easier to reason about. Document that ParentRef references that cross namespaces are required to obey ReferencePolicy restrictions. I believe that this was always the intention, though the documentation text was overlooked. Signed-off-by: James Peach <jpeach@apache.org>
k8s-ci-robot
added
kind/bug
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jpeach 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 |
k8s-ci-robot
added
the
approved
robscott
reviewed
Dec 23, 2021
Comment on lines
+55
to
+58
| // Note that when a namespace is specified, a ReferencePolicy object | ||
| // is required in the referent namespace to allow that namespace's | ||
| // owner to accept the reference. See the ReferencePolicy documentation | ||
| // for details. |
There was a problem hiding this comment.
I think this is a bit more nuanced, maybe something like this would work?
Suggested change
| // Note that when a namespace is specified, a ReferencePolicy object | |
| // is required in the referent namespace to allow that namespace's | |
| // owner to accept the reference. See the ReferencePolicy documentation | |
| // for details. | |
| // Note that when a different namespace is specified, something in the | |
| // target namespace needs to allow that reference. When referring to a | |
| // Gateway in a different namespace, that Gateway needs to explicitly | |
| // allow for Routes to be attached from this namespace. For other kinds | |
| // of parent resources that don't include this configuration, a | |
| // ReferencePolicy must be present to accept the reference. See the | |
| // ReferencePolicy documentation for details. |
|
Closing this out. Talking about ReferencePolicy would just add to the confusion that I'm suffering from. I'll think about some different language. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind bug
/kind api-change
What this PR does / why we need it:
Consistent use of ReferencePolicy across the API makes it more
predictable and easier to reason about. Document that ParentRef
references that cross namespaces are required to obey ReferencePolicy
restrictions. I believe that this was always the intention, though
the documentation text was overlooked.
Which issue(s) this PR fixes:
Fixes #973.
Does this PR introduce a user-facing change?: