chore(deps): update docker.io/volkerraschek/helm docker tag to v4

.gitea/workflows/generate-readme.yaml

@@ -22,7 +22,7 @@ jobs:
       run: |
         apk update
         apk add git npm
-    - uses: actions/checkout@v5.0.1
+    - uses: actions/checkout@v6.0.1
     - name: Generate parameter section in README
       run: |
         npm install

.gitea/workflows/helm.yaml

@@ -14,7 +14,7 @@ jobs:
   helm-lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v5.0.1
+    - uses: actions/checkout@v6.0.1
     - uses: azure/setup-helm@v4.3.1
       with:
         version: v4.0.1 # renovate: datasource=github-releases depName=helm/helm
@@ -25,7 +25,7 @@ jobs:
   helm-unittest:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v5.0.1
+    - uses: actions/checkout@v6.0.1
     - uses: azure/setup-helm@v4.3.1
       with:
         version: v4.0.1 # renovate: datasource=github-releases depName=helm/helm

.gitea/workflows/markdown-linters.yaml

@@ -22,7 +22,7 @@ jobs:
       run: |
         apk update
         apk add git npm
-    - uses: actions/checkout@v5.0.1
+    - uses: actions/checkout@v6.0.1
     - name: Verify links in markdown files
       run: |
         npm install
@@ -37,7 +37,7 @@ jobs:
       run: |
         apk update
         apk add git
-    - uses: actions/checkout@v5.0.1
+    - uses: actions/checkout@v6.0.1
     - name: Lint markdown files
       run: |
         npm install

.gitea/workflows/release.yaml

@@ -8,7 +8,7 @@ on:
 jobs:
   publish-chart:
     container:
-      image: docker.io/volkerraschek/helm:3.19.2
+      image: docker.io/volkerraschek/helm:4.0.1
     runs-on: ubuntu-latest
     steps:
       - name: Install packages via apk
@@ -16,7 +16,7 @@ jobs:
           apk update
           apk add git npm jq yq
 
-      - uses: actions/checkout@v5.0.1
+      - uses: actions/checkout@v6.0.1
         with:
           fetch-depth: 0
 

README.md

@@ -37,7 +37,7 @@ version of the chart must be in sync with the `values.yaml`. Newer *minor* versi
 versions can break something!
 
 ```bash
-CHART_VERSION=1.2.1
+CHART_VERSION=1.3.0
 helm show values volker.raschek/athens-proxy --version "${CHART_VERSION}" > values.yaml
 ```
 
@@ -51,7 +51,7 @@ The helm chart also contains a persistent volume claim definition. It persistent
 Use the `--set` argument to persist your data.
 
 ```bash
-CHART_VERSION=1.2.1
+CHART_VERSION=1.3.0
 helm install --version "${CHART_VERSION}" athens-proxy volker.raschek/athens-proxy \
   persistence.enabled=true
 ```
@@ -81,7 +81,7 @@ Further information about this topic can be found in one of Kanishk's blog
 > Please take care the a CPU limit < `1000m` can also lead to CPU throttling. Please read the linked documentation carefully.
 
 ```bash
-CHART_VERSION=1.2.1
+CHART_VERSION=1.3.0
 helm install --version "${CHART_VERSION}" athens-proxy volker.raschek/athens-proxy \
   --set 'deployment.athensProxy.env.name=GOMAXPROCS' \
   --set 'deployment.athensProxy.env.valueFrom.resourceFieldRef.resource=limits.cpu' \
@@ -101,7 +101,7 @@ The secret must be from type `kubernetes.io/tls`.
 > `athens-proxy-ca` is present in the same namespace of the helm deployment.
 
 ```bash
-CHART_VERSION=1.2.1
+CHART_VERSION=1.3.0
 helm install --version "${CHART_VERSION}" athens-proxy volker.raschek/athens-proxy \
   --set 'config.certificate.enabled=true' \
   --set 'config.certificate.new.issuerRef.kind=Issuer' \
@@ -338,42 +338,52 @@ spec:
 
 ### Deployment
 
