feat(argo-cd): Update Notification Liveness/Readiness Probes (#2872)

argoproj · Aug 12, 2024 · 96320b6 · 96320b6
1 parent 4f4fb95
commit 96320b6
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 3 deletions.
diff --git a/charts/argo-cd/Chart.yaml b/charts/argo-cd/Chart.yaml
@@ -3,7 +3,7 @@ appVersion: v2.12.0
 kubeVersion: ">=1.25.0-0"
 description: A Helm chart for Argo CD, a declarative, GitOps continuous delivery tool for Kubernetes.
 name: argo-cd
-version: 7.4.2
+version: 7.4.3
 home: https://github.com/argoproj/argo-helm
 icon: https://argo-cd.readthedocs.io/en/stable/assets/logo.png
 sources:
@@ -26,5 +26,5 @@ annotations:
  fingerprint: 2B8F22F57260EFA67BE1C5824B11F800CD9D2252
  url: https://argoproj.github.io/argo-helm/pgp_keys.asc
  artifacthub.io/changes: |
- - kind: fixed
- description: Fix Redis race condition due to optional REDIS_PASSWORD
+ - kind: added
+ description: "Added liveness and readiness probes to the notification controller."
diff --git a/charts/argo-cd/README.md b/charts/argo-cd/README.md
@@ -1542,6 +1542,12 @@ If you use an External Redis (See Option 3 above), this Job is not deployed.
 | notifications.image.tag | string | `""` (defaults to global.image.tag) | Tag to use for the notifications controller |
 | notifications.imagePullSecrets | list | `[]` (defaults to global.imagePullSecrets) | Secrets with credentials to pull images from a private registry |
 | notifications.initContainers | list | `[]` | Init containers to add to the notifications controller pod |
+| notifications.livenessProbe.enabled | bool | `false` | Enable Kubernetes liveness probe for notifications controller Pods |
+| notifications.livenessProbe.failureThreshold | int | `3` | Minimum consecutive failures for the [probe] to be considered failed after having succeeded |
+| notifications.livenessProbe.initialDelaySeconds | int | `10` | Number of seconds after the container has started before [probe] is initiated |
+| notifications.livenessProbe.periodSeconds | int | `10` | How often (in seconds) to perform the [probe] |
+| notifications.livenessProbe.successThreshold | int | `1` | Minimum consecutive successes for the [probe] to be considered successful after having failed |
+| notifications.livenessProbe.timeoutSeconds | int | `1` | Number of seconds after which the [probe] times out |
 | notifications.logFormat | string | `""` (defaults to global.logging.format) | Notifications controller log format. Either `text` or `json` |
 | notifications.logLevel | string | `""` (defaults to global.logging.level) | Notifications controller log level. One of: `debug`, `info`, `warn`, `error` |
 | notifications.metrics.enabled | bool | `false` | Enables prometheus metrics server |
@@ -1570,6 +1576,12 @@ If you use an External Redis (See Option 3 above), this Job is not deployed.
 | notifications.podAnnotations | object | `{}` | Annotations to be applied to the notifications controller Pods |
 | notifications.podLabels | object | `{}` | Labels to be applied to the notifications controller Pods |
 | notifications.priorityClassName | string | `""` (defaults to global.priorityClassName) | Priority class for the notifications controller pods |
+| notifications.readinessProbe.enabled | bool | `false` | Enable Kubernetes liveness probe for notifications controller Pods |
+| notifications.readinessProbe.failureThreshold | int | `3` | Minimum consecutive failures for the [probe] to be considered failed after having succeeded |
+| notifications.readinessProbe.initialDelaySeconds | int | `10` | Number of seconds after the container has started before [probe] is initiated |
+| notifications.readinessProbe.periodSeconds | int | `10` | How often (in seconds) to perform the [probe] |
+| notifications.readinessProbe.successThreshold | int | `1` | Minimum consecutive successes for the [probe] to be considered successful after having failed |
+| notifications.readinessProbe.timeoutSeconds | int | `1` | Number of seconds after which the [probe] times out |
 | notifications.resources | object | `{}` | Resource limits and requests for the notifications controller |
 | notifications.secret.annotations | object | `{}` | key:value pairs of annotations to be added to the secret |
 | notifications.secret.create | bool | `true` | Whether helm chart creates notifications controller secret |

diff --git a/charts/argo-cd/templates/argocd-notifications/deployment.yaml b/charts/argo-cd/templates/argocd-notifications/deployment.yaml
@@ -107,6 +107,26 @@ spec:
  - name: metrics
  containerPort: {{ .Values.notifications.containerPorts.metrics }}
  protocol: TCP
+ {{- if .Values.notifications.livenessProbe.enabled }}
+ livenessProbe:
+ tcpSocket:
+ port: metrics
+ initialDelaySeconds: {{ .Values.notifications.livenessProbe.initialDelaySeconds }}
+ periodSeconds: {{ .Values.notifications.livenessProbe.periodSeconds }}
+ timeoutSeconds: {{ .Values.notifications.livenessProbe.timeoutSeconds }}
+ successThreshold: {{ .Values.notifications.livenessProbe.successThreshold }}
+ failureThreshold: {{ .Values.notifications.livenessProbe.failureThreshold }}
+ {{- end }}
+ {{- if .Values.notifications.readinessProbe.enabled }}
+ readinessProbe:
+ tcpSocket:
+ port: metrics
+ initialDelaySeconds: {{ .Values.notifications.readinessProbe.initialDelaySeconds }}
+ periodSeconds: {{ .Values.notifications.readinessProbe.periodSeconds }}
+ timeoutSeconds: {{ .Values.notifications.readinessProbe.timeoutSeconds }}
+ successThreshold: {{ .Values.notifications.readinessProbe.successThreshold }}
+ failureThreshold: {{ .Values.notifications.readinessProbe.failureThreshold }}
+ {{- end }}
  resources:
  {{- toYaml .Values.notifications.resources | nindent 12 }}
  {{- with .Values.notifications.containerSecurityContext }}

diff --git a/charts/argo-cd/values.yaml b/charts/argo-cd/values.yaml
@@ -3307,6 +3307,36 @@ notifications:
  drop:
  - ALL
 
+ ## Probes for notifications controller Pods (optional)
+ ## Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
+ readinessProbe:
+ # -- Enable Kubernetes liveness probe for notifications controller Pods
+ enabled: false
+ # -- Number of seconds after the container has started before [probe] is initiated
+ initialDelaySeconds: 10
+ # -- How often (in seconds) to perform the [probe]
+ periodSeconds: 10
+ # -- Number of seconds after which the [probe] times out
+ timeoutSeconds: 1
+ # -- Minimum consecutive successes for the [probe] to be considered successful after having failed
+ successThreshold: 1
+ # -- Minimum consecutive failures for the [probe] to be considered failed after having succeeded
+ failureThreshold: 3
+
+ livenessProbe:
+ # -- Enable Kubernetes liveness probe for notifications controller Pods
+ enabled: false
+ # -- Number of seconds after the container has started before [probe] is initiated
+ initialDelaySeconds: 10
+ # -- How often (in seconds) to perform the [probe]
+ periodSeconds: 10
+ # -- Number of seconds after which the [probe] times out
+ timeoutSeconds: 1
+ # -- Minimum consecutive successes for the [probe] to be considered successful after having failed
+ successThreshold: 1
+ # -- Minimum consecutive failures for the [probe] to be considered failed after having succeeded
+ failureThreshold: 3
+
  # -- terminationGracePeriodSeconds for container lifecycle hook
  terminationGracePeriodSeconds: 30