-
Notifications
You must be signed in to change notification settings - Fork 588
Docs: clarify SectionName #2605
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
Welcome @sdarwin! |
Hi @sdarwin. 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. |
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 this is a clarity improvement
/ok-to-test |
Thanks @sdarwin! /release-note-none |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: keithmattix, robscott, sdarwin 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 |
Hi,
On this page of documentation, the setting "SectionName" is explained. While it mentions the effect of adding a "SectionName" it may be slightly lacking in clarifying the default which would be the absence of a "SectionName". What happens without it?
My assumption, and what's added in this pull request, is that it will "attach to all listeners" of that gateway.
As evidence about the importance of addressing the topic, it seems that even Google's documentation has gotten confused?
Consider on this page
https://cloud.google.com/kubernetes-engine/docs/how-to/deploying-gateways
"""
When configuring HTTP-to-HTTPS redirects on the Gateway, the sectionName field is optional. If you don't configure this field, the HTTPS listener is automatically selected as the default option.
"""
What they have just said is "If you don't configure this field (sectionName), a particular listener (the HTTPS listener) is selected." I believe that's wrong and the fact is "If you don't configure this field (sectionName), all listeners are selected." In either case, it can't hurt to be sure this api-overview page has an answer.
/kind documentation