-
Notifications
You must be signed in to change notification settings - Fork 498
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
Update ReferenceGrant docs to include Gateway -> Secret use case #1181
Update ReferenceGrant docs to include Gateway -> Secret use case #1181
Conversation
Hi @nathancoleman. 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 Once the patch is verified, the new status will be reflected by the 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. |
Nice catch @nathancoleman! /approved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/assign @bowei |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the work on this @nathancoleman! I agree with the goal here, but I think it may require a bit more restructuring.
@@ -95,6 +95,7 @@ type ReferencePolicyFrom struct { | |||
// additional resources, the following Route types are part of the "Core" | |||
// support level for this field: | |||
// | |||
// * Gateway |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need some more nuance here. I'm not really sure how this will scale since we really need to document each valid pair, ie HTTPRoute -> Secret doesn't make sense, and there's not currently any way to do Gateway -> Service. I think the best option here is to add a note here that ReferencePolicy is only supported as explicitly documented on object reference fields. Then we can add a comment on the cert ref namespace field in Gateways that references to Secrets in other namespaces can be allowed by ReferenceGrant. Similarly, we can update the BackendRef namespace field to state that references to Services in other namespaces can be allowed by ReferenceGrant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The status Condition -> Reason mappings (see example in #1114) may provide a pattern for clarifying these relationships a bit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@robscott @mikemorris thoughts on the most recent commit?
I'm having trouble regenerating the CRDs on my machine, so those aren't updated in this PR yet.
0aed112
to
1330641
Compare
/retest |
Thanks @nathancoleman! /lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: nathancoleman, robscott, shaneutt 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 |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
The docs for ReferenceGrant in some cases only cover the route -> backend use case where they should also include the gateway -> secret use case for certificate references.
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: