Skip to content

Commit

Permalink
Add more detail to guide and update compatibility doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@kate-osborn
kate-osborn committed Aug 15, 2024
1 parent 2eeccbb commit 7875ca5
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 35 deletions.
77 changes: 57 additions & 20 deletions site/content/how-to/traffic-management/tls-passthrough.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "TLS Passthrough"
weight: 600
weight: 800
toc: true
docs: "DOCS-000"
---

Learn how to passthrough TLS connections using NGINX Gateway Fabric.
Learn how to use TLSRoutes to configure TLS Passthrough load-balancing with NGINX Gateway Fabric.

## Overview

Expand All @@ -18,19 +18,14 @@ In this guide, we will show how to configure TLS passthrough for your applicatio

```text
GW_IP=XXX.YYY.ZZZ.III
GW_PORT=<port number>
```

Save the ports of NGINX Gateway Fabric:

```text
GW_HTTP_PORT=<http port number>
GW_HTTPS_PORT=<https port number>
GW_TLS_PORT=<port number>
```

{{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}}

Create the tls-backend application by copying and pasting the following block into your terminal:
## Set up

Create the `secure-app` application by copying and pasting the following block into your terminal:

```yaml
kubectl apply -f - <<EOF
Expand Down Expand Up @@ -98,7 +93,7 @@ data:
default_type text/plain;
location / {
return 200 "hello from pod $hostname\n";
return 200 "hello from pod \$hostname\n";
}
}
---
Expand All @@ -112,7 +107,9 @@ data:
EOF
```

This will create the **secure-app** service and a deployment. Run the following command to verify the resources were created:
This will create the **secure-app** service and a deployment. The secure app is configured to serve HTTPS traffic on port 8443 for the host app.example.com. For TLS termination, a self-signed TLS certificate, with the common name `app.example.com`, and key are used. The app responds to clients HTTPS requests with a simple text response "hello from pod $POD_HOSTNAME".

Run the following command to verify the resources were created:

```shell
kubectl get pods,svc
Expand All @@ -128,7 +125,7 @@ NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/secure-app ClusterIP 192.168.194.152 <none> 8443/TCP 12s
```

Create a gateway. This will create TLS listener with the hostname *.example.com. Copy paste this into your terminal.
Create a gateway. This will create a TLS listener with the hostname `*.example.com` and a TLS mode of passthrough. Copy and paste this into your terminal.

```yaml
kubectl apply -f - <<EOF
Expand All @@ -154,7 +151,11 @@ spec:
EOF
```

Create a TLSRoute, this will reference the service and the gateway.
This gateway will configure NGINX Gateway Fabric to accept TLS connections on port 443 and route them to the corresponding backend services without decryption. The routing is done based on the SNI, which allows clients to specify a server name (like example.com) during the SSL handshake.

{{< note >}} It is possible to add an HTTPS listener on the same port that terminates TLS connections so long as the hostname does not overlap with the TLS listener hostname. {{< /note >}}

Create a TLSRoute that attaches to the gateway and routes requests to `app.example.com` to the `secure-app` service:

```yaml
kubectl apply -f - <<EOF
Expand All @@ -168,7 +169,6 @@ spec:
- name: gateway
namespace: default
hostnames:
- "cafe.example.com"
- "app.example.com"
rules:
- backendRefs:
Expand All @@ -177,18 +177,55 @@ spec:
EOF
```

{{< note >}}To route to a service in a namespace different from the TLSRoute namespace, create a [ReferenceGrant](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1beta1.ReferenceGrant) to permit the cross-namespace reference. {{< /note >}}

## Send traffic

Using the external IP address and port for NGINX Gateway Fabric, send traffic to the coffee application.
Using the external IP address and port for NGINX Gateway Fabric, send traffic to the `secure-app` application.

{{< note >}}If you have a DNS record allocated for `cafe.example.com`, you can send the request directly to that hostname, without needing to resolve.{{< /note >}}
{{< note >}}If you have a DNS record allocated for `app.example.com`, you can send the request directly to that hostname, without needing to resolve.{{< /note >}}

Send a request to the `secure-app` service on the HTTPS port with the `--insecure` flag. The `--insecure` flag is required because the `secure-app` is using self-signed certificates.
Send a request to the `secure-app` service on the TLS port with the `--insecure` flag. The `--insecure` flag is required because the `secure-app` is using self-signed certificates.

