Skip to content

Commit aebbd81

Browse files
committed
fix: add gen-check results
1 parent c8c416c commit aebbd81

4 files changed

Lines changed: 58 additions & 6 deletions

File tree

charts/gateway-helm/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,24 @@ helm uninstall eg -n envoy-gateway-system
6767
|-----|------|---------|-------------|
6868
| 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. |
6969
| commonLabels | object | `{}` | Labels to apply to all resources |
70-
| 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. |
70+
| config.envoyGateway | object | `{"extensionApis":{},"gateway":{"controllerName":"gateway.envoyproxy.io/gatewayclass-controller"},"logging":{"level":{"default":"info"}},"provider":{"kubernetes":{},"type":"Kubernetes"}}` | EnvoyGateway configuration. Visit https://gateway.envoyproxy.io/docs/api/extension_types/#envoygateway to view all options. |
7171
| createNamespace | bool | `false` | |
7272
| deployment.annotations | object | `{}` | |
7373
| deployment.envoyGateway.extraEnv | list | `[]` | Additional environment variables for the envoy-gateway container. |
7474
| deployment.envoyGateway.image.repository | string | `""` | |
7575
| deployment.envoyGateway.image.tag | string | `""` | |
7676
| deployment.envoyGateway.imagePullPolicy | string | `""` | |
7777
| deployment.envoyGateway.imagePullSecrets | list | `[]` | |
78+
| deployment.envoyGateway.livenessProbe.httpGet.path | string | `"/healthz"` | |
79+
| deployment.envoyGateway.livenessProbe.httpGet.port | int | `8081` | |
80+
| deployment.envoyGateway.livenessProbe.periodSeconds | int | `20` | |
81+
| deployment.envoyGateway.livenessProbe.successThreshold | int | `1` | |
82+
| deployment.envoyGateway.livenessProbe.timeoutSeconds | int | `1` | |
83+
| deployment.envoyGateway.readinessProbe.httpGet.path | string | `"/readyz"` | |
84+
| deployment.envoyGateway.readinessProbe.httpGet.port | int | `8081` | |
85+
| deployment.envoyGateway.readinessProbe.periodSeconds | int | `10` | |
86+
| deployment.envoyGateway.readinessProbe.successThreshold | int | `1` | |
87+
| deployment.envoyGateway.readinessProbe.timeoutSeconds | int | `1` | |
7888
| deployment.envoyGateway.resources.limits.memory | string | `"1024Mi"` | |
7989
| deployment.envoyGateway.resources.requests.cpu | string | `"100m"` | |
8090
| deployment.envoyGateway.resources.requests.memory | string | `"256Mi"` | |
@@ -85,6 +95,12 @@ helm uninstall eg -n envoy-gateway-system
8595
| deployment.envoyGateway.securityContext.runAsNonRoot | bool | `true` | |
8696
| deployment.envoyGateway.securityContext.runAsUser | int | `65532` | |
8797
| deployment.envoyGateway.securityContext.seccompProfile.type | string | `"RuntimeDefault"` | |
98+
| deployment.envoyGateway.startupProbe.failureThreshold | int | `30` | |
99+
| deployment.envoyGateway.startupProbe.httpGet.path | string | `"/healthz"` | |
100+
| deployment.envoyGateway.startupProbe.httpGet.port | int | `8081` | |
101+
| deployment.envoyGateway.startupProbe.periodSeconds | int | `1` | |
102+
| deployment.envoyGateway.startupProbe.successThreshold | int | `1` | |
103+
| deployment.envoyGateway.startupProbe.timeoutSeconds | int | `1` | |
88104
| deployment.pod.affinity | object | `{}` | |
89105
| deployment.pod.annotations."prometheus.io/port" | string | `"19001"` | |
90106
| deployment.pod.annotations."prometheus.io/scrape" | string | `"true"` | |

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,24 @@ The Helm chart for Envoy Gateway
3131
|-----|------|---------|-------------|
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 |
34-
| 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. |
34+
| config.envoyGateway | object | `{"extensionApis":{},"gateway":{"controllerName":"gateway.envoyproxy.io/gatewayclass-controller"},"logging":{"level":{"default":"info"}},"provider":{"kubernetes":{},"type":"Kubernetes"}}` | EnvoyGateway configuration. Visit https://gateway.envoyproxy.io/docs/api/extension_types/#envoygateway to view all options. |
3535
| createNamespace | bool | `false` | |
3636
| deployment.annotations | object | `{}` | |
3737
| deployment.envoyGateway.extraEnv | list | `[]` | Additional environment variables for the envoy-gateway container. |
3838
| deployment.envoyGateway.image.repository | string | `""` | |
3939
| deployment.envoyGateway.image.tag | string | `""` | |
4040
| deployment.envoyGateway.imagePullPolicy | string | `""` | |
4141
| deployment.envoyGateway.imagePullSecrets | list | `[]` | |
42+
| deployment.envoyGateway.livenessProbe.httpGet.path | string | `"/healthz"` | |
43+
| deployment.envoyGateway.livenessProbe.httpGet.port | int | `8081` | |
44+
| deployment.envoyGateway.livenessProbe.periodSeconds | int | `20` | |
45+
| deployment.envoyGateway.livenessProbe.successThreshold | int | `1` | |
46+
| deployment.envoyGateway.livenessProbe.timeoutSeconds | int | `1` | |
47+
| deployment.envoyGateway.readinessProbe.httpGet.path | string | `"/readyz"` | |
48+
| deployment.envoyGateway.readinessProbe.httpGet.port | int | `8081` | |
49+
| deployment.envoyGateway.readinessProbe.periodSeconds | int | `10` | |
50+
| deployment.envoyGateway.readinessProbe.successThreshold | int | `1` | |
51+
| deployment.envoyGateway.readinessProbe.timeoutSeconds | int | `1` | |
4252
| deployment.envoyGateway.resources.limits.memory | string | `"1024Mi"` | |
4353
| deployment.envoyGateway.resources.requests.cpu | string | `"100m"` | |
4454
| deployment.envoyGateway.resources.requests.memory | string | `"256Mi"` | |
@@ -49,6 +59,12 @@ The Helm chart for Envoy Gateway
4959
| deployment.envoyGateway.securityContext.runAsNonRoot | bool | `true` | |
5060
| deployment.envoyGateway.securityContext.runAsUser | int | `65532` | |
5161
| deployment.envoyGateway.securityContext.seccompProfile.type | string | `"RuntimeDefault"` | |
62+
| deployment.envoyGateway.startupProbe.failureThreshold | int | `30` | |
63+
| deployment.envoyGateway.startupProbe.httpGet.path | string | `"/healthz"` | |
64+
| deployment.envoyGateway.startupProbe.httpGet.port | int | `8081` | |
65+
| deployment.envoyGateway.startupProbe.periodSeconds | int | `1` | |
66+
| deployment.envoyGateway.startupProbe.successThreshold | int | `1` | |
67+
| deployment.envoyGateway.startupProbe.timeoutSeconds | int | `1` | |
5268
| deployment.pod.affinity | object | `{}` | |
5369
| deployment.pod.annotations."prometheus.io/port" | string | `"19001"` | |
5470
| deployment.pod.annotations."prometheus.io/scrape" | string | `"true"` | |

