|
| 1 | +# gateway-helm |
| 2 | + |
| 3 | +   |
| 4 | + |
| 5 | +The Helm chart for Envoy Gateway |
| 6 | + |
| 7 | +**Homepage:** <https://gateway.envoyproxy.io/> |
| 8 | + |
| 9 | +## Maintainers |
| 10 | + |
| 11 | +| Name | Email | Url | |
| 12 | +| ---- | ------ | --- | |
| 13 | +| envoy-gateway-steering-committee | | <https://github.com/envoyproxy/gateway/blob/main/GOVERNANCE.md> | |
| 14 | +| envoy-gateway-maintainers | | <https://github.com/envoyproxy/gateway/blob/main/CODEOWNERS> | |
| 15 | + |
| 16 | +## Source Code |
| 17 | + |
| 18 | +* <https://github.com/envoyproxy/gateway> |
| 19 | + |
| 20 | +## Usage |
| 21 | + |
| 22 | +[Helm](https://helm.sh) must be installed to use the charts. |
| 23 | +Please refer to Helm's [documentation](https://helm.sh/docs) to get started. |
| 24 | + |
| 25 | +### Install from DockerHub |
| 26 | + |
| 27 | +Once Helm has been set up correctly, install the chart from dockerhub: |
| 28 | + |
| 29 | +``` shell |
| 30 | + helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace |
| 31 | +``` |
| 32 | +You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-helm/tags) |
| 33 | + |
| 34 | +### Install from Source Code |
| 35 | + |
| 36 | +You can also install the helm chart from the source code: |
| 37 | + |
| 38 | +To install the eg chart along with Gateway API CRDs and Envoy Gateway CRDs: |
| 39 | + |
| 40 | +``` shell |
| 41 | + make kube-deploy TAG=latest |
| 42 | +``` |
| 43 | + |
| 44 | +### Skip install CRDs |
| 45 | + |
| 46 | +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: |
| 47 | + |
| 48 | +``` shell |
| 49 | + helm install eg --create-namespace oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --skip-crds |
| 50 | +``` |
| 51 | + |
| 52 | +To uninstall the chart: |
| 53 | + |
| 54 | +``` shell |
| 55 | + helm uninstall eg -n envoy-gateway-system |
| 56 | +``` |
| 57 | + |
| 58 | +## Values |
| 59 | + |
| 60 | +| Key | Type | Default | Description | |
| 61 | +|-----|------|---------|-------------| |
| 62 | +| certgen | object | `{"job":{"annotations":{},"resources":{},"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. | |
| 63 | +| config.envoyGateway.gateway.controllerName | string | `"gateway.envoyproxy.io/gatewayclass-controller"` | | |
| 64 | +| config.envoyGateway.logging.level.default | string | `"info"` | | |
| 65 | +| config.envoyGateway.provider.type | string | `"Kubernetes"` | | |
| 66 | +| createNamespace | bool | `false` | | |
| 67 | +| deployment.envoyGateway.image.repository | string | `""` | | |
| 68 | +| deployment.envoyGateway.image.tag | string | `""` | | |
| 69 | +| deployment.envoyGateway.imagePullPolicy | string | `""` | | |
| 70 | +| deployment.envoyGateway.imagePullSecrets | list | `[]` | | |
| 71 | +| deployment.envoyGateway.resources.limits.cpu | string | `"500m"` | | |
| 72 | +| deployment.envoyGateway.resources.limits.memory | string | `"1024Mi"` | | |
| 73 | +| deployment.envoyGateway.resources.requests.cpu | string | `"100m"` | | |
| 74 | +| deployment.envoyGateway.resources.requests.memory | string | `"256Mi"` | | |
| 75 | +| deployment.pod.affinity | object | `{}` | | |
| 76 | +| deployment.pod.annotations."prometheus.io/port" | string | `"19001"` | | |
| 77 | +| deployment.pod.annotations."prometheus.io/scrape" | string | `"true"` | | |
| 78 | +| deployment.pod.labels | object | `{}` | | |
| 79 | +| deployment.pod.tolerations | list | `[]` | | |
| 80 | +| deployment.pod.topologySpreadConstraints | list | `[]` | | |
| 81 | +| deployment.ports[0].name | string | `"grpc"` | | |
| 82 | +| deployment.ports[0].port | int | `18000` | | |
| 83 | +| deployment.ports[0].targetPort | int | `18000` | | |
| 84 | +| deployment.ports[1].name | string | `"ratelimit"` | | |
| 85 | +| deployment.ports[1].port | int | `18001` | | |
| 86 | +| deployment.ports[1].targetPort | int | `18001` | | |
| 87 | +| deployment.ports[2].name | string | `"wasm"` | | |
| 88 | +| deployment.ports[2].port | int | `18002` | | |
| 89 | +| deployment.ports[2].targetPort | int | `18002` | | |
| 90 | +| deployment.ports[3].name | string | `"metrics"` | | |
| 91 | +| deployment.ports[3].port | int | `19001` | | |
| 92 | +| deployment.ports[3].targetPort | int | `19001` | | |
| 93 | +| deployment.replicas | int | `1` | | |
| 94 | +| global.images.envoyGateway.image | string | `nil` | | |
| 95 | +| global.images.envoyGateway.pullPolicy | string | `nil` | | |
| 96 | +| global.images.envoyGateway.pullSecrets | list | `[]` | | |
| 97 | +| global.images.ratelimit.image | string | `"docker.io/envoyproxy/ratelimit:master"` | | |
| 98 | +| global.images.ratelimit.pullPolicy | string | `"IfNotPresent"` | | |
| 99 | +| global.images.ratelimit.pullSecrets | list | `[]` | | |
| 100 | +| kubernetesClusterDomain | string | `"cluster.local"` | | |
| 101 | +| podDisruptionBudget.minAvailable | int | `0` | | |
| 102 | + |
0 commit comments