Skip to content

Commit c455a6e

Browse files
zirainzirain
authored
helm: fix README (envoyproxy#6472)
Signed-off-by: zirain <[email protected]>
1 parent 65df41b commit c455a6e

File tree

6 files changed

+26
-16
lines changed

6 files changed

+26
-16
lines changed

‎charts/gateway-addons-helm/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ The Envoy Gateway must be installed before installing this chart.
4141
Once Helm has been set up correctly, install the chart from dockerhub:
4242

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

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

4949
To uninstall the chart:
5050

5151
``` shell
52-
helm uninstall eg-addons -n monitoring
52+
helm uninstall eg-addons -n monitoring
5353
```
5454

5555
## Values

‎charts/gateway-crds-helm/README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,20 @@ If you do, make sure that you don't install the CRDs again when installing the E
1717
Once Helm has been set up correctly, install the chart from dockerhub:
1818

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

24+
**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)
25+
related to large CRDs in the `templates/` directory.
26+
2327
You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-crds-helm/tags)
2428

2529
To uninstall the chart:
2630

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

3136
## Values

‎charts/gateway-helm/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Please refer to Helm's [documentation](https://helm.sh/docs) to get started.
2727
Once Helm has been set up correctly, install the chart from dockerhub:
2828

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

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

4040
``` shell
41-
make kube-deploy TAG=latest
41+
make kube-deploy TAG=latest
4242
```
4343

4444
### Skip install CRDs
4545

4646
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:
4747

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

5252
To uninstall the chart:
5353

5454
``` shell
55-
helm uninstall eg -n envoy-gateway-system
55+
helm uninstall eg -n envoy-gateway-system
5656
```
5757

5858
## Values

‎tools/helm-docs/readme.gateway-addons-helm.gotmpl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ The Envoy Gateway must be installed before installing this chart.
2525
Once Helm has been set up correctly, install the chart from dockerhub:
2626

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

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

3333
To uninstall the chart:
3434

3535
``` shell
36-
helm uninstall eg-addons -n monitoring
36+
helm uninstall eg-addons -n monitoring
3737
```
3838

3939
{{ template "chart.valuesSection" . }}

‎tools/helm-docs/readme.gateway-crds-helm.gotmpl‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,20 @@ If you do, make sure that you don't install the CRDs again when installing the E
2626
Once Helm has been set up correctly, install the chart from dockerhub:
2727

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

33+
**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)
34+
related to large CRDs in the `templates/` directory.
35+
3236
You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-crds-helm/tags)
3337

3438
To uninstall the chart:
3539

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

4045
{{ template "chart.valuesSection" . }}

‎tools/helm-docs/readme.gateway-helm.gotmpl‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Please refer to Helm's [documentation](https://helm.sh/docs) to get started.
2323
Once Helm has been set up correctly, install the chart from dockerhub:
2424

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

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

3636
``` shell
37-
make kube-deploy TAG=latest
37+
make kube-deploy TAG=latest
3838
```
3939

4040
### Skip install CRDs
4141

4242
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:
4343

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

4848
To uninstall the chart:
4949

5050
``` shell
51-
helm uninstall eg -n envoy-gateway-system
51+
helm uninstall eg -n envoy-gateway-system
5252
```
5353

5454
{{ template "chart.valuesSection" . }}

0 commit comments

Comments
 (0)