Skip to content

Commit 1035940

Browse files
Ian-wang-liyangdistro-ci[bot]
Ian-wang-liyang
and
distro-ci[bot]
authored
docs(8.8): fix @param deprecation notices to reference specific sub-keys (#6417)
Co-authored-by: distro-ci[bot] <122795778+distro-ci[bot]@users.noreply.github.com>
1 parent 49c6fa5 commit 1035940

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

‎charts/camunda-platform-8.8/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -341,9 +341,9 @@ Please see the corresponding [release guide](../../docs/release.md) to find out
341341
| `global.secrets.name` | defines the name of the secret object that has the auto-generated passwords. | `camunda-credentials` |
342342
| `global.secrets.annotations` | defines the secret object annotations that utilize Helm hooks to keep that object out of the Helm deployment. | `{}` |
343343
| `global.license` | | |
344-
| `global.license.key` | (DEPRECATED - use global.license.secret instead) if set, it will be exposed as "CAMUNDA_LICENSE_KEY" in the apps. | `""` |
345-
| `global.license.existingSecret` | (DEPRECATED - use global.license.secret instead) you can provide an existing secret name for Camunda license secret. | `""` |
346-
| `global.license.existingSecretKey` | (DEPRECATED - use global.license.secret instead) you can provide the key within the existing secret object for Camunda license key. | `""` |
344+
| `global.license.key` | (DEPRECATED - use global.license.secret.inlineSecret instead) if set, it will be exposed as "CAMUNDA_LICENSE_KEY" in the apps. | `""` |
345+
| `global.license.existingSecret` | (DEPRECATED - use global.license.secret.existingSecret instead) you can provide an existing secret name for Camunda license secret. | `""` |
346+
| `global.license.existingSecretKey` | (DEPRECATED - use global.license.secret.existingSecretKey instead) you can provide the key within the existing secret object for Camunda license key. | `""` |
347347
| `global.license.secret` | configuration to provide the license secret. | |
348348
| `global.license.secret.inlineSecret` | can be used to provide the license as a plain-text value for non-production usage. | `""` |
349349
| `global.license.secret.existingSecret` | can be used to reference an existing Kubernetes Secret containing the license. | `""` |

‎charts/camunda-platform-8.8/values.schema.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@
2525
"properties": {
2626
"key": {
2727
"type": "string",
28-
"description": "(DEPRECATED - use global.license.secret instead) if set, it will be exposed as \"CAMUNDA_LICENSE_KEY\" in the apps.",
28+
"description": "(DEPRECATED - use global.license.secret.inlineSecret instead) if set, it will be exposed as \"CAMUNDA_LICENSE_KEY\" in the apps.",
2929
"default": ""
3030
},
3131
"existingSecret": {
3232
"type": "string",
33-
"description": "(DEPRECATED - use global.license.secret instead) you can provide an existing secret name for Camunda license secret.",
33+
"description": "(DEPRECATED - use global.license.secret.existingSecret instead) you can provide an existing secret name for Camunda license secret.",
3434
"default": ""
3535
},
3636
"existingSecretKey": {
3737
"type": "string",
38-
"description": "(DEPRECATED - use global.license.secret instead) you can provide the key within the existing secret object for Camunda license key.",
38+
"description": "(DEPRECATED - use global.license.secret.existingSecretKey instead) you can provide the key within the existing secret object for Camunda license key.",
3939
"default": ""
4040
},
4141
"secret": {

‎charts/camunda-platform-8.8/values.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ global:
5757
## License configuration.
5858
## @extra global.license
5959
license:
60-
## @param global.license.key (DEPRECATED - use global.license.secret instead) if set, it will be exposed as "CAMUNDA_LICENSE_KEY" in the apps.
60+
## @param global.license.key (DEPRECATED - use global.license.secret.inlineSecret instead) if set, it will be exposed as "CAMUNDA_LICENSE_KEY" in the apps.
6161
key: ""
62-
## @param global.license.existingSecret (DEPRECATED - use global.license.secret instead) you can provide an existing secret name for Camunda license secret.
62+
## @param global.license.existingSecret (DEPRECATED - use global.license.secret.existingSecret instead) you can provide an existing secret name for Camunda license secret.
6363
existingSecret: ""
64-
## @param global.license.existingSecretKey (DEPRECATED - use global.license.secret instead) you can provide the key within the existing secret object for Camunda license key.
64+
## @param global.license.existingSecretKey (DEPRECATED - use global.license.secret.existingSecretKey instead) you can provide the key within the existing secret object for Camunda license key.
6565
existingSecretKey: ""
6666
## @extra global.license.secret configuration to provide the license secret.
6767
secret:

0 commit comments

Comments
 (0)