Skip to content

Commit 05ceef7

Browse files
committed
docs: recommend ListenerSet over mergeGateways
The mergeGateways feature was introduced before the Gateway API supported ListenerSet. ListenerSet is the Gateway API-native mechanism for splitting listeners across resources: it removes the single-Gateway 64-listener limit and enables a delegated management model suitable for high-scale, multi-tenant environments. Add recommendation alerts to the deployment-mode docs pointing users to ListenerSet, linking the upstream user guide and issue #1230. Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
1 parent 265fdeb commit 05ceef7

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

site/content/en/latest/tasks/operations/deployment-mode.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ Please follow the example [Multi-tenancy](#multi-tenancy).
2020

2121
### Merged Gateways onto a single EnvoyProxy fleet
2222

23+
{{% alert title="Recommendation" color="primary" %}}
24+
25+
The `mergeGateways` feature was introduced before the Gateway API supported [ListenerSet][]. For splitting listeners
26+
across multiple resources, prefer [ListenerSet][]: it is the Gateway API-native mechanism, it removes the
27+
single-Gateway 64-listener limit, and it enables a delegated management model where a platform team owns the Gateway
28+
and application teams define ports, hostnames, and TLS certificates in their own ListenerSets, suitable for
29+
high-scale, multi-tenant environments. See the [ListenerSet user guide][] and [issue 1230][] for details.
30+
31+
{{% /alert %}}
32+
2333
By default, each Gateway has its own dedicated set of Envoy Proxy and its configurations.
2434
However, for some deployments, it may be more convenient to merge listeners across multiple Gateways and deploy a single Envoy Proxy fleet.
2535

@@ -659,6 +669,12 @@ Handling connection for 8889
659669

660670
### Merged gateways deployment
661671

672+
{{% alert title="Recommendation" color="primary" %}}
673+
674+
For new deployments, consider using [ListenerSet][] instead of `mergeGateways`.
675+
676+
{{% /alert %}}
677+
662678
In this example, we will deploy GatewayClass
663679

664680
```shell
@@ -1083,3 +1099,5 @@ curl --header "Host: www.merged3.com" http://$GATEWAY_HOST:8082/example3
10831099
[Gateway Namespace Mode]: ./gateway-namespace-mode
10841100
[issue1231]: https://github.com/envoyproxy/gateway/issues/1231
10851101
[issue2629]: https://github.com/envoyproxy/gateway/issues/2629
1102+
[issue 1230]: https://github.com/envoyproxy/gateway/issues/1230
1103+
[ListenerSet]: https://gateway-api.sigs.k8s.io/guides/user-guides/listener-set/

0 commit comments

Comments
 (0)