-| Name                                               | Description                                                                                                | Value           |
+| Name                                                        | Description                                                                                                | Value           |
-| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | --------------- |
+| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | --------------- |
-| `deployment.annotations`                           | Additional deployment annotations.                                                                         | `{}`            |
+| `deployment.annotations`                                    | Additional deployment annotations.                                                                         | `{}`            |
-| `deployment.labels`                                | Additional deployment labels.                                                                              | `{}`            |
+| `deployment.labels`                                         | Additional deployment labels.                                                                              | `{}`            |
-| `deployment.additionalContainers`                  | List of additional containers.                                                                             | `[]`            |
+| `deployment.additionalContainers`                           | List of additional containers.                                                                             | `[]`            |
-| `deployment.affinity`                              | Affinity for the athens-proxy deployment.                                                                  | `{}`            |
+| `deployment.affinity`                                       | Affinity for the athens-proxy deployment.                                                                  | `{}`            |
-| `deployment.initContainers`                        | List of additional init containers.                                                                        | `[]`            |
+| `deployment.initContainers`                                 | List of additional init containers.                                                                        | `[]`            |
-| `deployment.dnsConfig`                             | dnsConfig of the athens-proxy deployment.                                                                  | `{}`            |
+| `deployment.dnsConfig`                                      | dnsConfig of the athens-proxy deployment.                                                                  | `{}`            |
-| `deployment.dnsPolicy`                             | dnsPolicy of the athens-proxy deployment.                                                                  | `""`            |
+| `deployment.dnsPolicy`                                      | dnsPolicy of the athens-proxy deployment.                                                                  | `""`            |
-| `deployment.hostname`                              | Individual hostname of the pod.                                                                            | `""`            |
+| `deployment.hostname`                                       | Individual hostname of the pod.                                                                            | `""`            |
-| `deployment.subdomain`                             | Individual domain of the pod.                                                                              | `""`            |
+| `deployment.subdomain`                                      | Individual domain of the pod.                                                                              | `""`            |
-| `deployment.hostNetwork`                           | Use the kernel network namespace of the host system.                                                       | `false`         |
+| `deployment.hostNetwork`                                    | Use the kernel network namespace of the host system.                                                       | `false`         |
-| `deployment.imagePullSecrets`                      | Secret to use for pulling the image.                                                                       | `[]`            |
+| `deployment.imagePullSecrets`                               | Secret to use for pulling the image.                                                                       | `[]`            |
-| `deployment.athensProxy.args`                      | Arguments passed to the athens-proxy container.                                                            | `[]`            |
+| `deployment.athensProxy.args`                               | Arguments passed to the athens-proxy container.                                                            | `[]`            |
-| `deployment.athensProxy.command`                   | Command passed to the athens-proxy container.                                                              | `[]`            |
+| `deployment.athensProxy.command`                            | Command passed to the athens-proxy container.                                                              | `[]`            |
-| `deployment.athensProxy.env`                       | List of environment variables for the athens-proxy container.                                              | `[]`            |
+| `deployment.athensProxy.env`                                | List of environment variables for the athens-proxy container.                                              | `[]`            |
-| `deployment.athensProxy.envFrom`                   | List of environment variables mounted from configMaps or secrets for the athens-proxy container.           | `[]`            |
+| `deployment.athensProxy.envFrom`                            | List of environment variables mounted from configMaps or secrets for the athens-proxy container.           | `[]`            |
-| `deployment.athensProxy.image.registry`            | Image registry, eg. `docker.io`.                                                                           | `docker.io`     |
+| `deployment.athensProxy.image.registry`                     | Image registry, eg. `docker.io`.                                                                           | `docker.io`     |
-| `deployment.athensProxy.image.repository`          | Image repository, eg. `library/busybox`.                                                                   | `gomods/athens` |
+| `deployment.athensProxy.image.repository`                   | Image repository, eg. `library/busybox`.                                                                   | `gomods/athens` |
-| `deployment.athensProxy.image.tag`                 | Custom image tag, eg. `0.1.0`. Defaults to `appVersion`.                                                   | `""`            |
+| `deployment.athensProxy.image.tag`                          | Custom image tag, eg. `0.1.0`. Defaults to `appVersion`.                                                   | `""`            |
-| `deployment.athensProxy.image.pullPolicy`          | Image pull policy.                                                                                         | `IfNotPresent`  |
+| `deployment.athensProxy.image.pullPolicy`                   | Image pull policy.                                                                                         | `IfNotPresent`  |
-| `deployment.athensProxy.resources`                 | CPU and memory resources of the pod.                                                                       | `{}`            |
+| `deployment.athensProxy.livenessProbe.failureThreshold`     | Minimum consecutive failures for the probe to be considered failed after having succeeded.                 | `3`             |
-| `deployment.athensProxy.securityContext`           | Security context of the container of the deployment.                                                       | `{}`            |
+| `deployment.athensProxy.livenessProbe.initialDelaySeconds`  | Number of seconds after the container has started before liveness probes are initiated.                    | `5`             |
-| `deployment.athensProxy.volumeMounts`              | Additional volume mounts.                                                                                  | `[]`            |
+| `deployment.athensProxy.livenessProbe.periodSeconds`        | How often (in seconds) to perform the probe.                                                               | `60`            |
-| `deployment.nodeSelector`                          | NodeSelector of the athens-proxy deployment.                                                               | `{}`            |
+| `deployment.athensProxy.livenessProbe.successThreshold`     | Minimum consecutive successes for the probe to be considered successful after having failed.               | `1`             |
-| `deployment.priorityClassName`                     | PriorityClassName of the athens-proxy deployment.                                                          | `""`            |
+| `deployment.athensProxy.livenessProbe.timeoutSeconds`       | Number of seconds after which the probe times out.                                                         | `3`             |
-| `deployment.replicas`                              | Number of replicas for the athens-proxy deployment.                                                        | `1`             |
+| `deployment.athensProxy.readinessProbe.failureThreshold`    | Minimum consecutive failures for the probe to be considered failed after having succeeded.                 | `3`             |
-| `deployment.restartPolicy`                         | Restart policy of the athens-proxy deployment.                                                             | `""`            |
+| `deployment.athensProxy.readinessProbe.initialDelaySeconds` | Number of seconds after the container has started before liveness probes are initiated.                    | `5`             |
-| `deployment.securityContext`                       | Security context of the athens-proxy deployment.                                                           | `{}`            |
+| `deployment.athensProxy.readinessProbe.periodSeconds`       | How often (in seconds) to perform the probe.                                                               | `15`            |
-| `deployment.strategy.type`                         | Strategy type - `Recreate` or `RollingUpdate`.                                                             | `RollingUpdate` |
+| `deployment.athensProxy.readinessProbe.successThreshold`    | Minimum consecutive successes for the probe to be considered successful after having failed.               | `1`             |
-| `deployment.strategy.rollingUpdate.maxSurge`       | The maximum number of pods that can be scheduled above the desired number of pods during a rolling update. | `1`             |
+| `deployment.athensProxy.readinessProbe.timeoutSeconds`      | Number of seconds after which the probe times out.                                                         | `3`             |
-| `deployment.strategy.rollingUpdate.maxUnavailable` | The maximum number of pods that can be unavailable during a rolling update.                                | `1`             |
+| `deployment.athensProxy.resources`                          | CPU and memory resources of the pod.                                                                       | `{}`            |
-| `deployment.terminationGracePeriodSeconds`         | How long to wait until forcefully kill the pod.                                                            | `60`            |
+| `deployment.athensProxy.securityContext`                    | Security context of the container of the deployment.                                                       | `{}`            |
-| `deployment.tolerations`                           | Tolerations of the athens-proxy deployment.                                                                | `[]`            |
+| `deployment.athensProxy.volumeMounts`                       | Additional volume mounts.                                                                                  | `[]`            |
-| `deployment.topologySpreadConstraints`             | TopologySpreadConstraints of the athens-proxy deployment.                                                  | `[]`            |
+| `deployment.nodeSelector`                                   | NodeSelector of the athens-proxy deployment.                                                               | `{}`            |
-| `deployment.volumes`                               | Additional volumes to mount into the pods of the athens-proxy deployment.                                  | `[]`            |
+| `deployment.priorityClassName`                              | PriorityClassName of the athens-proxy deployment.                                                          | `""`            |
+| `deployment.replicas`                                       | Number of replicas for the athens-proxy deployment.                                                        | `1`             |
+| `deployment.restartPolicy`                                  | Restart policy of the athens-proxy deployment.                                                             | `""`            |
+| `deployment.securityContext`                                | Security context of the athens-proxy deployment.                                                           | `{}`            |
+| `deployment.strategy.type`                                  | Strategy type - `Recreate` or `RollingUpdate`.                                                             | `RollingUpdate` |
+| `deployment.strategy.rollingUpdate.maxSurge`                | The maximum number of pods that can be scheduled above the desired number of pods during a rolling update. | `1`             |
+| `deployment.strategy.rollingUpdate.maxUnavailable`          | The maximum number of pods that can be unavailable during a rolling update.                                | `1`             |
+| `deployment.terminationGracePeriodSeconds`                  | How long to wait until forcefully kill the pod.                                                            | `60`            |
+| `deployment.tolerations`                                    | Tolerations of the athens-proxy deployment.                                                                | `[]`            |
+| `deployment.topologySpreadConstraints`                      | TopologySpreadConstraints of the athens-proxy deployment.                                                  | `[]`            |
+| `deployment.volumes`                                        | Additional volumes to mount into the pods of the athens-proxy deployment.                                  | `[]`            |
 
 ### Horizontal Pod Autoscaler (HPA)
 

