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-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,9 @@ Describes configuration options. <br>Has exclusively the following sub-fields: <
56
56
| `preScript` | A Powershell script to be executed before the installation jobs endpoints are processed.
57
57
| `postScript` | A Powershell script to be executed after the installation jobs endpoints are processed.
58
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>      `]"`
59
+
| `proxy.httpProxy` | If set to a non empty string, the value is added as environment variable `HTTP_PROXY` to `hull-install` and `hull-configure` installation containers | `""` | `"http://10.161.172.192:3128"`
60
+
| `proxy.httpsProxy` | If set to a non empty string, the value is added as environment variable `HTTPS_PROXY` to `hull-install` and `hull-configure` installation containers | `""` | `"http://10.161.172.192:3128"`
61
+
| `proxy.noProxy` | If set to a non empty string, the value is added as environment variable `NO_PROXY` to `hull-install` and `hull-configure` installation containers | `""` | `".cluster.local.,.cluster.local,.svc,10.42.0.0/16,10.43.0.0/16"`
| `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`
61
64
| `debug.retriesForEntityRestCall` | Sets number of retries for each individual GET, PUT, POST and DELETE call before considering the operation failed. | `3` | `1`
@@ -95,7 +98,7 @@ Describes a subresource on an endpoint which is communicated with. <br>Has exclu
95
98
| `entities` | Dictionary of entities on the subresource to create, modify or delete.<br><br>Key: <br>Key for entry in dictionary `entities`<br><br>Value: <br>The entity definition in form of a `<entitySpec>`
96
99
97
100
### EntitySpec
98
-
Describes a particular entity on a subresource on an endpoint which is communicated with. <br>Has exclusively the following sub-fields: <br><br>`register`<br>`remove`<br>`identifier`<br>`putUriExcludeIdentifier`<br>`putInsteadOfPost`<br>`postQueryParams`<br>`overwriteExisting`<br>`getUriExcludeIdentifier`<br>`getCustomScript`<br>`noGet`<br>`contentType`<br>`config`<br>`extraHeaders`
101
+
Describes a particular entity on a subresource on an endpoint which is communicated with. <br>Has exclusively the following sub-fields: <br><br>`extraHeaders`<br>`identifier`<br>`getQueryParams`<br>`getUriExcludeIdentifier`<br>`getCustomScript`<br>`noGet`<br>`customGetScriptJsonResponseConfigReplacements`<br>`readConfigFromFile`<br>`readConfigValuesFromFiles`<br>`updateConfigValues`<br>`config`<br>`register`<br>`overwriteExisting`<br>`contentType`<br>`postQueryParams`<br>`putInteadOfPost`<br>`putUriExcludeIdentifier`<br>`putQueryParams`<br>`remove`<br>`deleteUriExcludeIdentifier`<br>`deleteQueryParams`<br>`processNoOp`
@@ -116,6 +119,7 @@ Describes a particular entity on a subresource on an endpoint which is communica
116
119
| `postQueryParams` | Query Parameters to add to the Url of a POST command. Not a frequent use case but required to submit for example the `guid` of a UseCaseDefinition to migrate. | | `POST`
117
120
| `putInsteadOfPost` | Some APIs use PUTting instead of POSTing for creation of new entities. If the subresource uses PUTting instead of POSTing, set this parameter to `true`. | `false` | `POST` <br> `PUT`
118
121
| `putUriExcludeIdentifier` | Some APIs handle PUTting of entities by PUTing to the parent resource and specifying the entity to create in the body. If the subresource handles PUTting in that way, set this parameter to `true`. If `false` or unspecified, PUT calls will be made to the path which ends with the entities __identifier__. | `false` | `PUT`
122
+
| `putQueryParams` | Query Parameters to add to the Url of a PUT command. | | `PUT`
119
123
| `remove` | The entity will be DELETEd if it exists. If both `register` and `remove` is true, any found entity is first removed if it exists before it is being created. | `false` | `DELETE`
120
124
| `deleteUriExcludeIdentifier` | Some APIs handle DELETEing of entities by calling DELETE to the parent resource and specifying the entity to delete in query params. If the subresource handles DELETEing in that way, set this parameter to `true` and provide the subresource `identifierQueryParam` to identify the entity. If `false` or unspecified, DELETE calls will be made to the path which ends with the entities identifier name. | `false` | `DELETE`
121
125
| `deleteQueryParams` | Query Parameters to add to the Url of a DELETE command. Not a frequent use case but required to delete an entity in auth service. | `false` | `DELETE`
0 commit comments