Skip to content

Commit e9495d3

Browse files
fty4fty4
authored
docs(argo-cd): Fix Argo CD value description typos for AppSet and Notification controllers (argoproj#1706)
* docs(argo-cd): rename 'application set' to 'ApplicationSet' * docs(argo-cd): add ApplicationSet prefix for controller * docs(argo-cd): fix ApplicationSet to PascalCase * docs(argo-cd): fix notification controller description for logFormat/logLevel * docs(argo-cd): add notification prefix to values file description * chore(argo-cd): bump chart version * chore(argo-cd): add changelog * chore: generate helm-docs Signed-off-by: Marco Lecheler <[email protected]>
1 parent 3644e71 commit e9495d3

File tree

3 files changed

+54
-53
lines changed

3 files changed

+54
-53
lines changed

‎charts/argo-cd/Chart.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ appVersion: v2.5.4
33
kubeVersion: ">=1.22.0-0"
44
description: A Helm chart for Argo CD, a declarative, GitOps continuous delivery tool for Kubernetes.
55
name: argo-cd
6-
version: 5.16.4
6+
version: 5.16.5
77
home: https://github.com/argoproj/argo-helm
88
icon: https://argo-cd.readthedocs.io/en/stable/assets/logo.png
99
sources:
@@ -23,4 +23,5 @@ dependencies:
2323
condition: redis-ha.enabled
2424
annotations:
2525
artifacthub.io/changes: |
26-
- "[Fixed]: Prevent could not parse 0 warning"
26+
- "[Docs]: Updated ApplicationSet value documentation"
27+
- "[Docs]: Updated notification value documentation"

‎charts/argo-cd/README.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -965,14 +965,14 @@ If you want to use an existing Redis (eg. a managed service from a cloud provide
965965
| applicationSet.deploymentAnnotations | object | `{}` | Annotations to be added to ApplicationSet controller Deployment |
966966
| applicationSet.enabled | bool | `true` | Enable ApplicationSet controller |
967967
| applicationSet.extraArgs | list | `[]` | List of extra cli args to add |
968-
| applicationSet.extraContainers | list | `[]` | Additional containers to be added to the applicationset controller pod |
969-
| applicationSet.extraEnv | list | `[]` | Environment variables to pass to the controller |
970-
| applicationSet.extraEnvFrom | list | `[]` (See [values.yaml]) | envFrom to pass to the controller |
968+
| applicationSet.extraContainers | list | `[]` | Additional containers to be added to the ApplicationSet controller pod |
969+
| applicationSet.extraEnv | list | `[]` | Environment variables to pass to the ApplicationSet controller |
970+
| applicationSet.extraEnvFrom | list | `[]` (See [values.yaml]) | envFrom to pass to the ApplicationSet controller |
971971
| applicationSet.extraVolumeMounts | list | `[]` | List of extra mounts to add (normally used with extraVolumes) |
972972
| applicationSet.extraVolumes | list | `[]` | List of extra volumes to add |
973-
| applicationSet.image.imagePullPolicy | string | `""` (defaults to global.image.imagePullPolicy) | Image pull policy for the application set controller |
974-
| applicationSet.image.repository | string | `""` (defaults to global.image.repository) | Repository to use for the application set controller |
975-
| applicationSet.image.tag | string | `""` (defaults to global.image.tag) | Tag to use for the application set controller |
973+
| applicationSet.image.imagePullPolicy | string | `""` (defaults to global.image.imagePullPolicy) | Image pull policy for the ApplicationSet controller |
974+
| applicationSet.image.repository | string | `""` (defaults to global.image.repository) | Repository to use for the ApplicationSet controller |
975+
| applicationSet.image.tag | string | `""` (defaults to global.image.tag) | Tag to use for the ApplicationSet controller |
976976
| applicationSet.imagePullSecrets | list | `[]` (defaults to global.imagePullSecrets) | If defined, uses a Secret to pull an image from a private Docker registry or repository. |
977977
| applicationSet.livenessProbe.enabled | bool | `false` | Enable Kubernetes liveness probe for ApplicationSet controller |
978978
| applicationSet.livenessProbe.failureThreshold | int | `3` | Minimum consecutive failures for the [probe] to be considered failed after having succeeded |
@@ -997,15 +997,15 @@ If you want to use an existing Redis (eg. a managed service from a cloud provide
997997
| applicationSet.metrics.serviceMonitor.scheme | string | `""` | Prometheus ServiceMonitor scheme |
998998
| applicationSet.metrics.serviceMonitor.selector | object | `{}` | Prometheus ServiceMonitor selector |
999999
| applicationSet.metrics.serviceMonitor.tlsConfig | object | `{}` | Prometheus ServiceMonitor tlsConfig |
1000-
| applicationSet.name | string | `"applicationset-controller"` | Application Set controller name string |
1000+
| applicationSet.name | string | `"applicationset-controller"` | ApplicationSet controller name string |
10011001
| applicationSet.nodeSelector | object | `{}` | [Node selector] |
10021002
| applicationSet.pdb.annotations | object | `{}` | Annotations to be added to ApplicationSet controller pdb |
10031003
| applicationSet.pdb.enabled | bool | `false` | Deploy a [PodDisruptionBudget] for the ApplicationSet controller |
10041004
| applicationSet.pdb.labels | object | `{}` | Labels to be added to ApplicationSet controller pdb |
10051005
| applicationSet.pdb.maxUnavailable | string | `""` | Number of pods that are unavailble after eviction as number or percentage (eg.: 50%). |
10061006
| applicationSet.pdb.minAvailable | string | `""` (defaults to 0 if not specified) | Number of pods that are available after eviction as number or percentage (eg.: 50%) |
1007-
| applicationSet.podAnnotations | object | `{}` | Annotations for the controller pods |
1008-
| applicationSet.podLabels | object | `{}` | Labels for the controller pods |
1007+
| applicationSet.podAnnotations | object | `{}` | Annotations for the ApplicationSet controller pods |
1008+
| applicationSet.podLabels | object | `{}` | Labels for the ApplicationSet controller pods |
10091009
| applicationSet.priorityClassName | string | `""` | If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default. |
10101010
| applicationSet.readinessProbe.enabled | bool | `false` | Enable Kubernetes liveness probe for ApplicationSet controller |
10111011
| applicationSet.readinessProbe.failureThreshold | int | `3` | Minimum consecutive failures for the [probe] to be considered failed after having succeeded |
@@ -1014,11 +1014,11 @@ If you want to use an existing Redis (eg. a managed service from a cloud provide
10141014
| applicationSet.readinessProbe.successThreshold | int | `1` | Minimum consecutive successes for the [probe] to be considered successful after having failed |
10151015
| applicationSet.readinessProbe.timeoutSeconds | int | `1` | Number of seconds after which the [probe] times out |
10161016
| applicationSet.replicaCount | int | `1` | The number of ApplicationSet controller pods to run |
1017-
| applicationSet.resources | object | `{}` | Resource limits and requests for the controller pods. |
1018-
| applicationSet.service.annotations | object | `{}` | Application set service annotations |
1019-
| applicationSet.service.labels | object | `{}` | Application set service labels |
1020-
| applicationSet.service.port | int | `7000` | Application set service port |
1021-
| applicationSet.service.portName | string | `"webhook"` | Application set service port name |
1017+
| applicationSet.resources | object | `{}` | Resource limits and requests for the ApplicationSet controller pods. |
1018+
| applicationSet.service.annotations | object | `{}` | ApplicationSet service annotations |
1019+
| applicationSet.service.labels | object | `{}` | ApplicationSet service labels |
1020+
| applicationSet.service.port | int | `7000` | ApplicationSet service port |
1021+
| applicationSet.service.portName | string | `"webhook"` | ApplicationSet service port name |
10221022
| applicationSet.serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
10231023
| applicationSet.serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
10241024
| applicationSet.serviceAccount.labels | object | `{}` | Labels applied to created service account |
@@ -1028,7 +1028,7 @@ If you want to use an existing Redis (eg. a managed service from a cloud provide
10281028
| applicationSet.webhook.ingress.enabled | bool | `false` | Enable an ingress resource for Webhooks |
10291029
| applicationSet.webhook.ingress.extraPaths | list | `[]` | Additional ingress paths |
10301030
| applicationSet.webhook.ingress.hosts | list | `[]` | List of ingress hosts |
1031-
| applicationSet.webhook.ingress.ingressClassName | string | `""` | Defines which ingress controller will implement the resource |
1031+
| applicationSet.webhook.ingress.ingressClassName | string | `""` | Defines which ingress ApplicationSet controller will implement the resource |
10321032
| applicationSet.webhook.ingress.labels | object | `{}` | Additional ingress labels |
10331033
| applicationSet.webhook.ingress.pathType | string | `"Prefix"` | Ingress path type. One of `Exact`, `Prefix` or `ImplementationSpecific` |
10341034
| applicationSet.webhook.ingress.paths | list | `["/api/webhook"]` | List of ingress paths |
@@ -1061,22 +1061,22 @@ If you want to use an existing Redis (eg. a managed service from a cloud provide
10611061
| notifications.bots.slack.serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
10621062
| notifications.bots.slack.serviceAccount.name | string | `"argocd-notifications-bot"` | The name of the service account to use. |
10631063
| notifications.bots.slack.tolerations | list | `[]` | [Tolerations] for use with node taints |
1064-
| notifications.cm.create | bool | `true` | Whether helm chart creates controller config map |
1064+
| notifications.cm.create | bool | `true` | Whether helm chart creates notifications controller config map |
10651065
| notifications.containerSecurityContext | object | See [values.yaml] | Notification controller container-level security Context |
10661066
| notifications.context | object | `{}` | Define user-defined context |
10671067
| notifications.deploymentAnnotations | object | `{}` | Annotations to be applied to the notifications controller Deployment |
10681068
| notifications.enabled | bool | `true` | Enable notifications controller |
1069-
| notifications.extraArgs | list | `[]` | Extra arguments to provide to the controller |
1069+
| notifications.extraArgs | list | `[]` | Extra arguments to provide to the notifications controller |
10701070
| notifications.extraEnv | list | `[]` | Additional container environment variables |
1071-
| notifications.extraEnvFrom | list | `[]` (See [values.yaml]) | envFrom to pass to the controller |
1071+
| notifications.extraEnvFrom | list | `[]` (See [values.yaml]) | envFrom to pass to the notifications controller |
10721072
| notifications.extraVolumeMounts | list | `[]` | List of extra mounts to add (normally used with extraVolumes) |
10731073
| notifications.extraVolumes | list | `[]` | List of extra volumes to add |
10741074
| notifications.image.imagePullPolicy | string | `""` (defaults to global.image.imagePullPolicy) | Image pull policy for the notifications controller |
10751075
| notifications.image.repository | string | `""` (defaults to global.image.repository) | Repository to use for the notifications controller |
10761076
| notifications.image.tag | string | `""` (defaults to global.image.tag) | Tag to use for the notifications controller |
10771077
| notifications.imagePullSecrets | list | `[]` (defaults to global.imagePullSecrets) | Secrets with credentials to pull images from a private registry |
1078-
| notifications.logFormat | string | `""` (defaults to global.logging.format) | Application controller log format. Either `text` or `json` |
1079-
| notifications.logLevel | string | `""` (defaults to global.logging.level) | Application controller log level. One of: `debug`, `info`, `warn`, `error` |
1078+
| notifications.logFormat | string | `""` (defaults to global.logging.format) | Notifications controller log format. Either `text` or `json` |
1079+
| notifications.logLevel | string | `""` (defaults to global.logging.level) | Notifications controller log level. One of: `debug`, `info`, `warn`, `error` |
10801080
| notifications.metrics.enabled | bool | `false` | Enables prometheus metrics server |
10811081
| notifications.metrics.port | int | `9001` | Metrics port |
10821082
| notifications.metrics.service.annotations | object | `{}` | Metrics service annotations |
@@ -1096,12 +1096,12 @@ If you want to use an existing Redis (eg. a managed service from a cloud provide
10961096
| notifications.pdb.labels | object | `{}` | Labels to be added to notifications controller pdb |
10971097
| notifications.pdb.maxUnavailable | string | `""` | Number of pods that are unavailble after eviction as number or percentage (eg.: 50%). |
10981098
| notifications.pdb.minAvailable | string | `""` (defaults to 0 if not specified) | Number of pods that are available after eviction as number or percentage (eg.: 50%) |
1099-
| notifications.podAnnotations | object | `{}` | Annotations to be applied to the controller Pods |
1100-
| notifications.podLabels | object | `{}` | Labels to be applied to the controller Pods |
1101-
| notifications.priorityClassName | string | `""` | Priority class for the controller pods |
1102-
| notifications.resources | object | `{}` | Resource limits and requests for the controller |
1099+
| notifications.podAnnotations | object | `{}` | Annotations to be applied to the notifications controller Pods |
1100+
| notifications.podLabels | object | `{}` | Labels to be applied to the notifications controller Pods |
1101+
| notifications.priorityClassName | string | `""` | Priority class for the notifications controller pods |
1102+
| notifications.resources | object | `{}` | Resource limits and requests for the notifications controller |
11031103
| notifications.secret.annotations | object | `{}` | key:value pairs of annotations to be added to the secret |
1104-
| notifications.secret.create | bool | `true` | Whether helm chart creates controller secret |
1104+
| notifications.secret.create | bool | `true` | Whether helm chart creates notifications controller secret |
11051105
| notifications.secret.items | object | `{}` | Generic key:value pairs to be inserted into the secret |
11061106
| notifications.serviceAccount.annotations | object | `{}` | Annotations applied to created service account |
11071107
| notifications.serviceAccount.create | bool | `true` | Specifies whether a service account should be created |

‎charts/argo-cd/values.yaml‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2132,7 +2132,7 @@ applicationSet:
21322132
# -- Enable ApplicationSet controller
21332133
enabled: true
21342134

2135-
# -- Application Set controller name string
2135+
# -- ApplicationSet controller name string
21362136
name: applicationset-controller
21372137

21382138
# -- The number of ApplicationSet controller pods to run
@@ -2156,13 +2156,13 @@ applicationSet:
21562156

21572157
## ApplicationSet controller image
21582158
image:
2159-
# -- Repository to use for the application set controller
2159+
# -- Repository to use for the ApplicationSet controller
21602160
# @default -- `""` (defaults to global.image.repository)
21612161
repository: ""
2162-
# -- Tag to use for the application set controller
2162+
# -- Tag to use for the ApplicationSet controller
21632163
# @default -- `""` (defaults to global.image.tag)
21642164
tag: ""
2165-
# -- Image pull policy for the application set controller
2165+
# -- Image pull policy for the ApplicationSet controller
21662166
# @default -- `""` (defaults to global.image.imagePullPolicy)
21672167
imagePullPolicy: ""
21682168

@@ -2187,7 +2187,7 @@ applicationSet:
21872187
# @default -- `""` (defaults to global.logging.level)
21882188
logLevel: ""
21892189

2190-
# -- Additional containers to be added to the applicationset controller pod
2190+
# -- Additional containers to be added to the ApplicationSet controller pod
21912191
extraContainers: []
21922192

21932193
## Metrics service configuration
@@ -2227,15 +2227,15 @@ applicationSet:
22272227
# -- Prometheus ServiceMonitor annotations
22282228
annotations: {}
22292229

2230-
## Application set service configuration
2230+
## ApplicationSet service configuration
22312231
service:
2232-
# -- Application set service annotations
2232+
# -- ApplicationSet service annotations
22332233
annotations: {}
2234-
# -- Application set service labels
2234+
# -- ApplicationSet service labels
22352235
labels: {}
2236-
# -- Application set service port
2236+
# -- ApplicationSet service port
22372237
port: 7000
2238-
# -- Application set service port name
2238+
# -- ApplicationSet service port name
22392239
portName: webhook
22402240

22412241
serviceAccount:
@@ -2252,10 +2252,10 @@ applicationSet:
22522252
# -- Annotations to be added to ApplicationSet controller Deployment
22532253
deploymentAnnotations: {}
22542254

2255-
# -- Annotations for the controller pods
2255+
# -- Annotations for the ApplicationSet controller pods
22562256
podAnnotations: {}
22572257

2258-
# -- Labels for the controller pods
2258+
# -- Labels for the ApplicationSet controller pods
22592259
podLabels: {}
22602260

22612261
# -- ApplicationSet controller container-level security context
@@ -2300,7 +2300,7 @@ applicationSet:
23002300
# -- Minimum consecutive failures for the [probe] to be considered failed after having succeeded
23012301
failureThreshold: 3
23022302

2303-
# -- Resource limits and requests for the controller pods.
2303+
# -- Resource limits and requests for the ApplicationSet controller pods.
23042304
resources: {}
23052305
# We usually recommend not to specify default resources and to leave this as a conscious
23062306
# choice for the user. This also increases chances charts run on environments with little
@@ -2338,12 +2338,12 @@ applicationSet:
23382338
# -- List of extra cli args to add
23392339
extraArgs: []
23402340

2341-
# -- Environment variables to pass to the controller
2341+
# -- Environment variables to pass to the ApplicationSet controller
23422342
extraEnv: []
23432343
# - name: "MY_VAR"
23442344
# value: "value"
23452345

2346-
# -- envFrom to pass to the controller
2346+
# -- envFrom to pass to the ApplicationSet controller
23472347
# @default -- `[]` (See [values.yaml])
23482348
extraEnvFrom: []
23492349
# - configMapRef:
@@ -2361,7 +2361,7 @@ applicationSet:
23612361
annotations: {}
23622362
# -- Additional ingress labels
23632363
labels: {}
2364-
# -- Defines which ingress controller will implement the resource
2364+
# -- Defines which ingress ApplicationSet controller will implement the resource
23652365
ingressClassName: ""
23662366

23672367
# -- List of ingress hosts
@@ -2452,7 +2452,7 @@ notifications:
24522452
# environmentName: staging
24532453

24542454
secret:
2455-
# -- Whether helm chart creates controller secret
2455+
# -- Whether helm chart creates notifications controller secret
24562456
create: true
24572457

24582458
# -- key:value pairs of annotations to be added to the secret
@@ -2474,20 +2474,20 @@ notifications:
24742474
# email-password:
24752475
# For more information: https://argocd-notifications.readthedocs.io/en/stable/services/email/
24762476

2477-
# -- Application controller log format. Either `text` or `json`
2477+
# -- Notifications controller log format. Either `text` or `json`
24782478
# @default -- `""` (defaults to global.logging.format)
24792479
logFormat: ""
2480-
# -- Application controller log level. One of: `debug`, `info`, `warn`, `error`
2480+
# -- Notifications controller log level. One of: `debug`, `info`, `warn`, `error`
24812481
# @default -- `""` (defaults to global.logging.level)
24822482
logLevel: ""
24832483

2484-
# -- Extra arguments to provide to the controller
2484+
# -- Extra arguments to provide to the notifications controller
24852485
extraArgs: []
24862486

24872487
# -- Additional container environment variables
24882488
extraEnv: []
24892489

2490-
# -- envFrom to pass to the controller
2490+
# -- envFrom to pass to the notifications controller
24912491
# @default -- `[]` (See [values.yaml])
24922492
extraEnvFrom: []
24932493
# - configMapRef:
@@ -2545,10 +2545,10 @@ notifications:
25452545
# -- Annotations to be applied to the notifications controller Deployment
25462546
deploymentAnnotations: {}
25472547

2548-
# -- Annotations to be applied to the controller Pods
2548+
# -- Annotations to be applied to the notifications controller Pods
25492549
podAnnotations: {}
25502550

2551-
# -- Labels to be applied to the controller Pods
2551+
# -- Labels to be applied to the notifications controller Pods
25522552
podLabels: {}
25532553

25542554
# -- Notification controller container-level security Context
@@ -2563,10 +2563,10 @@ notifications:
25632563
drop:
25642564
- ALL
25652565

2566-
# -- Priority class for the controller pods
2566+
# -- Priority class for the notifications controller pods
25672567
priorityClassName: ""
25682568

2569-
# -- Resource limits and requests for the controller
2569+
# -- Resource limits and requests for the notifications controller
25702570
resources: {}
25712571
# limits:
25722572
# cpu: 100m
@@ -2589,7 +2589,7 @@ notifications:
25892589
# -- Labels applied to created service account
25902590
labels: {}
25912591
cm:
2592-
# -- Whether helm chart creates controller config map
2592+
# -- Whether helm chart creates notifications controller config map
25932593
create: true
25942594

25952595
# -- Contains centrally managed global application subscriptions

0 commit comments

Comments
 (0)