-
Notifications
You must be signed in to change notification settings - Fork 621
feat: Exclude experimental guidance from standard channel CRDs #2264
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
Conversation
|
Hi @slayer321. 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. |
|
I raised this PR which already have Routability changes, and after raising as there was a merge conflict I found that the Routability changes where drop. So the changes I made is tested with Routability part and can confirm it works. |
robscott
left a comment
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 @slayer321! This looks good to me, but it would be helpful if you could start by wrapping some examples so we can confirm it works as intended. Here are the main ones I'm thinking of:
gateway-api/apis/v1beta1/shared_types.go
Line 28 in 73d727a
// * Service (Mesh conformance profile, experimental, ClusterIP Services only) gateway-api/apis/v1beta1/shared_types.go
Lines 69 to 77 in 73d727a
// ParentRefs from a Route to a Service in the same namespace are "producer" // routes, which apply default routing rules to inbound connections from // any namespace to the Service. // // ParentRefs from a Route to a Service in a different namespace are // "consumer" routes, and these routing rules are only applied to outbound // connections originating from the same namespace as the Route, for which // the intended destination of the connections are a Service targeted as a // ParentRef of the Route. gateway-api/apis/v1beta1/shared_types.go
Lines 130 to 132 in 73d727a
// When the parent resource is a Service, this targets a specific port in the // Service spec. When both Port (experimental) and SectionName are specified, // the name and port of the selected port must match both specified values. gateway-api/apis/v1beta1/shared_types.go
Line 170 in 73d727a
// * Service (Mesh conformance profile, experimental, ClusterIP Services only) gateway-api/apis/v1beta1/shared_types.go
Lines 192 to 200 in 73d727a
// ParentRefs from a Route to a Service in the same namespace are "producer" // routes, which apply default routing rules to inbound connections from // any namespace to the Service. // // ParentRefs from a Route to a Service in a different namespace are // "consumer" routes, and these routing rules are only applied to outbound // connections originating from the same namespace as the Route, for which // the intended destination of the connections are a Service targeted as a // ParentRef of the Route.
pkg/generator/main.go
Outdated
| startTag := "<experimental:description:start>" | ||
| endTag := "<experimental:description:end>" |
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.
Maybe we should just copy xml here? (Non-blocking, just an idea)
| startTag := "<experimental:description:start>" | |
| endTag := "<experimental:description:end>" | |
| startTag := "<experimental:description>" | |
| endTag := "</experimental:description>" |
Signed-off-by: slayer321 <[email protected]>
Signed-off-by: slayer321 <[email protected]>
Signed-off-by: slayer321 <[email protected]>
robscott
left a comment
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 @slayer321! Sorry I lost track of this one!
apis/v1beta1/shared_types.go
Outdated
| // Gateway has the AllowedRoutes field, and ReferenceGrant provides a | ||
| // generic way to enable any other kind of cross-namespace reference. | ||
| // | ||
| //<experimental:description> |
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.
One tiny nit, probably best to stick with the <gateway:experimental prefix we're using elsewhere.
| //<experimental:description> | |
| // <gateway:experimental:description> |
|
/ok-to-test |
Signed-off-by: slayer321 <[email protected]>
Signed-off-by: slayer321 <[email protected]>
Signed-off-by: slayer321 <[email protected]>
|
@robscott I have made the changes can you please take a look. |
|
Thanks @slayer321, Sorry I lost track of this one! Please add a release-note in the PR description above, maybe something like "Excluding experimental guidance in field descriptions from standard CRDs". Once you do that, I believe the PR should merge. /lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: robscott, slayer321 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 feature
What this PR does / why we need it:
This PR adds the feature where we can specifiy the start and end tag to the CRDs description which only need to be there in expremental channel CRDs and exclude from standard channel CRDs.
Which issue(s) this PR fixes:
Fixes #2160
Does this PR introduce a user-facing change?: