From 6e8826641443322def667f498c162a1ae4fb0d19 Mon Sep 17 00:00:00 2001 From: Tristan Duverger Date: Fri, 4 Oct 2024 10:55:11 +0200 Subject: [PATCH] doc(argo-cd): generate documentation Signed-off-by: Tristan Duverger --- charts/argo-cd/README.md | 27 +++++++++++++++++++++++++++ charts/argo-cd/values.yaml | 35 +++++++++++++++++++++++++++-------- 2 files changed, 54 insertions(+), 8 deletions(-) diff --git a/charts/argo-cd/README.md b/charts/argo-cd/README.md index 8b0cb174..27ba569f 100644 --- a/charts/argo-cd/README.md +++ b/charts/argo-cd/README.md @@ -1020,6 +1020,33 @@ NAME: my-release | server.extensions.resources | object | `{}` | Resource limits and requests for the argocd-extensions container | | server.extraArgs | list | `[]` | Additional command line arguments to pass to Argo CD server | | server.extraContainers | list | `[]` | Additional containers to be added to the server pod | +| server.gateway.annotations | object | `{}` | Additional gateway annotations | +| server.gateway.controller | string | `"None"` | Specific implementation for gateway controller. Only `None` and `gke` are supported. | +| server.gateway.enabled | bool | `false` | enable a gateway resource for ArgoCD | +| server.gateway.gatewayClassName | string | `""` (See [values.yaml]) | Getaway class name | +| server.gateway.gke.GCPBackendPolicy.annotations | object | `{}` (See [values.yaml]) | Additional backend policy annotations | +| server.gateway.gke.GCPBackendPolicy.labels | object | `{}` (See [values.yaml]) | Additional backend policy labels | +| server.gateway.gke.GCPBackendPolicy.spec.default | object | `{}` (See [values.yaml]) | Default spec for GCPBackendPolicy | +| server.gateway.gke.GCPGatewayPolicy.annotations | object | `{}` (See [values.yaml]) | Additional gateway policy annotations | +| server.gateway.gke.GCPGatewayPolicy.labels | object | `{}` (See [values.yaml]) | Additional gateway policy labels | +| server.gateway.gke.GCPGatewayPolicy.spec.default | object | `{}` (See [values.yaml]) | Default spec for GCPGatewayPolicy | +| server.gateway.gke.HealthCheckPolicy.annotations | object | `{}` (See [values.yaml]) | Additional heath check policy annotations | +| server.gateway.gke.HealthCheckPolicy.labels | object | `{}` (See [values.yaml]) | Additional heath check policy labels | +| server.gateway.gke.HealthCheckPolicy.spec.default | object | Logs enabled and Heath check on argo server service (See [values.yaml]) | Default spec for GCP HealthCheckPolicy | +| server.gateway.httpRoute.annotations | object | `{}` (See [values.yaml]) | Additional route annotations | +| server.gateway.httpRoute.enabled | string | Same value than server.gateway.enabled (See [values.yaml]) | Enable a Gateway HTTP route resources for the Argo CD server | +| server.gateway.httpRoute.extraHosts | list | `[]` (See [values.yaml]) | The list of additional hostnames to be covered by API Gateway record | +| server.gateway.httpRoute.extraPaths | list | `[]` (See [values.yaml]) | Additional API Gateway paths | +| server.gateway.httpRoute.extraRules | list | `[]` (See [values.yaml]) | Additional routing rules | +| server.gateway.httpRoute.gateway | string | `""` (See [values.yaml]) | Defines which Gateway will implement the resource | +| server.gateway.httpRoute.gatewaySection | string | `""` (See [values.yaml]) | Defines which Gateway section will implement the resource | +| server.gateway.httpRoute.hostname | string | `""` (defaults to global.domain) | Argo CD server hostname | +| server.gateway.httpRoute.labels | object | `{}` (See [values.yaml]) | Additional route labels | +| server.gateway.httpRoute.path | string | `/` (See [values.yaml]) | The path to Argo CD server | +| server.gateway.httpRoute.pathType | string | `PathPrefix` (See [values.yaml]) | HTTP reoute path type. Either 'Exact' or `PathPrefix` | +| server.gateway.labels | object | `{}` | Additional gateway labels | +| server.gateway.listeners | list | Listen on http. | Gateway listeners | +| server.gateway.name | string | `""` (calculated with template "argo-cd.server.fullname") (See [values.yaml]) | Name of the new gateway | | server.hostNetwork | bool | `false` | Host Network for Server pods | | server.image.imagePullPolicy | string | `""` (defaults to global.image.imagePullPolicy) | Image pull policy for the Argo CD server | | server.image.repository | string | `""` (defaults to global.image.repository) | Repository to use for the Argo CD server | diff --git a/charts/argo-cd/values.yaml b/charts/argo-cd/values.yaml index fc14b08e..1f37c5f5 100644 --- a/charts/argo-cd/values.yaml +++ b/charts/argo-cd/values.yaml @@ -2168,10 +2168,15 @@ server: labels: {} # -- Additional gateway annotations annotations: {} - # networking.gke.io/certmap: "CERTIFICATE_MAP" - gatewayClassName: "" + #networking.gke.io/certmap: "CERTIFICATE_MAP_NAME" + + # -- Getaway class name # @default -- `""` (See [values.yaml]) ## Example: gatewayClassName: gke-l7-global-external-managed + gatewayClassName: "" + # -- Gateway listeners + # @default -- Listen on http. + ## Notes: Enabled https required ssl configuration depending on your k8s environment listeners: - name: http protocol: HTTP @@ -2188,30 +2193,36 @@ server: gke: GCPGatewayPolicy: # -- Additional gateway policy labels + # @default -- `{}` (See [values.yaml]) labels: {} # -- Additional gateway policy annotations + # @default -- `{}` (See [values.yaml]) annotations: {} spec: - # @default -- `{}` - ## Note: default spec for GCPGatewayPolicy + # -- Default spec for GCPGatewayPolicy + # @default -- `{}` (See [values.yaml]) default: {} GCPBackendPolicy: # -- Additional backend policy labels + # @default -- `{}` (See [values.yaml]) labels: {} # -- Additional backend policy annotations + # @default -- `{}` (See [values.yaml]) annotations: {} spec: + # -- Default spec for GCPBackendPolicy # @default -- `{}` (See [values.yaml]) - ## Note: default spec for GCPBackendPolicy default: {} HealthCheckPolicy: # -- Additional heath check policy labels + # @default -- `{}` (See [values.yaml]) labels: {} # -- Additional heath check policy annotations + # @default -- `{}` (See [values.yaml]) annotations: {} spec: - # @default -- `` (See [values.yaml]) - ## Note: default spec for HealthCheckPolicy. Logs enabled and Heath check on argo server service + # -- Default spec for GCP HealthCheckPolicy + # @default -- Logs enabled and Heath check on argo server service (See [values.yaml]) default: logConfig: enabled: true @@ -2224,16 +2235,21 @@ server: # NOTE: Alpha feature, gRPC & TLS pass-through will not work httpRoute: # -- Enable a Gateway HTTP route resources for the Argo CD server - enabled: "{{ .Values.server.gateway.enabled | default false }}" + # @default -- Same value than server.gateway.enabled (See [values.yaml]) + enabled: "{{ .Values.server.gateway.enabled }}" # -- Additional route labels + # @default -- `{}` (See [values.yaml]) labels: {} # -- Additional route annotations + # @default -- `{}` (See [values.yaml]) annotations: {} # -- Defines which Gateway will implement the resource + # @default -- `""` (See [values.yaml]) gateway: "" # -- Defines which Gateway section will implement the resource + # @default -- `""` (See [values.yaml]) gatewaySection: "" # -- Argo CD server hostname @@ -2241,12 +2257,15 @@ server: hostname: "" # -- The path to Argo CD server + # @default -- `/` (See [values.yaml]) path: / # -- HTTP reoute path type. Either 'Exact' or `PathPrefix` + # @default -- `PathPrefix` (See [values.yaml]) pathType: PathPrefix # -- The list of additional hostnames to be covered by API Gateway record + # @default -- `[]` (See [values.yaml]) extraHosts: [] # -- Additional API Gateway paths