doc(argo-cd): generate documentation

Signed-off-by: Tristan Duverger <tristan.duverger@gmail.com>
This commit is contained in:
Tristan Duverger 2024-10-04 10:55:11 +02:00 committed by Tristan Duverger
parent 44377b3664
commit 6e88266414
2 changed files with 54 additions and 8 deletions

View file

@ -1020,6 +1020,33 @@ NAME: my-release
| server.extensions.resources | object | `{}` | Resource limits and requests for the argocd-extensions container | | 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.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.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.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.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 | | server.image.repository | string | `""` (defaults to global.image.repository) | Repository to use for the Argo CD server |

View file

@ -2168,10 +2168,15 @@ server:
labels: {} labels: {}
# -- Additional gateway annotations # -- Additional gateway annotations
annotations: {} annotations: {}
# networking.gke.io/certmap: "CERTIFICATE_MAP" #networking.gke.io/certmap: "CERTIFICATE_MAP_NAME"
gatewayClassName: ""
# -- Getaway class name
# @default -- `""` (See [values.yaml]) # @default -- `""` (See [values.yaml])
## Example: gatewayClassName: gke-l7-global-external-managed ## 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: listeners:
- name: http - name: http
protocol: HTTP protocol: HTTP
@ -2188,30 +2193,36 @@ server:
gke: gke:
GCPGatewayPolicy: GCPGatewayPolicy:
# -- Additional gateway policy labels # -- Additional gateway policy labels
# @default -- `{}` (See [values.yaml])
labels: {} labels: {}
# -- Additional gateway policy annotations # -- Additional gateway policy annotations
# @default -- `{}` (See [values.yaml])
annotations: {} annotations: {}
spec: spec:
# @default -- `{}` # -- Default spec for GCPGatewayPolicy
## Note: default spec for GCPGatewayPolicy # @default -- `{}` (See [values.yaml])
default: {} default: {}
GCPBackendPolicy: GCPBackendPolicy:
# -- Additional backend policy labels # -- Additional backend policy labels
# @default -- `{}` (See [values.yaml])
labels: {} labels: {}
# -- Additional backend policy annotations # -- Additional backend policy annotations
# @default -- `{}` (See [values.yaml])
annotations: {} annotations: {}
spec: spec:
# -- Default spec for GCPBackendPolicy
# @default -- `{}` (See [values.yaml]) # @default -- `{}` (See [values.yaml])
## Note: default spec for GCPBackendPolicy
default: {} default: {}
HealthCheckPolicy: HealthCheckPolicy:
# -- Additional heath check policy labels # -- Additional heath check policy labels
# @default -- `{}` (See [values.yaml])
labels: {} labels: {}
# -- Additional heath check policy annotations # -- Additional heath check policy annotations
# @default -- `{}` (See [values.yaml])
annotations: {} annotations: {}
spec: spec:
# @default -- `` (See [values.yaml]) # -- Default spec for GCP HealthCheckPolicy
## Note: default spec for HealthCheckPolicy. Logs enabled and Heath check on argo server service # @default -- Logs enabled and Heath check on argo server service (See [values.yaml])
default: default:
logConfig: logConfig:
enabled: true enabled: true
@ -2224,16 +2235,21 @@ server:
# NOTE: Alpha feature, gRPC & TLS pass-through will not work # NOTE: Alpha feature, gRPC & TLS pass-through will not work
httpRoute: httpRoute:
# -- Enable a Gateway HTTP route resources for the Argo CD server # -- 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 # -- Additional route labels
# @default -- `{}` (See [values.yaml])
labels: {} labels: {}
# -- Additional route annotations # -- Additional route annotations
# @default -- `{}` (See [values.yaml])
annotations: {} annotations: {}
# -- Defines which Gateway will implement the resource # -- Defines which Gateway will implement the resource
# @default -- `""` (See [values.yaml])
gateway: "" gateway: ""
# -- Defines which Gateway section will implement the resource # -- Defines which Gateway section will implement the resource
# @default -- `""` (See [values.yaml])
gatewaySection: "" gatewaySection: ""
# -- Argo CD server hostname # -- Argo CD server hostname
@ -2241,12 +2257,15 @@ server:
hostname: "" hostname: ""
# -- The path to Argo CD server # -- The path to Argo CD server
# @default -- `/` (See [values.yaml])
path: / path: /
# -- HTTP reoute path type. Either 'Exact' or `PathPrefix` # -- HTTP reoute path type. Either 'Exact' or `PathPrefix`
# @default -- `PathPrefix` (See [values.yaml])
pathType: PathPrefix pathType: PathPrefix
# -- The list of additional hostnames to be covered by API Gateway record # -- The list of additional hostnames to be covered by API Gateway record
# @default -- `[]` (See [values.yaml])
extraHosts: [] extraHosts: []
# -- Additional API Gateway paths # -- Additional API Gateway paths