test/helm/gateway-helm/deployment-extraenv.out.yaml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -434,12 +434,21 @@ spec:
434434
value: "50"
435435
image: docker.io/envoyproxy/gateway-dev:latest
436436
imagePullPolicy: Always
437+
startupProbe:
438+
failureThreshold: 30
439+
httpGet:
440+
path: /healthz
441+
port: 8081
442+
periodSeconds: 1
443+
successThreshold: 1
444+
timeoutSeconds: 1
437445
livenessProbe:
438446
httpGet:
439447
path: /healthz
440448
port: 8081
441-
initialDelaySeconds: 15
442449
periodSeconds: 20
450+
successThreshold: 1
451+
timeoutSeconds: 1
443452
name: envoy-gateway
444453
ports:
445454
- containerPort: 18000
@@ -456,8 +465,9 @@ spec:
456465
httpGet:
457466
path: /readyz
458467
port: 8081
459-
initialDelaySeconds: 5
460468
periodSeconds: 10
469+
successThreshold: 1
470+
timeoutSeconds: 1
461471
resources:
462472
limits:
463473
memory: 1024Mi

test/helm/gateway-helm/deployment-volume-mounts.out.yaml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -430,12 +430,21 @@ spec:
430430
value: cluster.local
431431
image: docker.io/envoyproxy/gateway-dev:latest
432432
imagePullPolicy: Always
433+
startupProbe:
434+
failureThreshold: 30
435+
httpGet:
436+
path: /healthz
437+
port: 8081
438+
periodSeconds: 1
439+
successThreshold: 1
440+
timeoutSeconds: 1
433441
livenessProbe:
434442
httpGet:
435443
path: /healthz
436444
port: 8081
437-
initialDelaySeconds: 15
438445
periodSeconds: 20
446+
successThreshold: 1
447+
timeoutSeconds: 1
439448
name: envoy-gateway
440449
ports:
441450
- containerPort: 18000
@@ -452,8 +461,9 @@ spec:
452461
httpGet:
453462
path: /readyz
454463
port: 8081
455-
initialDelaySeconds: 5
456464
periodSeconds: 10
465+
successThreshold: 1
466+
timeoutSeconds: 1
457467
resources:
458468
limits:
459469
memory: 1024Mi

0 commit comments

Comments
 (0)