```shell
curl --resolve cafe.example.com:$GW_PORT:$GW_IP https://cafe.example.com:$GW_PORT --insecure
curl --resolve app.example.com:$GW_TLS_PORT:$GW_IP https://app.example.com:$GW_TLS_PORT --insecure -v
```

```text
Added app.example.com:8443:127.0.0.1 to DNS cache
* Hostname app.example.com was found in DNS cache
* Trying 127.0.0.1:8443...
* Connected to app.example.com (127.0.0.1) port 8443
* ALPN: curl offers h2,http/1.1
* (304) (OUT), TLS handshake, Client hello (1):
* (304) (IN), TLS handshake, Server hello (2):
* (304) (IN), TLS handshake, Unknown (8):
* (304) (IN), TLS handshake, Certificate (11):
* (304) (IN), TLS handshake, CERT verify (15):
* (304) (IN), TLS handshake, Finished (20):
* (304) (OUT), TLS handshake, Finished (20):
* SSL connection using TLSv1.3 / AEAD-AES256-GCM-SHA384 / [blank] / UNDEF
* ALPN: server accepted http/1.1
* Server certificate:
* subject: C=US; ST=CA; L=San Francisco; CN=app.example.com
* start date: Mar 23 23:20:43 2020 GMT
* expire date: Mar 23 23:20:43 2023 GMT
* issuer: C=US; ST=CA; L=San Francisco; CN=app.example.com
* SSL certificate verify result: self signed certificate (18), continuing anyway.
* using HTTP/1.x
> GET / HTTP/1.1
> Host: app.example.com:8443
> User-Agent: curl/8.6.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: nginx/1.27.0
< Date: Wed, 14 Aug 2024 20:41:21 GMT
< Content-Type: text/plain
< Content-Length: 43
< Connection: keep-alive
<
hello from pod secure-app-575785644-kzqf6
```

Note that the server certificate used to terminate the TLS connection has the subject common name of `app.example.com`. This is the server certificate that the `secure-app` is configured with and shows that the TLS connection was terminated by the `secure-app`, not NGINX Gateway Fabric.
58 changes: 44 additions & 14 deletions site/content/overview/gateway-api-compatibility.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ Learn which Gateway API resources NGINX Gateway Fabric supports and to which lev
## Summary

