Skip to content

Commit 29cb580

Browse files
authored
docs(gateway-helm): clarify envoyProxy image values (#9222)
Signed-off-by: immanuwell <pchpr.00@list.ru>
1 parent 2af650c commit 29cb580

4 files changed

Lines changed: 27 additions & 19 deletions

File tree

charts/gateway-helm/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ Once Helm has been set up correctly, install the chart from dockerhub:
3535
``` shell
3636
helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
3737
```
38+
39+
Image overrides target different components. `global.images.envoyGateway.*` configures the Envoy Gateway control plane Deployment rendered by this chart. `global.images.envoyProxy.*` configures the managed Envoy Proxy data plane through the generated `EnvoyGateway` config.
40+
3841
This command installs both Gateway API CRDs and Envoy Gateway CRDs. If your Kubernetes provider already manages
3942
Gateway API CRDs for the cluster, confirm that the provider-installed Gateway API version and channel are compatible
4043
with the Envoy Gateway release and the Gateway API resources you plan to use. If they are compatible, install only the
@@ -138,12 +141,12 @@ helm uninstall eg -n envoy-gateway-system
138141
| deployment.replicas | int | `1` | |
139142
| global.imagePullSecrets | list | `[]` | Global override for image pull secrets |
140143
| global.imageRegistry | string | `""` | Global override for image registry |
141-
| global.images.envoyGateway.image | string | `nil` | |
142-
| global.images.envoyGateway.pullPolicy | string | `nil` | |
143-
| global.images.envoyGateway.pullSecrets | list | `[]` | |
144-
| global.images.envoyProxy.image | string | `""` | |
145-
| global.images.envoyProxy.pullPolicy | string | `""` | |
146-
| global.images.envoyProxy.pullSecrets | list | `[]` | |
144+
| global.images.envoyGateway.image | string | `nil` | Full image for the Envoy Gateway control plane Deployment installed by this chart. |
145+
| global.images.envoyGateway.pullPolicy | string | `nil` | Image pull policy for the Envoy Gateway control plane Deployment. Default behavior: latest images will be Always else IfNotPresent. |
146+
| global.images.envoyGateway.pullSecrets | list | `[]` | Pull secrets for the Envoy Gateway control plane Deployment. |
147+
| global.images.envoyProxy.image | string | `""` | Full image for the managed Envoy Proxy data plane. This updates the generated `envoyProxy` config and does not change the `envoy-gateway` control plane Deployment image. If not specified, the default image built into `envoy-gateway` is used. |
148+
| global.images.envoyProxy.pullPolicy | string | `""` | Image pull policy for the managed Envoy Proxy data plane. Default behavior: IfNotPresent. |
149+
| global.images.envoyProxy.pullSecrets | list | `[]` | Pull secrets for the managed Envoy Proxy data plane. |
147150
| global.images.ratelimit.image | string | `"docker.io/envoyproxy/ratelimit:master"` | |
148151
| global.images.ratelimit.pullPolicy | string | `"IfNotPresent"` | |
149152
| global.images.ratelimit.pullSecrets | list | `[]` | |

charts/gateway-helm/values.tmpl.yaml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ global:
1010
# Override image-specific values directly if a global override is not desired.
1111
images:
1212
envoyGateway:
13-
# This is the full image name including the hub, repo, and tag.
13+
# -- Full image for the Envoy Gateway control plane Deployment installed by this chart.
1414
image: ${GatewayImage}
15-
# Specify image pull policy if default behavior isn't desired.
15+
# -- Image pull policy for the Envoy Gateway control plane Deployment.
1616
# Default behavior: latest images will be Always else IfNotPresent.
1717
pullPolicy: ${GatewayImagePullPolicy}
18-
# List of secrets in the same namespace of the component that can be used to pull images from private repositories.
18+
# -- Pull secrets for the Envoy Gateway control plane Deployment.
1919
pullSecrets: []
2020
ratelimit:
2121
# This is the full image name including the hub, repo, and tag.
@@ -26,13 +26,15 @@ global:
2626
# List of secrets in the same namespace of the component that can be used to pull images from private repositories.
2727
pullSecrets: []
2828
envoyProxy:
29-
# This is the full image name including the hub, repo, and tag for the Envoy Proxy data plane.
30-
# If not specified, uses the default image built into envoy-gateway.
29+
# -- Full image for the managed Envoy Proxy data plane.
30+
# This updates the generated `envoyProxy` config and does not change the `envoy-gateway`
31+
# control plane Deployment image. If not specified, the default image built into
32+
# `envoy-gateway` is used.
3133
image: ""
32-
# Specify image pull policy if default behavior isn't desired.
34+
# -- Image pull policy for the managed Envoy Proxy data plane.
3335
# Default behavior: IfNotPresent.
3436
pullPolicy: ""
35-
# List of secrets in the same namespace of the component that can be used to pull images from private repositories.
37+
# -- Pull secrets for the managed Envoy Proxy data plane.
3638
pullSecrets: []
3739

3840
# Values for CRDs dependency

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,12 @@ The Helm chart for Envoy Gateway
8080
| deployment.replicas | int | `1` | |
8181
| global.imagePullSecrets | list | `[]` | Global override for image pull secrets |
8282
| global.imageRegistry | string | `""` | Global override for image registry |
83-
| global.images.envoyGateway.image | string | `nil` | |
84-
| global.images.envoyGateway.pullPolicy | string | `nil` | |
85-
| global.images.envoyGateway.pullSecrets | list | `[]` | |
86-
| global.images.envoyProxy.image | string | `""` | |
87-
| global.images.envoyProxy.pullPolicy | string | `""` | |
88-
| global.images.envoyProxy.pullSecrets | list | `[]` | |
83+
| global.images.envoyGateway.image | string | `nil` | Full image for the Envoy Gateway control plane Deployment installed by this chart. |
84+
| global.images.envoyGateway.pullPolicy | string | `nil` | Image pull policy for the Envoy Gateway control plane Deployment. Default behavior: latest images will be Always else IfNotPresent. |
85+
| global.images.envoyGateway.pullSecrets | list | `[]` | Pull secrets for the Envoy Gateway control plane Deployment. |
86+
| global.images.envoyProxy.image | string | `""` | Full image for the managed Envoy Proxy data plane. This updates the generated `envoyProxy` config and does not change the `envoy-gateway` control plane Deployment image. If not specified, the default image built into `envoy-gateway` is used. |
87+
| global.images.envoyProxy.pullPolicy | string | `""` | Image pull policy for the managed Envoy Proxy data plane. Default behavior: IfNotPresent. |
88+
| global.images.envoyProxy.pullSecrets | list | `[]` | Pull secrets for the managed Envoy Proxy data plane. |
8989
| global.images.ratelimit.image | string | `"docker.io/envoyproxy/ratelimit:master"` | |
9090
| global.images.ratelimit.pullPolicy | string | `"IfNotPresent"` | |
9191
| global.images.ratelimit.pullSecrets | list | `[]` | |

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ Once Helm has been set up correctly, install the chart from dockerhub:
2525
``` shell
2626
helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace
2727
```
28+
29+
Image overrides target different components. `global.images.envoyGateway.*` configures the Envoy Gateway control plane Deployment rendered by this chart. `global.images.envoyProxy.*` configures the managed Envoy Proxy data plane through the generated `EnvoyGateway` config.
30+
2831
This command installs both Gateway API CRDs and Envoy Gateway CRDs. If your Kubernetes provider already manages
2932
Gateway API CRDs for the cluster, confirm that the provider-installed Gateway API version and channel are compatible
3033
with the Envoy Gateway release and the Gateway API resources you plan to use. If they are compatible, install only the

0 commit comments

Comments
 (0)