Skip to content

Commit

Permalink
Add the new fields for helm-common
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrunner committed Dec 17, 2024
1 parent d405d0c commit 5a86f6c
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 8 deletions.
36 changes: 32 additions & 4 deletions values.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,40 @@

- **`common`**
- **`global`** _(object)_
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`image`**: Refer to _[#/definitions/globalImage](#definitions/globalImage)_.
- **`configMapNameOverride`**: Refer to _[#/definitions/configMapNameOverride](#definitions/configMapNameOverride)_.
- **`revisionHistoryLimit`** _(integer)_: The number of old history to keep to allow rollback.
- **`ingress`** _(object)_
- **`noSecretName`** _(boolean)_: Don't add a secret name to the Ingress TLS host, useful when the certification is configured in the Ingress controller.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`metadata`** _(object)_: Create a ConfigMap to expose some metadata about the chart. Cannot contain additional properties.
- **`enabled`** _(boolean)_: Enable the metadata ConfigMap. Default: `true`.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
- **`ingress`** _(object)_: Cannot contain additional properties.
- **`enabled`** _(boolean)_: Enable the Ingress.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
Expand All @@ -43,8 +57,10 @@
- **`dockerregistry`** _(object)_: Cannot contain additional properties.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
Expand All @@ -66,8 +82,10 @@
- **`enabled`** _(boolean)_: Enable the Secret. Default: `true`.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
Expand All @@ -86,8 +104,10 @@
- **`enabled`** _(boolean)_: Enable the ExternalSecret. Default: `true`.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
Expand All @@ -100,8 +120,10 @@
- **`configMaps`** _(object)_: Cannot contain additional properties.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
Expand Down Expand Up @@ -197,8 +219,10 @@
- **`enabled`** _(boolean)_: Enable the ingress for this service.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
Expand Down Expand Up @@ -232,17 +256,21 @@

## Definitions

- <a id="definitions/nameOverride"></a>**`nameOverride`** _(string)_: [helm-common] Override the name.
- <a id="definitions/fullnameOverride"></a>**`fullnameOverride`** _(string)_: [helm-common] Override the fullname.
- <a id="definitions/releaseTrunc"></a>**`releaseTrunc`** _(integer)_: [helm-common] The release trunk length. Default: `20`.
- <a id="definitions/prefixTrunc"></a>**`prefixTrunc`** _(integer)_: [helm-common] The prefix trunk length (release and chart name). Default: `40`.
- <a id="definitions/nameOverride"></a>**`nameOverride`** _(string)_: [helm-common] Override the name (can be in the service or values).
- <a id="definitions/fullnameOverride"></a>**`fullnameOverride`** _(string)_: [helm-common] Override the fullname (can be in the service or values).
- <a id="definitions/releaseNameOverride"></a>**`releaseNameOverride`** _(string)_: [helm-common] Override the the release name (can be in the service, values or global).
- <a id="definitions/releaseTrunc"></a>**`releaseTrunc`** _(integer)_: [helm-common] The release name trunk length (can be in the service, values or global). Default: `20`.
- <a id="definitions/nameTrunc"></a>**`nameTrunc`** _(integer)_: [helm-common] The chart name trunk length (can be in the service, values or global). Default: `20`.
- <a id="definitions/prefixTrunc"></a>**`prefixTrunc`** _(integer)_: [helm-common] The prefix trunk length (release and chart name) (can be in the service, values or global). Default: `40`.
- <a id="definitions/serviceAccount"></a>**`serviceAccount`** _(object)_: Service account configuration. Cannot contain additional properties.
- **`create`** _(boolean)_: Create a service account.
- **`name`** _(string)_: Name of the service account.
- **`nameOverride`**: Refer to _[#/definitions/nameOverride](#definitions/nameOverride)_.
- **`fullnameOverride`**: Refer to _[#/definitions/fullnameOverride](#definitions/fullnameOverride)_.
- **`releaseNameOverride`**: Refer to _[#/definitions/releaseNameOverride](#definitions/releaseNameOverride)_.
- **`serviceName`**: Refer to _[#/definitions/serviceName](#definitions/serviceName)_.
- **`releaseTrunc`**: Refer to _[#/definitions/releaseTrunc](#definitions/releaseTrunc)_.
- **`nameTrunc`**: Refer to _[#/definitions/nameTrunc](#definitions/nameTrunc)_.
- **`prefixTrunc`**: Refer to _[#/definitions/prefixTrunc](#definitions/prefixTrunc)_.
- **`labels`**: Refer to _[#/definitions/labels](#definitions/labels)_.
- **`annotations`**: Refer to _[#/definitions/annotations](#definitions/annotations)_.
Expand Down
95 changes: 91 additions & 4 deletions values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,29 @@
"definitions": {
"nameOverride": {
"type": "string",
"description": "[helm-common] Override the name"
"description": "[helm-common] Override the name (can be in the service or values)"
},
"fullnameOverride": {
"type": "string",
"description": "[helm-common] Override the fullname"
"description": "[helm-common] Override the fullname (can be in the service or values)"
},
"releaseNameOverride": {
"type": "string",
"description": "[helm-common] Override the the release name (can be in the service, values or global)"
},
"releaseTrunc": {
"type": "integer",
"description": "[helm-common] The release trunk length",
"description": "[helm-common] The release name trunk length (can be in the service, values or global)",
"default": 20
},
"nameTrunc": {
"type": "integer",
"description": "[helm-common] The chart name trunk length (can be in the service, values or global)",
"default": 20
},
"prefixTrunc": {
"type": "integer",
"description": "[helm-common] The prefix trunk length (release and chart name)",
"description": "[helm-common] The prefix trunk length (release and chart name) (can be in the service, values or global)",
"default": 40
},
"serviceAccount": {
Expand All @@ -40,12 +49,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand Down Expand Up @@ -285,6 +300,18 @@
"global": {
"type": "object",
"properties": {
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
"image": {
"$ref": "#/definitions/globalImage"
},
Expand All @@ -306,6 +333,24 @@
}
}
},
"nameOverride": {
"$ref": "#/definitions/nameOverride"
},
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
"metadata": {
"type": "object",
"description": "Create a ConfigMap to expose some metadata about the chart",
Expand All @@ -322,12 +367,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand All @@ -353,12 +404,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand Down Expand Up @@ -428,12 +485,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand Down Expand Up @@ -521,12 +584,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand Down Expand Up @@ -600,12 +669,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand Down Expand Up @@ -652,12 +727,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand Down Expand Up @@ -1035,12 +1116,18 @@
"fullnameOverride": {
"$ref": "#/definitions/fullnameOverride"
},
"releaseNameOverride": {
"$ref": "#/definitions/releaseNameOverride"
},
"serviceName": {
"$ref": "#/definitions/serviceName"
},
"releaseTrunc": {
"$ref": "#/definitions/releaseTrunc"
},
"nameTrunc": {
"$ref": "#/definitions/nameTrunc"
},
"prefixTrunc": {
"$ref": "#/definitions/prefixTrunc"
},
Expand Down

0 comments on commit 5a86f6c

Please sign in to comment.