Skip to content

helm: follow-up docs and template wording #9317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhaohuabing merged 2 commits into from
Jun 26, 2026
Merged

helm: follow-up docs and template wording #9317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00f15e4
follow-up docs and template wording
jukie Jun 24, 2026
7266217
Merge branch 'main' into helm-followup
jukie Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/gateway-crds-helm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ A Helm chart for Envoy Gateway CRDs
Please refer to Helm's [documentation](https://helm.sh/docs) to get started.

If you want to manage the CRDs outside of the Envoy Gateway Helm chart, you can use this chart to install the CRDs separately.
If you do, make sure that you don't install the CRDs again when installing the Envoy Gateway Helm chart, by using `--skip-crds` flag.
If you do, make sure that you don't install the CRDs again when installing the Envoy Gateway Helm chart, by using `--set crds.enabled=false`.
If your Kubernetes provider already manages Gateway API CRDs for the cluster, compare the provider-installed Gateway API
version and channel with the [Envoy Gateway compatibility matrix](https://gateway.envoyproxy.io/news/releases/matrix/)
and the Gateway API resources you plan to use. If they are compatible, leave those CRDs disabled in this chart and
Expand Down
17 changes: 9 additions & 8 deletions charts/gateway-helm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest
This command installs both Gateway API CRDs and Envoy Gateway CRDs. If your Kubernetes provider already manages
Gateway API CRDs for the cluster, confirm that the provider-installed Gateway API version and channel are compatible
with the Envoy Gateway release and the Gateway API resources you plan to use. If they are compatible, install only the
Envoy Gateway CRDs separately and use `--skip-crds` when installing this chart.
Envoy Gateway CRDs separately and use `--set crds.enabled=false` when installing this chart.

You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-helm/tags)

Expand All @@ -54,8 +54,9 @@ make kube-deploy TAG=latest

### Skip install CRDs

You can install the eg chart without Gateway API CRDs and Envoy Gateway CRDs. Make sure the CRDs exist in the cluster
before installing the chart with `--skip-crds`, otherwise Envoy Gateway may fail to start.
You can install the eg chart without the bundled Gateway API CRDs, Envoy Gateway CRDs, and Gateway API safe upgrade
policy resources by setting `crds.enabled=false`. Make sure these resources exist in the cluster before installing the
chart with `--set crds.enabled=false`, otherwise Envoy Gateway may fail to start.

If your Kubernetes provider manages compatible Gateway API CRDs, install only the Envoy Gateway CRDs from the
`gateway-crds-helm` chart first:
Expand All @@ -66,14 +67,14 @@ helm template eg-crds oci://docker.io/envoyproxy/gateway-crds-helm --set 'crds.g
```

If the provider-managed Gateway API CRDs are not compatible, use a compatible Gateway API CRD installation method for
the cluster first, then install this chart with `--skip-crds`.
the cluster first, then install this chart with `--set crds.enabled=false`.

After the required CRDs are installed, install the eg chart with `--skip-crds`. Gateway API safe upgrade policy
resources (the safe-upgrades ValidatingAdmissionPolicy and binding shipped with the Gateway API bundle) are rendered
from the chart templates on install by default, so disable them when these resources are managed outside this chart:
After the required CRDs are installed, install the eg chart with `--set crds.enabled=false`. Setting `crds.enabled=false`
also skips the Gateway API safe upgrade policy resources (the safe-upgrades ValidatingAdmissionPolicy and binding shipped
with the Gateway API bundle), so manage them outside this chart when these resources are owned elsewhere:

``` shell
helm install eg --create-namespace oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --skip-crds --set crds.gatewayAPI.safeUpgradePolicy.enabled=false
helm install eg --create-namespace oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --set crds.enabled=false
```

To uninstall the chart:
Expand Down
2 changes: 1 addition & 1 deletion tools/helm-docs/readme.gateway-crds-helm.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
Please refer to Helm's [documentation](https://helm.sh/docs) to get started.

If you want to manage the CRDs outside of the Envoy Gateway Helm chart, you can use this chart to install the CRDs separately.
If you do, make sure that you don't install the CRDs again when installing the Envoy Gateway Helm chart, by using `--skip-crds` flag.
If you do, make sure that you don't install the CRDs again when installing the Envoy Gateway Helm chart, by using `--set crds.enabled=false`.
If your Kubernetes provider already manages Gateway API CRDs for the cluster, compare the provider-installed Gateway API
version and channel with the [Envoy Gateway compatibility matrix](https://gateway.envoyproxy.io/news/releases/matrix/)
and the Gateway API resources you plan to use. If they are compatible, leave those CRDs disabled in this chart and
Expand Down
17 changes: 9 additions & 8 deletions tools/helm-docs/readme.gateway-helm.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest
This command installs both Gateway API CRDs and Envoy Gateway CRDs. If your Kubernetes provider already manages
Gateway API CRDs for the cluster, confirm that the provider-installed Gateway API version and channel are compatible
with the Envoy Gateway release and the Gateway API resources you plan to use. If they are compatible, install only the
Envoy Gateway CRDs separately and use `--skip-crds` when installing this chart.
Envoy Gateway CRDs separately and use `--set crds.enabled=false` when installing this chart.

You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-helm/tags)

Expand All @@ -44,8 +44,9 @@ make kube-deploy TAG=latest

### Skip install CRDs

You can install the eg chart without Gateway API CRDs and Envoy Gateway CRDs. Make sure the CRDs exist in the cluster
before installing the chart with `--skip-crds`, otherwise Envoy Gateway may fail to start.
You can install the eg chart without the bundled Gateway API CRDs, Envoy Gateway CRDs, and Gateway API safe upgrade
policy resources by setting `crds.enabled=false`. Make sure these resources exist in the cluster before installing the
chart with `--set crds.enabled=false`, otherwise Envoy Gateway may fail to start.

If your Kubernetes provider manages compatible Gateway API CRDs, install only the Envoy Gateway CRDs from the
`gateway-crds-helm` chart first:
Expand All @@ -56,14 +57,14 @@ helm template eg-crds oci://docker.io/envoyproxy/gateway-crds-helm --set 'crds.g
```

If the provider-managed Gateway API CRDs are not compatible, use a compatible Gateway API CRD installation method for
the cluster first, then install this chart with `--skip-crds`.
the cluster first, then install this chart with `--set crds.enabled=false`.

After the required CRDs are installed, install the eg chart with `--skip-crds`. Gateway API safe upgrade policy
resources (the safe-upgrades ValidatingAdmissionPolicy and binding shipped with the Gateway API bundle) are rendered
from the chart templates on install by default, so disable them when these resources are managed outside this chart:
After the required CRDs are installed, install the eg chart with `--set crds.enabled=false`. Setting `crds.enabled=false`
also skips the Gateway API safe upgrade policy resources (the safe-upgrades ValidatingAdmissionPolicy and binding shipped
with the Gateway API bundle), so manage them outside this chart when these resources are owned elsewhere:

``` shell
helm install eg --create-namespace oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --skip-crds --set crds.gatewayAPI.safeUpgradePolicy.enabled=false
helm install eg --create-namespace oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --set crds.enabled=false
```

To uninstall the chart:
Expand Down