Merge pull request #1576 from porter-dev/ym/existing_volume_job

chore: allow mounting volumes on job charts

Author: yosefmih

applications/job/form.yaml

@@ -147,6 +147,31 @@ tabs:
       label: Propagate SIGTERM to child processes.
       settings:
         default: true
+  - name: persistence_toggle
+    contents:
+      - type: heading
+        label: Persistent Disks
+      - type: subtitle
+        label: Attach persistent disks to your job to retain data across runs.
+      - type: checkbox
+        label: Enable Persistence
+        variable: pvc.enabled
+  - name: persistent_storage
+    show_if: pvc.enabled
+    contents:
+      - type: number-input
+        label: Persistent Storage
+        variable: pvc.storage
+        placeholder: "ex: 20"
+        settings:
+          unit: Gi
+          default: 20
+      - type: string-input
+        label: Mount Path
+        variable: pvc.mountPath
+        placeholder: "ex: /mypath"
+        settings:
+          default: /mypath
     - type: heading
       label: Image Settings
     - type: subtitle

applications/job/templates/cronjob.yaml

@@ -175,6 +175,11 @@ spec:
                   readOnly: true
               {{ end }}
               {{ end }}
+              {{ if .Values.pvc.enabled }}
+              volumeMounts:
+                - name: "{{ include "docker-template.fullname" . }}-storage"
+                  mountPath: {{ .Values.pvc.mountPath }}
+              {{ end }}
               resources:
                 requests:
                   cpu: {{ .Values.resources.requests.cpu }}
@@ -245,13 +250,22 @@ spec:
                   mountPath: /secrets/
                   readOnly: true
           {{ end }}
-          {{ if or .Values.cloudsql.enabled .Values.fileSecretMounts.enabled}}
+          {{ if or .Values.cloudsql.enabled .Values.fileSecretMounts.enabled .Values.pvc.enabled}}
           volumes:
             {{ if .Values.cloudsql.enabled }}
             - name: "sidecar-volume-{{ include "docker-template.fullname" . }}"
               secret:
                 secretName: "{{ include "cloudsql.serviceAccountJSONSecret" . }}"
             {{ end }}
+            {{ if .Values.pvc.enabled }}
+            - name: "{{ include "docker-template.fullname" . }}-storage"
+              persistentVolumeClaim:
+                {{- if .Values.pvc.existingVolume }}
+                claimName: {{ .Values.pvc.existingVolume }}
+                {{- else }}
+                claimName: "{{ include "docker-template.fullname" . }}-pvc"
+                {{- end }}
+            {{ end }}
             {{ if .Values.fileSecretMounts.enabled }}
             {{ range .Values.fileSecretMounts.mounts }}
             - name: {{ .mountPath }}

applications/job/templates/pvc.yaml

@@ -0,0 +1,12 @@
+{{- if and .Values.pvc.enabled (not .Values.pvc.existingVolume) -}}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: "{{ include "docker-template.fullname" . }}-pvc"
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: {{ .Values.pvc.storage }}
+{{ end }} 

applications/job/validate.json

@@ -68,6 +68,28 @@
           }
         }
       }
+    },
+    "pvc": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false
+        },
+        "storage": {
+          "type": "string",
+          "pattern": "^\\d+(Ki|Mi|Gi|Ti)$",
+          "default": "20Gi"
+        },
+        "mountPath": {
+          "type": "string",
+          "default": "/mypath"
+        },
+        "existingVolume": {
+          "type": "string",
+          "default": ""
+        }
+      }
     }
   }
 }

applications/job/values.yaml

@@ -105,5 +105,11 @@ fileSecretMounts:
 # enable this conservatively
 enableHostIpc: false
 
+pvc:
+  enabled: false
+  storage: 20Gi
+  mountPath: /mypath
+  existingVolume: ""
+
 # job timeout configuration
 activeDeadlineSeconds: # Optional - if not set, will use sidecar.timeout