Skip to content

Commit

Permalink
docs: add ssl passthrough note in FAQ (#844)
Browse files Browse the repository at this point in the history
* docs: note about SSL passthrough in gateway godoc

* docs: add FAQ entry about SSL passthrough

* Apply suggestions from code review

Co-authored-by: Rob Scott <rob.scott87@gmail.com>

* Update site-src/faq.md

Co-authored-by: Rob Scott <rob.scott87@gmail.com>
  • Loading branch information
shaneutt and robscott authored Sep 2, 2021
1 parent 11c196d commit 817f1b6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
3 changes: 3 additions & 0 deletions apis/v1alpha2/gateway_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -334,9 +334,12 @@ const (
// In this mode, TLS session between the downstream client
// and the Gateway is terminated at the Gateway.
TLSModeTerminate TLSModeType = "Terminate"

// In this mode, the TLS session is NOT terminated by the Gateway. This
// implies that the Gateway can't decipher the TLS stream except for
// the ClientHello message of the TLS protocol.
//
// Note that SSL passthrough is only supported by TLSRoute.
TLSModePassthrough TLSModeType = "Passthrough"
)

Expand Down
10 changes: 10 additions & 0 deletions site-src/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,15 @@
AppProtocol depend on Kubernetes 1.18 (opt-in) or 1.19 (on by default).
There are not any other exceptions to the 1.16+ guideline right now.

* **Q: Is SSL Passthrough supported?**
A: SSL Passthrough (wherein a Gateway routes traffic with the [Transport
Layer Security (TLS)][tls] encryption _intact_ to a backend service instead of
terminating it) is supported by [TLSRoutes][tlsroute]. See the
[TLS Guide][tlsguide] for more details about passthrough and other TLS
configurations.

[1]: https://github.com/kubernetes-sigs/gateway-api
[2]: https://github.com/kubernetes-sigs/gateway-api/releases
[tls]:https://en.wikipedia.org/wiki/Transport_Layer_Security
[tlsroute]:/concepts/api-overview.md#tlsroute
[tlsguide]:/guides/tls.md

0 comments on commit 817f1b6

Please sign in to comment.