diff --git a/charts/gateway-addons-helm/README.md b/charts/gateway-addons-helm/README.md index ad9bd969a6..a55b39cc41 100644 --- a/charts/gateway-addons-helm/README.md +++ b/charts/gateway-addons-helm/README.md @@ -41,7 +41,7 @@ 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) @@ -49,7 +49,7 @@ You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envo To uninstall the chart: ``` shell - helm uninstall eg-addons -n monitoring +helm uninstall eg-addons -n monitoring ``` ## Values diff --git a/charts/gateway-crds-helm/README.md b/charts/gateway-crds-helm/README.md index 54998fa960..a729d50b2d 100644 --- a/charts/gateway-crds-helm/README.md +++ b/charts/gateway-crds-helm/README.md @@ -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 diff --git a/charts/gateway-helm/README.md b/charts/gateway-helm/README.md index d2c7c8d68a..1b296544b6 100644 --- a/charts/gateway-helm/README.md +++ b/charts/gateway-helm/README.md @@ -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) @@ -38,7 +38,7 @@ 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 @@ -46,13 +46,13 @@ To install the eg chart along with Gateway API CRDs and Envoy Gateway 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 diff --git a/tools/helm-docs/readme.gateway-addons-helm.gotmpl b/tools/helm-docs/readme.gateway-addons-helm.gotmpl index b12c570796..54d78e42e5 100644 --- a/tools/helm-docs/readme.gateway-addons-helm.gotmpl +++ b/tools/helm-docs/readme.gateway-addons-helm.gotmpl @@ -25,7 +25,7 @@ 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) @@ -33,7 +33,7 @@ You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envo To uninstall the chart: ``` shell - helm uninstall eg-addons -n monitoring +helm uninstall eg-addons -n monitoring ``` {{ template "chart.valuesSection" . }} diff --git a/tools/helm-docs/readme.gateway-crds-helm.gotmpl b/tools/helm-docs/readme.gateway-crds-helm.gotmpl index 603c905b4a..39d446663e 100644 --- a/tools/helm-docs/readme.gateway-crds-helm.gotmpl +++ b/tools/helm-docs/readme.gateway-crds-helm.gotmpl @@ -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" . }} diff --git a/tools/helm-docs/readme.gateway-helm.gotmpl b/tools/helm-docs/readme.gateway-helm.gotmpl index 6fcd191975..bc631c9b83 100644 --- a/tools/helm-docs/readme.gateway-helm.gotmpl +++ b/tools/helm-docs/readme.gateway-helm.gotmpl @@ -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) @@ -34,7 +34,7 @@ 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 @@ -42,13 +42,13 @@ To install the eg chart along with Gateway API CRDs and Envoy Gateway 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" . }}