templates/deployment.yaml

@@ -52,27 +52,27 @@ spec:
         livenessProbe:
           exec:
             {{- if not .Values.certificate.enabled }}
-            command: [ "wget", "-T", "3", "-O", "/dev/null", "http://localhost:3000" ]
+            command: [ "wget", "-T", "{{ .Values.deployment.athensProxy.livenessProbe.timeoutSeconds }}", "-O", "/dev/null", "http://localhost:3000" ]
             {{- else }}
-            command: [ "wget", "--no-check-certificate", "-T", "3", "-O", "/dev/null", "https://localhost:3000" ]
+            command: [ "wget", "--no-check-certificate", "-T", "{{ .Values.deployment.athensProxy.livenessProbe.timeoutSeconds }}", "-O", "/dev/null", "https://localhost:3000" ]
             {{- end }}
-          failureThreshold: 3
+          failureThreshold: {{ .Values.deployment.athensProxy.livenessProbe.failureThreshold }}
-          initialDelaySeconds: 5
+          initialDelaySeconds: {{ .Values.deployment.athensProxy.livenessProbe.initialDelaySeconds }}
-          periodSeconds: 60
+          periodSeconds: {{ .Values.deployment.athensProxy.livenessProbe.periodSeconds }}
-          successThreshold: 1
+          successThreshold: {{ .Values.deployment.athensProxy.livenessProbe.successThreshold }}
-          timeoutSeconds: 3
+          timeoutSeconds: {{ .Values.deployment.athensProxy.livenessProbe.timeoutSeconds }}
         readinessProbe:
           exec:
             {{- if not .Values.certificate.enabled }}
