extra volume support

Author: Georg Martin Weber

hull-vidispine-addon/Chart.yaml

@@ -3,4 +3,4 @@ apiVersion: v1
 appVersion: 1.29.0
 description: hull-vidispine-addon
 name: hull-vidispine-addon
-version: 1.29.2
+version: 1.29.3

hull-vidispine-addon/README.md

@@ -63,7 +63,8 @@ Describes configuration options. <br>Has exclusively the following sub-fields: <
 | `debug.ignoreEntityRestCallErrors` | If `false`, the `hull-install` and `hull-configure` scripts will stop after an error was encountered and the allowed number of retries was exceeded. To instead ignore errors and provide a list of failed `entities` after execution set this value to `true`, This can be useful for debugging potential issues with Helm Charts. | `false` | `true`
 | `debug.retriesForEntityRestCall` | Sets number of retries for each individual GET, PUT, POST and DELETE call before considering the operation failed. | `3` | `1`
 | `debug.retriesForEntityRestCall` | Sets number of retries for each individual GET, PUT, POST and DELETE call before considering the operation failed. | `5` | `2`
-
+| `legacy` | Setttings for legacy compatibility.
+| `legacy.defaultServiceAccountIsHook` |  In older versions of the `hull-vidispine-addon`, the `default` ServiceAccount that is being created by HULL was annotated as a Helm hook by the `hull-vidispine-addon`and used for all pods in the Helm chart. This behavior was problematic because the Hook lifecycle was only appropriate for the `hull-vidispine-addon` jobs but not the remaining pods. Furthermore it opposed granular RBAC settings for the `hull-install` Jobs vs. continuously running regular pods. So by now there are different Helm hook ServiceAccounts created for the `hull-install` and `hull-configure` job and the `default` ServiceAccount is not annotated as a Helm hook anymore.<br><br> This setting should **NEVER** be set to `true` for new Helm charts, only for a transition phase it may be useful to set it to `true` to avoid immediate migration issues. | `false` | `true`
 ### EndpointSpec
 Describes an endpoint which is communicated with. <br>Has exclusively the following sub-fields: <br><br>`endpoint`<br>`auth`<br>`extraHeaders`<br>`stage`<br>`subresources`
 
@@ -1037,7 +1038,7 @@ _PVCS_:  The additional persistentVolumeClaim volumes to add to the volumes as c
 Usage:
 
 This function renders a pods volumes section based on the arguments and rest of the charts configuration:
-First it traverses the _COMPONENT_ in `hull.config.specific.components` and adds all `mounts.secret`'s and `mounts.configmap`'s names as references to the volumes secret and configMap volumes. It also adds all Secrets and ConfigMaps names as references for all defined physical files which are stored under the `files/_COMPONENT_/mounts/secret` and `files/_COMPONENT_/mounts/configmap` folders. Then it adds all additional secret's, configMap's, emptyDir's and persistentVolumeClaim's static reference names provided as additional arguments where the name of the reference is the full object name which is being referenced.
+First it traverses the _COMPONENT_ in `hull.config.specific.components` and adds all `mounts.secret`'s and `mounts.configmap`'s names as references to the volumes secret and configMap volumes. Furthermore it is possible to specify arbitrary `volumes` under a _COMPONENT_s `extraVolumes` property which are also added to the pods `volume` section. It also adds all Secrets and ConfigMaps names as references for all defined physical files which are stored under the `files/_COMPONENT_/mounts/secret` and `files/_COMPONENT_/mounts/configmap` folders. Furthermore it is possible to specify arbitrary `volume`'s under a _COMPONENT_'s `extraVolumes` property, these are also added to the pods `volume` section. This grants maximum freedom to add system-specific `volume`'s to the pod. Finally it adds all additional secret's, configMap's, emptyDir's and persistentVolumeClaim's static reference names provided as additional arguments where the name of the reference is the full object name which is to be included.
 
 ### hull.vidispine.addon.library.component.pod.env
 

hull-vidispine-addon/files/test/HULL/sources/cases/legacyserviceaccounthooks/legacyserviceaccounthooks.values.hull.yaml

