chore: update diagram and bump version

Author: aldbr

diracx/Chart.yaml

@@ -11,7 +11,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: "1.0.19"
+version: "1.0.20"
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diracx/templates/diracx/cleanup-authdb/cronjob.yaml

@@ -3,6 +3,10 @@
 {{/* Define common volume mounts for reusability */}}
 {{- $commonVolumeMounts := list }}
 {{- $commonVolumeMounts = append $commonVolumeMounts (dict "mountPath" "/entrypoint.sh" "name" "container-entrypoint" "subPath" "entrypoint.sh") }}
+{{- if and .Values.developer.enabled .Values.developer.enableCoverage }}
+{{- $commonVolumeMounts = append $commonVolumeMounts (dict "mountPath" "/diracx-coveragerc" "name" "container-entrypoint" "subPath" "coveragerc") }}
+{{- $commonVolumeMounts = append $commonVolumeMounts (dict "mountPath" "/coverage-reports" "name" "coverage-data" "readOnly" false) }}
+{{- end }}
 {{- if and .Values.developer.enabled .Values.developer.mountedPythonModulesToInstall }}
 {{- $commonVolumeMounts = append $commonVolumeMounts (dict "mountPath" .Values.developer.sourcePath "name" "diracx-code-mount" "readOnly" true) }}
 {{- range $module := .Values.developer.mountedPythonModulesToInstall }}
@@ -21,6 +25,8 @@ metadata:
   namespace: {{ .Release.Namespace }}
 spec:
   schedule: {{ $.Values.cleanupAuthDB.schedule | quote }}
+  successfulJobsHistoryLimit: 3
+  failedJobsHistoryLimit: 1
   jobTemplate:
     spec:
       template:
@@ -29,6 +35,7 @@ spec:
           containers:
             - name: {{ .Chart.Name }}-cleanup
               image: "{{ include "diracx.servicesImage" . }}"
+              imagePullPolicy: {{ .Values.global.imagePullPolicy }}
               command: ["/bin/bash", "/entrypoint.sh"]
               args: ["/bin/bash", "/scripts/cleanup-authdb"]
               envFrom:
@@ -45,8 +52,6 @@ spec:
                   subPath: jwks.json
                 - name: scripts
                   mountPath: /scripts
-              resources:
-                {{- toYaml .Values.cleanupAuthDB.resources | nindent 16 }}
           volumes:
           - name: keystore
             secret:
@@ -67,6 +72,11 @@ spec:
               sizeLimit: 5Mi
           {{- end }}
           {{- end }}
+          {{- if and .Values.developer.enabled .Values.developer.enableCoverage }}
+          - name: coverage-data
+            persistentVolumeClaim:
+              claimName: pvc-coverage
+          {{- end }}
           - name: container-entrypoint
             configMap:
               name: diracx-container-entrypoint

diracx/values.yaml

@@ -105,7 +105,9 @@ initKeyStore:
   enabled: true
 
 cleanupAuthDB:
+  # -- Enable the AuthDB cleanup CronJob
   enabled: true
+  # -- Cron schedule for AuthDB cleanup (default: monthly on the 1st)
   schedule: "0 0 1 * *"
 
 developer:

docs/admin/explanations/architecture_diagram.md

@@ -5,13 +5,15 @@ config:
 flowchart TD
 
     subgraph k8s_instance ["K8s Instance: diracx"]
-        subgraph helm_chart ["Helm Chart: diracx 1.0.19"]
+        subgraph helm_chart ["Helm Chart: diracx 1.0.20"]
             subgraph k8s_app ["K8s Application: diracx"]
                 ing_diracx{{"ing: diracx"}}
                 svc_diracx(("svc: diracx"))
                 svc_diracx_web(("svc: diracx-web"))
                 deploy_diracx["deploy: diracx"]
                 deploy_diracx_web["deploy: diracx-web"]
+                cronjob_diracx_cleanup_authdb(["cronjob: diracx-cleanup-authdb"])
+                cm_diracx_cleanup_authdb[("cm: diracx-cleanup-authdb")]
                 cm_mysql_init_diracx_dbs[("cm: mysql-init-diracx-dbs")]
                 secret_diracx_secrets>"secret: diracx-secrets"]
                 sa_diracx[["sa: diracx"]]
@@ -51,6 +53,9 @@ flowchart TD
     job_diracx_validate_config -->|"mounts"| cm_diracx_validate_config
     job_diracx_validate_config -->|"mounts"| cm_diracx_container_entrypoint
     job_diracx_validate_config -->|"env"| secret_diracx_secrets
+    cronjob_diracx_cleanup_authdb -->|"mounts"| cm_diracx_cleanup_authdb
+    cronjob_diracx_cleanup_authdb -->|"mounts"| cm_diracx_container_entrypoint
+    cronjob_diracx_cleanup_authdb -->|"env"| secret_diracx_secrets
 
     %% Styling
     classDef ing fill:#4a90d9,stroke:#2563eb,color:#ffffff
@@ -62,10 +67,12 @@ flowchart TD
     classDef cm fill:#7ec8e3,stroke:#2563eb,color:#1a1a2e
     classDef secret fill:#a78bfa,stroke:#2563eb,color:#ffffff
     classDef sa fill:#94a3b8,stroke:#2563eb,color:#ffffff
+    class cm_diracx_cleanup_authdb cm
     class cm_diracx_container_entrypoint cm
     class cm_diracx_init_keystore cm
     class cm_diracx_validate_config cm
     class cm_mysql_init_diracx_dbs cm
+    class cronjob_diracx_cleanup_authdb cronjob
     class deploy_diracx deploy
     class deploy_diracx_web deploy
     class ing_diracx ing

docs/admin/reference/values.md

@@ -24,8 +24,8 @@
 | cert-manager.enabled | bool | `true` |  |
 | cert-manager.installCRDs | bool | `true` |  |
 | cert-manager.startupapicheck.enabled | bool | `true` |  |
-| cleanupAuthDB.enabled | bool | `true` |  |
-| cleanupAuthDB.schedule | string | `"0 0 1 * *"` |  |
+| cleanupAuthDB.enabled | bool | `true` | Enable the AuthDB cleanup CronJob |
+| cleanupAuthDB.schedule | string | `"0 0 1 * *"` | Cron schedule for AuthDB cleanup (default: monthly on the 1st) |
 | developer.autoReload | bool | `true` | Enable automatic reloading inside uvicorn when the sources change Used by the integration tests for running closer to prod setup |
 | developer.editableMountedPythonModules | bool | `true` | Use pip install -e for mountedPythonModulesToInstall This is used by the integration tests because editable install might behave differently |
 | developer.enableCoverage | bool | `false` | Enable collection of coverage reports (intended for CI usage only) |