From 8f03ae54fd3a219476582b6046e968094e5e05a6 Mon Sep 17 00:00:00 2001 From: Yevhen Ivantsov Date: Fri, 8 Sep 2023 09:55:03 +1000 Subject: [PATCH] Fix comments --- src/main/charts/bamboo/README.md | 2 +- src/main/charts/bamboo/values.yaml | 2 +- src/main/charts/bitbucket/README.md | 2 +- src/main/charts/bitbucket/values.yaml | 2 +- src/main/charts/confluence/README.md | 2 +- src/main/charts/confluence/values.yaml | 2 +- src/main/charts/crowd/README.md | 2 +- src/main/charts/crowd/values.yaml | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/main/charts/bamboo/README.md b/src/main/charts/bamboo/README.md index 1c4218414..5c32c566f 100644 --- a/src/main/charts/bamboo/README.md +++ b/src/main/charts/bamboo/README.md @@ -97,7 +97,7 @@ Kubernetes: `>=1.21.x-0` | bamboo.sysadminCredentials.usernameSecretKey | string | `"username"` | The key in the Kubernetes Secret that contains the sysadmin username | | bamboo.topologySpreadConstraints | list | `[]` | Defines topology spread constraints for Bamboo pods. See details: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | | bamboo.unattendedSetup | bool | `true` | To skip the setup wizard post deployment set this property to 'true' and ensure values for all 'REQUIRED' and 'UNATTENDED-SETUP' stanzas (see banner of this file) have been supplied. For release 1.0.0 this value is by default set to 'true' and should not be changed. | -| bamboo.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. The default, the container name is bamboo (Helm chart name) | +| bamboo.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. By default the container name is `bamboo` which corresponds to the name of the Helm Chart. | | database.credentials.passwordSecretKey | string | `"password"` | The key ('password') in the Secret used to store the database login password | | database.credentials.secretName | string | `nil` | from-literal=password=' https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets | | database.credentials.usernameSecretKey | string | `"username"` | The key ('username') in the Secret used to store the database login username | diff --git a/src/main/charts/bamboo/values.yaml b/src/main/charts/bamboo/values.yaml index f8add8141..17d6d69df 100644 --- a/src/main/charts/bamboo/values.yaml +++ b/src/main/charts/bamboo/values.yaml @@ -380,7 +380,7 @@ ingress: # bamboo: - # -- Whether the main container should acquire helm release name. The default, the container name is bamboo (Helm chart name) + # -- Whether the main container should acquire helm release name. By default the container name is `bamboo` which corresponds to the name of the Helm Chart. # useHelmReleaseNameAsContainerName: false diff --git a/src/main/charts/bitbucket/README.md b/src/main/charts/bitbucket/README.md index 571af629d..739eed745 100644 --- a/src/main/charts/bitbucket/README.md +++ b/src/main/charts/bitbucket/README.md @@ -130,7 +130,7 @@ Kubernetes: `>=1.21.x-0` | bitbucket.sysadminCredentials.secretName | string | `nil` | The name of the Kubernetes Secret that contains the Bitbucket sysadmin credentials If specified, then these will be automatically populated during Bitbucket setup. Otherwise, they will need to be provided via the browser after initial startup. | | bitbucket.sysadminCredentials.usernameSecretKey | string | `"username"` | The key in the Kubernetes Secret that contains the sysadmin username | | bitbucket.topologySpreadConstraints | list | `[]` | Defines topology spread constraints for Bitbucket pods. See details: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | -| bitbucket.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. The default, the container name is bitbucket (Helm chart name) | +| bitbucket.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. By default the container name is `bitbucket` which corresponds to the name of the Helm Chart. | | database.credentials.passwordSecretKey | string | `"password"` | The key ('password') in the Secret used to store the database login password | | database.credentials.secretName | string | `nil` | from-literal=password=' https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets | | database.credentials.usernameSecretKey | string | `"username"` | The key ('username') in the Secret used to store the database login username | diff --git a/src/main/charts/bitbucket/values.yaml b/src/main/charts/bitbucket/values.yaml index eda828f7c..fb697ef3e 100644 --- a/src/main/charts/bitbucket/values.yaml +++ b/src/main/charts/bitbucket/values.yaml @@ -463,7 +463,7 @@ ingress: # bitbucket: - # -- Whether the main container should acquire helm release name. The default, the container name is bitbucket (Helm chart name) + # -- Whether the main container should acquire helm release name. By default the container name is `bitbucket` which corresponds to the name of the Helm Chart. # useHelmReleaseNameAsContainerName: false diff --git a/src/main/charts/confluence/README.md b/src/main/charts/confluence/README.md index 2883976c9..065313bf6 100644 --- a/src/main/charts/confluence/README.md +++ b/src/main/charts/confluence/README.md @@ -92,7 +92,7 @@ Kubernetes: `>=1.21.x-0` | confluence.tomcatConfig.generateByHelm | bool | `false` | Mount server.xml as a ConfigMap. Override configuration elements if necessary | | confluence.topologySpreadConstraints | list | `[]` | Defines topology spread constraints for Confluence pods. See details: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | | confluence.umask | string | `"0022"` | The umask used by the Confluence process when it creates new files. The default is 0022. This gives the new files: - read/write permissions for the Confluence user - read permissions for everyone else. | -| confluence.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. The default, the container name is confluence (Helm chart name) | +| confluence.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. By default the container name is `confluence` which corresponds to the name of the Helm Chart. | | database.credentials.passwordSecretKey | string | `"password"` | The key ('password') in the Secret used to store the database login password | | database.credentials.secretName | string | `nil` | from-literal=password=' https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets | | database.credentials.usernameSecretKey | string | `"username"` | The key ('username') in the Secret used to store the database login username | diff --git a/src/main/charts/confluence/values.yaml b/src/main/charts/confluence/values.yaml index 94d461ebe..a1705d643 100644 --- a/src/main/charts/confluence/values.yaml +++ b/src/main/charts/confluence/values.yaml @@ -483,7 +483,7 @@ ingress: # confluence: - # -- Whether the main container should acquire helm release name. The default, the container name is confluence (Helm chart name) + # -- Whether the main container should acquire helm release name. By default the container name is `confluence` which corresponds to the name of the Helm Chart. # useHelmReleaseNameAsContainerName: false diff --git a/src/main/charts/crowd/README.md b/src/main/charts/crowd/README.md index c138f0ce2..1c96b8e08 100644 --- a/src/main/charts/crowd/README.md +++ b/src/main/charts/crowd/README.md @@ -75,7 +75,7 @@ Kubernetes: `>=1.21.x-0` | crowd.startupProbe.periodSeconds | int | `5` | How often (in seconds) the Crowd container startup probe will run | | crowd.topologySpreadConstraints | list | `[]` | Defines topology spread constraints for Crowd pods. See details: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | | crowd.umask | string | `"0022"` | The umask used by the Crowd process when it creates new files. The default is 0022. This gives the new files: - read/write permissions for the Crowd user - read permissions for everyone else. | -| crowd.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. The default, the container name is crowd (Helm chart name) | +| crowd.useHelmReleaseNameAsContainerName | bool | `false` | Whether the main container should acquire helm release name. By default the container name is `crowd` which corresponds to the name of the Helm Chart. | | fluentd.command | string | `nil` | The command used to start Fluentd. If not supplied the default command will be used: "fluentd -c /fluentd/etc/fluent.conf -v" Note: The custom command can be free-form, however pay particular attention to the process that should ultimately be left running in the container. This process should be invoked with 'exec' so that signals are appropriately propagated to it, for instance SIGTERM. An example of how such a command may look is: " && && exec " | | fluentd.customConfigFile | bool | `false` | Set to 'true' if a custom config (see 'configmap-fluentd.yaml' for default) should be used for Fluentd. If enabled this config must be supplied via the 'fluentdCustomConfig' property below. | | fluentd.elasticsearch.enabled | bool | `true` | Set to 'true' if Fluentd should send all log events to an Elasticsearch service. | diff --git a/src/main/charts/crowd/values.yaml b/src/main/charts/crowd/values.yaml index c66248cb9..dc7ec5a6d 100644 --- a/src/main/charts/crowd/values.yaml +++ b/src/main/charts/crowd/values.yaml @@ -78,7 +78,7 @@ serviceAccount: # crowd: - # -- Whether the main container should acquire helm release name. The default, the container name is crowd (Helm chart name) + # -- Whether the main container should acquire helm release name. By default the container name is `crowd` which corresponds to the name of the Helm Chart. # useHelmReleaseNameAsContainerName: false