-
Notifications
You must be signed in to change notification settings - Fork 361
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: bitliu <[email protected]>
- Loading branch information
Showing
1 changed file
with
53 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,83 @@ | ||
# Usage | ||
# gateway-helm | ||
|
||
![Version: v0.0.0-latest](https://img.shields.io/badge/Version-v0.0.0--latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) | ||
|
||
The Helm chart for Envoy Gateway | ||
|
||
**Homepage:** <https://gateway.envoyproxy.io/> | ||
|
||
## Maintainers | ||
|
||
| Name | Email | Url | | ||
| ---- | ------ | --- | | ||
| envoy-gateway-steering-committee | | <https://github.com/envoyproxy/gateway/blob/main/GOVERNANCE.md> | | ||
| envoy-gateway-maintainers | | <https://github.com/envoyproxy/gateway/blob/main/CODEOWNERS> | | ||
|
||
## Source Code | ||
|
||
* <https://github.com/envoyproxy/gateway> | ||
|
||
## Usage | ||
|
||
[Helm](https://helm.sh) must be installed to use the charts. Please refer to | ||
Helm's [documentation](https://helm.sh/docs) to get started. | ||
|
||
## Install from DockerHub | ||
### Install from DockerHub | ||
|
||
Once Helm has been set up correctly, install the chart from dockerhub: | ||
|
||
``` shell | ||
helm install eg oci://docker.io/envoyproxy/gateway-helm -n envoy-gateway-system --create-namespace | ||
``` | ||
|
||
## Install from Source Code | ||
### Install from Source Code | ||
|
||
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 | ||
helm install eg --create-namespace charts/gateway-helm -n envoy-gateway-system | ||
make kube-deploy TAG=latest | ||
``` | ||
|
||
## Skip install CRDs | ||
### Skip install 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 charts/gateway-helm -n envoy-gateway-system --skip-crds | ||
helm install eg --create-namespace oci://docker.io/envoyproxy/gateway-helm -n envoy-gateway-system --skip-crds | ||
``` | ||
|
||
To uninstall the chart: | ||
|
||
``` shell | ||
helm delete eg | ||
``` | ||
|
||
## Values | ||
|
||
| Key | Type | Default | Description | | ||
|-----|------|---------|-------------| | ||
| config.envoyGateway.gateway.controllerName | string | `"gateway.envoyproxy.io/gatewayclass-controller"` | | | ||
| config.envoyGateway.provider.type | string | `"Kubernetes"` | | | ||
| deployment.envoyGateway.image.repository | string | `"docker.io/envoyproxy/gateway-dev"` | | | ||
| deployment.envoyGateway.image.tag | string | `"latest"` | | | ||
| deployment.envoyGateway.imagePullPolicy | string | `"Always"` | | | ||
| deployment.envoyGateway.resources.limits.cpu | string | `"500m"` | | | ||
| deployment.envoyGateway.resources.limits.memory | string | `"128Mi"` | | | ||
| deployment.envoyGateway.resources.requests.cpu | string | `"10m"` | | | ||
| deployment.envoyGateway.resources.requests.memory | string | `"64Mi"` | | | ||
| deployment.kubeRbacProxy.image.repository | string | `"gcr.io/kubebuilder/kube-rbac-proxy"` | | | ||
| deployment.kubeRbacProxy.image.tag | string | `"v0.11.0"` | | | ||
| deployment.kubeRbacProxy.resources.limits.cpu | string | `"500m"` | | | ||
| deployment.kubeRbacProxy.resources.limits.memory | string | `"128Mi"` | | | ||
| deployment.kubeRbacProxy.resources.requests.cpu | string | `"5m"` | | | ||
| deployment.kubeRbacProxy.resources.requests.memory | string | `"64Mi"` | | | ||
| deployment.ports[0].name | string | `"grpc"` | | | ||
| deployment.ports[0].port | int | `18000` | | | ||
| deployment.ports[0].targetPort | int | `18000` | | | ||
| deployment.replicas | int | `1` | | | ||
| envoyGatewayMetricsService.ports[0].name | string | `"https"` | | | ||
| envoyGatewayMetricsService.ports[0].port | int | `8443` | | | ||
| envoyGatewayMetricsService.ports[0].protocol | string | `"TCP"` | | | ||
| envoyGatewayMetricsService.ports[0].targetPort | string | `"https"` | | |