Skip to content

Commit a467c51

Browse files
committed
docs(gateway): scope the suppression note to HTTP-01
The upgrade note states without qualification that a hostname held by a passthrough listener stops producing a listener and a certificate. That holds only in HTTP-01. DNS-01 and existingSecret render no per-hostname listeners at all: the wildcard https and https-apex listeners keep covering every name under the apex, passthrough hostnames included, so neither mode changes and neither sheds anything on upgrade. Assisted-By: Claude <[email protected]> Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent e269262 commit a467c51

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎packages/extra/gateway/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Two current limitations are worth knowing before designing around this. Each ent
7979

8080
This field is set on the `TenantGateway` resource directly; the chart exposes no corresponding value yet. That matters operationally: the `TenantGateway` object is rendered and owned by this chart, so a `kubectl edit` adding `tlsPassthroughListeners` is drift that Flux reverts on its next reconcile of the release. Until the chart exposes a value, treat the field as reachable only for experimentation on a suspended release.
8181

82-
One behaviour change reaches clusters that never set this field. A hostname a route claimed used to earn an HTTPS-terminate listener and an ACME certificate even when a passthrough listener already held that hostname, and the certificate went to a hostname whose backend presents its own. On port 443 that also put two listeners on one port and hostname — Gateway API admits the pair, because its listener uniqueness rule counts the protocol as well as the port and hostname, and its compatibility rules then call for both to report `Conflicted`. A hostname a passthrough listener holds now produces neither listener nor certificate, and neither does a hostname only a `TLSRoute` claims. The shipped `tlsPassthroughServices` default is `api`, `vm-exportproxy` and `cdi-uploadproxy`, each with a platform `TLSRoute` attached, so a stock Gateway-enabled cluster sheds three terminate listeners on upgrade and the controller garbage-collects the three certificates that went with them. Read the Gateway's listener conditions before upgrading if you want to know what those listeners were doing on your cluster rather than what the spec says they should have been doing.
82+
One behaviour change reaches clusters that never set this field. A hostname a route claimed used to earn an HTTPS-terminate listener and an ACME certificate even when a passthrough listener already held that hostname, and the certificate went to a hostname whose backend presents its own. On port 443 that also put two listeners on one port and hostname — Gateway API admits the pair, because its listener uniqueness rule counts the protocol as well as the port and hostname, and its compatibility rules then call for both to report `Conflicted`. In HTTP-01 mode a hostname a passthrough listener holds now produces neither listener nor certificate, and neither does a hostname only a `TLSRoute` claims. The other two cert modes are unaffected, because neither renders per-hostname listeners at all: the wildcard `https` and `https-apex` listeners still cover every name under the apex, passthrough hostnames included, so nothing changes and nothing is shed there. On HTTP-01 the shipped `tlsPassthroughServices` default is `api`, `vm-exportproxy` and `cdi-uploadproxy`, each with a platform `TLSRoute` attached, so a stock Gateway-enabled cluster sheds three terminate listeners on upgrade and the controller garbage-collects the three certificates that went with them. Read the Gateway's listener conditions before upgrading if you want to know what those listeners were doing on your cluster rather than what the spec says they should have been doing.
8383

8484
Two schema constraints tightened alongside this field apply to objects that already exist, since they are enforced on the next write rather than retroactively: `apex` must now be a lowercase hostname of at most 253 characters, and `tlsPassthroughServices` entries must be unique DNS-1123 labels. The shipped defaults and the chart's own `fail` on an empty host already conform, so an upgrade is a no-op in practice — but a cluster carrying a hand-edited upper-case apex will see its gateway release fail on the next apply rather than silently render a Gateway that Gateway API would reject anyway.
8585

0 commit comments

Comments
 (0)