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

apis: document ParentRef functionality for GAMMA #2146

Merged
merged 14 commits into from
Jul 5, 2023

Conversation

mikemorris
Copy link
Contributor

@mikemorris mikemorris commented Jun 26, 2023

What type of PR is this?
/kind documentation
/area mesh

What this PR does / why we need it:
Updates API documentation support for ParentRef targeting a Kubernetes Service, as proposed in GEP-1426.

Which issue(s) this PR fixes:
Fixes #2139
Service port targeting refs #1995

Links:

Does this PR introduce a user-facing change?:

Adds support for ParentRef targeting a Kubernetes Service resource for mesh implementations.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. area/mesh Mesh networks related cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 26, 2023
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 26, 2023
@robscott
Copy link
Member

Thanks @mikemorris!

/cc @howardjohn @keithmattix @kflynn

@robscott robscott added this to the v0.8.0 milestone Jun 26, 2023
@robscott robscott added the release-blocker MUST be completed to complete the milestone label Jun 26, 2023
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks @mikemorris!

apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot requested a review from mlavacca June 27, 2023 18:33
Copy link
Contributor

@howardjohn howardjohn left a comment

Choose a reason for hiding this comment

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

Nice!

apis/v1beta1/shared_types.go Outdated Show resolved Hide resolved
@robscott
Copy link
Member

🤦 this failed with the same error that I thought I fixed with #2156. Will try again to see if this is a flake or more consistent failure.

/retest

Copy link
Member

@hzxuzhonghu hzxuzhonghu left a comment

Choose a reason for hiding this comment

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

lgtm.
Just one question: if we have a CRD defining some rules functioning on service, should we use ParentRef or TargetRef?

@mikemorris
Copy link
Contributor Author

Resolved suggested changes for support level <> conformance profile documentation and clarifying ReferenceGrant non-applicability to Service as ParentRef, this should be ready for a final review pass now.

@mikemorris
Copy link
Contributor Author

@hzxuzhonghu If you're implementing your own CRD for defining some service policy rules, I believe that should follow the pattern in https://gateway-api.sigs.k8s.io/references/policy-attachment/ and use targetRef (although I do see how the distinction between targetRef and parentRef for similar use cases could be confusing).

Copy link
Member

@hzxuzhonghu hzxuzhonghu left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 4, 2023
@robscott
Copy link
Member

robscott commented Jul 5, 2023

Thanks @mikemorris! Will add a hold for someone else to sign off on this as well, but LGTM.

/cc @howardjohn @keithmattix @kflynn
/approve

@robscott
Copy link
Member

robscott commented Jul 5, 2023

/hold

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jul 5, 2023
Copy link
Contributor

@kflynn kflynn left a comment

Choose a reason for hiding this comment

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

Hit it! Thanks, @mikemorris. 🙂

Copy link
Contributor

@keithmattix keithmattix left a comment

Choose a reason for hiding this comment

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

LGTM as well. Thanks @mikemorris

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: keithmattix, kflynn, mikemorris, robscott

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

@keithmattix
Copy link
Contributor

2/3 GAMMA leads approve, so removing the hold
/remove-hold

@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 Jul 5, 2023
@k8s-ci-robot k8s-ci-robot merged commit 995b170 into kubernetes-sigs:main Jul 5, 2023
@mikemorris mikemorris deleted the apis/gamma-parentrefs branch July 6, 2023 15:20
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. area/mesh Mesh networks related cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-blocker MUST be completed to complete the milestone release-note Denotes a PR that will be considered when it comes time to generate release notes. 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.

Add GAMMA references to API Spec
8 participants