-            command: [ "wget", "-T", "3", "-O", "/dev/null", "http://localhost:3000" ]
+            command: [ "wget", "-T", "{{ .Values.deployment.athensProxy.readinessProbe.timeoutSeconds }}", "-O", "/dev/null", "http://localhost:3000" ]
             {{- else }}
-            command: [ "wget", "--no-check-certificate", "-T", "3", "-O", "/dev/null", "https://localhost:3000" ]
+            command: [ "wget", "--no-check-certificate", "-T", "{{ .Values.deployment.athensProxy.readinessProbe.timeoutSeconds }}", "-O", "/dev/null", "https://localhost:3000" ]
             {{- end }}
-          failureThreshold: 3
+          failureThreshold: {{ .Values.deployment.athensProxy.readinessProbe.failureThreshold }}
-          initialDelaySeconds: 5
+          initialDelaySeconds: {{ .Values.deployment.athensProxy.readinessProbe.initialDelaySeconds }}
-          periodSeconds: 15
+          periodSeconds: {{ .Values.deployment.athensProxy.readinessProbe.periodSeconds }}
-          successThreshold: 1
+          successThreshold: {{ .Values.deployment.athensProxy.readinessProbe.successThreshold }}
-          timeoutSeconds: 3
+          timeoutSeconds: {{ .Values.deployment.athensProxy.readinessProbe.timeoutSeconds }}
         ports:
         - name: http
           containerPort: 3000

