You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: hull-vidispine-addon/README.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,11 +47,12 @@ To mimic this tree structure the configuration is built around this three-part w
47
47
| `endpoints` | Dictionary of endpoints to communicate with.<br><br>Key: <br>Key for entry in dictionary `endpoints`<br><br>Value: <br>The endpoint definition in form of a `<endpointSpec>` | `10_vidicore:`<br>`20_authservice:`<br>`30_configportal:`
48
48
49
49
### ConfigSpec
50
-
Describes configuration options. <br>Has exclusively the following sub-fields: <br><br>`customCaCertificates`<br>`preScript`<br>`postScript`<br>`productUris`<br>`debug`
50
+
Describes configuration options. <br>Has exclusively the following sub-fields: <br><br>`customCaCertificates`<br>`certificateSecrets`<br>`preScript`<br>`postScript`<br>`productUris`<br>`debug`
| `customCaCertificates` | An optional dictionary of custom ca certificates that are being mounted into the`hull-install` and `hull-configure` pods. Presence of certificates may be required for proper communication with the authentication service.
55
+
| `certificateSecrets` | An optional dictionary of keys and secret configurations for certificates that should be included as custom CA certificates at runtime. The keys will be used to create the `volumeMount` name using the schema `cert-<KEY>-<FILENAME>`and the file name of the secrets entry that is mounted into the `/usr/local/share/ca-certificates` folder under the name `custom-ca-certificates-<KEY>-<FILENAME>`.<br><br>Each secret configuration under a key needs the following entries:<br>- `secretName`: the complete name of the secret<br>- `fileNames`: an array of filenames/`data` keys which are to be mounted | `certificateSecrets:`<br>  `opensearch:`<br>    `secretName:` `opensearch-node-certs`<br>    `fileNames:`<br>    - `cert.tls`
55
56
| `preScript` | A Powershell script to be executed before the installation jobs endpoints are processed.
56
57
| `postScript` | A Powershell script to be executed after the installation jobs endpoints are processed.
57
58
| `productUris` | Product URIs that are can be used in conjunction with the transformations that populate authentication client data such as `hull.vidispine.addon.coruris` and `hull.vidispine.addon.producturis`. <br><br>When populated the entries here will be manipulated according to the transformation and are added to the fields where the transformation is applied. <br><br>Note that this can be automatically populated by a `hull.util.transformation.tpl` from the `hull.config.general.data.endpoints` fields like in the example. | `[]` | `productUris:`<br>`-` `https://myapp`<br>`-` `https://myappalternativehost`<br><br>or<br><br>`productUris:`<br>  `_HULL_TRANSFORMATION_:`<br>    `NAME:` `hull.util.transformation.tpl`<br>    `CONTENT:` `"`<br>      `[`<br>      `{{-` `(index` `.` `\"PARENT\").Values.hull.config.general.data.endpoints.configportal.uri.api` `-}},`<br>      `{{-` `(index` `.` `\"PARENT\").Values.hull.config.general.data.endpoints.configportal.uri.ui` `-}}`<br>      `]"`
@@ -1018,6 +1019,8 @@ Parameters:
1018
1019
_PARENT_CONTEXT_: The Helm charts global context
1019
1020
_COMPONENT_: The `component` to create a volume section for
1020
1021
need to be lowercase seperated with '-' (kebapcase) and are converted to the URI keys by making them camelCase.
1022
+
_HASH_CONFIGMAP_: Determines whether the `hashsumAnnotation` key is set on the ConfigMap volume if it is being created. This does not apply to the additional _CONFIGMAPS_, only to the one created if the component has at least one ConfigMap element. Defaults to true.
1023
+
_HASH_SECRET_: Determines whether the `hashsumAnnotation` key is set on the Secret volume if it is being created. This does not apply to the additional _SECRETS_, only to the one created if the component has at least one Secret element. Defaults to true.
1021
1024
_SECRETS_: The additional Secrets to add to the volumes as comma-seperated list
1022
1025
_CONFIGMAPS_: The additional configMap volumes to add to the volumes as comma-seperated list
1023
1026
_EMPTYDIRS_: The additional emptyDir volumes to add to the volumes as comma-seperated list
@@ -1026,7 +1029,7 @@ _PVCS_: The additional persistentVolumeClaim volumes to add to the volumes as c
1026
1029
Usage:
1027
1030
1028
1031
This function renders a pods volumes section based on the arguments and rest of the charts configuration:
1029
-
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 addional 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.
1032
+
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.
0 commit comments