Sorting out the weekly cronjob for pvc auto deletion, also adding someting to value yaml to turn it off

Author: Alexj9837

helm/blueapi/README.md

@@ -9,6 +9,7 @@ A Helm chart deploying a worker pod that runs Bluesky plans
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` | May be required to run on specific nodes (e.g. the control machine) |
+| autodeletion.enabled | bool | `true` |  |
 | debug.enabled | bool | `false` | If enabled, runs debugpy, allowing port-forwarding to expose port 5678 or attached vscode instance |
 | debug.log_to_stderr | bool | `false` | If enabled configures debugpy to use the option `--log-to-stderr` |
 | debug.suspend | bool | `false` | If enabled does not start the service on startup This allows connecting to the pod and starting the service manually to allow debugging on the cluster |

helm/blueapi/templates/configmap.yaml

@@ -46,3 +46,15 @@ data:
   time-stamper.sh: |-
 {{ $files.Get "files/scripts/time-stamper.sh" | indent 4 }}
 {{- end }}
+
+---
+{{- if .Values.pvcautodeletion.enabled }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name : {{include "blueapi.fullname" . }}-pvc-autodeletion-script
+data:
+  {{- $files := .Files }}
+  pvc-autodeletion.sh: |-
+{{ $files.Get "files/scripts/pvc-autodeletion.sh" | indent 4 }}
+{{- end }}

helm/blueapi/templates/cronjob.yaml

@@ -45,7 +45,7 @@ spec:
     spec:
       # amount of attempts of labeling a pvc
       backoffLimit: 3
-      # job stops after 60 secounds
+      # job stops after 60 seconds
       activeDeadlineSeconds: 60
       template:
         spec:
@@ -77,3 +77,83 @@ spec:
             command: ["/scripts/time-stamper.sh"]
           restartPolicy: OnFailure
 {{- end }}
+
+{{- if .Values.pvcautodeletion.enabled }}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "blueapi.fullname" . }}-pvcautodeletion
+  namespace: {{ .Release.Namespace }}
+automountServiceAccountToken: true
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: Role
+metadata:
+  name: {{ include "blueapi.fullname" . }}-pvcautodeletion
+  namespace: {{ .Release.Namespace }}
+rules:
+- apiGroups: [""]
+  resources: ["pods", "persistentvolumeclaims"]
+  verbs: ["get", "list", "patch"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: RoleBinding
+metadata:
+  name: {{ include "blueapi.fullname" . }}-pvcautodeletion
+  namespace: {{ .Release.Namespace }}
+subjects:
+- kind: ServiceAccount
+  name: {{ include "blueapi.fullname" . }}-pvcautodeletion
+  namespace: {{ .Release.Namespace }}
+roleRef:
+  kind: Role
+  name: {{ include "blueapi.fullname" . }}-pvcautodeletion
+  apiGroup: rbac.authorization.k8s.io
+---
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: {{ include "blueapi.fullname" . }}-pvcautodeletion
+  namespace: {{ .Release.Namespace }}
+spec:
+  concurrencyPolicy: Forbid
+  successfulJobsHistoryLimit: 3
+  failedJobsHistoryLimit: 1
+  schedule: "@weekly"
+
+  jobTemplate:
+    spec:
+      # amount of attempts of labeling a pvc
+      backoffLimit: 3
+      # job stops after 300 seconds
+      activeDeadlineSeconds: 300
+      template:
+        spec:
+          serviceAccountName: {{ include "blueapi.fullname" . }}-pvcautodeletion
+          {{- with .Values.tolerations }}
+          tolerations:
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+
+          volumes:
+            - name : {{include "blueapi.fullname" . }}-pvc-autodeletion-script
+              configMap:
+                name: {{include "blueapi.fullname" . }}-pvc-autodeletion-script
+                defaultMode: 0555
+
+
+          containers:
+          - name: pvcautodeletion
+            env:
+              - name: RELEASE_NAME
+                value: {{ .Release.Name }}
+              - name: RELEASE_NAMESPACE
+                value: {{ .Release.Namespace }}
+            volumeMounts:
+              - name: {{include "blueapi.fullname" . }}-pvc-autodeletion-script
+                mountPath: /scripts
+            image: bitnami/kubectl:latest
+            imagePullPolicy: IfNotPresent
+            command: ["/scripts/pvc-deletion.sh"]
+          restartPolicy: OnFailure
+{{- end }}

helm/blueapi/values.schema.json

@@ -8,6 +8,14 @@
             "description": "May be required to run on specific nodes (e.g. the control machine)",
             "type": "object"
         },
+        "autodeletion": {
+            "type": "object",
+            "properties": {
+                "enabled": {
+                    "type": "boolean"
+                }
+            }
+        },
         "debug": {
             "type": "object",
             "properties": {

helm/blueapi/values.yaml

@@ -227,6 +227,9 @@ initContainer:
 timeStampCron:
   enabled: true
 
+autodeletion:
+  enabled: true
+
 debug:
   # -- If enabled, runs debugpy, allowing port-forwarding to expose port 5678 or attached vscode instance
   enabled: false