Skip to content

Align GRPCRoute hostname cross-serving godoc with the relaxed site docs - #5176

Open
lexfrei wants to merge 1 commit into
kubernetes-sigs:mainfrom
lexfrei:docs/grpcroute-hostnames-may
Open

Align GRPCRoute hostname cross-serving godoc with the relaxed site docs#5176
lexfrei wants to merge 1 commit into
kubernetes-sigs:mainfrom
lexfrei:docs/grpcroute-hostnames-may

Conversation

@lexfrei

@lexfrei lexfrei commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

#4598 relaxed the cross-serving rule on the site page: implementations may enforce hostname uniqueness between GRPCRoute and HTTPRoute, they no longer must. The GRPCRouteSpec.Hostnames godoc still says MUST, and that text is what ends up in the CRD descriptions and the API reference. This changes the godoc to match and regenerates.

Left alone on purpose: GEP-1016 still carries the old wording, and the "When to Use GRPCRoute" section of the site page still says to use HTTPRoute for both when sharing a hostname. I can fold either in if you want them here.

This PR was written in part with the assistance of generative AI.

Which issue(s) this PR fixes:

None

Does this PR introduce a user-facing change?:

NONE

AI disclosure

This PR was prepared with AIL:3. I personally reviewed each line of the submission prior to opening this PR.

The site docs no longer require implementations to reject a GRPCRoute
whose hostnames intersect an HTTPRoute on the same listener; enforcing
uniqueness is optional. The GRPCRouteSpec.Hostnames godoc still stated
the old MUST, and that text is what the generated CRD descriptions and
API reference carry. Update the godoc and regenerate.

Signed-off-by: Aleksei Sviridkin <f@lex.la>
@kubernetes-prow kubernetes-prow Bot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Aug 16, 2026
@kubernetes-prow
kubernetes-prow Bot requested review from rikatz and youngnick August 16, 2026 11:57
@kubernetes-prow kubernetes-prow Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 16, 2026
@kubernetes-prow

Copy link
Copy Markdown

Hi @lexfrei. 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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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-sigs/prow repository.

@kubernetes-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: lexfrei
Once this PR has been reviewed and has the lgtm label, please assign danwinship for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details 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

@rikatz

rikatz commented Aug 18, 2026

Copy link
Copy Markdown
Member

/ok-to-test

@kubernetes-prow kubernetes-prow Bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 18, 2026
@lexfrei

lexfrei commented Aug 30, 2026

Copy link
Copy Markdown
Contributor Author

This is a two-line godoc alignment with the site docs; CI is green since the ok-to-test. Anything needed from my side?

@youngnick

Copy link
Copy Markdown
Contributor

Yeah, I didn't know about #4598, but this definitely does what that did. So, I guess final approval is for @rikatz when he is back from leave.

/lgtm

@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants