From cca1e46a32df98682433f8f80aad85f7b2c5de40 Mon Sep 17 00:00:00 2001 From: Alexander Volchok Date: Mon, 10 Jun 2024 18:46:49 +0200 Subject: [PATCH] updating Signed-off-by: Alexander Volchok --- charts/gateway-addons-helm/README.md | 86 +++++++++++++++++++ charts/gateway-addons-helm/api.md | 50 +++++++++++ charts/gateway-helm/README.md | 2 +- charts/gateway-helm/values.tmpl.yaml | 2 +- .../en/latest/install/gateway-helm-api.md | 2 +- .../zh/latest/install/gateway-helm-api.md | 2 +- test/helm/default-config.out.yaml | 2 +- test/helm/deployment-images-config.out.yaml | 2 +- test/helm/envoy-gateway-config.out.yaml | 2 +- test/helm/global-images-config.out.yaml | 2 +- 10 files changed, 144 insertions(+), 8 deletions(-) create mode 100644 charts/gateway-addons-helm/README.md create mode 100644 charts/gateway-addons-helm/api.md diff --git a/charts/gateway-addons-helm/README.md b/charts/gateway-addons-helm/README.md new file mode 100644 index 00000000000..a1de66778e0 --- /dev/null +++ b/charts/gateway-addons-helm/README.md @@ -0,0 +1,86 @@ +# gateway-addons-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) + +An Add-ons Helm chart for Envoy Gateway + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| envoy-gateway-steering-committee | | | +| envoy-gateway-maintainers | | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| https://grafana.github.io/helm-charts | grafana | 6.58.4 | +| https://prometheus-community.github.io/helm-charts | prometheus | 23.1.0 | + +## 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 + +Once Helm has been set up correctly, install the chart from dockerhub: + +``` shell + helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace +``` +You can find all helm chart release in [Dockerhub](https://hub.docker.com/r/envoyproxy/gateway-helm/tags) + +### 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 + make kube-deploy TAG=latest +``` + +### 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 oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --skip-crds +``` + +To uninstall the chart: + +``` shell + helm delete eg +``` + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| grafana.adminPassword | string | `"admin"` | | +| grafana.datasources."datasources.yaml".apiVersion | int | `1` | | +| grafana.datasources."datasources.yaml".datasources[0].name | string | `"Prometheus"` | | +| grafana.datasources."datasources.yaml".datasources[0].type | string | `"prometheus"` | | +| grafana.datasources."datasources.yaml".datasources[0].url | string | `"http://prometheus-server"` | | +| grafana.service.type | string | `"LoadBalancer"` | | +| prometheus.alertmanager.enabled | bool | `false` | | +| prometheus.kube-state-metrics.enabled | bool | `false` | | +| prometheus.prometheus-node-exporter.enabled | bool | `false` | | +| prometheus.prometheus-pushgateway.enabled | bool | `false` | | +| prometheus.server.fullnameOverride | string | `"prometheus"` | | +| prometheus.server.global.scrape_interval | string | `"15s"` | | +| prometheus.server.image.repository | string | `"prom/prometheus"` | | +| prometheus.server.persistentVolume.enabled | bool | `false` | | +| prometheus.server.readinessProbeInitialDelay | int | `0` | | +| prometheus.server.securityContext | string | `nil` | | +| prometheus.server.service.type | string | `"LoadBalancer"` | | + diff --git a/charts/gateway-addons-helm/api.md b/charts/gateway-addons-helm/api.md new file mode 100644 index 00000000000..1680712cd5e --- /dev/null +++ b/charts/gateway-addons-helm/api.md @@ -0,0 +1,50 @@ ++++ +title = "Gateway Helm Chart" ++++ + +![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) + +An Add-ons Helm chart for Envoy Gateway + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| envoy-gateway-steering-committee | | | +| envoy-gateway-maintainers | | | + +## Source Code + +* + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| https://grafana.github.io/helm-charts | grafana | 6.58.4 | +| https://prometheus-community.github.io/helm-charts | prometheus | 23.1.0 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| grafana.adminPassword | string | `"admin"` | | +| grafana.datasources."datasources.yaml".apiVersion | int | `1` | | +| grafana.datasources."datasources.yaml".datasources[0].name | string | `"Prometheus"` | | +| grafana.datasources."datasources.yaml".datasources[0].type | string | `"prometheus"` | | +| grafana.datasources."datasources.yaml".datasources[0].url | string | `"http://prometheus-server"` | | +| grafana.service.type | string | `"LoadBalancer"` | | +| prometheus.alertmanager.enabled | bool | `false` | | +| prometheus.kube-state-metrics.enabled | bool | `false` | | +| prometheus.prometheus-node-exporter.enabled | bool | `false` | | +| prometheus.prometheus-pushgateway.enabled | bool | `false` | | +| prometheus.server.fullnameOverride | string | `"prometheus"` | | +| prometheus.server.global.scrape_interval | string | `"15s"` | | +| prometheus.server.image.repository | string | `"prom/prometheus"` | | +| prometheus.server.persistentVolume.enabled | bool | `false` | | +| prometheus.server.readinessProbeInitialDelay | int | `0` | | +| prometheus.server.securityContext | string | `nil` | | +| prometheus.server.service.type | string | `"LoadBalancer"` | | + diff --git a/charts/gateway-helm/README.md b/charts/gateway-helm/README.md index 9f03eb6b3e4..1e3d352d2cf 100644 --- a/charts/gateway-helm/README.md +++ b/charts/gateway-helm/README.md @@ -98,5 +98,5 @@ To uninstall the chart: | global.images.ratelimit.pullPolicy | string | `"IfNotPresent"` | | | global.images.ratelimit.pullSecrets | list | `[]` | | | kubernetesClusterDomain | string | `"cluster.local"` | | -| podDisruptionBudget.minAvailable | int | `0` | | +| podDisruptionBudget.minAvailable | int | `1` | | diff --git a/charts/gateway-helm/values.tmpl.yaml b/charts/gateway-helm/values.tmpl.yaml index 7e11291edd2..d2f075577aa 100644 --- a/charts/gateway-helm/values.tmpl.yaml +++ b/charts/gateway-helm/values.tmpl.yaml @@ -19,7 +19,7 @@ global: # List of secrets in the same namespace of the component that can be used to pull images from private repositories. pullSecrets: [] podDisruptionBudget: - minAvailable: 0 + minAvailable: 1 deployment: envoyGateway: image: diff --git a/site/content/en/latest/install/gateway-helm-api.md b/site/content/en/latest/install/gateway-helm-api.md index 29a3c9218bc..e20c5eba919 100644 --- a/site/content/en/latest/install/gateway-helm-api.md +++ b/site/content/en/latest/install/gateway-helm-api.md @@ -62,5 +62,5 @@ The Helm chart for Envoy Gateway | global.images.ratelimit.pullPolicy | string | `"IfNotPresent"` | | | global.images.ratelimit.pullSecrets | list | `[]` | | | kubernetesClusterDomain | string | `"cluster.local"` | | -| podDisruptionBudget.minAvailable | int | `0` | | +| podDisruptionBudget.minAvailable | int | `1` | | diff --git a/site/content/zh/latest/install/gateway-helm-api.md b/site/content/zh/latest/install/gateway-helm-api.md index 29a3c9218bc..e20c5eba919 100644 --- a/site/content/zh/latest/install/gateway-helm-api.md +++ b/site/content/zh/latest/install/gateway-helm-api.md @@ -62,5 +62,5 @@ The Helm chart for Envoy Gateway | global.images.ratelimit.pullPolicy | string | `"IfNotPresent"` | | | global.images.ratelimit.pullSecrets | list | `[]` | | | kubernetesClusterDomain | string | `"cluster.local"` | | -| podDisruptionBudget.minAvailable | int | `0` | | +| podDisruptionBudget.minAvailable | int | `1` | | diff --git a/test/helm/default-config.out.yaml b/test/helm/default-config.out.yaml index 6e3c92d981f..8797f7d4e8f 100644 --- a/test/helm/default-config.out.yaml +++ b/test/helm/default-config.out.yaml @@ -6,7 +6,7 @@ metadata: name: envoy-gateway namespace: 'envoy-gateway-system' spec: - minAvailable: 0 + minAvailable: 1 selector: matchLabels: control-plane: envoy-gateway diff --git a/test/helm/deployment-images-config.out.yaml b/test/helm/deployment-images-config.out.yaml index 7a902c0d115..a132ce9ed99 100644 --- a/test/helm/deployment-images-config.out.yaml +++ b/test/helm/deployment-images-config.out.yaml @@ -6,7 +6,7 @@ metadata: name: envoy-gateway namespace: 'envoy-gateway-system' spec: - minAvailable: 0 + minAvailable: 1 selector: matchLabels: control-plane: envoy-gateway diff --git a/test/helm/envoy-gateway-config.out.yaml b/test/helm/envoy-gateway-config.out.yaml index d09e08a416a..04c432dd4e3 100644 --- a/test/helm/envoy-gateway-config.out.yaml +++ b/test/helm/envoy-gateway-config.out.yaml @@ -6,7 +6,7 @@ metadata: name: envoy-gateway namespace: 'envoy-gateway-system' spec: - minAvailable: 0 + minAvailable: 1 selector: matchLabels: control-plane: envoy-gateway diff --git a/test/helm/global-images-config.out.yaml b/test/helm/global-images-config.out.yaml index c9977c1bc11..9fc93bef1d4 100644 --- a/test/helm/global-images-config.out.yaml +++ b/test/helm/global-images-config.out.yaml @@ -6,7 +6,7 @@ metadata: name: envoy-gateway namespace: 'envoy-gateway-system' spec: - minAvailable: 0 + minAvailable: 1 selector: matchLabels: control-plane: envoy-gateway