Skip to content

Commit acc6b83

Browse files
committed
docs(gateway): document helm template CRD install to avoid 1MB secret limit
1 parent 96f72b0 commit acc6b83

1 file changed

Lines changed: 25 additions & 11 deletions

File tree

docs/guide/gateway/gateway.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,33 @@ The LBC is built for Gateway API version v1.5.0.
1818
* For `ip` target type:
1919
* Pods have native AWS VPC networking configured. For more information, see the [Amazon VPC CNI plugin](https://github.com/aws/amazon-vpc-cni-k8s#readme) documentation.
2020
* Installation of Gateway API CRDs — choose one of:
21-
* **Helm (recommended):** enable via Helm values when installing or upgrading the chart:
22-
```yaml
23-
crds:
24-
gatewayAPI:
25-
standard:
26-
enabled: true # required for L7 (HTTPRoute, GRPCRoute)
27-
experimental:
28-
enabled: true # optional, required for L4 (TCPRoute, UDPRoute, TLSRoute)
21+
* **`helm template` (recommended):** render the chart locally and pipe into `kubectl apply --server-side`. This installs CRDs without creating a Helm release secret, bypassing the 1 MB limit that causes `helm install`/`helm upgrade` to fail when CRDs are enabled.
22+
23+
Standard channel only (required for L7 — HTTPRoute, GRPCRoute):
24+
```bash
25+
helm template aws-load-balancer-controller eks/aws-load-balancer-controller \
26+
--set crds.gatewayAPI.standard.enabled=true \
27+
--include-crds \
28+
| kubectl apply --server-side -f -
2929
```
30+
31+
Standard + experimental (also enables L4 — TCPRoute, UDPRoute, TLSRoute):
32+
```bash
33+
helm template aws-load-balancer-controller eks/aws-load-balancer-controller \
34+
--set crds.gatewayAPI.standard.enabled=true \
35+
--set crds.gatewayAPI.experimental.enabled=true \
36+
--include-crds \
37+
| kubectl apply --server-side -f -
38+
```
39+
3040
* **Manual:** apply directly from the upstream release:
31-
* Standard: `kubectl apply --server-side=true -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.5.0/standard-install.yaml` [REQUIRED]
32-
* Experimental: `kubectl apply --server-side=true -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.5.0/experimental-install.yaml` [OPTIONAL: Used for L4 Routes]
33-
* Installation of LBC Gateway API specific CRDs: `kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/refs/heads/main/config/crd/gateway/gateway-crds.yaml`
41+
* Standard: `kubectl apply --server-side -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.5.0/standard-install.yaml` [REQUIRED]
42+
* Experimental: `kubectl apply --server-side -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.5.0/experimental-install.yaml` [OPTIONAL: Used for L4 Routes]
43+
44+
* Installation of LBC Gateway API specific CRDs:
45+
```bash
46+
kubectl apply --server-side -f https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/refs/heads/main/config/crd/gateway/gateway-crds.yaml
47+
```
3448

3549

3650
## Upgrading Gateway API CRDs

0 commit comments

Comments
 (0)