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.

Sign up for GitHub

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

Jump to bottom

Add new BackendTLSPolicy configuration options to documentation #3563

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add new BackendTLSPolicy configuration options to documentation #3563

wants to merge 1 commit into from
+28 −2

Conversation

08volt
Copy link

@08volt 08volt commented Jan 22, 2025

/kind documentation

What this PR does / why we need it:
Updated documentation page regarding BackendTLSPolicy with the following fields:

  • Gateway backendTLS field
  • subjectAltNames field
  • options field

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?:

NONE

@08volt
Add new BackendTLSPolicy configuration options to documentation:
6d86df4 
- Gateway backendTLS field
- subjectAltNames field
- options field

The documentation includes descriptions of each new field along with
their purpose, usage constraints and reference links.
@k8s-ci-robot k8s-ci-robot 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 Jan 22, 2025
@08volt 08volt changed the title Add new BackendTLSPolicy configuration options to documentation: Add new BackendTLSPolicy configuration options to documentation Jan 22, 2025
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 22, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @08volt!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 22, 2025
@k8s-ci-robot
Copy link
Contributor

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 /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. Regular contributors should join the org to skip this step.

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.

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.

robscott
robscott approved these changes Jan 22, 2025
View reviewed changes
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 @08volt! This mostly LGTM. Added some suggestions for version indicators, not quite sure the formatting will be quite right, but should be close.

site-src/api-types/backendtlspolicy.md
@@ -28,6 +28,12 @@ to prevent the complications involved with sharing trust across namespace bounda

All Gateway API Routes that point to a referenced Service should respect a configured BackendTLSPolicy.

## Gateway Backend TLS Configuration
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Gateway Backend TLS Configuration
## Gateway Backend TLS Configuration
??? example "Experimental Channel since v1.1.0"
These fields were added to Gateway in `v1.1.0`

site-src/api-types/backendtlspolicy.md
@@ -111,6 +119,22 @@ Also note:

- Wildcard hostnames are not allowed.

#### Subject Alternative Names
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#### Subject Alternative Names
#### Subject Alternative Names
??? example "Experimental Channel since v1.2.0"
This field was added to BackendTLSPolicy in `v1.2.0`

site-src/api-types/backendtlspolicy.md
- Hostname: DNS name format
- URI: URI format (e.g., SPIFFE ID)

#### TLS Options
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#### TLS Options
#### TLS Options
??? example "Experimental Channel since v1.2.0"
This field was added to BackendTLSPolicy in `v1.2.0`

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 22, 2025
@robscott
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot 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 Jan 22, 2025
kflynn
kflynn reviewed Jan 22, 2025
View reviewed changes
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.

Looks good from here too, with @robscott's changes. 🙂 Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kflynn kflynn kflynn left review comments

@robscott robscott robscott approved these changes

@mlavacca mlavacca Awaiting requested review from mlavacca

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. 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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@08volt @k8s-ci-robot @robscott @kflynn