Skip to content

Commit 8596ed2

Browse files
SantoDErobscott
andauthored
Enhance docs around Gateways, Routes and TLS (kubernetes-sigs#633)
* first draft * typo * add table and address feedback * Update site-src/guides/tls.md Co-authored-by: Rob Scott <[email protected]> * Update site-src/guides/tls.md Co-authored-by: Rob Scott <[email protected]> * wrap and rephrase Co-authored-by: Rob Scott <[email protected]>
1 parent 92e4d9f commit 8596ed2

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

site-src/guides/tls.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ For Gateways, there are two connections involved:
1717
With Gateway API, TLS configuration of downstream and
1818
upstream connections is managed independently.
1919

20+
Depending on the Listener Protocol, different TLS modes and Route types are supported.
21+
22+
Listener Protocol | TLS Mode | Route Type Supported
23+
--- | --- | ---
24+
TLS | Passthrough | TLSRoute
25+
TLS | Terminate | TCPRoute
26+
HTTPS | Terminate | HTTPRoute
27+
2028
Please note that in case of `Passthrough` TLS mode, no TLS settings take
2129
effect as the TLS session from the client is NOT terminated at the Gateway.
2230
The rest of the document assumes that TLS is being terminated at the Gateway,
@@ -42,7 +50,7 @@ listeners:
4250
- protocol: HTTPS # Other possible value is `TLS`
4351
port: 443
4452
tls:
45-
mode: Terminate
53+
mode: Terminate # If protocol is `TLS`, `Passthrough` is a possible mode
4654
certificateRef:
4755
kind: Secret
4856
group: core
@@ -77,6 +85,15 @@ before an HTTP request is sent from the client.
7785
[TLS Certificate in Route](#tls-certificate-in-route) provides an example
7886
of how this feature can be used.
7987

88+
Also, as mentioned above, the Route Kind (`HTTPRoute`, `TLSRoute`, `TCPRoute`)
89+
is dependent on the protocol on the listener level. Listeners with `HTTPS` or
90+
`HTTP` protocols can use `HTTPRoute` as the TLS Termination is done at the
91+
listener level and thus, only HTTP information is used for routing.
92+
93+
Listeners with the `TLS` protocol must use `TLSRoute` when the mode is set to `Passthrough` and `TCPRoute` when the mode is `Terminate`.
94+
95+
Listeners with the TCP protocol must use `TCPRoute` for plain TCP Routing.
96+
8097
### Examples
8198

8299
#### TLS in listener

0 commit comments

Comments
 (0)