Skip to content

helm: fix README #6472

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 1 commit into from
Jul 7, 2025
Merged

helm: fix README #6472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions charts/gateway-addons-helm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ The Envoy Gateway must be installed before installing this chart.
Once Helm has been set up correctly, install the chart from dockerhub:

``` shell
helm install eg-addons oci://docker.io/envoyproxy/gateway-addons-helm --version v0.0.0-latest -n monitoring --create-namespace
helm install eg-addons oci://docker.io/envoyproxy/gateway-addons-helm --version v0.0.0-latest -n monitoring --create-namespace
```

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

To uninstall the chart:

``` shell
helm uninstall eg-addons -n monitoring
helm uninstall eg-addons -n monitoring
```

## Values
Expand Down
9 changes: 7 additions & 2 deletions charts/gateway-crds-helm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,20 @@ If you do, make sure that you don't install the CRDs again when installing the E
Once Helm has been set up correctly, install the chart from dockerhub:

``` shell
helm install gateway-crds oci://docker.io/envoyproxy/gateway-crds-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
helm template eg-crds oci://docker.io/envoyproxy/gateway-crds-helm \
--version v0.0.0-latest | kubectl apply --server-side -f -
```

**Note**: We're using `helm template` piped into `kubectl apply` instead of `helm install` due to a [known Helm limitation](https://github.com/helm/helm/pull/12277)
related to large CRDs in the `templates/` directory.

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

To uninstall the chart:

``` shell
helm uninstall gateway-crds -n envoy-gateway-system
helm template eg-crds oci://docker.io/envoyproxy/gateway-crds-helm \
--version v0.0.0-latest | kubectl delete --server-side -f -
```

## Values
Expand Down
8 changes: 4 additions & 4 deletions charts/gateway-helm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Please refer to Helm's [documentation](https://helm.sh/docs) to get started.
Once Helm has been set up correctly, install the chart from dockerhub:

``` shell
helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
```
You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-helm/tags)

Expand All @@ -38,21 +38,21 @@ You can also install the helm chart from the source code:
To install the eg chart along with Gateway API CRDs and Envoy Gateway CRDs:

``` shell
make kube-deploy TAG=latest
make kube-deploy TAG=latest
```

### Skip install CRDs

You can install the eg chart along without Gateway API CRDs and Envoy Gateway CRDs, make sure CRDs exist in Cluster first if you want to skip to install them, otherwise EG may fail to start:

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

To uninstall the chart:

``` shell
helm uninstall eg -n envoy-gateway-system
helm uninstall eg -n envoy-gateway-system
```

## Values
Expand Down
4 changes: 2 additions & 2 deletions tools/helm-docs/readme.gateway-addons-helm.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ The Envoy Gateway must be installed before installing this chart.
Once Helm has been set up correctly, install the chart from dockerhub:

``` shell
helm install eg-addons oci://docker.io/envoyproxy/gateway-addons-helm --version v0.0.0-latest -n monitoring --create-namespace
helm install eg-addons oci://docker.io/envoyproxy/gateway-addons-helm --version v0.0.0-latest -n monitoring --create-namespace
```

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

To uninstall the chart:

``` shell
helm uninstall eg-addons -n monitoring
helm uninstall eg-addons -n monitoring
```

{{ template "chart.valuesSection" . }}
Expand Down
9 changes: 7 additions & 2 deletions 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 @@ -26,15 +26,20 @@ If you do, make sure that you don't install the CRDs again when installing the E
Once Helm has been set up correctly, install the chart from dockerhub:

``` shell
helm install gateway-crds oci://docker.io/envoyproxy/gateway-crds-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
helm template eg-crds oci://docker.io/envoyproxy/gateway-crds-helm \
--version v0.0.0-latest | kubectl apply --server-side -f -
```

**Note**: We're using `helm template` piped into `kubectl apply` instead of `helm install` due to a [known Helm limitation](https://github.com/helm/helm/pull/12277)
related to large CRDs in the `templates/` directory.

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

To uninstall the chart:

``` shell
helm uninstall gateway-crds -n envoy-gateway-system
helm template eg-crds oci://docker.io/envoyproxy/gateway-crds-helm \
--version v0.0.0-latest | kubectl delete --server-side -f -
```

{{ template "chart.valuesSection" . }}
Expand Down
8 changes: 4 additions & 4 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 @@ -23,7 +23,7 @@ Please refer to Helm's [documentation](https://helm.sh/docs) to get started.
Once Helm has been set up correctly, install the chart from dockerhub:

``` shell
helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
```
You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-helm/tags)

Expand All @@ -34,21 +34,21 @@ You can also install the helm chart from the source code:
To install the eg chart along with Gateway API CRDs and Envoy Gateway CRDs:

``` shell
make kube-deploy TAG=latest
make kube-deploy TAG=latest
```

### Skip install CRDs

You can install the eg chart along without Gateway API CRDs and Envoy Gateway CRDs, make sure CRDs exist in Cluster first if you want to skip to install them, otherwise EG may fail to start:

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

To uninstall the chart:

``` shell
helm uninstall eg -n envoy-gateway-system
helm uninstall eg -n envoy-gateway-system
```

{{ template "chart.valuesSection" . }}
Expand Down