-
Notifications
You must be signed in to change notification settings - Fork 582
Add new BackendTLSPolicy configuration options to documentation #3563
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
base: main
Are you sure you want to change the base?
Conversation
Welcome @08volt! |
Hi @08volt. 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-sigs/prow 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.
Thanks @08volt! This mostly LGTM. Added some suggestions for version indicators, not quite sure the formatting will be quite right, but should be close.
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: 08volt, 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 |
/ok-to-test |
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.
Looks good from here too, with @robscott's changes. 🙂 Thanks!
be9a8dc
to
f1b863d
Compare
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
cc @candita Could you take a look here please and let us know your thoughts? |
/remove-lifecycle stale |
@08volt I know it's been a while since you created this PR, not sure if you still have time to spend on this. If not, one of us could open a new PR based on your initial commit to help get this across the line, just let us know what you prefer. |
- Gateway backendTLS field - subjectAltNames field - options field The documentation includes descriptions of each new field along with their purpose, usage constraints and reference links.
Thanks for the very insightful suggestions, I corrected the documentation. |
No worries, I addressed the comments, let me know if there is anything else left to do. Thank you |
@candita as a person leading the |
These fields were added to Gateway in `v1.1.0` | ||
The Gateway specification now includes a new backendTLS field that allows configuration of TLS settings when the Gateway connects to backends. This provides a default configuration for all backend Services. It is important to note that if a BackendTLSPolicy is attached to a specific Service, it will override the backendTLS configuration on the Gateway. | ||
This functionality enables the specification of client certificates that the Gateway should use when establishing TLS connections with backends. | ||
The backendTLS configuration consists of a single field: | ||
|
||
- [ClientCertificateRef][clientCertificateRef] - References an object containing a Client Certificate and its associated private key |
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.
Note that this information is changing in #3960, so this should be updated with that design, and this PR should probably merge after that one does.
Some of this belongs under Gateway and not BackendTLSPolicy. https://github.com/kubernetes-sigs/gateway-api/pull/3563/files#r2219923354 I did not add the new fields to API, so I think it's best for @LiorLieberman to validate these changes to the docs. To me, this feels like it came out of nowhere, as there isn't even an issue linked to #3180. Most frighteningly, there are NO conformance tests for these additions. I don't think they should be added to an API object on its way to Standard without them. Should I raise an issue? |
/kind documentation
What this PR does / why we need it:
Updated documentation page regarding BackendTLSPolicy with the following fields:
The documentation includes descriptions of each new field along with their purpose, usage constraints and reference links.
Fixes #
Does this PR introduce a user-facing change?: