From 5a86f6cd78d1d3d542fb07eb7bfd7d0d46e3ae27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Brunner?= Date: Tue, 17 Dec 2024 09:32:52 +0100 Subject: [PATCH] Add the new fields for helm-common --- values.md | 36 ++++++++++++++++-- values.schema.json | 95 ++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 123 insertions(+), 8 deletions(-) diff --git a/values.md b/values.md index 441c500..0e94f75 100644 --- a/values.md +++ b/values.md @@ -4,17 +4,29 @@ - **`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)_. @@ -22,8 +34,10 @@ - **`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)_. @@ -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)_. @@ -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)_. @@ -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)_. @@ -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)_. @@ -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)_. @@ -232,17 +256,21 @@ ## Definitions -- **`nameOverride`** _(string)_: [helm-common] Override the name. -- **`fullnameOverride`** _(string)_: [helm-common] Override the fullname. -- **`releaseTrunc`** _(integer)_: [helm-common] The release trunk length. Default: `20`. -- **`prefixTrunc`** _(integer)_: [helm-common] The prefix trunk length (release and chart name). Default: `40`. +- **`nameOverride`** _(string)_: [helm-common] Override the name (can be in the service or values). +- **`fullnameOverride`** _(string)_: [helm-common] Override the fullname (can be in the service or values). +- **`releaseNameOverride`** _(string)_: [helm-common] Override the the release name (can be in the service, values or global). +- **`releaseTrunc`** _(integer)_: [helm-common] The release name trunk length (can be in the service, values or global). Default: `20`. +- **`nameTrunc`** _(integer)_: [helm-common] The chart name trunk length (can be in the service, values or global). Default: `20`. +- **`prefixTrunc`** _(integer)_: [helm-common] The prefix trunk length (release and chart name) (can be in the service, values or global). Default: `40`. - **`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)_. diff --git a/values.schema.json b/values.schema.json index 3afe7a8..0f0119b 100644 --- a/values.schema.json +++ b/values.schema.json @@ -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": { @@ -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" }, @@ -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" }, @@ -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", @@ -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" }, @@ -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" }, @@ -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" }, @@ -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" }, @@ -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" }, @@ -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" }, @@ -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" },