Add volumes for index and storage

Author: jennydaman

charts/orthanc/.helmignore

@@ -21,3 +21,6 @@
 .idea/
 *.tmproj
 .vscode/
+
+# helm-unittest
+/tests

charts/orthanc/templates/deployment.yaml

@@ -147,6 +147,14 @@ spec:
             - name: config
               readOnly: true
               mountPath: /etc/orthanc
+            {{- if .Values.persistence.storage.enabled }}
+            - name: index
+              mountPath: {{ .Values.config.IndexDirectory }}
+            {{- end }}
+            {{- if .Values.persistence.storage.enabled }}
+            - name: storage
+              mountPath: {{ .Values.config.StorageDirectory }}
+            {{- end }}
             - name: tmp
               mountPath: {{ .Values.config.TemporaryDirectory }}
             {{- with include "orthanc.encryption-secret" . }}
@@ -161,6 +169,16 @@ spec:
         - name: config
           configMap:
             name: {{ include "orthanc.fullname" . }}
+        {{- if .Values.persistence.storage.enabled }}
+        - name: storage
+          persistentVolumeClaim:
+            claimName: {{ .Values.persistence.storage.existingClaim | default (include "orthanc.fullname" . | printf "%s-storage") }}
+        {{- end }}
+        {{- if .Values.persistence.index.enabled }}
+        - name: index
+          persistentVolumeClaim:
+            claimName: {{ .Values.persistence.index.existingClaim | default (include "orthanc.fullname" . | printf "%s-index") }}
+        {{- end }}
         - name: tmp
           emptyDir:
             {{- with .Values.emptyDirs.temporaryDirectory }}

charts/orthanc/templates/storage.yml

@@ -0,0 +1,29 @@
+{{- define "orthanc.volume" }}
+{{- $volume := get .Values.persistence .name }}
+{{- if (and $volume.enabled (empty $volume.existingClaim)) }}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ include "orthanc.fullname" . }}-{{ .name }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- merge $volume.labels (include "orthanc.labels" . | fromYaml) | toYaml | nindent 4 }}
+  {{- with (merge $volume.annotations .Values.commonAnnotations) }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- with $volume.storageClass | default .Values.global.defaultStorageClass }}
+  storageClassName: {{ . }}
+  {{- end }}
+  accessModes:
+    {{- toYaml $volume.accessModes | nindent 4 }}
+  resources:
+    requests:
+      storage: {{ $volume.size }}
+{{- end }}
+{{- end }}
+
+{{- include "orthanc.volume" (merge (dict "name" "index") $) }}
+---
+{{- include "orthanc.volume" (merge (dict "name" "storage") $) }}

charts/orthanc/tests/volumes_test.yaml

@@ -0,0 +1,56 @@
+suite: PersistentVolumeClaims
+release:
+  name: pvctest
+templates:
+  - storage.yml
+tests:
+  - it: should be empty when persistence is disabled
+    set:
+      persistence.index.enabled: false
+      persistence.storage.enabled: false
+    asserts:
+      - hasDocuments:
+          count: 0
+  - it: should create a volume when existingClaim is empty
+    set:
+      persistence:
+        index:
+          enabled: true
+          existingClaim: ""
+          size: 2Gi
+        storage:
+          enabled: true
+          existingClaim: "existing-claim-name"
+    asserts:
+      - hasDocuments:
+          count: 1
+      - containsDocument:
+          apiVersion: v1
+          kind: PersistentVolumeClaim
+          name: pvctest-orthanc-index
+      - equal:
+          path: spec.resources.requests.storage
+          value: 2Gi
+  - it: should create both volumes
+    set:
+      persistence:
+        index:
+          enabled: true
+          existingClaim: ""
+        storage:
+          enabled: true
+          existingClaim: ""
+    asserts:
+      - hasDocuments:
+          count: 2
+      - containsDocument:
+          apiVersion: v1
+          kind: PersistentVolumeClaim
+          name: pvctest-orthanc-index
+          any: true
+      - containsDocument:
+          apiVersion: v1
+          kind: PersistentVolumeClaim
+          name: pvctest-orthanc-storage
+          any: true
+

charts/orthanc/values.yaml

@@ -191,9 +191,9 @@ persistence:
     # -- PVC Storage Request for Orthanc SQLite index
     size: 1Gi
     # -- Annotations for the PVC
-    annotations:
+    annotations: {}
     # -- Labels for the PVC
-    labels:
+    labels: {}
   storage:
     # -- Enable Orthanc storage data persistence using PVC
     enabled: false
@@ -206,9 +206,9 @@ persistence:
     # -- PVC Storage Request for Orthanc storage
     size: 1Gi
     # -- Annotations for the PVC
-    annotations:
+    annotations: {}
     # -- Labels for the PVC
-    labels:
+    labels: {}
 
 # -- Use the CrunchyData PostgreSQL Operator to create a PostgreSQL database
 crunchyPgo:
@@ -534,6 +534,18 @@ config:
   #          which can be configured by emptyDirs.temporaryDirectory.
   TemporaryDirectory: /tmp/Orthanc
 
+  # -- Path to the directory that holds the heavyweight files (i.e. the
+  # -- raw DICOM instances).
+  # -- NOTE: a PersistentVolumeClaim can be created for this path by
+  #          setting persistence.storage.enabled=true
+  StorageDirectory: /var/lib/orthanc/storage
+  # -- Path to the directory that holds the SQLite index (if unset, the
+  # -- value of StorageDirectory is used). This index could be stored on
+  # -- a RAM-drive or a SSD device for performance reasons.
+  # -- NOTE: a PersistentVolumeClaim can be created for this path by
+  #          setting persistence.index.enabled=true
+  IndexDirectory: /var/lib/orthanc/index
+
 metrics:
   # -- Enables the Prometheus metrics endpoint of Orthanc.
   # -- metrics.enabled is an alias for config.MetricsEnabled.