Skip to content

Commit 9c620fc

Browse files
committed
Fix inconsistencies on TLSRoute documentation
1 parent cb5da2f commit 9c620fc

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

site-src/concepts/api-overview.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,10 @@ modifying them in-flight.
117117

118118
TLSRoute is for multiplexing TLS connections, discriminated via SNI. It's intended
119119
for where you want to use the SNI as the main routing method, and are not interested
120-
in properties of the higher-level protocols like HTTP. The byte stream of the
121-
connection is proxied without any inspection to the backend.
120+
in properties of the higher-level protocols like HTTP. The byte stream of the
121+
connection is proxied without any inspection to the backend when using a `Passthrough`
122+
TLS listener, or proxied unencrypted to the backend when using a `Terminate` TLS
123+
listener.
122124

123125
#### TCPRoute and UDPRoute
124126

@@ -157,7 +159,7 @@ to allow multiple Routes to share ports on the Listener.
157159
|------|---------|---------------------|-----------|-------|
158160
|HTTPRoute| Layer 7 | Anything in the HTTP Protocol | Terminated only | HTTP and HTTPS Routing|
159161
|TLSRoute| Somewhere between layer 4 and 7| SNI or other TLS properties| Passthrough or Terminated | Routing of TLS protocols including HTTPS where inspection of the HTTP stream is not required.|
160-
|TCPRoute| Layer 4| destination port | Passthrough or Terminated | Allows for forwarding of a TCP stream from the Listener to the Backends |
162+
|TCPRoute| Layer 4| destination port | Terminated | Allows for forwarding of a TCP stream from the Listener to the Backends |
161163
|UDPRoute| Layer 4| destination port | None | Allows for forwarding of a UDP stream from the Listener to the Backends. |
162164
|GRPCRoute| Layer 7 | Anything in the gRPC Protocol | Terminated only | gRPC Routing over HTTP/2 and HTTP/2 cleartext|
163165

site-src/guides/tls.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ implementation(s) you're using with Gateway API.
1212

1313
!!! info "Experimental Channel"
1414

15-
The `TLSRoute` and `BackendTLSPolicy` resources described below are currently only included in the
15+
The `TLSRoute` resources described below is currently only included in the
1616
"Experimental" channel of Gateway API. For more information on release
1717
channels, refer to our [versioning guide](../concepts/versioning.md).
1818

@@ -26,14 +26,15 @@ For Gateways, there are two connections involved:
2626
- **upstream**: This is the connection between the Gateway and backend resources
2727
specified by routes. These backend resources will usually be Services.
2828

29-
With Gateway API, TLS configuration of downstream and
30-
upstream connections is managed independently.
29+
With Gateway API, TLS configuration of downstream and upstream connections is
30+
managed independently.
3131

3232
For downstream connections, depending on the Listener Protocol, different TLS modes and Route types are supported.
3333

3434
| Listener Protocol | TLS Mode | Route Type Supported |
3535
|-------------------|-------------|---------------------|
3636
| TLS | Passthrough | TLSRoute |
37+
| TLS | Terminate | TLSRoute |
3738
| TLS | Terminate | TCPRoute |
3839
| HTTPS | Terminate | HTTPRoute |
3940
| GRPC | Terminate | GRPCRoute |
@@ -47,6 +48,11 @@ upstream TLS configuration. For `HTTPRoute`, the use of both `Terminate` TLS mod
4748
Using these together provides what is commonly known as a connection that is terminated and then re-encrypted at
4849
the Gateway.
4950

51+
For `TLSRoute`, the use of `Terminate` means that the TLS termination happens on
52+
the `Gateway` and the connection to the backend may happen as a unencrypted TCP connection.
53+
`BackendTLSPolicy` can be used in this case to re-encrypt the connection using different
54+
set of certificate authorities, SNI and other configurations.
55+
5056
## Downstream TLS
5157

5258
Downstream TLS settings are configured using listeners at the Gateway level.

0 commit comments

Comments
 (0)