Skip to content

Commit f898042

Browse files
cilindroxzhaohuabing
authored andcommitted
docs: update Helm installation steps
Use the `crds.enabled` variable in the examples instead of the `--skip-crds` flag. Update crds.enabled variable description. Co-authored-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com> Signed-off-by: Gaston Festari <cilindrox@gmail.com>
1 parent f87a7d5 commit f898042

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

charts/gateway-helm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ helm uninstall eg -n envoy-gateway-system
8989
| certgen | object | `{"job":{"affinity":{},"annotations":{},"args":[],"nodeSelector":{},"pod":{"annotations":{},"labels":{}},"resources":{},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"privileged":false,"readOnlyRootFilesystem":true,"runAsGroup":65532,"runAsNonRoot":true,"runAsUser":65532,"seccompProfile":{"type":"RuntimeDefault"}},"tolerations":[],"ttlSecondsAfterFinished":30},"rbac":{"annotations":{},"labels":{}}}` | Certgen is used to generate the certificates required by EnvoyGateway. If you want to construct a custom certificate, you can generate a custom certificate through Cert-Manager before installing EnvoyGateway. Certgen will not overwrite the custom certificate. Please do not manually modify `values.yaml` to disable certgen, it may cause EnvoyGateway OIDC,OAuth2,etc. to not work as expected. |
9090
| commonLabels | object | `{}` | Labels to apply to all resources |
9191
| config.envoyGateway | object | `{"extensionApis":{},"gateway":{"controllerName":"gateway.envoyproxy.io/gatewayclass-controller"},"logging":{"level":{"default":"info"}},"provider":{"type":"Kubernetes"}}` | EnvoyGateway configuration. Visit https://gateway.envoyproxy.io/docs/api/extension_types/#envoygateway to view all options. |
92-
| crds.enabled | bool | `true` | |
92+
| crds.enabled | bool | `true` | Install Envoy Gateway CRDs, Gateway API CRDs, and Gateway API safe upgrade policy resources. Set to false when these resources are managed separately. |
9393
| createNamespace | bool | `false` | |
9494
| deployment.annotations | object | `{}` | |
9595
| deployment.envoyGateway.extraEnv | list | `[]` | Additional environment variables for the envoy-gateway container. |

charts/gateway-helm/values.tmpl.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ global:
3737

3838
# Values for CRDs dependency
3939
crds:
40+
# -- Install Envoy Gateway CRDs, Gateway API CRDs, and Gateway API safe upgrade policy resources. Set to false when these resources are managed separately.
4041
enabled: true
4142

4243
# -- Labels to apply to all resources

site/content/en/latest/install/gateway-helm-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The Helm chart for Envoy Gateway
3232
| certgen | object | `{"job":{"affinity":{},"annotations":{},"args":[],"nodeSelector":{},"pod":{"annotations":{},"labels":{}},"resources":{},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"privileged":false,"readOnlyRootFilesystem":true,"runAsGroup":65532,"runAsNonRoot":true,"runAsUser":65532,"seccompProfile":{"type":"RuntimeDefault"}},"tolerations":[],"ttlSecondsAfterFinished":30},"rbac":{"annotations":{},"labels":{}}}` | Certgen is used to generate the certificates required by EnvoyGateway. If you want to construct a custom certificate, you can generate a custom certificate through Cert-Manager before installing EnvoyGateway. Certgen will not overwrite the custom certificate. Please do not manually modify `values.yaml` to disable certgen, it may cause EnvoyGateway OIDC,OAuth2,etc. to not work as expected. |
3333
| commonLabels | object | `{}` | Labels to apply to all resources |
3434
| config.envoyGateway | object | `{"extensionApis":{},"gateway":{"controllerName":"gateway.envoyproxy.io/gatewayclass-controller"},"logging":{"level":{"default":"info"}},"provider":{"type":"Kubernetes"}}` | EnvoyGateway configuration. Visit https://gateway.envoyproxy.io/docs/api/extension_types/#envoygateway to view all options. |
35-
| crds.enabled | bool | `true` | |
35+
| crds.enabled | bool | `true` | Install Envoy Gateway CRDs, Gateway API CRDs, and Gateway API safe upgrade policy resources. Set to false when these resources are managed separately. |
3636
| createNamespace | bool | `false` | |
3737
| deployment.annotations | object | `{}` | |
3838
| deployment.envoyGateway.extraEnv | list | `[]` | Additional environment variables for the envoy-gateway container. |

site/content/en/latest/install/install-helm.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Install the Gateway API CRDs and Envoy Gateway:
3333
The default Helm install applies both Gateway API CRDs and Envoy Gateway CRDs. If your Kubernetes provider already
3434
manages Gateway API CRDs for the cluster, confirm that the provider-installed Gateway API version and channel are
3535
compatible with the Envoy Gateway release and the Gateway API resources you plan to use. If they are compatible,
36-
install only the Envoy Gateway CRDs separately, then install the Envoy Gateway Helm chart with `--skip-crds`.
36+
install only the Envoy Gateway CRDs separately, then install the Envoy Gateway Helm chart with `--set crds.enabled=false`.
3737
{{% /alert %}}
3838

3939
```shell
@@ -89,14 +89,14 @@ helm template eg oci://docker.io/envoyproxy/gateway-crds-helm \
8989
**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)
9090
related to large CRDs in the `templates/` directory.
9191

92-
Once the CRDs are installed, you can install the main Envoy Gateway Helm chart without re-applying CRDs by using the `--skip-crds` flag:
92+
Once the CRDs are installed, you can install the main Envoy Gateway Helm chart without re-applying CRDs by disabling the dependency via `--set crds.enabled=false`:
9393

9494
```shell
9595
helm install eg oci://docker.io/envoyproxy/gateway-helm \
9696
--version {{< helm-version >}} \
9797
-n envoy-gateway-system \
9898
--create-namespace \
99-
--skip-crds
99+
--set crds.enabled=false
100100
```
101101

102102
### Clusters with compatible provider-managed Gateway API CRDs
@@ -132,13 +132,12 @@ helm install eg oci://docker.io/envoyproxy/gateway-helm \
132132
--version {{< helm-version >}} \
133133
-n envoy-gateway-system \
134134
--create-namespace \
135-
--skip-crds \
136-
--set crds.gatewayAPI.safeUpgradePolicy.enabled=false
135+
--set crds.enabled=false
137136
```
138137

139138
If the provider-managed Gateway API CRDs are not compatible with your Envoy Gateway release or required Gateway API
140139
resources, do not mix them with another copy installed by Envoy Gateway. Use a compatible Gateway API CRD installation
141-
method for the cluster first, then install Envoy Gateway with `--skip-crds`.
140+
method for the cluster first, then install Envoy Gateway with `--set crds.enabled=false`.
142141

143142
## Upgrading from the previous version
144143

0 commit comments

Comments
 (0)