Skip to content

Commit e30286e

Browse files
committed
Add new BackendTLSPolicy configuration options to documentation:
- Gateway backendTLS field - subjectAltNames field - options field The documentation includes descriptions of each new field along with their purpose, usage constraints and reference links.
1 parent 24803c3 commit e30286e

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

site-src/api-types/backendtlspolicy.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ to prevent the complications involved with sharing trust across namespace bounda
2828

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

31+
## Gateway Backend TLS Configuration
32+
33+
??? example "Experimental Channel since v1.1.0"
34+
35+
These fields were added to Gateway in `v1.1.0`
36+
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.
37+
This functionality enables the specification of client certificates that the Gateway should use when establishing TLS connections with backends.
38+
The backendTLS configuration consists of a single field:
39+
40+
- [ClientCertificateRef][clientCertificateRef] - References an object containing a Client Certificate and its associated private key
41+
3142
## Spec
3243

3344
The specification of a [BackendTLSPolicy][backendtlspolicy] consists of:
@@ -36,19 +47,21 @@ The specification of a [BackendTLSPolicy][backendtlspolicy] consists of:
3647
- [Validation][validation] - Defines the configuration for TLS, including hostname, CACertificateRefs, and
3748
WellKnownCACertificates.
3849
- [Hostname][hostname] - Defines the Server Name Indication (SNI) that the Gateway uses to connect to the backend.
50+
- [SubjectAltNames][subjectAltNames] - Specifies one or more Subject Alternative Names that the backend certificate must match. When specified, the certificate must have at least one matching SAN. This field enables separation between SNI (hostname) and certificate identity validation. A maximum of 5 SANs are allowed.
3951
- [CACertificateRefs][caCertificateRefs] - Defines one or more references to objects that contain PEM-encoded TLS certificates,
4052
which are used to establish a TLS handshake between the Gateway and backend Pod. Either CACertificateRefs or
4153
WellKnownCACertificates may be specified, but not both.
4254
- [WellKnownCACertificates][wellKnownCACertificates] - Specifies whether system CA certificates may be used in the TLS
4355
handshake between the Gateway and backend Pod. Either CACertificateRefs or WellKnownCACertificates may be specified, but not both.
56+
- [Options][options] - A map of key/value pairs enabling extended TLS configuration for implementations that choose to provide support. Check your implementation's documentation for details.
4457

4558
The following chart outlines the object definitions and relationship:
4659
```mermaid
4760
flowchart LR
4861
backendTLSPolicy[["<b>backendTLSPolicy</b> <hr><align=left>BackendTLSPolicySpec: spec<br>PolicyStatus: status</align>"]]
4962
spec[["<b>spec</b><hr>PolicyTargetReferenceWithSectionName: targetRefs <br> BackendTLSPolicyValidation: tls"]]
5063
status[["<b>status</b><hr>[ ]PolicyAncestorStatus: ancestors"]]
51-
validation[["<b>tls</b><hr>LocalObjectReference: caCertificateRefs<br>wellKnownCACertificatesType: wellKnownCACertificates/<br>PreciseHostname: hostname"]]
64+
validation[["<b>tls</b><hr>LocalObjectReference: caCertificateRefs<br>wellKnownCACertificatesType: wellKnownCACertificates<br>PreciseHostname: hostname<br>[]SubjectAltName: subjectAltNames"]]
5265
ancestorStatus[["<b>ancestors</b><hr>AncestorRef: parentReference<br>GatewayController: controllerName<br>[]Condition: conditions"]]
5366
targetRefs[[<b>targetRefs</b><hr>]]
5467
service["<b>service</>"]
@@ -111,6 +124,34 @@ Also note:
111124

112125
- Wildcard hostnames are not allowed.
113126

127+
#### Subject Alternative Names
128+
129+
??? example "Experimental Channel since v1.2.0"
130+
131+
This field was added to BackendTLSPolicy in `v1.2.0`
132+
The subjectAltNames field enables basic mutual TLS configuration between Gateways and backends, as well as the optional use of SPIFFE. When subjectAltNames is specified, the certificate served by the backend must have at least one Subject Alternative Name matching one of the specified values. This is particularly useful for SPIFFE implementations where URI-based SANs may not be valid SNIs.
133+
Subject Alternative Names may contain one of either a Hostname or URI field, and must contain a Type specifying whether Hostname or URI is chosen.
134+
135+
!!! info "Restrictions"
136+
137+
- IP addresses and wildcard hostnames are not allowed. (see the description for Hostname above for more details).
138+
- Hostname: DNS name format
139+
- URI: URI format (e.g., SPIFFE ID)
140+
141+
#### TLS Options
142+
143+
??? example "Experimental Channel since v1.2.0"
144+
145+
This field was added to BackendTLSPolicy in `v1.2.0`
146+
The options field allows specification of implementation-specific TLS configurations. This can include:
147+
148+
- Vendor-specific mutual TLS automation configuration
149+
- Minimum supported TLS version restrictions
150+
- Supported cipher suite configurations
151+
152+
Check your implementation documentation for details.
153+
154+
###
114155
#### Certificates
115156

116157
The BackendTLSPolicyValidation must contain a certificate reference of some kind, and contains two ways to configure the
@@ -145,4 +186,6 @@ uses `PolicyAncestorStatus` to allow you to know which parentReference set that
145186
[wellKnownCACertificates]: ../reference/spec.md#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation.WellKnownCACertificates
146187
[hostname]: ../reference/spec.md#gateway.networking.k8s.io/v1.PreciseHostname
147188
[rfc-3986]: https://tools.ietf.org/html/rfc3986
148-
[targetRefs]: ../reference/spec.md#gateway.networking.k8s.io/v1alpha2.PolicyTargetReference
189+
[targetRefs]: ../references/spec/#gateway.networking.k8s.io/v1alpha2.PolicyTargetReference
190+
[subjectAltNames]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.BackendTLSPolicyValidation
191+
[options]: ../references/spec/#gateway.networking.k8s.io/v1alpha3.GatewayTLSConfig

0 commit comments

Comments
 (0)