@@ -0,0 +1,8 @@
+hull:
+  config:
+    general:
+      data:
+        installation:
+          config:
+            legacy:
+              defaultServiceAccountIsHook: true

hull-vidispine-addon/files/test/HULL/sources/cases/serviceaccount/values.hull.yaml

@@ -0,0 +1,7 @@
+################################ 
+### Example values.yaml with all features applied
+################################
+
+###################################################
+### CONFIG
+{}

hull-vidispine-addon/files/test/HULL/specs/serviceaccount.spec

@@ -0,0 +1,43 @@
+# ServiceAccount
+
+Test creation of objects and features.
+
+* Prepare default test case for kind "ServiceAccount"
+
+## Render and Validate
+* Render
+* Expected number of "9" objects were rendered
+* Validate
+
+## Metadata
+* Check basic metadata functionality
+
+## Hooks
+* Render
+* Set test object to "release-name-hull-test-default"
+* Test Object does not have key "metadata§annotations§helm.sh/hook"
+* Test Object does not have key "metadata§annotations§helm.sh/hook-weight"
+* Test Object does not have key "metadata§annotations§helm.sh/hook-delete-policy"
+* Test Object does not have key "metadata§annotations§safe"
+* Test Object does not have key "metadata§annotations§safe-weight"
+* Test Object does not have key "metadata§annotations§safe-delete-policy"
+
+* Set test object to "release-name-hull-test-hull-install"
+* Test Object has key "metadata§annotations§safe" with value "pre-install,pre-upgrade"
+* Test Object has key "metadata§annotations§safe-weight" with value "-100"
+* Test Object has key "metadata§annotations§safe-delete-policy" with value "before-hook-creation"
+
+## Legacy
+* Prepare default test case for kind "ServiceAccount" including suites "legacyserviceaccounthooks"
+* Render
+
+* Set test object to "release-name-hull-test-default"
+* Test Object has key "metadata§annotations§safe" with value "pre-install,pre-upgrade"
+* Test Object has key "metadata§annotations§safe-weight" with value "-100"
+* Test Object has key "metadata§annotations§safe-delete-policy" with value "before-hook-creation"
+
+
+___
+
+
+* Clean the test execution folder

hull-vidispine-addon/hull-vidispine-addon.yaml

@@ -19,6 +19,8 @@ hull:
               ignoreEntityRestCallErrors: false
               retriesForEntityRestCall: 3
               retriesForAuthServiceCall: 10
+            legacy:
+              defaultServiceAccountIsHook: false
             runtime:
               sourcesFolders: _HT/hull.vidispine.addon.sources.folder.secret.count
           endpoints:
@@ -473,6 +475,20 @@ hull:
           "helm.sh/hook-delete-policy": before-hook-creation
 
     serviceaccount:
+      default:
+        annotations:
+          _HULL_TRANSFORMATION_:
+            NAME: hull.util.transformation.tpl
+            CONTENT: |- 
+              {
+                {{ if (index . "$").Values.hull.config.general.data.installation.config.legacy.defaultServiceAccountIsHook }}
+                "helm.sh/hook": "pre-install,pre-upgrade",
+                "helm.sh/hook-weight": "-100",
+                "helm.sh/hook-delete-policy": "before-hook-creation"
+                {{ end }}
+              }
+
+          
       hull-install:
         annotations:
           helm.sh/hook: pre-install,pre-upgrade

hull-vidispine-addon/templates/_library.tpl

@@ -657,12 +657,18 @@ etcssl:
 {{ range $pvc := $pvcs }}
 {{ if (ne $pvc "") }}
 {{ $pvc }}:
-  persistentVolumeClaim:     
+  persistentVolumeClaim:
     claimName: {{ $pvc }}
     staticName: true
 {{ end }}
 {{ end }}
 {{ end }}
+{{ if (ne nil (dig $component "extraVolumes" nil $parent.Values.hull.config.specific.components)) }}
+{{ range $evKey, $evValue := (index $parent.Values.hull.config.specific.components $component).extraVolumes }}
+{{ $evKey }}:
+{{ $evValue | toYaml | indent 2 }}
+{{ end }}
+{{ end }}
 {{ end }}