-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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 misleading webhook authentication documentation #26018
Conversation
Update misleading information that HTTPS is required and link to self-documented code to find more edge-case configuration options
Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA. It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.
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 understand the commands that are listed here. |
Welcome @CharlyRipp! |
✔️ Deploy preview for kubernetes-io-master-staging ready! 🔨 Explore the source changes: 7347a9d 🔍 Inspect the deploy logs: https://app.netlify.com/sites/kubernetes-io-master-staging/deploys/5ffc919221443300085592cc 😎 Browse the preview: https://deploy-preview-26018--kubernetes-io-master-staging.netlify.app |
@@ -475,6 +475,8 @@ contexts: | |||
name: webhook | |||
``` | |||
|
|||
Refer to [Cluster Struct](https://github.com/kubernetes/kubernetes/blob/2b8cac754c88900ea3ad91d6c3f0997b602a3051/staging/src/k8s.io/client-go/tools/clientcmd/api/v1/types.go#L63) for more configuration options. |
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.
We (SIG Docs) strongly prefer actually documenting this kind of detail, rather than signposting users to source code.
The umbrella issue #23889 is also about improving experience for readers who want to understand configuration and other data formats that are not part of the main Kubernetes HTTP API.
I recommend one of:
- save it for later
- omit this line, for now
- log an issue (a child of Document the unpublished APIs #23889) about adding that page
- in the same issue, also mention changing https://k8s.io/docs/reference/access-authn-authz/authentication/ to link there
- add a new reference page with a very basic outline of the kubeconfig format (as part of this PR), then link to that
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 @CharlyRipp
I like the spirit of this PR. That said, would it be OK to update just line 460 initially?
Remove reference in favor of kubernetes#23889
/lgtm |
LGTM label has been added. Git tree hash: d50325c7d8ddd92add6cceb38c9e31a00e424180
|
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tengqm 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 |
Update misleading information that HTTPS is required and link to self-documented code to find more edge-case configuration options.
HTTPS is not required for the Webhook Authentication, but definitely is recommended. Was also a bit of a pain to hunt down additional configurations - figured a link to the struct would be handy for those with edge cases instead of spelling them all out directly in the doc site.