Helm chart: Add option to create PVC for local configuration path (#3761)

* Add option to create PVC for local configuration path

This enables persistence for deployment with local sqlite database.

* ignore persistence option when DB url is set

Author: jsuchome

helm/templates/server-config-pvc.yaml

@@ -0,0 +1,25 @@
+{{- if and .Values.zenml.database.persistence.enabled (not .Values.zenml.database.url) }}
+{{- $pvc_name := printf "%s-config" (include "zenml.fullname" .) -}}
+{{- $pvc := (lookup "v1" "PersistentVolumeClaim" .Release.Namespace $pvc_name) }}
+{{- if not $pvc }}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ $pvc_name }}
+  labels:
+    {{- include "zenml.labels" . | nindent 4 }}
+  annotations:
+    "helm.sh/hook": "pre-install,pre-upgrade"
+    "helm.sh/hook-weight": "-1"
+    "helm.sh/hook-delete-policy": before-hook-creation
+spec:
+  {{- with .Values.zenml.database.persistence.storageClassName }}
+  storageClassName: {{.}}
+  {{- end }}
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: {{.Values.zenml.database.persistence.size}}
+{{- end }}
+{{- end }}

helm/templates/server-db-job.yaml

@@ -59,7 +59,12 @@ spec:
         {{- toYaml .Values.podSecurityContext | nindent 8 }}
       volumes:
         - name: zenml-config
+        {{- if and .Values.zenml.database.persistence.enabled (not .Values.zenml.database.url) }}
+          persistentVolumeClaim:
+            claimName: {{ include "zenml.fullname" . }}-config
+        {{- else }}
           emptyDir: {}
+        {{- end }}
       {{- if eq .Values.zenml.database.backupStrategy "dump-file" }}
         # define a volume that will hold a backup of the database
         - name: db-backup
@@ -227,4 +232,4 @@ spec:
       nodeSelector:
         {{- toYaml . | nindent 8 }}
       {{- end }}
-{{- end }}
+{{- end }}

helm/templates/server-db-pvc.yaml

@@ -22,4 +22,4 @@ spec:
   storageClassName: {{ . }}
   {{- end }}
 {{- end }}
-{{- end }}
+{{- end }}

helm/templates/server-deployment.yaml

@@ -59,7 +59,12 @@ spec:
         {{- toYaml .Values.podSecurityContext | nindent 8 }}
       volumes:
         - name: zenml-config
+        {{- if and .Values.zenml.database.persistence.enabled (not .Values.zenml.database.url) }}
+          persistentVolumeClaim:
+            claimName: {{ include "zenml.fullname" . }}-config
+        {{- else }}
           emptyDir: {}
+        {{- end }}
       {{- if or .Values.zenml.certificates.customCAs .Values.zenml.certificates.secretRefs }}
         - name: custom-certs
           projected:

helm/values.yaml

@@ -306,11 +306,19 @@ zenml:
   enableImplicitAuthMethods: false
 
   # MySQL database configuration. If not set, a local sqlite database will be
-  # used, which will not be persisted across pod restarts.
+  # used. To ensure data are not lost, check the persistence part.
   # NOTE: the certificate files need to be copied in the helm chart folder and
   # the paths configured here need to be relative to the root of the helm chart.
   database:
 
+    # If set to true, path where the local database is created will be
+    # mounted as a persistent volume so the data is not lost on pod restarts.
+    # Only relevant for local sqlite database.
+    persistence:
+      enabled: false
+      size: 1Gi
+      storageClassName: ""
+
     # The database URL. If not set, a local sqlite database will be used, which
     # will not be persisted across pod restarts. The URL can contain the
     # password or it can be provided in a secret using the `passwordSecretRef`