From 25b0ab998daee1c10d748d6fd60a7878964007e3 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 13 Jul 2026 14:48:41 +0100 Subject: [PATCH 1/6] docs: add Gateway API TLSRoute external access guide (beta, 26.2) New page for the per-listener type: tlsroute external access mode from operator PR #1615: bootstrap and per-broker TLSRoutes, SNI routing through a user-managed Gateway, hostTemplate semantics, migration from NodePort/LoadBalancer, validation rules, and troubleshooting. Facts verified against redpanda-operator main (8b034ee69): values schema, rendered resource names, advertisedPort default 443, fail-closed validation messages, and cert SAN handling. --- modules/ROOT/nav.adoc | 1 + .../kubernetes/networking/external/index.adoc | 2 +- .../networking/external/k-gateway-api.adoc | 255 ++++++++++++++++++ 3 files changed, 257 insertions(+), 1 deletion(-) create mode 100644 modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 089097e22c..527b6b1f2f 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -131,6 +131,7 @@ ***** xref:manage:kubernetes/networking/external/k-nodeport.adoc[Use a NodePort Service] ***** xref:manage:kubernetes/networking/external/k-loadbalancer.adoc[Use LoadBalancer Services] ***** xref:manage:kubernetes/networking/external/k-custom-services.adoc[Use Custom Services] +***** xref:manage:kubernetes/networking/external/k-gateway-api.adoc[Use Gateway API] *** xref:manage:kubernetes/security/index.adoc[Security] **** xref:manage:kubernetes/security/tls/index.adoc[TLS Encryption] ***** xref:manage:kubernetes/security/tls/k-cert-manager.adoc[Use cert-manager] diff --git a/modules/manage/pages/kubernetes/networking/external/index.adoc b/modules/manage/pages/kubernetes/networking/external/index.adoc index c197e41841..d88042bbf7 100644 --- a/modules/manage/pages/kubernetes/networking/external/index.adoc +++ b/modules/manage/pages/kubernetes/networking/external/index.adoc @@ -5,4 +5,4 @@ :page-categories: Management, Networking :env-kubernetes: true -Setting up external access to your Redpanda cluster allows applications running outside the Kubernetes cluster to communicate with Redpanda. To make the Redpanda brokers externally accessible, the Pods must be exposed through Kubernetes Services. \ No newline at end of file +Setting up external access to your Redpanda cluster allows applications running outside the Kubernetes cluster to communicate with Redpanda. To make the Redpanda brokers externally accessible, the Pods must be exposed through Kubernetes Services, or routed through a Gateway with xref:manage:kubernetes/networking/external/k-gateway-api.adoc[Gateway API TLSRoutes] (beta). \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc new file mode 100644 index 0000000000..b07fa318e9 --- /dev/null +++ b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc @@ -0,0 +1,255 @@ += Configure External Access through Gateway API +:description: Use Gateway API TLSRoutes to expose your Redpanda cluster through a Gateway, without NodePort or LoadBalancer Services. +:page-beta: true +:tags: ["Kubernetes", "Helm configuration"] +:page-categories: Management, Networking +:env-kubernetes: true + +Expose your Redpanda cluster to external clients through a single https://gateway-api.sigs.k8s.io/[Gateway API^] entry point instead of NodePort or LoadBalancer Services. Clients connect to one static Gateway address, and the Gateway routes each connection to the right broker using TLS Server Name Indication (SNI), so you avoid per-broker LoadBalancers and node port management. + +This feature is in beta. The configuration surface (`external.gateway` and the per-listener `type` field) may change before general availability. Beta features are not recommended for production environments. To give feedback, reach out to the Redpanda team in https://redpanda.com/slack[Redpanda Community Slack^]. + +== How it works + +You bring your own Gateway: deploy a Gateway API implementation that supports `TLSRoute` in passthrough mode, and create a Gateway resource with a TLS passthrough listener. Redpanda then creates the routing configuration for you: + +* **A bootstrap TLSRoute and Service**: Clients make their first connection to a single hostname, such as `redpanda.example.com`. The bootstrap Service targets all brokers, so initial connections are spread across the cluster. +* **A TLSRoute and Service per broker**: After the initial connection, Kafka clients reconnect to individual brokers using the per-broker hostnames that the brokers advertise, such as `redpanda-0-broker.example.com`. The Gateway routes each connection to the right broker by matching the SNI hostname. + +The Gateway does not terminate TLS. Connections pass through to the brokers, which present their own certificates. All traffic enters through the Gateway's listener port, and brokers advertise that port (`443` by default) to clients. + +Each external listener opts in independently with `type: tlsroute`, so you can migrate from NodePort or LoadBalancer Services one listener at a time: listeners without `type: tlsroute` keep using the conventional Service, and listeners with it are excluded from that Service. + +== Prerequisites + +* Redpanda Helm chart or Redpanda Operator from the 26.2 release line or later. + +* The https://gateway-api.sigs.k8s.io/[Gateway API^] CRDs, version 1.5 or later, installed in your Kubernetes cluster. Redpanda creates `TLSRoute` resources from the GA `gateway.networking.k8s.io/v1` API, which is available in Gateway API 1.5. + +* A Gateway controller that supports `TLSRoute` with TLS passthrough, such as Envoy Gateway or Istio, and a deployed `Gateway` resource with a TLS listener in `Passthrough` mode. Redpanda does not create the Gateway. + +* TLS enabled on every listener that you route through the Gateway. The Gateway routes connections by SNI, which requires TLS. If you use xref:manage:kubernetes/security/tls/k-cert-manager.adoc[cert-manager-managed certificates], Redpanda automatically adds the bootstrap and per-broker hostnames to the certificate's Subject Alternative Names (SANs). + +* Control over DNS for your chosen hostnames. The bootstrap hostname and all per-broker hostnames must resolve to the Gateway's external address. + +* Install xref:get-started:rpk-install.adoc[rpk] on your local machine so that you can test connections from outside Kubernetes. + +== Configure Redpanda listeners for the Gateway + +. Enable gateway mode and reference your Gateway. ++ +[tabs] +====== +Operator:: ++ +-- +.`redpanda-cluster.yaml` +[,yaml] +---- +apiVersion: cluster.redpanda.com/v1alpha2 +kind: Redpanda +metadata: + name: redpanda +spec: + clusterSpec: + external: + enabled: true + gateway: + enabled: true + parentRefs: + - name: # <1> + namespace: + sectionName: # <2> + tls: + enabled: true + certs: + default: + caEnabled: true + listeners: + kafka: + external: + default: + port: 9094 + type: tlsroute # <3> + host: redpanda.example.com # <4> + hostTemplate: redpanda-$POD_ORDINAL-broker.example.com # <5> + tls: + cert: default +---- +<1> The name of the Gateway resource that you deployed. At least one `parentRefs` entry is required. +<2> Optional: The name of the TLS passthrough listener on the Gateway. +<3> Routes this listener through the Gateway and excludes it from the NodePort or LoadBalancer Service. +<4> The bootstrap hostname that clients use for their first connection. +<5> The per-broker hostname pattern. `$POD_ORDINAL` is replaced with the broker's ordinal, and `$POD_NAME` with the Pod name. Required for Kafka listeners when you run more than one broker. + +[,bash] +---- +kubectl apply -f redpanda-cluster.yaml --namespace +---- +-- +Helm:: ++ +-- +.`gateway-values.yaml` +[,yaml] +---- +external: + enabled: true + gateway: + enabled: true + parentRefs: + - name: # <1> + namespace: + sectionName: # <2> +tls: + enabled: true + certs: + default: + caEnabled: true +listeners: + kafka: + external: + default: + port: 9094 + type: tlsroute # <3> + host: redpanda.example.com # <4> + hostTemplate: redpanda-$POD_ORDINAL-broker.example.com # <5> + tls: + cert: default +---- +<1> The name of the Gateway resource that you deployed. At least one `parentRefs` entry is required. +<2> Optional: The name of the TLS passthrough listener on the Gateway. +<3> Routes this listener through the Gateway and excludes it from the NodePort or LoadBalancer Service. +<4> The bootstrap hostname that clients use for their first connection. +<5> The per-broker hostname pattern. `$POD_ORDINAL` is replaced with the broker's ordinal, and `$POD_NAME` with the Pod name. Required for Kafka listeners when you run more than one broker. + +[,bash] +---- +helm upgrade --install redpanda redpanda/redpanda \ + --namespace --create-namespace \ + --values gateway-values.yaml +---- +-- +====== ++ +By default, brokers advertise port `443` to clients. If your Gateway listens on a different port, set `external.gateway.advertisedPort`. + +. Create DNS records that resolve the bootstrap hostname and all per-broker hostnames to your Gateway's external address. A wildcard record such as `*.example.com` covers both. + +. Verify that Redpanda created the TLSRoutes and that the Gateway accepted them: ++ +[,bash] +---- +kubectl get tlsroutes --namespace +---- ++ +For a three-broker cluster named `redpanda`, expect a bootstrap route and one route per broker: ++ +---- +NAME HOSTNAMES +redpanda-kafka-default-bootstrap ["redpanda.example.com"] +redpanda-kafka-default-0 ["redpanda-0-broker.example.com"] +redpanda-kafka-default-1 ["redpanda-1-broker.example.com"] +redpanda-kafka-default-2 ["redpanda-2-broker.example.com"] +---- ++ +Check that each route's `status.parents` reports `Accepted: True` from your Gateway controller: ++ +[,bash] +---- +kubectl get tlsroute --namespace -o jsonpath='{.status.parents}' +---- + +. Test the connection from outside the Kubernetes cluster: ++ +[,bash] +---- +rpk cluster info \ + -X brokers=redpanda.example.com:443 \ + -X tls.enabled=true \ + -X tls.ca=ca.crt +---- ++ +The broker list shows the per-broker hostnames with the advertised port. + +== Route other listeners through the Gateway + +The HTTP Proxy, Admin API, and Schema Registry listeners support `type: tlsroute` with the same `host` field. For these listeners, `hostTemplate` is optional: without it, Redpanda creates only the bootstrap route, and the Gateway load-balances requests across brokers. Give each listener a unique hostname: + +[,yaml] +---- +listeners: + kafka: + external: + default: + port: 9094 + type: tlsroute + host: kafka.example.com + hostTemplate: kafka-$POD_ORDINAL.example.com + tls: + cert: default + http: + external: + default: + port: 8082 + type: tlsroute + host: proxy.example.com + tls: + cert: default + schemaRegistry: + external: + default: + port: 8081 + type: tlsroute + host: schema.example.com + tls: + cert: default +---- + +== Migrate from NodePort or LoadBalancer Services + +The per-listener `type` field lets conventional and Gateway-routed listeners coexist, so you can migrate with no downtime: + +. Add a new external listener with `type: tlsroute` on a different port, alongside your existing listener. +. Point new clients, or a subset of clients, at the bootstrap hostname and verify connectivity. +. Move the remaining clients over. +. Remove the old external listener. When no listeners use the conventional Service, remove `external.type` and the associated NodePort or LoadBalancer configuration. + +== Configuration validation + +Redpanda refuses to render configurations that would silently break connectivity: + +* A listener with `type: tlsroute` requires `external.gateway.enabled: true` with at least one `parentRefs` entry. The listener is never placed in a NodePort or LoadBalancer Service as a fallback. +* Every Gateway-routed listener requires `host`. +* A Kafka listener with more than one broker requires `hostTemplate`, because Kafka clients must reconnect to individual brokers. + +If any of these conditions fail, the Helm release or Redpanda resource fails with an error that names the listener. + +== Troubleshooting + +**Clients connect to the bootstrap hostname but fail on reconnect**: The per-broker hostnames don't resolve to the Gateway, or the broker certificates don't include them. Check your DNS records, and verify the certificate SANs: + +[,bash] +---- +kubectl get secret --namespace \ + -o jsonpath='{.data.tls\.crt}' | base64 -d | openssl x509 -noout -text | grep DNS +---- + +**TLSRoutes exist but `status.parents` is empty or not Accepted**: Your Gateway controller doesn't support `TLSRoute` from `gateway.networking.k8s.io/v1`, the Gateway listener isn't in `Passthrough` mode, or the route's `parentRefs` doesn't match the Gateway's name, namespace, or listener `sectionName`. + +**Connection refused or routed to the wrong broker**: Verify that your client sends SNI. Connections without SNI (for example, plain TCP tools like `nc`) cannot be routed. Test with: + +[,bash] +---- +openssl s_client -connect :443 -servername redpanda.example.com Date: Mon, 13 Jul 2026 16:27:19 +0100 Subject: [PATCH 2/6] docs: add validated prerequisites for Gateway API external access Kind validation findings: - Kubernetes 1.31+ required: Gateway API 1.5 CRDs use CEL functions (isIP) that older API servers cannot compile - Controllers watching TLSRoute v1alpha2 (Envoy Gateway <= 1.7) need the Gateway API experimental channel CRDs, which serve v1alpha2 alongside v1; the standard channel serves v1 only - New troubleshooting entry for attachedRoutes: 0 / missing route status --- .../kubernetes/networking/external/k-gateway-api.adoc | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc index b07fa318e9..797b3622c9 100644 --- a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc +++ b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc @@ -24,9 +24,16 @@ Each external listener opts in independently with `type: tlsroute`, so you can m * Redpanda Helm chart or Redpanda Operator from the 26.2 release line or later. +* Kubernetes 1.31 or later. The Gateway API 1.5 CRDs use Common Expression Language (CEL) functions that older API servers cannot compile, so they fail to install on earlier Kubernetes versions. + * The https://gateway-api.sigs.k8s.io/[Gateway API^] CRDs, version 1.5 or later, installed in your Kubernetes cluster. Redpanda creates `TLSRoute` resources from the GA `gateway.networking.k8s.io/v1` API, which is available in Gateway API 1.5. * A Gateway controller that supports `TLSRoute` with TLS passthrough, such as Envoy Gateway or Istio, and a deployed `Gateway` resource with a TLS listener in `Passthrough` mode. Redpanda does not create the Gateway. ++ +[NOTE] +==== +Check which `TLSRoute` API version your Gateway controller watches. Controllers that still watch the deprecated `v1alpha2` version, which includes Envoy Gateway 1.7 and earlier, cannot see routes when the Gateway API *standard* channel CRDs are installed, because the standard channel serves `TLSRoute` only at `v1`. In that case, install the Gateway API *experimental* channel CRDs instead: they serve `v1alpha2` alongside `v1`, so both Redpanda and the controller can work with the same routes. Also install such controllers without their bundled, older Gateway API CRDs (for example, `helm install --skip-crds` for Envoy Gateway). +==== * TLS enabled on every listener that you route through the Gateway. The Gateway routes connections by SNI, which requires TLS. If you use xref:manage:kubernetes/security/tls/k-cert-manager.adoc[cert-manager-managed certificates], Redpanda automatically adds the bootstrap and per-broker hostnames to the certificate's Subject Alternative Names (SANs). @@ -235,7 +242,9 @@ kubectl get secret --namespace \ -o jsonpath='{.data.tls\.crt}' | base64 -d | openssl x509 -noout -text | grep DNS ---- -**TLSRoutes exist but `status.parents` is empty or not Accepted**: Your Gateway controller doesn't support `TLSRoute` from `gateway.networking.k8s.io/v1`, the Gateway listener isn't in `Passthrough` mode, or the route's `parentRefs` doesn't match the Gateway's name, namespace, or listener `sectionName`. +**TLSRoutes exist but have no `status`, and the Gateway reports `attachedRoutes: 0`**: Your Gateway controller cannot see the routes because it watches the deprecated `v1alpha2` version of `TLSRoute` and your installed Gateway API CRDs serve only `v1`. Install the Gateway API experimental channel CRDs, which serve both versions, and restart the controller. See <>. + +**TLSRoutes have a `status.parents` entry but the route is not Accepted**: The Gateway listener isn't in `Passthrough` mode, or the route's `parentRefs` doesn't match the Gateway's name, namespace, or listener `sectionName`. **Connection refused or routed to the wrong broker**: Verify that your client sends SNI. Connections without SNI (for example, plain TCP tools like `nc`) cannot be routed. Test with: From f93979def1781ce8c391dee16927ca0ee643c3f1 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 14 Jul 2026 10:49:29 +0100 Subject: [PATCH 3/6] docs: pin Gateway API prerequisite to published operator beta version The feature ships in the published operator chart 26.2.1-beta.x (the Redpanda CR path is runnable today), but no published Redpanda Helm chart includes it yet (latest is 26.1.8). State both explicitly and note the Helm tab requires the future 26.2 chart. --- .../pages/kubernetes/networking/external/k-gateway-api.adoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc index 797b3622c9..550fcae699 100644 --- a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc +++ b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc @@ -22,7 +22,9 @@ Each external listener opts in independently with `type: tlsroute`, so you can m == Prerequisites -* Redpanda Helm chart or Redpanda Operator from the 26.2 release line or later. +* Redpanda Operator {operator-beta-version} or later, or Redpanda Helm chart 26.2.0 or later. ++ +NOTE: During the 26.2 beta, this feature is available only through the Redpanda Operator beta releases. No published Redpanda Helm chart includes it yet. If you deploy with Helm rather than the Operator, wait for the 26.2 chart release. * Kubernetes 1.31 or later. The Gateway API 1.5 CRDs use Common Expression Language (CEL) functions that older API servers cannot compile, so they fail to install on earlier Kubernetes versions. @@ -97,6 +99,8 @@ kubectl apply -f redpanda-cluster.yaml --namespace Helm:: + -- +NOTE: Requires Redpanda Helm chart 26.2.0 or later. During the 26.2 beta, no published chart includes this feature; use the Redpanda Operator instead. + .`gateway-values.yaml` [,yaml] ---- From 323269d67d4964700ba401e6a47a5d6e5052f817 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 14 Jul 2026 12:52:17 +0100 Subject: [PATCH 4/6] docs: add operator beta version fallbacks so the Gateway API page renders a version The prerequisite uses {operator-beta-version}; without the antora.yml fallback it renders empty when the build-time version fetch is unavailable. Same fallback values as PR #1681 (identical lines, so the eventual merge is clean). --- antora.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/antora.yml b/antora.yml index 4e2c794239..e854317b0d 100644 --- a/antora.yml +++ b/antora.yml @@ -38,7 +38,8 @@ asciidoc: latest-console-tag: 'v3.3.1' latest-release-commit: 'ebee215fdb2b8004735c6f800e532564cdcc05e1' latest-operator-version: 'v2.3.8-24.3.6' - operator-beta-tag: '' + operator-beta-version: '26.2.1-beta.3' + operator-beta-tag: 'v26.2.1-beta.3' helm-beta-tag: '' latest-redpanda-helm-chart-version: '' redpanda-beta-version: '' From 3c4a97b315313e4dbd5e2ecb15746ecfe6f536e2 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 14 Jul 2026 12:59:06 +0100 Subject: [PATCH 5/6] docs: show how to install the beta operator in Gateway API prerequisites The prerequisite named a beta version without saying how to get it. Add the operator beta install command (beta chart version pinned via the operator-beta-version attribute) and a not-for-production note. --- .../networking/external/k-gateway-api.adoc | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc index 550fcae699..290862a782 100644 --- a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc +++ b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc @@ -24,7 +24,22 @@ Each external listener opts in independently with `type: tlsroute`, so you can m * Redpanda Operator {operator-beta-version} or later, or Redpanda Helm chart 26.2.0 or later. + -NOTE: During the 26.2 beta, this feature is available only through the Redpanda Operator beta releases. No published Redpanda Helm chart includes it yet. If you deploy with Helm rather than the Operator, wait for the 26.2 chart release. +[NOTE] +==== +During the 26.2 beta, this feature is available only through the Redpanda Operator beta releases. Beta releases are not recommended for production use. Install or upgrade the operator with the beta chart version: + +[,bash,subs="attributes+"] +---- +helm repo add redpanda https://charts.redpanda.com +helm repo update +helm upgrade --install redpanda-operator redpanda/operator \ + --namespace --create-namespace \ + --version {operator-beta-version} \ + --set crds.enabled=true +---- + +No published Redpanda Helm chart includes this feature yet. If you deploy with the Helm chart rather than the Operator, wait for the 26.2 chart release. +==== * Kubernetes 1.31 or later. The Gateway API 1.5 CRDs use Common Expression Language (CEL) functions that older API servers cannot compile, so they fail to install on earlier Kubernetes versions. From b3a8479b8340fa2c30533dda1c9da4a74abc6eb5 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 14 Jul 2026 17:17:25 +0100 Subject: [PATCH 6/6] docs: correct Gateway API TLSRoute controller and verification guidance Validated the procedure end-to-end on kind (operator 26.2.1-beta.3, Gateway API 1.5, Envoy Gateway, cert-manager) and fixed two issues: - Verification step: plain `kubectl get tlsroutes` prints only NAME/AGE, so use `-o custom-columns` to show hostnames; corrected sample output. - Controller guidance: recommend a controller that watches TLSRoute at v1 (Envoy Gateway 1.8+). Envoy Gateway 1.7 and earlier detect the CRD only at their server-preferred version, which Gateway API 1.5 makes v1, so they never attach the routes even with the experimental channel. --- .../networking/external/k-gateway-api.adoc | 23 ++++++++++++------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc index 290862a782..305acd6e4b 100644 --- a/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc +++ b/modules/manage/pages/kubernetes/networking/external/k-gateway-api.adoc @@ -49,7 +49,11 @@ No published Redpanda Helm chart includes this feature yet. If you deploy with t + [NOTE] ==== -Check which `TLSRoute` API version your Gateway controller watches. Controllers that still watch the deprecated `v1alpha2` version, which includes Envoy Gateway 1.7 and earlier, cannot see routes when the Gateway API *standard* channel CRDs are installed, because the standard channel serves `TLSRoute` only at `v1`. In that case, install the Gateway API *experimental* channel CRDs instead: they serve `v1alpha2` alongside `v1`, so both Redpanda and the controller can work with the same routes. Also install such controllers without their bundled, older Gateway API CRDs (for example, `helm install --skip-crds` for Envoy Gateway). +Use a controller version that watches `TLSRoute` at the GA `gateway.networking.k8s.io/v1` API, because Redpanda creates its routes at `v1`. For Envoy Gateway, this means version 1.8 or later. + +Envoy Gateway 1.7 and earlier watch the deprecated `v1alpha2` version and detect the `TLSRoute` CRD only at its server-preferred version. Because Gateway API 1.5 makes `v1` the preferred (storage) version of `TLSRoute`, these earlier controllers log `TLSRoute CRD not found, skipping TLSRoute watch` and never attach the routes, even when the *experimental* channel CRDs serve `v1alpha2` alongside `v1`. Upgrading the controller is the reliable fix; installing the experimental channel alone does not resolve it. + +Install the controller without its bundled Gateway API CRDs (for example, `helm install --skip-crds` for Envoy Gateway) so it uses your Gateway API 1.5 CRDs rather than replacing them with an older bundled version. ==== * TLS enabled on every listener that you route through the Gateway. The Gateway routes connections by SNI, which requires TLS. If you use xref:manage:kubernetes/security/tls/k-cert-manager.adoc[cert-manager-managed certificates], Redpanda automatically adds the bootstrap and per-broker hostnames to the certificate's Subject Alternative Names (SANs). @@ -166,17 +170,20 @@ By default, brokers advertise port `443` to clients. If your Gateway listens on + [,bash] ---- -kubectl get tlsroutes --namespace +kubectl get tlsroutes --namespace \ + -o custom-columns='NAME:.metadata.name,HOSTNAMES:.spec.hostnames' ---- + +NOTE: Plain `kubectl get tlsroutes` prints only the `NAME` and `AGE` columns. Use the `custom-columns` output above (or `-o yaml`) to see the hostnames. ++ For a three-broker cluster named `redpanda`, expect a bootstrap route and one route per broker: + ---- -NAME HOSTNAMES -redpanda-kafka-default-bootstrap ["redpanda.example.com"] -redpanda-kafka-default-0 ["redpanda-0-broker.example.com"] -redpanda-kafka-default-1 ["redpanda-1-broker.example.com"] -redpanda-kafka-default-2 ["redpanda-2-broker.example.com"] +NAME HOSTNAMES +redpanda-kafka-default-0 [redpanda-0-broker.example.com] +redpanda-kafka-default-1 [redpanda-1-broker.example.com] +redpanda-kafka-default-2 [redpanda-2-broker.example.com] +redpanda-kafka-default-bootstrap [redpanda.example.com] ---- + Check that each route's `status.parents` reports `Accepted: True` from your Gateway controller: @@ -261,7 +268,7 @@ kubectl get secret --namespace \ -o jsonpath='{.data.tls\.crt}' | base64 -d | openssl x509 -noout -text | grep DNS ---- -**TLSRoutes exist but have no `status`, and the Gateway reports `attachedRoutes: 0`**: Your Gateway controller cannot see the routes because it watches the deprecated `v1alpha2` version of `TLSRoute` and your installed Gateway API CRDs serve only `v1`. Install the Gateway API experimental channel CRDs, which serve both versions, and restart the controller. See <>. +**TLSRoutes exist but have no `status`, and the Gateway reports `attachedRoutes: 0`**: Your Gateway controller isn't watching `TLSRoute` at the `v1` API that Redpanda uses. Controllers that watch only the deprecated `v1alpha2` version, such as Envoy Gateway 1.7 and earlier, cannot attach these routes, and the controller log shows a message such as `TLSRoute CRD not found, skipping TLSRoute watch`. Upgrade to a controller version that watches `TLSRoute` at `v1` (Envoy Gateway 1.8 or later). Installing the experimental channel CRDs or restarting the controller does not help on its own. See <>. **TLSRoutes have a `status.parents` entry but the route is not Accepted**: The Gateway listener isn't in `Passthrough` mode, or the route's `parentRefs` doesn't match the Gateway's name, namespace, or listener `sectionName`.