{{< bootstrap-table "table table-striped table-bordered" >}}
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version |
| ------------------------------------- | ------------------- | ---------------------- | ------------------------------------- | ----------- |
| [GatewayClass](#gatewayclass) | Supported | Not supported | Supported | v1 |
| [Gateway](#gateway) | Supported | Partially supported | Not supported | v1 |
| [HTTPRoute](#httproute) | Supported | Partially supported | Not supported | v1 |
| [ReferenceGrant](#referencegrant) | Supported | N/A | Not supported | v1beta1 |
| [GRPCRoute](#grpcroute) | Supported | Partially supported | Not supported | v1 |
| [TLSRoute](#tlsroute) | Not supported | Not supported | Not supported | N/A |
| [TCPRoute](#tcproute) | Not supported | Not supported | Not supported | N/A |
| [UDPRoute](#udproute) | Not supported | Not supported | Not supported | N/A |
| [BackendTLSPolicy](#backendtlspolicy) | Supported | Supported | Not supported | v1alpha3 |
| [Custom policies](#custom-policies) | N/A | N/A | Supported | N/A |
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version |
|---------------------------------------|--------------------|------------------------|---------------------------------------|-------------|
| [GatewayClass](#gatewayclass) | Supported | Not supported | Supported | v1 |
| [Gateway](#gateway) | Supported | Partially supported | Not supported | v1 |
| [HTTPRoute](#httproute) | Supported | Partially supported | Not supported | v1 |
| [ReferenceGrant](#referencegrant) | Supported | N/A | Not supported | v1beta1 |
| [GRPCRoute](#grpcroute) | Supported | Partially supported | Not supported | v1 |
| [TLSRoute](#tlsroute) | Supported | Not supported | Not supported | v1alpha2 |
| [TCPRoute](#tcproute) | Not supported | Not supported | Not supported | N/A |
| [UDPRoute](#udproute) | Not supported | Not supported | Not supported | N/A |
| [BackendTLSPolicy](#backendtlspolicy) | Supported | Supported | Not supported | v1alpha3 |
| [Custom policies](#custom-policies) | N/A | N/A | Supported | N/A |
{{< /bootstrap-table >}}

---
Expand Down Expand Up @@ -123,6 +123,7 @@ See the [static-mode]({{< relref "/reference/cli-help.md#static-mode">}}) comman
- `Accepted/False/UnsupportedProtocol`
- `Accepted/False/InvalidCertificateRef`
- `Accepted/False/ProtocolConflict`
- `Accpeted/False/HostnameConflict`
- `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Listener is invalid or not supported.
- `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. NGINX Gateway Fabric only supports a single Gateway.
- `Programmed/True/Programmed`
Expand All @@ -131,6 +132,7 @@ See the [static-mode]({{< relref "/reference/cli-help.md#static-mode">}}) comman
- `ResolvedRefs/False/InvalidCertificateRef`
- `ResolvedRefs/False/InvalidRouteKinds`
- `Conflicted/True/ProtocolConflict`
- `Conflicted/True/HostnameConflict`
- `Conflicted/False/NoConflicts`

---
Expand Down Expand Up @@ -255,10 +257,38 @@ Fields:

{{< bootstrap-table "table table-striped table-bordered" >}}
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version |
| -------- | ------------------ | ---------------------- | ------------------------------------- | ----------- |
| TLSRoute | Not supported | Not supported | Not supported | N/A |
|----------|--------------------|------------------------|---------------------------------------|-------------|
| TLSRoute | Supported | Not supported | Not supported | v1alpha2 |
{{< /bootstrap-table >}}

**Fields**:

- `spec`
- `parentRefs`: Partially supported. Port not supported.
- `hostnames`: Supported.
- `rules`
- `backendRefs`: Partially supported. Only one backend ref allowed.
- `weight`: Not supported.
- `status`
- `parents`
- `parentRef`: Supported.
- `controllerName`: Supported.
- `conditions`: Supported (Condition/Status/Reason):
- `Accepted/True/Accepted`
- `Accepted/False/NoMatchingListenerHostname`
- `Accepted/False/NoMatchingParent`
- `Accepted/False/NotAllowedByListeners`
- `Accepted/False/UnsupportedValue`: Custom reason for when the TLSRoute includes an invalid or unsupported value.
- `Accepted/False/InvalidListener`: Custom reason for when the TLSRoute references an invalid listener.
- `Accepted/False/GatewayNotProgrammed`: Custom reason for when the Gateway is not Programmed. TLSRoute can be valid and configured, but will maintain this status as long as the Gateway is not Programmed.
- `Accepted/False/HostnameConflict`: Custom reason for when the TLSRoute has a hostname that conflicts with another TLSRoute on the same port.
- `ResolvedRefs/True/ResolvedRefs`
- `ResolvedRefs/False/InvalidKind`
- `ResolvedRefs/False/RefNotPermitted`
- `ResolvedRefs/False/BackendNotFound`
- `ResolvedRefs/False/UnsupportedValue`: Custom reason for when one of the TLSRoute rules has a backendRef with an unsupported value.
- `PartiallyInvalid/True/UnsupportedValue`

---

### TCPRoute
Expand Down
2 changes: 1 addition & 1 deletion site/go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ module github.com/nginxinc/nginx-gateway-fabric/site

go 1.21

require github.com/nginxinc/nginx-hugo-theme v0.41.0 // indirect
require github.com/nginxinc/nginx-hugo-theme v0.41.1 // indirect
2 changes: 2 additions & 0 deletions site/go.sum
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
github.com/nginxinc/nginx-hugo-theme v0.41.0 h1:uB9jC0Qk9i2CG63gScHxVHAEz1zyGoAdtY0Lcpkg1lI=
github.com/nginxinc/nginx-hugo-theme v0.41.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
github.com/nginxinc/nginx-hugo-theme v0.41.1 h1:Wan0Mb8uz1X4Z2vd/1nR0GOPel5mWVPuFD3jd4SezsU=
github.com/nginxinc/nginx-hugo-theme v0.41.1/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

0 comments on commit 7875ca5

Please sign in to comment.