unittests/deployment/deployment.yaml

@@ -67,6 +67,46 @@ tests:
       path: spec.template.spec.containers[0].imagePullPolicy
       value: IfNotPresent
     template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.failureThreshold
+      value: 3
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.initialDelaySeconds
+      value: 5
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.periodSeconds
+      value: 60
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.successThreshold
+      value: 1
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.timeoutSeconds
+      value: 3
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.failureThreshold
+      value: 3
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.initialDelaySeconds
+      value: 5
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.periodSeconds
+      value: 15
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.successThreshold
+      value: 1
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.timeoutSeconds
+      value: 3
+    template: templates/deployment.yaml
   - notExists:
       path: spec.template.spec.containers[0].resources
     template: templates/deployment.yaml
@@ -221,6 +261,77 @@ tests:
       value: Always
     template: templates/deployment.yaml
 
+- it: Test custom livenessProbe
+  set:
+    # Normal test values
+    deployment.athensProxy.livenessProbe:
+      failureThreshold: 5
+      initialDelaySeconds: 10
+      periodSeconds: 120
+      successThreshold: 3
+      timeoutSeconds: 5
+  asserts:
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.failureThreshold
+      value: 5
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.initialDelaySeconds
+      value: 10
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.periodSeconds
+      value: 120
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.successThreshold
+      value: 3
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].livenessProbe.timeoutSeconds
+      value: 5
+    template: templates/deployment.yaml
+  - contains:
+      path: spec.template.spec.containers[0].livenessProbe.exec.command
+      content: "5"
+    template: templates/deployment.yaml
+
+- it: Test custom readinessProbe
+  set:
+    # Normal test values
+    deployment.athensProxy.readinessProbe:
+      failureThreshold: 10
+      initialDelaySeconds: 10
+      periodSeconds: 30
+      successThreshold: 5
+      timeoutSeconds: 5
+
+  asserts:
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.failureThreshold
+      value: 10
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.initialDelaySeconds
+      value: 10
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.periodSeconds
+      value: 30
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.successThreshold
+      value: 5
+    template: templates/deployment.yaml
+  - equal:
+      path: spec.template.spec.containers[0].readinessProbe.timeoutSeconds
+      value: 5
+    template: templates/deployment.yaml
+  - contains:
+      path: spec.template.spec.containers[0].readinessProbe.exec.command
+      content: "5"
+    template: templates/deployment.yaml
+
 - it: Test custom resource limits and requests
   set:
     # Ensure that the secrets and config maps are well configured.

values.yaml

@@ -415,6 +415,30 @@ deployment:
       tag: ""
       pullPolicy: IfNotPresent
 
+    ## @param deployment.athensProxy.livenessProbe.failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded.
+    ## @param deployment.athensProxy.livenessProbe.initialDelaySeconds Number of seconds after the container has started before liveness probes are initiated.
+    ## @param deployment.athensProxy.livenessProbe.periodSeconds How often (in seconds) to perform the probe.
+    ## @param deployment.athensProxy.livenessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
+    ## @param deployment.athensProxy.livenessProbe.timeoutSeconds Number of seconds after which the probe times out.
+    livenessProbe:
+      failureThreshold: 3
+      initialDelaySeconds: 5
+      periodSeconds: 60
+      successThreshold: 1
+      timeoutSeconds: 3
+
+    ## @param deployment.athensProxy.readinessProbe.failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded.
+    ## @param deployment.athensProxy.readinessProbe.initialDelaySeconds Number of seconds after the container has started before liveness probes are initiated.
+    ## @param deployment.athensProxy.readinessProbe.periodSeconds How often (in seconds) to perform the probe.
+    ## @param deployment.athensProxy.readinessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after having failed.
+    ## @param deployment.athensProxy.readinessProbe.timeoutSeconds Number of seconds after which the probe times out.
+    readinessProbe:
+      failureThreshold: 3
+      initialDelaySeconds: 5
+      periodSeconds: 15
+      successThreshold: 1
+      timeoutSeconds: 3
+
     ## @param deployment.athensProxy.resources CPU and memory resources of the pod.
     resources: {}
       # limits: