diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 000a150bd9..1b5b456a05 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,9 @@ The sign-off is a simple line at the end of the explanation for a commit. All co Then you just add a line to every git commit message: - Signed-off-by: Joe Smith +```text +Signed-off-by: Joe Smith +``` Use your real name (sorry, no pseudonyms or anonymous contributions.) @@ -33,14 +35,14 @@ If you set your `user.name` and `user.email` git configs, you can sign your comm Note: If your git config information is set properly then viewing the `git log` information for your commit will look something like this: - ```text - Author: Joe Smith - Date: Thu Feb 2 11:41:15 2018 -0800 +```text +Author: Joe Smith +Date: Thu Feb 2 11:41:15 2018 -0800 - Update README + Update README - Signed-off-by: Joe Smith - ``` + Signed-off-by: Joe Smith +``` Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will be rejected by the automated DCO check. @@ -53,9 +55,9 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will ### PR Approval and Release Process 1. Changes are manually reviewed by Bitnami team members. -1. Once the changes are accepted, the PR is verified with a [Static analysis](https://github.com/bitnami/charts/blob/main/TESTING.md#Static-analysis) that includes the lint and the vulnerability checks. If that passes, the Bitnami team will review the changes and trigger the verification and functional tests. -1. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub `main` branch. -1. Then our CI/CD system is going to push the chart to the Helm registry including the recently merged changes and also the latest images and dependencies used by the chart. The changes in the images will be also committed by the CI/CD to the GitHub repository, bumping the chart version again. +2. Once the changes are accepted, the PR is verified with a [Static analysis](https://github.com/bitnami/charts/blob/main/TESTING.md#Static-analysis) that includes the lint and the vulnerability checks. If that passes, the Bitnami team will review the changes and trigger the verification and functional tests. +3. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub `main` branch. +4. Then our CI/CD system is going to push the chart to the Helm registry including the recently merged changes and also the latest images and dependencies used by the chart. The changes in the images will be also committed by the CI/CD to the GitHub repository, bumping the chart version again. ***NOTE***: Please note that, in terms of time, may be a slight difference between the appearance of the code in GitHub and the chart in the registry. diff --git a/LICENSE.md b/LICENSE.md index b57c3f728f..261eeb9e9f 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -199,4 +199,3 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - diff --git a/TESTING.md b/TESTING.md index 29d97a50eb..eeb2a49eeb 100644 --- a/TESTING.md +++ b/TESTING.md @@ -3,7 +3,7 @@ At Bitnami, we are committed to ensure the quality of the assets we deliver, and as such, tests play a fundamental role in the `bitnami/charts` repository. Bear in mind that every contribution to our charts is ultimately published to our Helm index, where it is made available for the rest of the community to benefit from. Before this happens, different checks are required to succeed. More precisely, tests are run when: 1. A new contribution (regardless of its author) is made through a GitHub Pull Request. -1. Accepted changes are merged to the `main` branch, prior to their release. +2. Accepted changes are merged to the `main` branch, prior to their release. This strategy ensures that a set of changes must have succeeded twice before a new version is sent out to the public. @@ -139,8 +139,8 @@ Before writing any test scenario, understand the primary purpose of the chart an As Charts are usually composed of a number of different components, it is also essential to test their integrations and the Chart as a whole. As a general guideline, testing a `bitnami/chart` can be reduced to: 1. Identifying the components of the Chart and verifying their integration. _e.g. WordPress + MariaDB + PHP + Data Volume_ -1. Summarizing the main area features the asset offers and asserting the Chart delivers them. _e.g. Creating a post in a blog_ -1. Focusing on the unique features the Chart offers. _e.g. ConfigMaps, PVCs, Services, secrets, etc._ +2. Summarizing the main area features the asset offers and asserting the Chart delivers them. _e.g. Creating a post in a blog_ +3. Focusing on the unique features the Chart offers. _e.g. ConfigMaps, PVCs, Services, secrets, etc._ It is easily noticeable though that Charts are usually highly configurable artifacts. Through parameters exposed in `values.yaml`, it is fairly common to perform customizations that range from enabling simple features (e.g. exporting metrics to Prometheus) to complete changes in the architecture of the application that will be deployed (e.g. standalone vs. main-secondary replication in DBs). In order to cope with this high variability, we should: @@ -190,11 +190,11 @@ containerPorts: The default vale for `moodleUsername` is `user` (you can check in [values.yaml](https://github.com/bitnami/charts/blob/main/bitnami/moodle/values.yaml)). Following the strategy, the default value was changed to see if the Chart is able to correctly pick it up. This is later checked [in one the tests](https://github.com/bitnami/charts/blob/30f2069e0b8ce5331987d06dc744b6d1bc1f04ec/.vib/moodle/cypress/cypress/support/commands.js#L19). -1. Why were other properties, like `moodleEmail`, NOT included? +2. Why were other properties, like `moodleEmail`, NOT included? Although the same reasoning would apply, there are no implicit checks in any of the tests that actively assert the email was changed. -1. Does that mean that every property in `runtime_parameters` should have an associated test? +3. Does that mean that every property in `runtime_parameters` should have an associated test? No, there is no need to have an specific test for each property, but the property **should have influence over the tests** to include it in the installation parameters. For instance, the property `service.type=LoadBalancer` does not have an associated test, but it is crucial for [Cypress](#cypress) to succeed. @@ -270,8 +270,8 @@ Sometimes it is of interest to run the tests locally, for example during develop $ helm install nginx bitnami/nginx -f <(echo "Y29udGFpbmVyUG9ydHM6CiAgaHR0cDogODA4MQogIGh0dHBzOiA4NDQ0CnBvZFNlY3VyaXR5Q29udGV4dDoKICBlbmFibGVkOiB0cnVlCiAgZnNHcm91cDogMTAwMgpjb250YWluZXJTZWN1cml0eUNvbnRleHQ6CiAgZW5hYmxlZDogdHJ1ZQogIHJ1bkFzVXNlcjogMTAwMgpzZXJ2aWNlOgogIHR5cGU6IExvYWRCYWxhbmNlcgogIHBvcnRzOgogICAgaHR0cDogODAKICAgIGh0dHBzOiA0NDQK" | base64 -d) ``` -1. Download and install [Cypress](https://www.cypress.io/). The version currently used is `9.5.4` -1. Obtain the IP and port of the Service exposing the UI of the application and adapt `cypress.json` to these values +2. Download and install [Cypress](https://www.cypress.io/). The version currently used is `9.5.4` +3. Obtain the IP and port of the Service exposing the UI of the application and adapt `cypress.json` to these values ```bash $ kubectl get svc @@ -316,7 +316,7 @@ Sometimes it is of interest to run the tests locally, for example during develop } ``` -1. Launch Cypress indicating the folder where tests are located +4. Launch Cypress indicating the folder where tests are located ```bash $ cypress run . @@ -403,8 +403,8 @@ Sometimes it is of interest to run the tests locally, for example during develop $ helm install metallb bitnami/metallb -f <(echo "Y29udHJvbGxlcjoKICBwb2RTZWN1cml0eUNvbnRleHQ6CiAgICBlbmFibGVkOiB0cnVlCiAgICBmc0dyb3VwOiAxMDAyCiAgY29udGFpbmVyU2VjdXJpdHlDb250ZXh0OgogICAgZW5hYmxlZDogdHJ1ZQogICAgcnVuQXNVc2VyOiAxMDAyCiAgICByZWFkT25seVJvb3RGaWxlc3lzdGVtOiBmYWxzZQogICAgY2FwYWJpbGl0aWVzOgogICAgICBkcm9wOgogICAgICAgIC0gQUxMCiAgc2VydmljZUFjY291bnQ6CiAgICBjcmVhdGU6IHRydWUKICAgIGF1dG9tb3VudFNlcnZpY2VBY2NvdW50VG9rZW46IHRydWU=" | base64 -d) ``` -1. Download and [install Ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo) in your system -1. Execute the tests. Provide the necessary params (usually, the path to the kubeconfig file and namespace name, but check `vib-verify.yaml`). +2. Download and [install Ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo) in your system +3. Execute the tests. Provide the necessary params (usually, the path to the kubeconfig file and namespace name, but check `vib-verify.yaml`). ```bash $ cd .vib/metallb/ginkgo @@ -471,8 +471,8 @@ Sometimes it is of interest to run the tests locally, for example during develop $ helm install nginx bitnami/nginx -f <(echo "Y29udGFpbmVyUG9ydHM6CiAgaHR0cDogODA4MQogIGh0dHBzOiA4NDQ0CnBvZFNlY3VyaXR5Q29udGV4dDoKICBlbmFibGVkOiB0cnVlCiAgZnNHcm91cDogMTAwMgpjb250YWluZXJTZWN1cml0eUNvbnRleHQ6CiAgZW5hYmxlZDogdHJ1ZQogIHJ1bkFzVXNlcjogMTAwMgpzZXJ2aWNlOgogIHR5cGU6IExvYWRCYWxhbmNlcgogIHBvcnRzOgogICAgaHR0cDogODAKICAgIGh0dHBzOiA0NDQK" | base64 -d) ``` -1. Download the [GOSS binary for Linux AMD64](https://github.com/goss-org/goss/releases/) -1. Copy the binary and test files to the target pod where it should be executed +2. Download the [GOSS binary for Linux AMD64](https://github.com/goss-org/goss/releases/) +3. Copy the binary and test files to the target pod where it should be executed ```bash $ kubectl get pods @@ -484,7 +484,7 @@ Sometimes it is of interest to run the tests locally, for example during develop $ kubectl cp .vib/nginx/goss/vars.yaml nginx-5fbc8786f-95rpl:/tmp/ ``` -1. Grant execution permissions to the binary and launch the tests +4. Grant execution permissions to the binary and launch the tests ```bash $ kubectl exec -it nginx-5fbc8786f-95rpl -- chmod +x /tmp/goss-linux-amd64 diff --git a/bitnami/airflow/README.md b/bitnami/airflow/README.md index 6ba0202f06..32f55fb677 100644 --- a/bitnami/airflow/README.md +++ b/bitnami/airflow/README.md @@ -59,7 +59,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -75,7 +74,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the the deployment(s)/statefulset(s) | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the the deployment(s)/statefulset(s) | `["infinity"]` | - ### Airflow common parameters | Name | Description | Value | @@ -105,7 +103,6 @@ The command removes all the Kubernetes components associated with the chart and | `extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for all the Airflow pods | `[]` | | `extraVolumes` | Optionally specify extra list of additional volumes for the all the Airflow pods | `[]` | - ### Airflow web parameters | Name | Description | Value | @@ -181,7 +178,6 @@ The command removes all the Kubernetes components associated with the chart and | `web.pdb.minAvailable` | Maximum number/percentage of unavailable Airflow web replicas | `1` | | `web.pdb.maxUnavailable` | Maximum number/percentage of unavailable Airflow web replicas | `""` | - ### Airflow scheduler parameters | Name | Description | Value | @@ -236,7 +232,6 @@ The command removes all the Kubernetes components associated with the chart and | `scheduler.pdb.minAvailable` | Maximum number/percentage of unavailable Airflow scheduler replicas | `1` | | `scheduler.pdb.maxUnavailable` | Maximum number/percentage of unavailable Airflow scheduler replicas | `""` | - ### Airflow worker parameters | Name | Description | Value | @@ -317,7 +312,6 @@ The command removes all the Kubernetes components associated with the chart and | `worker.autoscaling.targetCPU` | Define the CPU target to trigger the scaling actions (utilization percentage) | `80` | | `worker.autoscaling.targetMemory` | Define the memory target to trigger the scaling actions (utilization percentage) | `80` | - ### Airflow git sync parameters | Name | Description | Value | @@ -348,7 +342,6 @@ The command removes all the Kubernetes components associated with the chart and | `git.sync.extraEnvVarsSecret` | Secret with extra environment variables | `""` | | `git.sync.resources` | Sync sidecar container resource requests and limits | `{}` | - ### Airflow ldap parameters | Name | Description | Value | @@ -369,7 +362,6 @@ The command removes all the Kubernetes components associated with the chart and | `ldap.tls.certificatesMountPath` | Where LDAP certifcates are mounted. | `/opt/bitnami/airflow/conf/certs` | | `ldap.tls.CAFilename` | LDAP CA cert filename | `""` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -400,7 +392,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Other Parameters | Name | Description | Value | @@ -412,7 +403,6 @@ The command removes all the Kubernetes components associated with the chart and | `rbac.create` | Create Role and RoleBinding | `false` | | `rbac.rules` | Custom RBAC rules to set | `[]` | - ### Airflow metrics parameters | Name | Description | Value | @@ -463,7 +453,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.serviceMonitor.honorLabels` | Specify honorLabels parameter to add the scrape endpoint | `false` | | `metrics.serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in prometheus. | `""` | - ### Airflow database parameters | Name | Description | Value | @@ -494,10 +483,8 @@ The command removes all the Kubernetes components associated with the chart and | `externalRedis.existingSecret` | Name of an existing secret resource containing the Redis&trade credentials | `""` | | `externalRedis.existingSecretPasswordKey` | Name of an existing secret key containing the Redis&trade credentials | `""` | - - ```console -$ helm install my-release \ +helm install my-release \ --set auth.username=my-user \ --set auth.password=my-passsword \ --set auth.fernetKey=my-fernet-key \ diff --git a/bitnami/apache/README.md b/bitnami/apache/README.md index feb256c0cc..78dd9c88d0 100644 --- a/bitnami/apache/README.md +++ b/bitnami/apache/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -75,7 +74,6 @@ The command removes all the Kubernetes components associated with the chart and | `commonAnnotations` | Annotations to add to all deployed objects | `{}` | | `extraDeploy` | Array of extra objects to deploy with the release | `[]` | - ### Apache parameters | Name | Description | Value | @@ -168,7 +166,6 @@ The command removes all the Kubernetes components associated with the chart and | `sidecars` | Add additional sidecar containers to the Apache pods | `[]` | | `updateStrategy.type` | Apache Server deployment strategy type. | `RollingUpdate` | - ### Other Parameters | Name | Description | Value | @@ -182,7 +179,6 @@ The command removes all the Kubernetes components associated with the chart and | `autoscaling.targetCPU` | Target CPU utilization percentage | `50` | | `autoscaling.targetMemory` | Target Memory utilization percentage | `50` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -216,7 +212,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Metrics Parameters | Name | Description | Value | @@ -246,10 +241,8 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.prometheusRule.labels` | Labels that can be used so PrometheusRule will be discovered by Prometheus | `{}` | | `metrics.prometheusRule.rules` | Prometheus Rule definitions | `[]` | - - ```console -$ helm install my-release \ +helm install my-release \ --set imagePullPolicy=Always \ my-repo/apache ``` diff --git a/bitnami/appsmith/README.md b/bitnami/appsmith/README.md index 979af16167..89004c14a8 100644 --- a/bitnami/appsmith/README.md +++ b/bitnami/appsmith/README.md @@ -65,7 +65,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -89,12 +88,8 @@ The command removes all the Kubernetes components associated with the chart and | `image.pullSecrets` | Appsmith image pull secrets | `[]` | | `image.debug` | Enable Appsmith image debug mode | `false` | - ### Appsmith common paramters - - - ### Appsmith Client Parameters | Name | Description | Value | @@ -157,7 +152,6 @@ The command removes all the Kubernetes components associated with the chart and | `client.sidecars` | Add additional sidecar containers to the Appsmith client pod(s) | `[]` | | `client.initContainers` | Add additional init containers to the Appsmith client pod(s) | `[]` | - ### Appsmith Client Traffic Exposure Parameters | Name | Description | Value | @@ -188,7 +182,6 @@ The command removes all the Kubernetes components associated with the chart and | `client.ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `client.ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Appsmith Backend Parameters | Name | Description | Value | @@ -260,7 +253,6 @@ The command removes all the Kubernetes components associated with the chart and | `backend.sidecars` | Add additional sidecar containers to the Appsmith backend pod(s) | `[]` | | `backend.initContainers` | Add additional init containers to the Appsmith backend pod(s) | `[]` | - ### Appsmith Backend Traffic Exposure Parameters | Name | Description | Value | @@ -277,7 +269,6 @@ The command removes all the Kubernetes components associated with the chart and | `backend.service.sessionAffinity` | Control where backend requests go, to the same pod or round-robin | `None` | | `backend.service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` | - ### Backend Persistence Parameters | Name | Description | Value | @@ -293,7 +284,6 @@ The command removes all the Kubernetes components associated with the chart and | `backend.persistence.selector` | Selector to match an existing Persistent Volume for WordPress data PVC | `{}` | | `backend.persistence.dataSource` | Custom PVC data source | `{}` | - ### Appsmith RTS Parameters | Name | Description | Value | @@ -356,7 +346,6 @@ The command removes all the Kubernetes components associated with the chart and | `rts.sidecars` | Add additional sidecar containers to the Appsmith rts pod(s) | `[]` | | `rts.initContainers` | Add additional init containers to the Appsmith rts pod(s) | `[]` | - ### Appsmith RTS Traffic Exposure Parameters | Name | Description | Value | @@ -373,7 +362,6 @@ The command removes all the Kubernetes components associated with the chart and | `rts.service.sessionAffinity` | Control where rts requests go, to the same pod or round-robin | `None` | | `rts.service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` | - ### Init Container Parameters | Name | Description | Value | @@ -388,7 +376,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the init container | `{}` | | `volumePermissions.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` | - ### Other Parameters | Name | Description | Value | @@ -398,7 +385,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.annotations` | Additional Service Account annotations (evaluated as a template) | `{}` | | `serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | - ### External MongoDB parameters | Name | Description | Value | @@ -411,7 +397,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.existingSecret` | Name of an existing secret resource containing the database credentials | `""` | | `externalDatabase.existingSecretPasswordKey` | Name of an existing secret key containing the database credentials | `""` | - ### External Redis parameters | Name | Description | Value | @@ -422,7 +407,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalRedis.existingSecret` | Name of an existing secret resource containing the Redis credentials | `""` | | `externalRedis.existingSecretPasswordKey` | Name of an existing secret key containing the Redis credentials | `""` | - ### Redis sub-chart parameters | Name | Description | Value | @@ -435,7 +419,6 @@ The command removes all the Kubernetes components associated with the chart and | `redis.auth.password` | Redis password | `""` | | `redis.auth.existingSecret` | Name of a secret containing the Redis password | `""` | - ### MongoDB sub-chart parameters | Name | Description | Value | @@ -448,12 +431,10 @@ The command removes all the Kubernetes components associated with the chart and | `mongodb.containerPorts.mongodb` | MongoDB container port (used by the headless service) | `27017` | | `mongodb.arbiter.enabled` | Enable Arbiter nodes in the ReplicaSet | `false` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set appsmithUsername=admin \ --set appsmithPassword=password \ --set mariadb.auth.rootPassword=secretpassword \ diff --git a/bitnami/argo-cd/README.md b/bitnami/argo-cd/README.md index 7ac58d491d..d6712c29cc 100644 --- a/bitnami/argo-cd/README.md +++ b/bitnami/argo-cd/README.md @@ -61,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -74,7 +73,6 @@ The command removes all the Kubernetes components associated with the chart and | `clusterDomain` | Kubernetes cluster domain name | `cluster.local` | | `extraDeploy` | Array of extra objects to deploy with the release | `[]` | - ### Argo CD image parameters | Name | Description | Value | @@ -87,7 +85,6 @@ The command removes all the Kubernetes components associated with the chart and | `image.pullSecrets` | Argo CD image pull secrets | `[]` | | `image.debug` | Enable Argo CD image debug mode | `false` | - ### Argo CD application controller parameters | Name | Description | Value | @@ -203,7 +200,6 @@ The command removes all the Kubernetes components associated with the chart and | `controller.sidecars` | Add additional sidecar containers to the Argo CD pod(s) | `[]` | | `controller.initContainers` | Add additional init containers to the Argo CD pod(s) | `[]` | - ### Argo CD ApplicationSet controller parameters | Name | Description | Value | @@ -309,7 +305,6 @@ The command removes all the Kubernetes components associated with the chart and | `applicationSet.webhook.ingress.extraTls` | Extra TLS configuration for the Argo CD applicationSet ingress | `[]` | | `applicationSet.webhook.ingress.tls` | Ingress TLS configuration | `[]` | - ### Argo CD server Parameters | Name | Description | Value | @@ -454,7 +449,6 @@ The command removes all the Kubernetes components associated with the chart and | `server.serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | | `server.serviceAccount.annotations` | Annotations for service account. Evaluated as a template. Only used if `create` is `true`. | `{}` | - ### Argo CD repo server Parameters | Name | Description | Value | @@ -564,7 +558,6 @@ The command removes all the Kubernetes components associated with the chart and | `repoServer.sidecars` | Add additional sidecar containers to the Argo CD repo server pod(s) | `[]` | | `repoServer.initContainers` | Add additional init containers to the Argo CD repo server pod(s) | `[]` | - ### Dex Parameters | Name | Description | Value | @@ -677,7 +670,6 @@ The command removes all the Kubernetes components associated with the chart and | `dex.sidecars` | Add additional sidecar containers to the Dex pod(s) | `[]` | | `dex.initContainers` | Add additional init containers to the Dex pod(s) | `[]` | - ### Shared config for Argo CD components | Name | Description | Value | @@ -704,7 +696,6 @@ The command removes all the Kubernetes components associated with the chart and | `config.secret.repositoryCredentials` | Repository credentials to add to the Argo CD server confgi secret | `{}` | | `config.clusterCredentials` | Configure external cluster credentials | `[]` | - ### Init Container Parameters | Name | Description | Value | @@ -720,7 +711,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the init container | `{}` | | `volumePermissions.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` | - ### Other Parameters | Name | Description | Value | @@ -748,12 +738,10 @@ The command removes all the Kubernetes components associated with the chart and | `redisWait.extraArgs` | Additional arguments for the redis-cli call, such as TLS | `""` | | `redisWait.securityContext` | Security context for init container | `{}` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set controller.replicaCount=2 \ --set server.metrics.enabled=true \ my-repo/argo-cd diff --git a/bitnami/argo-workflows/README.md b/bitnami/argo-workflows/README.md index 34a6d8c4c5..ca9548e6ce 100644 --- a/bitnami/argo-workflows/README.md +++ b/bitnami/argo-workflows/README.md @@ -61,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `rbac.singleNamespace` | Restrict Argo to only deploy into a single namespace by apply Roles and RoleBindings instead of the Cluster equivalents, and start argo-cli with the --namespaced flag. Use it in clusters with strict access policy. | `false` | | `createAggregateRoles` | Create Aggregated cluster roles | `true` | - ### Argo Workflows Server configuration parameters | Name | Description | Value | @@ -180,7 +178,6 @@ The command removes all the Kubernetes components associated with the chart and | `server.service.annotations` | Additional custom annotations for server service | `{}` | | `server.service.extraPorts` | Extra port to expose on the server service | `[]` | - ### Argo Workflows Controller configuration parameters | Name | Description | Value | @@ -287,7 +284,6 @@ The command removes all the Kubernetes components associated with the chart and | `controller.service.annotations` | Additional custom annotations for controller service | `{}` | | `controller.service.extraPorts` | Extra port to expose on the controller service | `[]` | - ### Executor configuration section | Name | Description | Value | @@ -305,7 +301,6 @@ The command removes all the Kubernetes components associated with the chart and | `executor.containerSecurityContext.fsGroup` | Set executor pod's Security Context fsGroup | `1001` | | `executor.containerSecurityContext.readOnlyRootFilesystem` | Set read only root file system pod's Security Context | `true` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -325,7 +320,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Workflows configuration | Name | Description | Value | @@ -336,7 +330,6 @@ The command removes all the Kubernetes components associated with the chart and | `workflows.serviceAccount.annotations` | Annotations for service account. Evaluated as a template. Only used if `create` is `true`. | `{}` | | `workflows.rbac.create` | Whether to create RBAC resource to run workflows | `true` | - ### PostgreSQL subchart | Name | Description | Value | @@ -347,7 +340,6 @@ The command removes all the Kubernetes components associated with the chart and | `postgresql.auth.database` | PortgreSQL database name | `bn_argo_workflows` | | `postgresql.auth.password` | PortgreSQL database password | `""` | - ### MySQL subchart | Name | Description | Value | @@ -358,7 +350,6 @@ The command removes all the Kubernetes components associated with the chart and | `mysql.auth.database` | MySQL database name | `bn_argo_workflows` | | `mysql.auth.password` | MySQL database password | `""` | - ### External Database configuration | Name | Description | Value | @@ -372,14 +363,12 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.existingSecret` | The name of an existing secret with database credentials | `""` | | `externalDatabase.type` | Either postgresql or mysql | `""` | - - The above parameters map to the env variables defined in [bitnami/argo-workflow-cli](https://github.com/bitnami/containers/tree/main/bitnami/argo-workflow-cli). For more information please refer to the [bitnami/argo-workflow-cli](https://github.com/bitnami/containers/tree/main/bitnami/argo-workflow-cli) image documentation. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set argo-workflowsUsername=admin \ --set argo-workflowsPassword=password \ --set mysql.auth.rootPassword=secretpassword \ diff --git a/bitnami/aspnet-core/README.md b/bitnami/aspnet-core/README.md index 0b8e0260b0..67cd0de6e9 100644 --- a/bitnami/aspnet-core/README.md +++ b/bitnami/aspnet-core/README.md @@ -61,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -75,7 +74,6 @@ The command removes all the Kubernetes components associated with the chart and | `clusterDomain` | Kubernetes cluster domain name | `cluster.local` | | `extraDeploy` | Array of extra objects to deploy with the release | `[]` | - ### ASP.NET Core parameters | Name | Description | Value | @@ -94,7 +92,6 @@ The command removes all the Kubernetes components associated with the chart and | `extraEnvVarsCM` | ConfigMap with extra environment variables | `""` | | `extraEnvVarsSecret` | Secret with extra environment variables | `""` | - ### ASP.NET Core deployment parameters | Name | Description | Value | @@ -159,7 +156,6 @@ The command removes all the Kubernetes components associated with the chart and | `autoscaling.targetCPU` | Target CPU utilization percentage | `""` | | `autoscaling.targetMemory` | Target Memory utilization percentage | `""` | - ### Custom ASP.NET Core application parameters | Name | Description | Value | @@ -186,7 +182,6 @@ The command removes all the Kubernetes components associated with the chart and | `appFromExistingPVC.enabled` | Enable mounting your ASP.NET Core app from an existing PVC | `false` | | `appFromExistingPVC.existingClaim` | A existing Persistent Volume Claim containing your ASP.NET Core app | `""` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -228,7 +223,6 @@ The command removes all the Kubernetes components associated with the chart and | `healthIngress.secrets` | Custom TLS certificates as secrets | `[]` | | `healthIngress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### RBAC parameters | Name | Description | Value | @@ -238,8 +232,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | | `serviceAccount.automountServiceAccountToken` | Automount service account token | `true` | - - ```console helm install my-release --set replicaCount=2 my-repo/aspnet-core ``` @@ -468,4 +460,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/cassandra/README.md b/bitnami/cassandra/README.md index 3018f6bb16..1fa109ba51 100644 --- a/bitnami/cassandra/README.md +++ b/bitnami/cassandra/README.md @@ -60,7 +60,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### Cassandra parameters | Name | Description | Value | @@ -114,7 +112,6 @@ The command removes all the Kubernetes components associated with the chart and | `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars | `""` | | `extraEnvVarsSecret` | Name of existing Secret containing extra env vars | `""` | - ### Statefulset parameters | Name | Description | Value | @@ -183,7 +180,6 @@ The command removes all the Kubernetes components associated with the chart and | `hostPorts.jmx` | JMX Port on the Host | `""` | | `hostPorts.cql` | CQL Port on the Host | `""` | - ### RBAC parameters | Name | Description | Value | @@ -193,7 +189,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.annotations` | Annotations for Cassandra Service Account | `{}` | | `serviceAccount.automountServiceAccountToken` | Automount API credentials for a service account. | `true` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -214,7 +209,6 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.enabled` | Specifies whether a NetworkPolicy should be created | `false` | | `networkPolicy.allowExternal` | Don't require client label for connections | `true` | - ### Persistence parameters | Name | Description | Value | @@ -229,7 +223,6 @@ The command removes all the Kubernetes components associated with the chart and | `persistence.mountPath` | The path the data volume will be mounted at | `/bitnami/cassandra` | | `persistence.commitLogMountPath` | The path the commit log volume will be mounted at. Unset by default. Set it to '/bitnami/cassandra/commitlog' to enable a separate commit log volume | `""` | - ### Volume Permissions parameters | Name | Description | Value | @@ -245,7 +238,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the container | `{}` | | `volumePermissions.securityContext.runAsUser` | User ID for the init container | `0` | - ### Metrics parameters | Name | Description | Value | @@ -282,7 +274,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.hostPorts.jmx` | JMX Port on the Host | `""` | | `metrics.configuration` | Configure Cassandra-exporter with a custom config.yml file | `""` | - ### TLS/SSL parameters | Name | Description | Value | @@ -299,12 +290,10 @@ The command removes all the Kubernetes components associated with the chart and | `tls.certificatesSecret` | Secret with the TLS certificates. | `""` | | `tls.tlsEncryptionSecretName` | Secret with the encryption of the TLS certificates | `""` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set dbUser.user=admin,dbUser.password=password \ my-repo/cassandra ``` diff --git a/bitnami/cert-manager/README.md b/bitnami/cert-manager/README.md index 496505ce8d..fdf33d6795 100644 --- a/bitnami/cert-manager/README.md +++ b/bitnami/cert-manager/README.md @@ -60,7 +60,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -77,7 +76,6 @@ The command removes all the Kubernetes components associated with the chart and | `installCRDs` | Flag to install cert-manager CRDs | `false` | | `replicaCount` | Number of cert-manager replicas | `1` | - ### Controller deployment parameters | Name | Description | Value | @@ -140,7 +138,6 @@ The command removes all the Kubernetes components associated with the chart and | `controller.serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | | `controller.serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | - ### Webhook deployment parameters | Name | Description | Value | @@ -213,7 +210,6 @@ The command removes all the Kubernetes components associated with the chart and | `webhook.serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | | `webhook.hostNetwork` | Specifies hostNetwork value | `false` | - ### CAInjector deployment parameters | Name | Description | Value | @@ -266,7 +262,6 @@ The command removes all the Kubernetes components associated with the chart and | `cainjector.serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | | `cainjector.serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | - ### Metrics Parameters | Name | Description | Value | @@ -287,17 +282,14 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.serviceMonitor.additionalLabels` | DEPRECATED. Use metrics.serviceMonitor.labels instead. | `{}` | | `metrics.serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions with target labels | `false` | - ### Other Parameters | Name | Description | Value | | ------------- | -------------------------------------------------- | ------ | | `rbac.create` | Specifies whether RBAC resources should be created | `true` | - - ```console -$ helm install my-release my-repo/cert-manager \ +helm install my-release my-repo/cert-manager \ --set installCRDs=true ``` diff --git a/bitnami/clickhouse/README.md b/bitnami/clickhouse/README.md index d9cd77e5ea..ea55e35e26 100644 --- a/bitnami/clickhouse/README.md +++ b/bitnami/clickhouse/README.md @@ -69,7 +69,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -86,7 +85,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### ClickHouse Parameters | Name | Description | Value | @@ -148,7 +146,6 @@ The command removes all the Kubernetes components associated with the chart and | `auth.existingSecretKey` | Name of the key inside the existing secret | `""` | | `logLevel` | Logging level | `information` | - ### ClickHouse keeper configuration parameters | Name | Description | Value | @@ -197,7 +194,6 @@ The command removes all the Kubernetes components associated with the chart and | `tls.certKeyFilename` | Certificate key filename | `""` | | `tls.certCAFilename` | CA Certificate filename | `""` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -278,7 +274,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Persistence Parameters | Name | Description | Value | @@ -291,7 +286,6 @@ The command removes all the Kubernetes components associated with the chart and | `persistence.selector` | Selector to match an existing Persistent Volume for WordPress data PVC | `{}` | | `persistence.dataSource` | Custom PVC data source | `{}` | - ### Init Container Parameters | Name | Description | Value | @@ -306,7 +300,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the init container | `{}` | | `volumePermissions.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` | - ### Other Parameters | Name | Description | Value | @@ -329,7 +322,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.serviceMonitor.relabelings` | Specify general relabeling | `[]` | | `metrics.serviceMonitor.selector` | Prometheus instance selector labels | `{}` | - ### External Zookeeper paramaters | Name | Description | Value | @@ -337,7 +329,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalZookeeper.servers` | List of external zookeeper servers to use | `[]` | | `externalZookeeper.port` | Port of the Zookeeper servers | `2888` | - ### Zookeeper subchart parameters | Name | Description | Value | @@ -346,14 +337,12 @@ The command removes all the Kubernetes components associated with the chart and | `zookeeper.replicaCount` | Number of Zookeeper instances | `3` | | `zookeeper.service.ports.client` | Zookeeper client port | `2181` | - - The above parameters map to the env variables defined in [bitnami/clickhouse](https://github.com/bitnami/containers/tree/main/bitnami/clickhouse). For more information please refer to the [bitnami/clickhouse](https://github.com/bitnami/containers/tree/main/bitnami/clickhouse) image documentation. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.username=admin \ --set auth.password=password \ my-repo/clickhouse diff --git a/bitnami/common/README.md b/bitnami/common/README.md index 5ffbe3b3ae..825639f2ad 100644 --- a/bitnami/common/README.md +++ b/bitnami/common/README.md @@ -182,7 +182,7 @@ keyMapping: If we force those values to be empty we will see some alerts ```console -$ helm install test mychart --set path.to.value00="",path.to.value01="" +helm install test mychart --set path.to.value00="",path.to.value01="" 'path.to.value00' must not be empty, please add '--set path.to.value00=$PASSWORD_00' to the command. To get the current value: export PASSWORD_00=$(kubectl get secret --namespace default secretName -o jsonpath="{.data.password-00}" | base64 -d) diff --git a/bitnami/concourse/README.md b/bitnami/concourse/README.md index c801b70bbb..73ebe926fa 100644 --- a/bitnami/concourse/README.md +++ b/bitnami/concourse/README.md @@ -61,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -77,7 +76,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment(s)/statefulset(s) | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment(s)/statefulset(s) | `["infinity"]` | - ### Common Concourse Parameters | Name | Description | Value | @@ -103,7 +101,6 @@ The command removes all the Kubernetes components associated with the chart and | `secrets.workerKeyPub` | Concourse Worker Keys. | `""` | | `secrets.workerAdditionalCerts` | Additional certificates to add to the worker nodes | `""` | - ### Concourse Web parameters | Name | Description | Value | @@ -205,7 +202,6 @@ The command removes all the Kubernetes components associated with the chart and | `web.serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount created | `true` | | `web.serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | - ### Concourse Worker parameters | Name | Description | Value | @@ -310,7 +306,6 @@ The command removes all the Kubernetes components associated with the chart and | `worker.serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount created | `true` | | `worker.serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | - ### Traffic exposure parameters | Name | Description | Value | @@ -354,7 +349,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Init Container Parameters | Name | Description | Value | @@ -371,7 +365,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.containerSecurityContext.enabled` | Enabled init container Security Context | `true` | | `volumePermissions.containerSecurityContext.runAsUser` | User ID for the init container | `0` | - ### Concourse database parameters | Name | Description | Value | @@ -384,7 +377,6 @@ The command removes all the Kubernetes components associated with the chart and | `postgresql.auth.existingSecret` | Name of existing secret to use for PostgreSQL credentials | `""` | | `postgresql.architecture` | PostgreSQL architecture (`standalone` or `replication`) | `standalone` | - ### External PostgreSQL configuration | Name | Description | Value | @@ -397,14 +389,12 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.existingSecret` | Name of an existing secret resource containing the database credentials | `""` | | `externalDatabase.existingSecretPasswordKey` | Name of an existing secret key containing the database credentials | `""` | - - The above parameters map to the env variables defined in [bitnami/concourse](https://github.com/bitnami/containers/tree/main/bitnami/concourse). For more information please refer to the [bitnami/concourse](https://github.com/bitnami/containers/tree/main/bitnami/concourse) image documentation. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set secrets.localUsers=admin:password \ my-repo/concourse ``` diff --git a/bitnami/consul/README.md b/bitnami/consul/README.md index f8958373cd..d21030d008 100644 --- a/bitnami/consul/README.md +++ b/bitnami/consul/README.md @@ -64,7 +64,6 @@ helm delete --purge my-release | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -80,7 +79,6 @@ helm delete --purge my-release | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### HashiCorp Consul parameters | Name | Description | Value | @@ -119,7 +117,6 @@ helm delete --purge my-release | `containerPorts.serfLAN` | Port to open for Serf LAN in Consul | `8301` | | `lifecycleHooks` | Add lifecycle hooks to the deployment | `{}` | - ### Statefulset parameters | Name | Description | Value | @@ -173,7 +170,6 @@ helm delete --purge my-release | `pdb.minAvailable` | Minimum number of pods that must still be available after the eviction | `1` | | `pdb.maxUnavailable` | Max number of pods that can be unavailable after the eviction | `""` | - ### Exposure parameters | Name | Description | Value | @@ -206,7 +202,6 @@ helm delete --purge my-release | `ingress.existingSecret` | It is you own the certificate as secret. | `""` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Persistence parameters | Name | Description | Value | @@ -217,7 +212,6 @@ helm delete --purge my-release | `persistence.accessModes` | Persistent Volume Access Mode | `["ReadWriteOnce"]` | | `persistence.size` | PVC Storage Request for HashiCorp Consul data volume | `8Gi` | - ### Volume Permissions parameters | Name | Description | Value | @@ -232,7 +226,6 @@ helm delete --purge my-release | `volumePermissions.resources.limits` | The resources limits for the container | `{}` | | `volumePermissions.resources.requests` | The requested resources for the container | `{}` | - ### Metrics parameters | Name | Description | Value | @@ -264,8 +257,6 @@ helm delete --purge my-release | `metrics.serviceMonitor.selector` | ServiceMonitor selector labels | `{}` | | `metrics.serviceMonitor.labels` | Used to pass Labels that are used by the Prometheus installed in your cluster to select Service Monitors to work with | `{}` | - - ```console helm install my-release --set domain=consul-domain,gossipKey=secretkey my-repo/consul ``` diff --git a/bitnami/contour-operator/README.md b/bitnami/contour-operator/README.md index a20dd30392..5262f95361 100644 --- a/bitnami/contour-operator/README.md +++ b/bitnami/contour-operator/README.md @@ -137,7 +137,6 @@ This solution allows to easily deploy multiple Contour instances compared to the | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -149,7 +148,6 @@ This solution allows to easily deploy multiple Contour instances compared to the | `commonAnnotations` | Annotations to add to all deployed objects | `{}` | | `extraDeploy` | Array of extra objects to deploy with the release | `[]` | - ### Contour Operator Parameters | Name | Description | Value | @@ -229,7 +227,6 @@ This solution allows to easily deploy multiple Contour instances compared to the | `sidecars` | Add additional sidecar containers to the Contour Operator pod(s) | `[]` | | `initContainers` | Add additional init containers to the Contour Operator pod(s) | `[]` | - ### Other Parameters | Name | Description | Value | @@ -240,7 +237,6 @@ This solution allows to easily deploy multiple Contour instances compared to the | `serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | | `serviceAccount.annotations` | Annotations for service account. Evaluated as a template. Only used if `create` is `true`. | `{}` | - ### Metrics parameters | Name | Description | Value | @@ -265,12 +261,10 @@ This solution allows to easily deploy multiple Contour instances compared to the | `metrics.serviceMonitor.relabelings` | Specify general relabeling | `[]` | | `metrics.serviceMonitor.selector` | Prometheus instance selector labels | `[]` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set livenessProbe.enabled=false \ my-repo/contour-operator ``` diff --git a/bitnami/contour/README.md b/bitnami/contour/README.md index ce854a1f22..2edde0f2c1 100644 --- a/bitnami/contour/README.md +++ b/bitnami/contour/README.md @@ -66,7 +66,6 @@ helm uninstall my-release | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -82,7 +81,6 @@ helm uninstall my-release | `diagnosticMode.command` | Command to override all containers in the deployment | `[]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `[]` | - ### Contour parameters | Name | Description | Value | @@ -189,7 +187,6 @@ helm uninstall my-release | `contour.kubernetesDebug` | Contour kubernetes debug log level, Default 0, minimum 0, maximum 9. | `0` | | `contour.rootNamespaces` | Restrict Contour to searching these namespaces for root ingress routes. | `""` | - ### Envoy parameters | Name | Description | Value | @@ -305,7 +302,6 @@ helm uninstall my-release | `envoy.extraEnvVarsCM` | ConfigMap containing extra env vars to be added to all Envoy containers | `""` | | `envoy.extraEnvVarsSecret` | Secret containing extra env vars to be added to all Envoy containers | `""` | - ### Default backend parameters | Name | Description | Value | @@ -399,7 +395,6 @@ helm uninstall my-release | `ingress.secrets` | If you're providing your own certificates, please use this to add the certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Metrics parameters | Name | Description | Value | @@ -415,7 +410,6 @@ helm uninstall my-release | `metrics.serviceMonitor.selector` | Specify honorLabels parameter to add the scrape endpoint | `{}` | | `metrics.serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` | - ### Other parameters | Name | Description | Value | @@ -424,10 +418,8 @@ helm uninstall my-release | `rbac.rules` | Custom RBAC rules to set | `[]` | | `tlsExistingSecret` | Name of the existingSecret to be use in both contour and envoy. If it is not nil `contour.certgen` will be disabled. | `""` | - - ```console -$ helm install my-release \ +helm install my-release \ --set envoy.readinessProbe.successThreshold=5 \ my-repo/contour ``` @@ -584,7 +576,7 @@ This version bumps the Envoy container from 1.17.X to 1.19.X; this Envoy version In this version it was synchronized CRD with the official [Contour repository](https://github.com/projectcontour/contour/blob/main/examples/render/contour.yaml) -#### Considerations when upgrading to this version +#### Considerations when upgrading to 5.0.0 If you are installing a fresh chart, you can ignore this section. @@ -594,12 +586,12 @@ If you are upgrading from 4.x of this Helm chart, this is a breaking change as t The 4.0 version of this chart introduces changes to handle Contour CRD upgrades. While Helm 3.x introduced the `crd` folder to place CRDs, Helm explicitly does not handle the [CRD upgrade scenario](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#some-caveats-and-explanations). -#### What changes were introduced in this major version? +#### What changes were introduced in 4.0.0? - The `resources` directory was added that contains all the Contour CRDs, which are imported by the `templates/00-crds.yaml` manifest on installation and upgrade. - If you do not wish for this chart to manage Contour CRDs, set the flag `contour.manageCRDs` to `false` when running Helm. -#### Considerations when upgrading to this version +#### Considerations when upgrading to 4.0.0 If you are installing a fresh chart, or if you are upgrading from a 4.x version of this chart, you can ignore this section. @@ -635,14 +627,14 @@ kubectl apply -f backup.yaml [On November 13, 2020, Helm v2 support was formally finished](https://github.com/helm/charts#status-of-the-project), this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL. -#### What changes were introduced in this major version? +#### What changes were introduced in 3.0.0? - Previous versions of this Helm Chart use `apiVersion: v1` (installable by both Helm 2 and 3), this Helm Chart was updated to `apiVersion: v2` (installable by Helm 3 only). [Here](https://helm.sh/docs/topics/charts/#the-apiversion-field) you can find more information about the `apiVersion` field. - Move dependency information from the *requirements.yaml* to the *Chart.yaml* - After running `helm dependency update`, a *Chart.lock* file is generated containing the same structure used in the previous *requirements.lock* - The different fields present in the *Chart.yaml* file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts -#### Considerations when upgrading to this version +#### Considerations when upgrading to 3.0.0 - If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues - If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore diff --git a/bitnami/discourse/README.md b/bitnami/discourse/README.md index 258308d188..131bb18c64 100644 --- a/bitnami/discourse/README.md +++ b/bitnami/discourse/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -79,7 +78,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the the deployment(s)/statefulset(s) | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the the deployment(s)/statefulset(s) | `["infinity"]` | - ### Discourse Common parameters | Name | Description | Value | @@ -130,7 +128,6 @@ The command removes all the Kubernetes components associated with the chart and | `extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for the Discourse pods | `[]` | | `extraVolumes` | Optionally specify extra list of additional volumes for the Discourse pods | `[]` | - ### Discourse container parameters | Name | Description | Value | @@ -179,7 +176,6 @@ The command removes all the Kubernetes components associated with the chart and | `persistence.selector` | Selector to match an existing Persistent Volume for Discourse data PVC | `{}` | | `persistence.annotations` | Persistent Volume Claim annotations | `{}` | - ### Sidekiq container parameters | Name | Description | Value | @@ -218,7 +214,6 @@ The command removes all the Kubernetes components associated with the chart and | `sidekiq.lifecycleHooks` | for the Sidekiq container(s) to automate configuration before or after startup | `{}` | | `sidekiq.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for the Sidekiq pods | `[]` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -249,7 +244,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Volume Permissions parameters | Name | Description | Value | @@ -265,7 +259,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | Init container volume-permissions resource requests | `{}` | | `volumePermissions.containerSecurityContext.runAsUser` | User ID for the init container | `0` | - ### Other Parameters | Name | Description | Value | @@ -275,7 +268,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount created | `true` | | `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | - ### NetworkPolicy parameters | Name | Description | Value | @@ -293,7 +285,6 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.egressRules.denyConnectionsToExternal` | Enable egress rule that denies outgoing traffic outside the cluster, except for DNS (port 53). | `false` | | `networkPolicy.egressRules.customRules` | Custom network policy rule | `{}` | - ### Discourse database parameters | Name | Description | Value | @@ -318,7 +309,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.existingSecretPasswordKey` | Name of an existing secret key containing the database credentials | `password` | | `externalDatabase.existingSecretPostgresPasswordKey` | Name of an existing secret key containing the database admin user credentials | `postgres-password` | - ### Redis® parameters | Name | Description | Value | @@ -334,12 +324,10 @@ The command removes all the Kubernetes components associated with the chart and | `externalRedis.existingSecret` | Name of an existing secret resource containing the Redis&trade credentials | `""` | | `externalRedis.existingSecretPasswordKey` | Name of an existing secret key containing the Redis&trade credentials | `redis-password` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.username=admin,auth.password=password \ my-repo/discourse ``` @@ -372,35 +360,35 @@ By default, this Chart only deploys a single pod running Discourse. Should you w 1. Create a conventional release, that will be scaled later: -```console -$ helm install my-release my-repo/discourse -... -``` + ```console + helm install my-release my-repo/discourse + ... + ``` -1. Wait for the release to complete and Discourse to be running successfully. +2. Wait for the release to complete and Discourse to be running successfully. -```console -$ kubectl get pods -NAME READY STATUS RESTARTS AGE -my-release-discourse-744c48dd97-wx5h9 2/2 Running 0 5m11s -my-release-postgresql-0 1/1 Running 0 5m10s -my-release-redis-master-0 1/1 Running 0 5m11s -``` + ```console + $ kubectl get pods + NAME READY STATUS RESTARTS AGE + my-release-discourse-744c48dd97-wx5h9 2/2 Running 0 5m11s + my-release-postgresql-0 1/1 Running 0 5m10s + my-release-redis-master-0 1/1 Running 0 5m11s + ``` -1. Perform an upgrade specifying the number of replicas and the credentials used. +3. Perform an upgrade specifying the number of replicas and the credentials used. -```console -helm upgrade my-release --set replicaCount=2,discourse.skipInstall=true my-repo/discourse -``` + ```console + helm upgrade my-release --set replicaCount=2,discourse.skipInstall=true my-repo/discourse + ``` -Note that for this to work properly, you need to provide ReadWriteMany PVCs. If you don't have a provisioner for this type of storage, we recommend that you install the NFS provisioner chart (with the correct parameters, such as `persistence.enabled=true` and `persistence.size=10Gi`) and map it to a RWO volume. + Note that for this to work properly, you need to provide ReadWriteMany PVCs. If you don't have a provisioner for this type of storage, we recommend that you install the NFS provisioner chart (with the correct parameters, such as `persistence.enabled=true` and `persistence.size=10Gi`) and map it to a RWO volume. -Then you can deploy Discourse chart using the proper parameters: + Then you can deploy Discourse chart using the proper parameters: -```console -persistence.storageClass=nfs -postgresql.primary.persistence.storageClass=nfs -``` + ```console + persistence.storageClass=nfs + postgresql.primary.persistence.storageClass=nfs + ``` ### Sidecars diff --git a/bitnami/dokuwiki/README.md b/bitnami/dokuwiki/README.md index 9596d74d6d..583970c527 100644 --- a/bitnami/dokuwiki/README.md +++ b/bitnami/dokuwiki/README.md @@ -61,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -74,7 +73,6 @@ The command removes all the Kubernetes components associated with the chart and | `commonLabels` | Labels to add to all deployed objects | `{}` | | `extraDeploy` | Array of extra objects to deploy with the release (evaluated as a template). | `[]` | - ### Dokuwiki parameters | Name | Description | Value | @@ -156,7 +154,6 @@ The command removes all the Kubernetes components associated with the chart and | `containerPorts.http` | Container HTTP port | `8080` | | `containerPorts.https` | Container HTTPS port | `8443` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -188,7 +185,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.selfSigned` | Create a TLS secret for this ingress record using self-signed certificates generated by Helm | `false` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Volume Permissions parameters | Name | Description | Value | @@ -203,7 +199,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.limits` | The resources limits for the container | `{}` | | `volumePermissions.resources.requests` | The requested resources for the container | `{}` | - ### Metrics parameters | Name | Description | Value | @@ -218,7 +213,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.podAnnotations` | Additional annotations for Metrics exporter pod | `{}` | | `metrics.resources` | Exporter resource requests/limit | `{}` | - ### Certificate injection parameters | Name | Description | Value | @@ -242,12 +236,10 @@ The command removes all the Kubernetes components associated with the chart and | `certificates.image.pullPolicy` | Container sidecar image pull policy | `IfNotPresent` | | `certificates.image.pullSecrets` | Container sidecar image pull secrets | `[]` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set dokuwikiUsername=admin,dokuwikiPassword=password \ my-repo/dokuwiki ``` @@ -301,7 +293,7 @@ certificates: - secret: my-ca-2 ``` -#### Secret +#### CA Certificates secret Secret can be created with: @@ -326,7 +318,7 @@ certificates: key: chain.pem ``` -#### Secret +#### TLS secret The certificate tls secret can be created with: diff --git a/bitnami/drupal/README.md b/bitnami/drupal/README.md index 4938dd34a7..13319ac7e0 100644 --- a/bitnami/drupal/README.md +++ b/bitnami/drupal/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `commonLabels` | Common labels to add to all Drupal resources (sub-charts are not considered). Evaluated as a template | `{}` | | `extraDeploy` | Array of extra objects to deploy with the release (evaluated as a template). | `[]` | - ### Drupal parameters | Name | Description | Value | @@ -171,7 +169,6 @@ The command removes all the Kubernetes components associated with the chart and | `podAnnotations` | Pod annotations | `{}` | | `podLabels` | Add additional labels to the pod (evaluated as a template) | `{}` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -202,7 +199,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | If you're providing your own certificates, please use this to add the certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Database parameters | Name | Description | Value | @@ -226,7 +222,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.database` | Name of the existing database | `bitnami_drupal` | | `externalDatabase.existingSecret` | Name of a secret with the database password. (externalDatabase.password will be ignored and picked up from this secret). The secret has to contain the key db-password | `""` | - ### Volume Permissions parameters | Name | Description | Value | @@ -241,7 +236,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.limits` | The resources limits for the container | `{}` | | `volumePermissions.resources.requests` | The requested resources for the container | `{}` | - ### Metrics parameters | Name | Description | Value | @@ -275,7 +269,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.prometheusRule.additionalLabels` | Additional labels for the prometheusRule | `{}` | | `metrics.prometheusRule.rules` | Custom Prometheus rules | `[]` | - ### Certificate injection parameters | Name | Description | Value | @@ -299,7 +292,6 @@ The command removes all the Kubernetes components associated with the chart and | `certificates.image.pullPolicy` | Container sidecar image pull policy | `IfNotPresent` | | `certificates.image.pullSecrets` | Container sidecar image pull secrets | `[]` | - ### NetworkPolicy parameters | Name | Description | Value | @@ -320,12 +312,10 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.egressRules.denyConnectionsToExternal` | Enable egress rule that denies outgoing traffic outside the cluster, except for DNS (port 53). | `false` | | `networkPolicy.egressRules.customRules` | Custom network policy rule | `{}` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set drupalUsername=admin,drupalPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/drupal ``` @@ -359,14 +349,14 @@ The `image` parameter allows specifying which image will be pulled for the chart If you configure the `image` value to one in a private registry, you will need to [specify an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). 1. Manually create image pull secret(s) in the namespace. See [this YAML example reference](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config). Consult your image registry's documentation about getting the appropriate secret. -1. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: +2. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: -```yaml -imagePullSecrets: - - name: SECRET_NAME -``` + ```yaml + imagePullSecrets: + - name: SECRET_NAME + ``` -1. Install the chart +3. Install the chart ### Setting Pod's affinity @@ -384,8 +374,8 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per ### Existing PersistentVolumeClaim 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/drupal @@ -401,14 +391,14 @@ helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/drupal #### Mounting steps 1. The specified `hostPath` directory must already exist (create one if it does not). -1. Install the chart +2. Install the chart ```console helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT my-repo/drupal ``` This will mount the `drupal-data` volume into the `hostPath` directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. -1. Because the container cannot control the host machine's directory permissions, you must set the Drupal file directory permissions yourself and disable or clear Drupal cache. See Drupal Core's [INSTALL.txt](http://cgit.drupalcode.org/drupal/tree/core/INSTALL.txt?h=8.3.x#n152) for setting file permissions, and see [Drupal handbook page](https://www.drupal.org/node/2598914) to disable the cache, or [Drush handbook](https://drushcommands.com/drush-8x/cache/cache-rebuild/) to clear cache. +3. Because the container cannot control the host machine's directory permissions, you must set the Drupal file directory permissions yourself and disable or clear Drupal cache. See Drupal Core's [INSTALL.txt](http://cgit.drupalcode.org/drupal/tree/core/INSTALL.txt?h=8.3.x#n152) for setting file permissions, and see [Drupal handbook page](https://www.drupal.org/node/2598914) to disable the cache, or [Drush handbook](https://drushcommands.com/drush-8x/cache/cache-rebuild/) to clear cache. ## Troubleshooting diff --git a/bitnami/ejbca/README.md b/bitnami/ejbca/README.md index 20ab031155..a3f784e00d 100644 --- a/bitnami/ejbca/README.md +++ b/bitnami/ejbca/README.md @@ -62,7 +62,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -78,7 +77,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### EJBCA parameters | Name | Description | Value | @@ -159,7 +157,6 @@ The command removes all the Kubernetes components associated with the chart and | `customReadinessProbe` | Custom readiness probe to execute (when the main one is disabled) | `{}` | | `containerPorts` | EJBCA Container ports to open | `{}` | - ### Service parameters | Name | Description | Value | @@ -179,7 +176,6 @@ The command removes all the Kubernetes components associated with the chart and | `service.sessionAffinity` | Session Affinity for Kubernetes service, can be "None" or "ClientIP" | `None` | | `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` | - ### Ingress parameters | Name | Description | Value | @@ -198,7 +194,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Database parameters | Name | Description | Value | @@ -222,7 +217,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.database` | Name of the existing database | `bitnami_ejbca` | | `externalDatabase.port` | Database port number | `3306` | - ### NetworkPolicy parameters | Name | Description | Value | @@ -240,12 +234,10 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.egressRules.denyConnectionsToExternal` | Enable egress rule that denies outgoing traffic outside the cluster, except for DNS (port 53). | `false` | | `networkPolicy.egressRules.customRules` | Custom network policy rule | `{}` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set ejbcaAdminUsername=admin,ejbcaAdminPassword=password,mariadb.auth.password=secretpassword \ my-repo/discourse ``` diff --git a/bitnami/elasticsearch/README.md b/bitnami/elasticsearch/README.md index 714bee77d9..64caf0ce5e 100644 --- a/bitnami/elasticsearch/README.md +++ b/bitnami/elasticsearch/README.md @@ -67,7 +67,6 @@ helm delete --purge my-release | `global.elasticsearch.service.ports.restAPI` | Elasticsearch service restAPI port to be used in the Kibana subchart (ignored if kibanaEnabled=false) | `9200` | | `global.kibanaEnabled` | Whether or not to enable Kibana | `false` | - ### Common parameters | Name | Description | Value | @@ -84,7 +83,6 @@ helm delete --purge my-release | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### Elasticsearch cluster Parameters | Name | Description | Value | @@ -137,7 +135,6 @@ helm delete --purge my-release | `security.tls.secretTruststoreKey` | Name of the secret key containing the Truststore password | `""` | | `security.tls.secretKey` | Name of the secret key containing the PEM key password | `""` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -170,7 +167,6 @@ helm delete --purge my-release | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Master-elegible nodes parameters | Name | Description | Value | @@ -255,7 +251,6 @@ helm delete --purge my-release | `master.autoscaling.targetCPU` | Define the CPU target to trigger the scaling actions (utilization percentage) | `""` | | `master.autoscaling.targetMemory` | Define the memory target to trigger the scaling actions (utilization percentage) | `""` | - ### Data-only nodes parameters | Name | Description | Value | @@ -339,7 +334,6 @@ helm delete --purge my-release | `data.autoscaling.targetCPU` | Define the CPU target to trigger the scaling actions (utilization percentage) | `""` | | `data.autoscaling.targetMemory` | Define the memory target to trigger the scaling actions (utilization percentage) | `""` | - ### Coordinating-only nodes parameters | Name | Description | Value | @@ -415,7 +409,6 @@ helm delete --purge my-release | `coordinating.autoscaling.targetCPU` | Define the CPU target to trigger the scaling actions (utilization percentage) | `""` | | `coordinating.autoscaling.targetMemory` | Define the memory target to trigger the scaling actions (utilization percentage) | `""` | - ### Ingest-only nodes parameters | Name | Description | Value | @@ -522,7 +515,6 @@ helm delete --purge my-release | `ingest.ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingest.ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Metrics parameters | Name | Description | Value | @@ -607,7 +599,6 @@ helm delete --purge my-release | `metrics.prometheusRule.additionalLabels` | Additional labels that can be used so PrometheusRule will be discovered by Prometheus | `{}` | | `metrics.prometheusRule.rules` | Prometheus Rule definitions | `[]` | - ### Init Container Parameters | Name | Description | Value | @@ -631,7 +622,6 @@ helm delete --purge my-release | `sysctlImage.resources.limits` | The resources limits for the container | `{}` | | `sysctlImage.resources.requests` | The requested resources for the container | `{}` | - ### Kibana Parameters | Name | Description | Value | @@ -639,10 +629,8 @@ helm delete --purge my-release | `kibana.elasticsearch.hosts` | Array containing hostnames for the ES instances. Used to generate the URL | `[]` | | `kibana.elasticsearch.port` | Port to connect Kibana and ES instance. Used to generate the URL | `{{ include "elasticsearch.service.ports.restAPI" . }}` | - - ```console -$ helm install my-release \ +helm install my-release \ --set name=my-elastic,client.service.port=8080 \ my-repo/elasticsearch ``` diff --git a/bitnami/etcd/README.md b/bitnami/etcd/README.md index b0e078c79e..d0f7227b11 100644 --- a/bitnami/etcd/README.md +++ b/bitnami/etcd/README.md @@ -60,7 +60,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### etcd parameters | Name | Description | Value | @@ -127,7 +125,6 @@ The command removes all the Kubernetes components associated with the chart and | `command` | Default container command (useful when using custom images) | `[]` | | `args` | Default container args (useful when using custom images) | `[]` | - ### etcd statefulset parameters | Name | Description | Value | @@ -192,7 +189,6 @@ The command removes all the Kubernetes components associated with the chart and | `persistentVolumeClaimRetentionPolicy.whenScaled` | Volume retention behavior when the replica count of the StatefulSet is reduced | `Retain` | | `persistentVolumeClaimRetentionPolicy.whenDeleted` | Volume retention behavior that applies when the StatefulSet is deleted | `Retain` | - ### Traffic exposure parameters | Name | Description | Value | @@ -215,7 +211,6 @@ The command removes all the Kubernetes components associated with the chart and | `service.sessionAffinity` | Session Affinity for Kubernetes service, can be "None" or "ClientIP" | `None` | | `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` | - ### Persistence parameters | Name | Description | Value | @@ -227,7 +222,6 @@ The command removes all the Kubernetes components associated with the chart and | `persistence.size` | PVC Storage Request for etcd data volume | `8Gi` | | `persistence.selector` | Selector to match an existing Persistent Volume | `{}` | - ### Volume Permissions parameters | Name | Description | Value | @@ -242,7 +236,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.limits` | Init container volume-permissions resource limits | `{}` | | `volumePermissions.resources.requests` | Init container volume-permissions resource requests | `{}` | - ### Network Policy parameters | Name | Description | Value | @@ -254,7 +247,6 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.ingressNSMatchLabels` | Labels to match to allow traffic from other namespaces | `{}` | | `networkPolicy.ingressNSPodMatchLabels` | Pod labels to match to allow traffic from other namespaces | `{}` | - ### Metrics parameters | Name | Description | Value | @@ -274,7 +266,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.prometheusRule.additionalLabels` | Additional labels that can be used so PrometheusRule will be discovered by Prometheus | `{}` | | `metrics.prometheusRule.rules` | Prometheus Rule definitions | `[]` | - ### Snapshotting parameters | Name | Description | Value | @@ -295,7 +286,6 @@ The command removes all the Kubernetes components associated with the chart and | `disasterRecovery.pvc.size` | PVC Storage Request | `2Gi` | | `disasterRecovery.pvc.storageClassName` | Storage Class for snapshots volume | `nfs` | - ### Service account parameters | Name | Description | Value | @@ -306,7 +296,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.annotations` | Additional annotations to be included on the service account | `{}` | | `serviceAccount.labels` | Additional labels to be included on the service account | `{}` | - ### Other parameters | Name | Description | Value | @@ -315,10 +304,8 @@ The command removes all the Kubernetes components associated with the chart and | `pdb.minAvailable` | Minimum number/percentage of pods that should remain scheduled | `51%` | | `pdb.maxUnavailable` | Maximum number/percentage of pods that may be made unavailable | `""` | - - ```console -$ helm install my-release \ +helm install my-release \ --set auth.rbac.rootPassword=secretpassword my-repo/etcd ``` @@ -511,7 +498,7 @@ To upgrade from previous charts versions, create a snapshot of the keyspace and You can use the command below to upgrade your chart by starting a new cluster using an existing snapshot, available in an existing PVC, to initialize the members: ```console -$ helm install new-release my-repo/etcd \ +helm install new-release my-repo/etcd \ --set statefulset.replicaCount=3 \ --set persistence.enabled=true \ --set persistence.size=8Gi \ @@ -543,4 +530,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/external-dns/README.md b/bitnami/external-dns/README.md index 952502d900..3fa13d26b8 100755 --- a/bitnami/external-dns/README.md +++ b/bitnami/external-dns/README.md @@ -58,7 +58,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imageRegistry` | Global Docker image registry | `""` | | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | - ### Common parameters | Name | Description | Value | @@ -73,7 +72,6 @@ The command removes all the Kubernetes components associated with the chart and | `watchReleaseNamespace` | Watch only namepsace used for the release | `false` | | `useDaemonset` | Use ExternalDNS in Daemonset mode | `false` | - ### external-dns parameters | Name | Description | Value | @@ -211,7 +209,7 @@ The command removes all the Kubernetes components associated with the chart and | `rfc2136.tsigSecretAlg` | When using the rfc2136 provider, specify the tsig secret to enable security (optional) | `hmac-sha256` | | `rfc2136.tsigKeyname` | When using the rfc2136 provider, specify the tsig keyname to enable security (optional) | `externaldns-key` | | `rfc2136.tsigAxfr` | When using the rfc2136 provider, enable AFXR to enable security (optional) | `true` | -| `rfc2136.minTTL` | When using the rfc2136 provider, specify minimal TTL (in duration format) for records[ns, us, ms, s, m, h], see more https://golang.org/pkg/time/#ParseDuration | `0s` | +| `rfc2136.minTTL` | When using the rfc2136 provider, specify minimal TTL (in duration format) for records[ns, us, ms, s, m, h], see more | `0s` | | `rfc2136.rfc3645Enabled` | When using the rfc2136 provider, extend using RFC3645 to support secure updates over Kerberos with GSS-TSIG | `false` | | `rfc2136.kerberosConfig` | When using the rfc2136 provider with rfc3645Enabled, the contents of a configuration file for krb5 (optional) | `""` | | `rfc2136.kerberosUsername` | When using the rfc2136 provider with rfc3645Enabled, specify the username to authenticate with (optional) | `""` | @@ -338,10 +336,8 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.googlePodMonitor.interval` | Interval at which metrics should be scraped by Google Managed Prometheus | `60s` | | `metrics.googlePodMonitor.endpoint` | The endpoint for Google Managed Prometheus scraping the metrics | `/metrics` | - - ```console -$ helm install my-release \ +helm install my-release \ --set provider=aws my-repo/external-dns ``` @@ -391,7 +387,7 @@ For instance, to install ExternalDNS on AWS, you need to: > Note: replace the placeholder HOSTED_ZONE_IDENTIFIER and HOSTED_ZONE_NAME, with your hosted zoned identifier and name, respectively. ```console -$ helm install my-release \ +helm install my-release \ --set provider=aws \ --set aws.zoneType=public \ --set txtOwnerId=HOSTED_ZONE_IDENTIFIER \ diff --git a/bitnami/fluentd/README.md b/bitnami/fluentd/README.md index 0ccf349bff..692c547d17 100644 --- a/bitnami/fluentd/README.md +++ b/bitnami/fluentd/README.md @@ -62,7 +62,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -78,7 +77,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### Fluentd parameters | Name | Description | Value | @@ -330,10 +328,8 @@ The command removes all the Kubernetes components associated with the chart and | `tls.forwarder.existingSecret` | Name of the existing secret containing the TLS certificates for the Fluentd forwarder | `""` | | `tls.aggregator.existingSecret` | Name of the existing secret containing the TLS certificates for the Fluentd aggregator | `""` | - - ```console -$ helm install my-release \ +helm install my-release \ --set aggregator.port=24444 my-repo/fluentd ``` diff --git a/bitnami/ghost/README.md b/bitnami/ghost/README.md index c56acd8bc3..5283e198b4 100644 --- a/bitnami/ghost/README.md +++ b/bitnami/ghost/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `clusterDomain` | Kubernetes cluster domain name | `cluster.local` | | `extraDeploy` | Array of extra objects to deploy with the release | `[]` | - ### Ghost Image parameters | Name | Description | Value | @@ -89,7 +87,6 @@ The command removes all the Kubernetes components associated with the chart and | `image.pullSecrets` | Ghost image pull secrets | `[]` | | `image.debug` | Enable image debug mode | `false` | - ### Ghost Configuration parameters | Name | Description | Value | @@ -117,7 +114,6 @@ The command removes all the Kubernetes components associated with the chart and | `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars | `""` | | `extraEnvVarsSecret` | Name of existing Secret containing extra env vars | `""` | - ### Ghost deployment parameters | Name | Description | Value | @@ -173,7 +169,6 @@ The command removes all the Kubernetes components associated with the chart and | `customLivenessProbe` | Custom livenessProbe that overrides the default one | `{}` | | `customReadinessProbe` | Custom readinessProbe that overrides the default one | `{}` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -206,7 +201,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Persistence Parameters | Name | Description | Value | @@ -229,7 +223,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the init container | `{}` | | `volumePermissions.securityContext.runAsUser` | Set init container's Security Context runAsUser | `0` | - ### Database Parameters | Name | Description | Value | @@ -254,7 +247,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.ssl` | External Database ssl | `false` | | `externalDatabase.sslCaFile` | External Database ssl CA filepath | `""` | - ### NetworkPolicy parameters | Name | Description | Value | @@ -276,8 +268,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | | `serviceAccount.annotations` | Annotations for service account. Evaluated as a template. Only used if `create` is `true`. | `{}` | - - > **Note**: > > For the Ghost application function correctly, you should specify the `ghostHost` parameter to specify the FQDN (recommended) or the public IP address of the Ghost service. @@ -295,7 +285,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set ghostUsername=admin,ghostPassword=password,mysql.auth.rootPassword=secretpassword \ my-repo/ghost ``` diff --git a/bitnami/gitea/README.md b/bitnami/gitea/README.md index 1d32d671be..d8564114e3 100644 --- a/bitnami/gitea/README.md +++ b/bitnami/gitea/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `commonLabels` | Common labels to add to all Gitea resources (sub-charts are not considered). Evaluated as a template | `{}` | | `extraDeploy` | Array of extra objects to deploy with the release (evaluated as a template). | `[]` | - ### Gitea parameters | Name | Description | Value | @@ -170,7 +168,6 @@ The command removes all the Kubernetes components associated with the chart and | `podAnnotations` | Pod annotations | `{}` | | `podLabels` | Add additional labels to the pod (evaluated as a template) | `{}` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -202,7 +199,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | If you're providing your own certificates, please use this to add the certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Other Parameters | Name | Description | Value | @@ -212,7 +208,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount created | `true` | | `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | - ### Database parameters | Name | Description | Value | @@ -232,7 +227,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.existingSecret` | Name of an existing secret resource containing the database credentials | `""` | | `externalDatabase.existingSecretPasswordKey` | Name of an existing secret key containing the database credentials | `db-password` | - ### Volume Permissions parameters | Name | Description | Value | @@ -247,10 +241,8 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.limits` | The resources limits for the container | `{}` | | `volumePermissions.resources.requests` | The requested resources for the container | `{}` | - - ```console -$ helm install my-release \ +helm install my-release \ --set adminUsername=user,giteaPassword=password,postgresql.auth.rootPassword=secretpassword \ my-repo/gitea ``` @@ -284,14 +276,14 @@ The `image` parameter allows specifying which image will be pulled for the chart If you configure the `image` value to one in a private registry, you will need to [specify an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). 1. Manually create image pull secret(s) in the namespace. See [this YAML example reference](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config). Consult your image registry's documentation about getting the appropriate secret. -1. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: +2. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: -```yaml -imagePullSecrets: - - name: SECRET_NAME -``` + ```yaml + imagePullSecrets: + - name: SECRET_NAME + ``` -1. Install the chart +3. Install the chart ### Setting Pod's affinity @@ -309,8 +301,8 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per ### Existing PersistentVolumeClaim 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/gitea @@ -326,14 +318,14 @@ helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/gitea #### Mounting steps 1. The specified `hostPath` directory must already exist (create one if it does not). -1. Install the chart +2. Install the chart ```console helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT my-repo/gitea ``` This will mount the `gitea-data` volume into the `hostPath` directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. -1. Because the container cannot control the host machine's directory permissions, you must set the Gitea file directory permissions yourself +3. Because the container cannot control the host machine's directory permissions, you must set the Gitea file directory permissions yourself ## Troubleshooting diff --git a/bitnami/grafana-loki/README.md b/bitnami/grafana-loki/README.md index 020b385721..c1dfa7dffc 100644 --- a/bitnami/grafana-loki/README.md +++ b/bitnami/grafana-loki/README.md @@ -64,7 +64,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -80,7 +79,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployments/statefulsets | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployments/statefulsets | `["infinity"]` | - ### Common Grafana Loki Parameters | Name | Description | Value | @@ -101,7 +99,6 @@ The command removes all the Kubernetes components associated with the chart and | `loki.gossipRing.service.ports.http` | Gossip Ring HTTP headless service port | `7946` | | `loki.gossipRing.service.annotations` | Additional custom annotations for Gossip Ring headless service | `{}` | - ### Compactor Deployment Parameters | Name | Description | Value | @@ -171,7 +168,6 @@ The command removes all the Kubernetes components associated with the chart and | `compactor.persistence.selector` | Selector to match an existing Persistent Volume for Compactor's data PVC | `{}` | | `compactor.persistence.dataSource` | PVC data source | `{}` | - ### Compactor Traffic Exposure Parameters | Name | Description | Value | @@ -188,7 +184,6 @@ The command removes all the Kubernetes components associated with the chart and | `compactor.service.annotations` | Additional custom annotations for Compactor service | `{}` | | `compactor.service.extraPorts` | Extra ports to expose in the Compactor service | `[]` | - ### Gateway Deployment Parameters | Name | Description | Value | @@ -263,7 +258,6 @@ The command removes all the Kubernetes components associated with the chart and | `gateway.sidecars` | Add additional sidecar containers to the Gateway pod(s) | `[]` | | `gateway.initContainers` | Add additional init containers to the Gateway pod(s) | `[]` | - ### Gateway Traffic Exposure Parameters | Name | Description | Value | @@ -293,7 +287,6 @@ The command removes all the Kubernetes components associated with the chart and | `gateway.ingress.extraTls` | TLS configuration for additional hostname(s) to be covered with this ingress record | `[]` | | `gateway.ingress.secrets` | Custom TLS certificates as secrets | `[]` | - ### index-gateway Deployment Parameters | Name | Description | Value | @@ -356,7 +349,6 @@ The command removes all the Kubernetes components associated with the chart and | `indexGateway.sidecars` | Add additional sidecar containers to the index-gateway pod(s) | `[]` | | `indexGateway.initContainers` | Add additional init containers to the index-gateway pod(s) | `[]` | - ### index-gateway Traffic Exposure Parameters | Name | Description | Value | @@ -375,7 +367,6 @@ The command removes all the Kubernetes components associated with the chart and | `indexGateway.service.annotations` | Additional custom annotations for index-gateway service | `{}` | | `indexGateway.service.extraPorts` | Extra ports to expose in the index-gateway service | `[]` | - ### Distributor Deployment Parameters | Name | Description | Value | @@ -436,7 +427,6 @@ The command removes all the Kubernetes components associated with the chart and | `distributor.sidecars` | Add additional sidecar containers to the Distributor pod(s) | `[]` | | `distributor.initContainers` | Add additional init containers to the Distributor pod(s) | `[]` | - ### Distributor Traffic Exposure Parameters | Name | Description | Value | @@ -455,7 +445,6 @@ The command removes all the Kubernetes components associated with the chart and | `distributor.service.annotations` | Additional custom annotations for Distributor service | `{}` | | `distributor.service.extraPorts` | Extra ports to expose in the Distributor service | `[]` | - ### Ingester Deployment Parameters | Name | Description | Value | @@ -517,7 +506,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingester.sidecars` | Add additional sidecar containers to the Ingester pod(s) | `[]` | | `ingester.initContainers` | Add additional init containers to the Ingester pod(s) | `[]` | - ### Ingester Persistence Parameters | Name | Description | Value | @@ -530,7 +518,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingester.persistence.annotations` | Additional PVC annotations | `{}` | | `ingester.persistence.selector` | Selector to match an existing Persistent Volume for Ingester's data PVC | `{}` | - ### Ingester Traffic Exposure Parameters | Name | Description | Value | @@ -549,7 +536,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingester.service.annotations` | Additional custom annotations for Ingester service | `{}` | | `ingester.service.extraPorts` | Extra ports to expose in the Ingester service | `[]` | - ### Querier Deployment Parameters | Name | Description | Value | @@ -611,7 +597,6 @@ The command removes all the Kubernetes components associated with the chart and | `querier.sidecars` | Add additional sidecar containers to the Querier pod(s) | `[]` | | `querier.initContainers` | Add additional init containers to the Querier pod(s) | `[]` | - ### Querier Persistence Parameters | Name | Description | Value | @@ -624,7 +609,6 @@ The command removes all the Kubernetes components associated with the chart and | `querier.persistence.annotations` | Additional PVC annotations | `{}` | | `querier.persistence.selector` | Selector to match an existing Persistent Volume for Querier's data PVC | `{}` | - ### Querier Traffic Exposure Parameters | Name | Description | Value | @@ -643,7 +627,6 @@ The command removes all the Kubernetes components associated with the chart and | `querier.service.annotations` | Additional custom annotations for Querier service | `{}` | | `querier.service.extraPorts` | Extra ports to expose in the Querier service | `[]` | - ### Query Frontend Deployment Parameters | Name | Description | Value | @@ -704,7 +687,6 @@ The command removes all the Kubernetes components associated with the chart and | `queryFrontend.sidecars` | Add additional sidecar containers to the queryFrontend pod(s) | `[]` | | `queryFrontend.initContainers` | Add additional init containers to the queryFrontend pod(s) | `[]` | - ### Query Frontend Traffic Exposure Parameters | Name | Description | Value | @@ -723,7 +705,6 @@ The command removes all the Kubernetes components associated with the chart and | `queryFrontend.service.annotations` | Additional custom annotations for queryFrontend service | `{}` | | `queryFrontend.service.extraPorts` | Extra ports to expose in the queryFrontend service | `[]` | - ### Query Scheduler Deployment Parameters | Name | Description | Value | @@ -785,7 +766,6 @@ The command removes all the Kubernetes components associated with the chart and | `queryScheduler.sidecars` | Add additional sidecar containers to the queryScheduler pod(s) | `[]` | | `queryScheduler.initContainers` | Add additional init containers to the queryScheduler pod(s) | `[]` | - ### Query Scheduler Traffic Exposure Parameters | Name | Description | Value | @@ -804,7 +784,6 @@ The command removes all the Kubernetes components associated with the chart and | `queryScheduler.service.annotations` | Additional custom annotations for queryScheduler service | `{}` | | `queryScheduler.service.extraPorts` | Extra ports to expose in the queryScheduler service | `[]` | - ### Ruler Deployment Parameters | Name | Description | Value | @@ -867,7 +846,6 @@ The command removes all the Kubernetes components associated with the chart and | `ruler.sidecars` | Add additional sidecar containers to the Ruler pod(s) | `[]` | | `ruler.initContainers` | Add additional init containers to the Ruler pod(s) | `[]` | - ### Ruler Persistence Parameters | Name | Description | Value | @@ -880,7 +858,6 @@ The command removes all the Kubernetes components associated with the chart and | `ruler.persistence.annotations` | Additional PVC annotations | `{}` | | `ruler.persistence.selector` | Selector to match an existing Persistent Volume for Ruler's data PVC | `{}` | - ### Ruler Traffic Exposure Parameters | Name | Description | Value | @@ -899,7 +876,6 @@ The command removes all the Kubernetes components associated with the chart and | `ruler.service.annotations` | Additional custom annotations for Ruler service | `{}` | | `ruler.service.extraPorts` | Extra ports to expose in the Ruler service | `[]` | - ### table-manager Deployment Parameters | Name | Description | Value | @@ -961,7 +937,6 @@ The command removes all the Kubernetes components associated with the chart and | `tableManager.sidecars` | Add additional sidecar containers to the table-manager pod(s) | `[]` | | `tableManager.initContainers` | Add additional init containers to the table-manager pod(s) | `[]` | - ### table-manager Traffic Exposure Parameters | Name | Description | Value | @@ -980,7 +955,6 @@ The command removes all the Kubernetes components associated with the chart and | `tableManager.service.annotations` | Additional custom annotations for table-manager service | `{}` | | `tableManager.service.extraPorts` | Extra ports to expose in the table-manager service | `[]` | - ### Promtail Deployment Parameters | Name | Description | Value | @@ -1051,7 +1025,6 @@ The command removes all the Kubernetes components associated with the chart and | `promtail.existingSecret` | Name of a Secret that contains the Promtail configuration | `""` | | `promtail.logLevel` | Promtail logging level | `info` | - ### Promtail Traffic Exposure Parameters | Name | Description | Value | @@ -1073,7 +1046,6 @@ The command removes all the Kubernetes components associated with the chart and | `promtail.serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the promtail.serviceAccount.created | `true` | | `promtail.serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | - ### Init Container Parameters | Name | Description | Value | @@ -1089,7 +1061,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the init container | `{}` | | `volumePermissions.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` | - ### Other Parameters | Name | Description | Value | @@ -1099,7 +1070,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount created | `true` | | `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | - ### Metrics Parameters | Name | Description | Value | @@ -1116,7 +1086,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.serviceMonitor.honorLabels` | Specify honorLabels parameter to add the scrape endpoint | `false` | | `metrics.serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in prometheus. | `""` | - ### External Memcached (Chunks) Parameters | Name | Description | Value | @@ -1124,7 +1093,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalMemcachedChunks.host` | Host of a running external memcached instance | `""` | | `externalMemcachedChunks.port` | Port of a running external memcached instance | `11211` | - ### Memcached Sub-chart Parameters (Chunks) | Name | Description | Value | @@ -1138,7 +1106,6 @@ The command removes all the Kubernetes components associated with the chart and | `memcachedchunks.architecture` | Memcached architecture | `high-availability` | | `memcachedchunks.service.ports.memcached` | Memcached service port | `11211` | - ### External Memcached (Frontend) Parameters | Name | Description | Value | @@ -1146,7 +1113,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalMemcachedFrontend.host` | Host of a running external memcached instance | `""` | | `externalMemcachedFrontend.port` | Port of a running external memcached instance | `11211` | - ### Memcached Sub-chart Parameters (Frontend) | Name | Description | Value | @@ -1160,7 +1126,6 @@ The command removes all the Kubernetes components associated with the chart and | `memcachedfrontend.nameOverride` | override the subchart name | `""` | | `memcachedfrontend.service.ports.memcached` | Memcached service port | `11211` | - ### External Memcached (Index-Queries) Parameters | Name | Description | Value | @@ -1168,7 +1133,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalMemcachedIndexQueries.host` | Host of a running external memcached instance | `""` | | `externalMemcachedIndexQueries.port` | Port of a running external memcached instance | `11211` | - ### Memcached Sub-chart Parameters (Index-Queries) | Name | Description | Value | @@ -1182,7 +1146,6 @@ The command removes all the Kubernetes components associated with the chart and | `memcachedindexqueries.nameOverride` | override the subchart name | `""` | | `memcachedindexqueries.service.ports.memcached` | Memcached service port | `11211` | - ### External Memcached (IndexWrites) Parameters | Name | Description | Value | @@ -1190,7 +1153,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalMemcachedIndexWrites.host` | Host of a running external memcached instance | `""` | | `externalMemcachedIndexWrites.port` | Port of a running external memcached instance | `11211` | - ### Memcached Sub-chart Parameters (Index-Writes) | Name | Description | Value | @@ -1204,14 +1166,12 @@ The command removes all the Kubernetes components associated with the chart and | `memcachedindexwrites.nameOverride` | override the subchart name | `""` | | `memcachedindexwrites.service.ports.memcached` | Memcached service port | `11211` | - - The above parameters map to the env variables defined in [bitnami/grafana-loki](https://github.com/bitnami/containers/tree/main/bitnami/grafana-loki). For more information please refer to the [bitnami/grafana-loki](https://github.com/bitnami/containers/tree/main/bitnami/grafana-loki) image documentation. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set loki.traces.jaeger.grpc=true \ my-repo/grafana-loki ``` diff --git a/bitnami/grafana-operator/README.md b/bitnami/grafana-operator/README.md index b2dd3fa98e..fd4128853f 100644 --- a/bitnami/grafana-operator/README.md +++ b/bitnami/grafana-operator/README.md @@ -272,7 +272,7 @@ For more information, refer to the [documentation on the differences between the Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set livenessProbe.successThreshold=5 \ my-repo/grafana-operator ``` diff --git a/bitnami/grafana-tempo/README.md b/bitnami/grafana-tempo/README.md index 4dfdd8d0be..a34aa1020a 100644 --- a/bitnami/grafana-tempo/README.md +++ b/bitnami/grafana-tempo/README.md @@ -64,7 +64,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -80,7 +79,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployments/statefulsets | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployments/statefulsets | `["infinity"]` | - ### Common Grafana Tempo Parameters | Name | Description | Value | @@ -112,7 +110,6 @@ The command removes all the Kubernetes components associated with the chart and | `tempo.gossipRing.service.ports.http` | Gossip Ring HTTP headless service port | `7946` | | `tempo.gossipRing.service.annotations` | Additional custom annotations for Gossip Ring headless service | `{}` | - ### Compactor Deployment Parameters | Name | Description | Value | @@ -174,7 +171,6 @@ The command removes all the Kubernetes components associated with the chart and | `compactor.sidecars` | Add additional sidecar containers to the Compactor pod(s) | `[]` | | `compactor.initContainers` | Add additional init containers to the Compactor pod(s) | `[]` | - ### Compactor Traffic Exposure Parameters | Name | Description | Value | @@ -191,7 +187,6 @@ The command removes all the Kubernetes components associated with the chart and | `compactor.service.annotations` | Additional custom annotations for Compactor service | `{}` | | `compactor.service.extraPorts` | Extra ports to expose in the Compactor service | `[]` | - ### Distributor Deployment Parameters | Name | Description | Value | @@ -252,7 +247,6 @@ The command removes all the Kubernetes components associated with the chart and | `distributor.sidecars` | Add additional sidecar containers to the Distributor pod(s) | `[]` | | `distributor.initContainers` | Add additional init containers to the Distributor pod(s) | `[]` | - ### Distributor Traffic Exposure Parameters | Name | Description | Value | @@ -271,7 +265,6 @@ The command removes all the Kubernetes components associated with the chart and | `distributor.service.annotations` | Additional custom annotations for Distributor service | `{}` | | `distributor.service.extraPorts` | Extra ports to expose in the Distributor service | `[]` | - ### Metrics Generator Deployment Parameters | Name | Description | Value | @@ -334,7 +327,6 @@ The command removes all the Kubernetes components associated with the chart and | `metricsGenerator.sidecars` | Add additional sidecar containers to the metricsGenerator pod(s) | `[]` | | `metricsGenerator.initContainers` | Add additional init containers to the metricsGenerator pod(s) | `[]` | - ### Metrics Generator Traffic Exposure Parameters | Name | Description | Value | @@ -352,7 +344,6 @@ The command removes all the Kubernetes components associated with the chart and | `metricsGenerator.service.annotations` | Additional custom annotations for metricsGenerator service | `{}` | | `metricsGenerator.service.extraPorts` | Extra ports to expose in the metricsGenerator service | `[]` | - ### Ingester Deployment Parameters | Name | Description | Value | @@ -413,7 +404,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingester.sidecars` | Add additional sidecar containers to the Ingester pod(s) | `[]` | | `ingester.initContainers` | Add additional init containers to the Ingester pod(s) | `[]` | - ### Ingester Persistence Parameters | Name | Description | Value | @@ -427,7 +417,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingester.persistence.annotations` | Additional PVC annotations | `{}` | | `ingester.persistence.selector` | Selector to match an existing Persistent Volume for Ingester's data PVC | `{}` | - ### Ingester Traffic Exposure Parameters | Name | Description | Value | @@ -446,7 +435,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingester.service.annotations` | Additional custom annotations for Ingester service | `{}` | | `ingester.service.extraPorts` | Extra ports to expose in the Ingester service | `[]` | - ### Querier Deployment Parameters | Name | Description | Value | @@ -507,7 +495,6 @@ The command removes all the Kubernetes components associated with the chart and | `querier.sidecars` | Add additional sidecar containers to the Querier pod(s) | `[]` | | `querier.initContainers` | Add additional init containers to the Querier pod(s) | `[]` | - ### Querier Traffic Exposure Parameters | Name | Description | Value | @@ -526,7 +513,6 @@ The command removes all the Kubernetes components associated with the chart and | `querier.service.annotations` | Additional custom annotations for Querier service | `{}` | | `querier.service.extraPorts` | Extra ports to expose in the Querier service | `[]` | - ### Query Frontend Deployment Parameters | Name | Description | Value | @@ -630,7 +616,6 @@ The command removes all the Kubernetes components associated with the chart and | `queryFrontend.query.resources.requests` | The requested resources for the query sidecar containers | `{}` | | `queryFrontend.query.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for the queryFrontend container(s) | `[]` | - ### Query Frontend Traffic Exposure Parameters | Name | Description | Value | @@ -649,7 +634,6 @@ The command removes all the Kubernetes components associated with the chart and | `queryFrontend.service.annotations` | Additional custom annotations for queryFrontend service | `{}` | | `queryFrontend.service.extraPorts` | Extra ports to expose in the queryFrontend service | `[]` | - ### Vulture Deployment Parameters | Name | Description | Value | @@ -718,7 +702,6 @@ The command removes all the Kubernetes components associated with the chart and | `vulture.sidecars` | Add additional sidecar containers to the Vulture pod(s) | `[]` | | `vulture.initContainers` | Add additional init containers to the Vulture pod(s) | `[]` | - ### Vulture Traffic Exposure Parameters | Name | Description | Value | @@ -735,7 +718,6 @@ The command removes all the Kubernetes components associated with the chart and | `vulture.service.annotations` | Additional custom annotations for Vulture service | `{}` | | `vulture.service.extraPorts` | Extra ports to expose in the Vulture service | `[]` | - ### Init Container Parameters | Name | Description | Value | @@ -751,7 +733,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the init container | `{}` | | `volumePermissions.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` | - ### Other Parameters | Name | Description | Value | @@ -761,7 +742,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.automountServiceAccountToken` | Allows auto mount of ServiceAccountToken on the serviceAccount created | `true` | | `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` | - ### Metrics Parameters | Name | Description | Value | @@ -778,7 +758,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.serviceMonitor.honorLabels` | Specify honorLabels parameter to add the scrape endpoint | `false` | | `metrics.serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in prometheus. | `""` | - ### External Memcached Parameters | Name | Description | Value | @@ -786,7 +765,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalMemcached.host` | Host of a running external memcached instance | `""` | | `externalMemcached.port` | Port of a running external memcached instance | `11211` | - ### Memcached Sub-chart Parameters | Name | Description | Value | @@ -797,14 +775,12 @@ The command removes all the Kubernetes components associated with the chart and | `memcached.auth.password` | Memcached admin password | `""` | | `memcached.service.ports.memcached` | Memcached service port | `11211` | - - The above parameters map to the env variables defined in [bitnami/grafana-tempo](https://github.com/bitnami/containers/tree/main/bitnami/grafana-tempo). For more information please refer to the [bitnami/grafana-tempo](https://github.com/bitnami/containers/tree/main/bitnami/grafana-tempo) image documentation. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set tempo.traces.jaeger.grpc=true \ my-repo/grafana-tempo ``` diff --git a/bitnami/grafana/README.md b/bitnami/grafana/README.md index 70eec90167..01a65fc66a 100644 --- a/bitnami/grafana/README.md +++ b/bitnami/grafana/README.md @@ -453,7 +453,7 @@ This solution allows to easily deploy multiple Grafana instances compared to the Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set admin.user=admin-user my-repo/grafana ``` diff --git a/bitnami/haproxy/README.md b/bitnami/haproxy/README.md index e3794a3a42..c357cc8f04 100644 --- a/bitnami/haproxy/README.md +++ b/bitnami/haproxy/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -79,7 +78,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -109,7 +107,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### HAProxy Parameters | Name | Description | Value | @@ -186,7 +183,6 @@ The command removes all the Kubernetes components associated with the chart and | `sidecars` | Add additional sidecar containers to the haproxy pod(s) | `[]` | | `initContainers` | Add additional init containers to the haproxy pod(s) | `[]` | - ### Other Parameters | Name | Description | Value | @@ -198,12 +194,10 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.create` | Specifies whether a ServiceAccount should be created | `true` | | `serviceAccount.name` | The name of the ServiceAccount to use. | `""` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set service.type=LoadBalancer \ my-repo/haproxy ``` @@ -279,4 +273,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/harbor/README.md b/bitnami/harbor/README.md index 9cf15cadf5..03b794a95d 100644 --- a/bitnami/harbor/README.md +++ b/bitnami/harbor/README.md @@ -1191,7 +1191,7 @@ Additionally, if `persistence.resourcePolicy` is set to `keep`, you should manua ```console -$ helm install my-release \ +helm install my-release \ --set adminPassword=password \ my-repo/harbor ``` diff --git a/bitnami/influxdb/README.md b/bitnami/influxdb/README.md index 3dc5bea8b2..849e830bdd 100644 --- a/bitnami/influxdb/README.md +++ b/bitnami/influxdb/README.md @@ -324,7 +324,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.admin.username=admin-user my-repo/influxdb ``` @@ -350,7 +350,7 @@ Bitnami will release a new chart updating its containers if a new version of the This chart installs a deployment with the following configuration: -``` +```text ------------------ | Ingress | | Controller | @@ -439,7 +439,7 @@ Find more information about how to deal with common errors related to Bitnami's It's necessary to specify the existing passwords while performing an upgrade to ensure the secrets are not updated with invalid randomly generated passwords. Remember to specify the existing values of the `auth.admin.password`, `user.pwd`, `auth.readUser.password` and `auth.writeUser.password` parameters when upgrading the chart: ```console -$ helm upgrade my-release my-repo/influxdb \ +helm upgrade my-release my-repo/influxdb \ --set auth.admin.password=[ADMIN_USER_PASSWORD] \ --set auth.user.password=[USER_PASSWORD] \ --set auth.readUser.password=[READ_USER_PASSWORD] \ @@ -456,7 +456,7 @@ This major release completely removes support for InfluxDB Relay™ because To update from the previous major, please follow this steps: -``` +```console kubectl delete deployments.apps influxdb helm upgrade influxdb my-repo/influxdb ``` @@ -488,7 +488,7 @@ However, you can use images for versions ~1.x.x taking into account the chart ma #### Installing InfluxDB™ v1 in chart v2 -``` +```console helm install my-repo/influxdb --set image.tag=1.8.3-debian-10-r88 ``` @@ -529,7 +529,7 @@ export INFLUXDB_ADMIN_PASSWORD=$(kubectl get secret --namespace default influxdb > NOTE: Please remember to migrate all the values to its new path following the above notes, e.g: `adminUser.pwd` -> `auth.admin.password`. ```console -$ helm upgrade influxdb my-repo/influxdb --set image.tag=1.8.3-debian-10-r99 \ +helm upgrade influxdb my-repo/influxdb --set image.tag=1.8.3-debian-10-r99 \ --set auth.admin.password=${INFLUXDB_ADMIN_PASSWORD} ``` diff --git a/bitnami/jasperreports/README.md b/bitnami/jasperreports/README.md index a710134299..d30d1fed34 100644 --- a/bitnami/jasperreports/README.md +++ b/bitnami/jasperreports/README.md @@ -239,7 +239,7 @@ The above parameters map to the env variables defined in [bitnami/jasperreports] Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set jasperreportsUsername=admin,jasperreportsPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/jasperreports ``` diff --git a/bitnami/jenkins/README.md b/bitnami/jenkins/README.md index 91c90acabe..853f387cc1 100644 --- a/bitnami/jenkins/README.md +++ b/bitnami/jenkins/README.md @@ -219,7 +219,7 @@ The above parameters map to the env variables defined in [bitnami/jenkins](https Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set jenkinsUser=admin \ --set jenkinsPassword=password \ my-repo/jenkins diff --git a/bitnami/joomla/README.md b/bitnami/joomla/README.md index fc0a789317..1b042652cf 100644 --- a/bitnami/joomla/README.md +++ b/bitnami/joomla/README.md @@ -253,7 +253,7 @@ The above parameters map to the env variables defined in [bitnami/joomla](https: Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set joomlaUsername=admin,joomlaPassword=password,mariadb.mariadbRootPassword=secretpassword \ my-repo/joomla ``` diff --git a/bitnami/jupyterhub/README.md b/bitnami/jupyterhub/README.md index e6d026aa9f..d6cbc2a9f3 100644 --- a/bitnami/jupyterhub/README.md +++ b/bitnami/jupyterhub/README.md @@ -485,7 +485,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set proxy.livenessProbe.successThreshold=5 \ my-repo/jupyterhub ``` diff --git a/bitnami/kafka/README.md b/bitnami/kafka/README.md index 41c1e093d3..601c9ed82c 100644 --- a/bitnami/kafka/README.md +++ b/bitnami/kafka/README.md @@ -485,7 +485,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set replicaCount=3 \ my-repo/kafka ``` @@ -565,7 +565,6 @@ If, for some reason (like using Cert-Manager) you can not use the default JKS se - `auth.tls.jksKeystoreSAN` if you want to use a SAN certificate for your brokers. Setting this parameter would mean that the chart expects a existing key in the `auth.tls.jksTruststoreSecret` with the `auth.tls.jksKeystoreSAN` value and use this as a keystore for **all** brokers > **Note**: If you are using cert-manager, particularly when an ACME issuer is used, the `ca.crt` field is not put in the `Secret` that cert-manager creates. To handle this, the `auth.tls.pemChainIncluded` property can be set to `true` and the initContainer created by this Chart will attempt to extract the intermediate certs from the `tls.crt` field of the secret (which is a PEM chain) - > **Note**: The truststore/keystore from above **must** be protected with the same password as in `auth.tls.password` You can deploy the chart with authentication using the following parameters: diff --git a/bitnami/kibana/README.md b/bitnami/kibana/README.md index a880370800..c42ee8ed3b 100644 --- a/bitnami/kibana/README.md +++ b/bitnami/kibana/README.md @@ -33,8 +33,8 @@ Bitnami charts can be used with [Kubeapps](https://kubeapps.dev/) for deployment To install the chart with the release name `my-release`: ```console -$ helm repo add my-repo https://charts.bitnami.com/bitnami -$ helm install my-release my-repo/kibana \ +helm repo add my-repo https://charts.bitnami.com/bitnami +helm install my-release my-repo/kibana \ --set elasticsearch.hosts[0]= \ --set elasticsearch.port= \ ``` @@ -247,7 +247,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set admin.user=admin-user my-repo/kibana ``` diff --git a/bitnami/kong/README.md b/bitnami/kong/README.md index b60821f4be..57ff13792a 100644 --- a/bitnami/kong/README.md +++ b/bitnami/kong/README.md @@ -343,7 +343,7 @@ helm delete my-release Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set service.exposeAdmin=true my-repo/kong ``` @@ -378,7 +378,7 @@ helm install my-release my-repo/kong - Use an external PostgreSQL database ```console -$ helm install my-release my-repo/kong \ +helm install my-release my-repo/kong \ --set postgresql.enabled=false \ --set postgresql.external.host=_HOST_OF_YOUR_POSTGRESQL_INSTALLATION_ \ --set postgresql.external.password=_PASSWORD_OF_YOUR_POSTGRESQL_INSTALLATION_ \ @@ -388,7 +388,7 @@ $ helm install my-release my-repo/kong \ - Deploy the Cassandra sub-chart ```console -$ helm install my-release my-repo/kong \ +helm install my-release my-repo/kong \ --set database=cassandra \ --set postgresql.enabled=false \ --set cassandra.enabled=true @@ -397,7 +397,7 @@ $ helm install my-release my-repo/kong \ - Use an existing Cassandra installation ```console -$ helm install my-release my-repo/kong \ +helm install my-release my-repo/kong \ --set database=cassandra \ --set postgresql.enabled=false \ --set cassandra.enabled=false \ @@ -511,7 +511,7 @@ Find more information about how to deal with common errors related to Bitnami's It's necessary to specify the existing passwords while performing a upgrade to ensure the secrets are not updated with invalid randomly generated passwords. Remember to specify the existing values of the `postgresql.postgresqlPassword` or `cassandra.password` parameters when upgrading the chart: ```console -$ helm upgrade my-release my-repo/kong \ +helm upgrade my-release my-repo/kong \ --set database=postgresql --set postgresql.enabled=true --set @@ -575,14 +575,14 @@ export POSTGRESQL_PVC=$(kubectl get pvc -l app.kubernetes.io/instance=kong,app.k Delete PostgreSQL statefulset. Notice the option `--cascade=false`: -``` +```console kubectl delete statefulsets.apps kong-postgresql --cascade=false ``` ##### Upgrade the chart release ```console -$ helm upgrade kong my-repo/kong \ +helm upgrade kong my-repo/kong \ --set postgresql.postgresqlPassword=$POSTGRESQL_PASSWORD \ --set postgresql.persistence.existingClaim=$POSTGRESQL_PVC ``` diff --git a/bitnami/kube-prometheus/README.md b/bitnami/kube-prometheus/README.md index 0435d20bc9..3a1206efd3 100644 --- a/bitnami/kube-prometheus/README.md +++ b/bitnami/kube-prometheus/README.md @@ -25,7 +25,7 @@ In the default configuration the chart deploys the following components on the K - [Prometheus](https://github.com/prometheus/prometheus/) - [Alertmanager](https://github.com/prometheus/alertmanager) -**IMPORTANT** +> **:warning: IMPORTANT** Only one instance of the Prometheus Operator component should be running in the cluster. If you wish to deploy this chart to **manage multiple instances** of Prometheus in your Kubernetes cluster, you **have to disable** the installation of the Prometheus Operator component using the `operator.enabled=false` chart installation argument. @@ -692,7 +692,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set operator.logLevel=debug \ --set prometheus.replicaCount=5 \ my-repo/kube-prometheus diff --git a/bitnami/kubeapps/README.md b/bitnami/kubeapps/README.md index a2eb73ab9f..27232330fa 100644 --- a/bitnami/kubeapps/README.md +++ b/bitnami/kubeapps/README.md @@ -552,7 +552,7 @@ Once you have installed Kubeapps follow the [Getting Started Guide](https://gith | `redis.replica.persistence.enabled` | Enable Redis® replica data persistence using PVC | `false` | ```console -$ helm install kubeapps --namespace kubeapps \ +helm install kubeapps --namespace kubeapps \ --set ingress.enabled=true \ my-repo/kubeapps ``` @@ -667,7 +667,7 @@ This major updates the PostgreSQL subchart to its newest major, 12.0.0. [Here](h To uninstall/delete the `kubeapps` deployment: ```console -$ helm uninstall -n kubeapps kubeapps +helm uninstall -n kubeapps kubeapps # Optional: Only if there are no more instances of Kubeapps $ kubectl delete crd apprepositories.kubeapps.com @@ -717,7 +717,7 @@ Have a look at the [dashboard documentation](https://github.com/vmware-tanzu/kub The example below will match the URL `http://example.com` to the Kubeapps dashboard. For further configuration, please refer to your specific Ingress configuration docs (e.g., [NGINX](https://github.com/kubernetes/ingress-nginx) or [HAProxy](https://github.com/haproxytech/kubernetes-ingress)). ```console -$ helm install kubeapps my-repo/kubeapps \ +helm install kubeapps my-repo/kubeapps \ --namespace kubeapps \ --set ingress.enabled=true \ --set ingress.hostname=example.com \ @@ -727,7 +727,7 @@ $ helm install kubeapps my-repo/kubeapps \ If you are using LDAP via Dex with OIDC or you are getting an error message like `upstream sent too big header while reading response header from upstream` it means the cookie size is too big and can't be processed by the Ingress Controller. You can work around this problem by setting the following Nginx ingress annotations (look for similar annotations in your preferred Ingress Controller): -``` +```text # rest of the helm install ... command --set ingress.annotations."nginx\.ingress\.kubernetes\.io/proxy-read-timeout"=600 --set ingress.annotations."nginx\.ingress\.kubernetes\.io/proxy-buffer-size"=8k @@ -739,7 +739,7 @@ You can work around this problem by setting the following Nginx ingress annotati You may want to serve Kubeapps with a subpath, for instance `http://example.com/subpath`, you have to set the proper Ingress configuration. If you are using the ingress configuration provided by the Kubeapps chart, you will have to set the `ingress.hostname` and `path` parameters: ```console -$ helm install kubeapps my-repo/kubeapps \ +helm install kubeapps my-repo/kubeapps \ --namespace kubeapps \ --set ingress.enabled=true \ --set ingress.hostname=example.com \ @@ -750,7 +750,7 @@ $ helm install kubeapps my-repo/kubeapps \ Besides, if you are using the OAuth2/OIDC login (more information at the [using an OIDC provider documentation](https://github.com/vmware-tanzu/kubeapps/blob/main/site/content/docs/latest/tutorials/using-an-OIDC-provider.md)), you will need, also, to configure the different URLs: ```console -$ helm install kubeapps my-repo/kubeapps \ +helm install kubeapps my-repo/kubeapps \ --namespace kubeapps \ # ... other OIDC and ingress flags --set authProxy.oauthLoginURI="/subpath/oauth2/login" \ @@ -881,44 +881,44 @@ It is possible that when upgrading Kubeapps an error appears. That can be caused 1. (Optional) Backup your personal repositories (if you have any): -```console -kubectl get apprepository -A -o yaml > .yaml -``` + ```console + kubectl get apprepository -A -o yaml > .yaml + ``` 2. Delete Kubeapps: -```console -helm del --purge kubeapps -``` + ```console + helm del --purge kubeapps + ``` 3. (Optional) Delete the App Repositories CRD: -> **Warning**: Do not run this step if you have more than one Kubeapps installation in your cluster. + > **Warning**: Do not run this step if you have more than one Kubeapps installation in your cluster. -```console -kubectl delete crd apprepositories.kubeapps.com -``` + ```console + kubectl delete crd apprepositories.kubeapps.com + ``` 4. (Optional) Clean the Kubeapps namespace: -> **Warning**: Do not run this step if you have workloads other than Kubeapps in the `kubeapps` namespace. + > **Warning**: Do not run this step if you have workloads other than Kubeapps in the `kubeapps` namespace. -```console -kubectl delete namespace kubeapps -``` + ```console + kubectl delete namespace kubeapps + ``` 5. Install the latest version of Kubeapps (using any custom modifications you need): -```console -helm repo update -helm install --name kubeapps --namespace kubeapps my-repo/kubeapps -``` + ```console + helm repo update + helm install --name kubeapps --namespace kubeapps my-repo/kubeapps + ``` 6. (Optional) Restore any repositories you backed up in the first step: -```console -kubectl apply -f .yaml -``` + ```console + kubectl apply -f .yaml + ``` After that you should be able to access the new version of Kubeapps. If the above doesn't work for you or you run into any other issues please open an [issue](https://github.com/vmware-tanzu/kubeapps/issues/new). @@ -937,21 +937,21 @@ Kubeapps 2.3.1 (Chart version 6.0.0) introduces some breaking changes. Helm-spec 1. Kubeapps will no longer create a database secret for you automatically but rather will rely on the default behavior of the PostgreSQL chart. If you try to upgrade Kubeapps and you installed it without setting a password, you will get the following error: -```console -Error: UPGRADE FAILED: template: kubeapps/templates/NOTES.txt:73:4: executing "kubeapps/templates/NOTES.txt" at : error calling include: template: kubeapps/charts/common/templates/_errors.tpl:18:48: executing "common.errors.upgrade.passwords.empty" at : error calling fail: -PASSWORDS ERROR: you must provide your current passwords when upgrade the release - 'postgresql.postgresqlPassword' must not be empty, please add '--set postgresql.postgresqlPassword=$POSTGRESQL_PASSWORD' to the command. To get the current value: -``` + ```console + Error: UPGRADE FAILED: template: kubeapps/templates/NOTES.txt:73:4: executing "kubeapps/templates/NOTES.txt" at : error calling include: template: kubeapps/charts/common/templates/_errors.tpl:18:48: executing "common.errors.upgrade.passwords.empty" at : error calling fail: + PASSWORDS ERROR: you must provide your current passwords when upgrade the release + 'postgresql.postgresqlPassword' must not be empty, please add '--set postgresql.postgresqlPassword=$POSTGRESQL_PASSWORD' to the command. To get the current value: + ``` -The error gives you generic instructions for retrieving the PostgreSQL password, but if you have installed a Kubeapps version prior to 2.3.1, the name of the secret will differ. Run the following command: + The error gives you generic instructions for retrieving the PostgreSQL password, but if you have installed a Kubeapps version prior to 2.3.1, the name of the secret will differ. Run the following command: -```console -export POSTGRESQL_PASSWORD=$(kubectl get secret --namespace "kubeapps" kubeapps-db -o jsonpath="{.data.postgresql-password}" | base64 -d) -``` + ```console + export POSTGRESQL_PASSWORD=$(kubectl get secret --namespace "kubeapps" kubeapps-db -o jsonpath="{.data.postgresql-password}" | base64 -d) + ``` -> NOTE: Replace the namespace in the command with the namespace in which you have deployed Kubeapps. + > NOTE: Replace the namespace in the command with the namespace in which you have deployed Kubeapps. -Make sure that you have stored the password in the variable `$POSTGRESQL_PASSWORD` before continuing with the next issue. + Make sure that you have stored the password in the variable `$POSTGRESQL_PASSWORD` before continuing with the next issue. 2. The chart `initialRepos` are no longer installed using [Helm hooks](https://helm.sh/docs/topics/charts_hooks/), which caused these repos not to be handled by Helm after the first installation. Now they will be tracked for every update. However, if you do not delete the existing ones, it will fail to update with: diff --git a/bitnami/logstash/README.md b/bitnami/logstash/README.md index 8538e27d2f..9639e41015 100644 --- a/bitnami/logstash/README.md +++ b/bitnami/logstash/README.md @@ -202,7 +202,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set enableMonitoringAPI=false my-repo/logstash ``` diff --git a/bitnami/magento/README.md b/bitnami/magento/README.md index 6aea9ca161..432e40d244 100644 --- a/bitnami/magento/README.md +++ b/bitnami/magento/README.md @@ -357,7 +357,7 @@ The above parameters map to the env variables defined in [bitnami/magento](https Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set magentoUsername=admin,magentoPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/magento ``` @@ -391,14 +391,14 @@ The `image` parameter allows specifying which image will be pulled for the chart If you configure the `image` value to one in a private registry, you will need to [specify an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). 1. Manually create image pull secret(s) in the namespace. See [this YAML example reference](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config). Consult your image registry's documentation about getting the appropriate secret. -1. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: +2. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: ```yaml imagePullSecrets: - name: SECRET_NAME ``` -1. Install the chart +3. Install the chart ### Ingress @@ -535,8 +535,8 @@ As an alternative, you can use of the preset configurations for pod affinity, po ### Existing PersistentVolumeClaim 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/magento @@ -552,14 +552,14 @@ As an alternative, you can use of the preset configurations for pod affinity, po #### Mounting steps 1. The specified `hostPath` directory must already exist (create one if it does not). -1. Install the chart +2. Install the chart ```console helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT my-repo/magento ``` This will mount the `magento-data` volume into the `hostPath` directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. -1. Because the container cannot control the host machine's directory permissions, you must set the Magento file directory permissions yourself and disable or clear Magento cache. +3. Because the container cannot control the host machine's directory permissions, you must set the Magento file directory permissions yourself and disable or clear Magento cache. ## CA Certificates diff --git a/bitnami/mariadb-galera/README.md b/bitnami/mariadb-galera/README.md index ff7e17bf99..a909166c58 100644 --- a/bitnami/mariadb-galera/README.md +++ b/bitnami/mariadb-galera/README.md @@ -260,7 +260,7 @@ The above parameters map to the env variables defined in [bitnami/mariadb-galera Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set rootUser.password=secretpassword, --set db.user=app_database \ my-repo/mariadb-galera @@ -285,7 +285,7 @@ While the chart allows you to specify the server configuration using the `.maria For example, if you want to enable the PAM cleartext plugin, specify the command line parameter while deploying the chart like so: ```console -$ helm install my-release \ +helm install my-release \ --set extraFlags="--pam-use-cleartext-plugin=ON" \ my-repo/mariadb-galera ``` @@ -496,7 +496,7 @@ $ kubectl run -i --rm --tty volpod --overrides=' The output should be similar to this: -``` +```text # GALERA saved state version: 2.1 uuid: 6f2cbfcd-951b-11ea-a116-5f407049e57d @@ -511,7 +511,7 @@ There are two possible scenarios: In this case you will need the node number `N` and run: ```console -$ helm install my-release my-repo/mariadb-galera \ +helm install my-release my-repo/mariadb-galera \ --set rootUser.password=XXXX \ --set galera.mariabackup.password=YYYY \ --set galera.bootstrap.forceBootstrap=true \ @@ -524,7 +524,7 @@ $ helm install my-release my-repo/mariadb-galera \ In this case the cluster was not stopped cleanly and you need to pick one to force the bootstrap from. The one to be chosen in the one with the highest `seqno` in `/bitnami/mariadb/data/grastate.dat`. The following example shows how to force bootstrap from node 3. ```console -$ helm install my-release my-repo/mariadb-galera \ +helm install my-release my-repo/mariadb-galera \ --set rootUser.password=XXXX \ --set galera.mariabackup.password=YYYY \ --set galera.bootstrap.forceBootstrap=true \ @@ -537,8 +537,8 @@ $ helm install my-release my-repo/mariadb-galera \ After you have started the cluster by forcing the bootstraping on one of the nodes, you will need to remove the forcing so the node can restart with normality. -``` -$ helm upgrade my-release my-repo/mariadb-galera \ +```console +helm upgrade my-release my-repo/mariadb-galera \ --set rootUser.password=XXXX \ --set galera.mariabackup.password=YYYY \ --set podManagementPolicy=Parallel @@ -565,7 +565,7 @@ Find more information about how to deal with common errors related to Bitnami's It's necessary to specify the existing passwords while performing a upgrade to ensure the secrets are not updated with invalid randomly generated passwords. Remember to specify the existing values of the `rootUser.password`, `db.password` and `galera.mariabackup.password` parameters when upgrading the chart: ```console -$ helm upgrade my-release my-repo/mariadb-galera \ +helm upgrade my-release my-repo/mariadb-galera \ --set rootUser.password=[ROOT_PASSWORD] \ --set db.password=[MARIADB_PASSWORD] \ --set galera.mariabackup.password=[GALERA_MARIABACKUP_PASSWORD] diff --git a/bitnami/mariadb/README.md b/bitnami/mariadb/README.md index 55ba82fc57..43336ae845 100644 --- a/bitnami/mariadb/README.md +++ b/bitnami/mariadb/README.md @@ -382,7 +382,7 @@ The above parameters map to the env variables defined in [bitnami/mariadb](https Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.rootPassword=secretpassword,auth.database=app_database \ my-repo/mariadb ``` diff --git a/bitnami/mastodon/README.md b/bitnami/mastodon/README.md index bce85d49bf..2925e5ef47 100644 --- a/bitnami/mastodon/README.md +++ b/bitnami/mastodon/README.md @@ -518,7 +518,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set adminUsername=admin \ --set adminPassword=password \ my-repo/mastodon diff --git a/bitnami/matomo/README.md b/bitnami/matomo/README.md index 1c172e09c2..ac112f5b1e 100644 --- a/bitnami/matomo/README.md +++ b/bitnami/matomo/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `commonLabels` | Common labels to add to all Matomo resources (sub-charts are not considered). Evaluated as a template | `{}` | | `extraDeploy` | Array of extra objects to deploy with the release (evaluated as a template). | `[]` | - ### Matomo parameters | Name | Description | Value | @@ -172,7 +170,6 @@ The command removes all the Kubernetes components associated with the chart and | `podAnnotations` | Pod annotations | `{}` | | `podLabels` | Add additional labels to the pod (evaluated as a template) | `{}` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -204,7 +201,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | If you're providing your own certificates, please use this to add the certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Database parameters | Name | Description | Value | @@ -228,7 +224,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.database` | Name of the existing database | `bitnami_matomo` | | `externalDatabase.existingSecret` | Name of a secret containing the database credentials | `""` | - ### Volume Permissions parameters | Name | Description | Value | @@ -243,7 +238,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.limits` | The resources limits for the container | `{}` | | `volumePermissions.resources.requests` | The requested resources for the container | `{}` | - ### Metrics parameters | Name | Description | Value | @@ -258,7 +252,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.resources` | Metrics exporter resource requests and limits | `{}` | | `metrics.podAnnotations` | Additional annotations for Metrics exporter pod | `{}` | - ### Certificate injection parameters | Name | Description | Value | @@ -282,7 +275,6 @@ The command removes all the Kubernetes components associated with the chart and | `certificates.image.pullPolicy` | Container sidecar image pull policy | `IfNotPresent` | | `certificates.image.pullSecrets` | Container sidecar image pull secrets | `[]` | - ### NetworkPolicy parameters | Name | Description | Value | @@ -303,12 +295,10 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.egressRules.denyConnectionsToExternal` | Enable egress rule that denies outgoing traffic outside the cluster, except for DNS (port 53). | `false` | | `networkPolicy.egressRules.customRules` | Custom network policy rule | `{}` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set matomoUsername=user,matomoPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/matomo ``` @@ -342,14 +332,14 @@ The `image` parameter allows specifying which image will be pulled for the chart If you configure the `image` value to one in a private registry, you will need to [specify an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). 1. Manually create image pull secret(s) in the namespace. See [this YAML example reference](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config). Consult your image registry's documentation about getting the appropriate secret. -1. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: +2. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: -```yaml -imagePullSecrets: - - name: SECRET_NAME -``` + ```yaml + imagePullSecrets: + - name: SECRET_NAME + ``` -1. Install the chart +3. Install the chart ### Setting Pod's affinity @@ -367,8 +357,8 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per ### Existing PersistentVolumeClaim 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/matomo @@ -384,14 +374,14 @@ helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/matomo #### Mounting steps 1. The specified `hostPath` directory must already exist (create one if it does not). -1. Install the chart +2. Install the chart ```console helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT my-repo/matomo ``` This will mount the `matomo-data` volume into the `hostPath` directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. -1. Because the container cannot control the host machine's directory permissions, you must set the Matomo file directory permissions yourself +3. Because the container cannot control the host machine's directory permissions, you must set the Matomo file directory permissions yourself ## Troubleshooting @@ -411,4 +401,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/mediawiki/README.md b/bitnami/mediawiki/README.md index 5cc625fe30..4075b50de1 100644 --- a/bitnami/mediawiki/README.md +++ b/bitnami/mediawiki/README.md @@ -279,7 +279,7 @@ The above parameters map to the env variables defined in [bitnami/mediawiki](htt Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set mediawikiUser=admin,mediawikiPassword=password,mariadb.mariadbRootPassword=secretpassword \ my-repo/mediawiki ``` diff --git a/bitnami/metallb/README.md b/bitnami/metallb/README.md index 2086848c3c..139301d57c 100644 --- a/bitnami/metallb/README.md +++ b/bitnami/metallb/README.md @@ -61,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imageRegistry` | Global Docker image registry | `""` | | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | - ### Common parameters | Name | Description | Value | @@ -76,7 +75,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the the deployment(s)/statefulset(s) | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the the deployment(s)/statefulset(s) | `["infinity"]` | - ### MetalLB parameters | Name | Description | Value | @@ -88,7 +86,6 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.ingressNSPodMatchLabels` | For other namespaces match by pod labels and namespace labels | `{}` | | `prometheusRule.enabled` | Prometheus Operator alertmanager alerts are created | `false` | - ### Controller parameters | Name | Description | Value | @@ -165,7 +162,6 @@ The command removes all the Kubernetes components associated with the chart and | `controller.customLivenessProbe` | Custom liveness probe for the Web component | `{}` | | `controller.customReadinessProbe` | Custom readiness probe for the Web component | `{}` | - ### Metallb controller Prometheus metrics export | Name | Description | Value | @@ -184,7 +180,6 @@ The command removes all the Kubernetes components associated with the chart and | `controller.metrics.serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` | | `controller.metrics.serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions with target labels | `false` | - ### Speaker parameters | Name | Description | Value | @@ -261,7 +256,6 @@ The command removes all the Kubernetes components associated with the chart and | `speaker.customLivenessProbe` | Custom liveness probe for the Web component | `{}` | | `speaker.customReadinessProbe` | Custom readiness probe for the Web component | `{}` | - ### Speaker Prometheus metrics export | Name | Description | Value | @@ -280,10 +274,8 @@ The command removes all the Kubernetes components associated with the chart and | `speaker.metrics.serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` | | `speaker.metrics.serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions with target labels | `false` | - - ```console -$ helm install my-release \ +helm install my-release \ --set readinessProbe.successThreshold=5 \ my-repo/metallb ``` @@ -350,7 +342,7 @@ Affected values: ### To 2.0.0 -#### What changes were introduced in this major version? +#### What changes were introduced in 2.0.0? - The `.Values.prometheus` section was moved into the components `.Values.controller.prometheus` and `.Values.speaker.prometheus` - The `prometheus.prometheusRule` which is used to toggle the deployment of the metallb alerts is moved under the root of the `.Values.prometheusRule` @@ -358,7 +350,7 @@ Affected values: - `Values.controller.rbac.create` and `Values.controller.psp.create` - `Values.speaker.rbac.create` and `Values.speaker.psp.create` -#### Considerations when upgrading to this version +#### Considerations when upgrading to 2.0.0 - Check if you used the `prometheus` section in you deployment. - If you do so, place the configuration you made into the sections `controller.prometheus` and `speaker.prometheus`. @@ -368,12 +360,12 @@ Affected values: [On November 13, 2020, Helm v2 support was formally finished](https://github.com/helm/charts#status-of-the-project), this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL. -#### What changes were introduced in this major version? +#### What changes were introduced in 1.0.0? - Previous versions of this Helm Chart use `apiVersion: v1` (installable by both Helm 2 and 3), this Helm Chart was updated to `apiVersion: v2` (installable by Helm 3 only). [Here](https://helm.sh/docs/topics/charts/#the-apiversion-field) you can find more information about the `apiVersion` field. - The different fields present in the *Chart.yaml* file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts -#### Considerations when upgrading to this version +#### Considerations when upgrading to 1.0.0 - If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues - If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore @@ -407,4 +399,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/metrics-server/README.md b/bitnami/metrics-server/README.md index 9c5ac0f067..24f24e58d4 100644 --- a/bitnami/metrics-server/README.md +++ b/bitnami/metrics-server/README.md @@ -170,7 +170,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set rbac.create=true my-repo/metrics-server ``` diff --git a/bitnami/minio/README.md b/bitnami/minio/README.md index bfadd931cd..6ceb23037d 100644 --- a/bitnami/minio/README.md +++ b/bitnami/minio/README.md @@ -306,7 +306,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.rootUser=minio-admin \ --set auth.rootPassword=minio-secret-password \ my-repo/minio diff --git a/bitnami/mongodb-sharded/README.md b/bitnami/mongodb-sharded/README.md index f8a24b601e..129b5a9ea4 100644 --- a/bitnami/mongodb-sharded/README.md +++ b/bitnami/mongodb-sharded/README.md @@ -514,7 +514,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set shards=4,configsvr.replicaCount=3,shardsvr.dataNode.replicaCount=2 \ my-repo/mongodb-sharded ``` diff --git a/bitnami/mongodb/README.md b/bitnami/mongodb/README.md index c1bdcf00bd..6200f01851 100644 --- a/bitnami/mongodb/README.md +++ b/bitnami/mongodb/README.md @@ -553,7 +553,7 @@ Refer to the [chart documentation for more information on each of these architec Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.rootPassword=secretpassword,auth.username=my-user,auth.password=my-password,auth.database=my-database \ my-repo/mongodb ``` diff --git a/bitnami/moodle/README.md b/bitnami/moodle/README.md index 39271311f4..b5fab4048b 100644 --- a/bitnami/moodle/README.md +++ b/bitnami/moodle/README.md @@ -63,7 +63,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -75,7 +74,6 @@ The command removes all the Kubernetes components associated with the chart and | `commonLabels` | Common labels to add to all Harbor resources (sub-charts are not considered). Evaluated as a template | `{}` | | `extraDeploy` | Array with extra yaml to deploy with the chart. Evaluated as a template | `[]` | - ### Moodle™ parameters | Name | Description | Value | @@ -168,7 +166,6 @@ The command removes all the Kubernetes components associated with the chart and | `podAnnotations` | Pod annotations | `{}` | | `podLabels` | Add additional labels to the pod (evaluated as a template) | `{}` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -200,7 +197,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Database parameters | Name | Description | Value | @@ -225,7 +221,6 @@ The command removes all the Kubernetes components associated with the chart and | `externalDatabase.database` | Name of the existing database | `bitnami_moodle` | | `externalDatabase.existingSecret` | Name of an existing secret resource containing the DB password | `""` | - ### Volume Permissions parameters | Name | Description | Value | @@ -240,7 +235,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.limits` | The resources limits for the container | `{}` | | `volumePermissions.resources.requests` | The requested resources for the container | `{}` | - ### Metrics parameters | Name | Description | Value | @@ -264,7 +258,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.resources` | Exporter resource requests/limit | `{}` | | `metrics.podAnnotations` | Metrics exporter pod Annotation and Labels | `{}` | - ### Certificate injection parameters | Name | Description | Value | @@ -288,7 +281,6 @@ The command removes all the Kubernetes components associated with the chart and | `certificates.image.pullPolicy` | Container sidecar image pull policy | `IfNotPresent` | | `certificates.image.pullSecrets` | Container sidecar image pull secrets | `[]` | - ### NetworkPolicy parameters | Name | Description | Value | @@ -309,12 +301,10 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.egressRules.denyConnectionsToExternal` | Enable egress rule that denies outgoing traffic outside the cluster, except for DNS (port 53). | `false` | | `networkPolicy.egressRules.customRules` | Custom network policy rule | `{}` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set moodleUsername=admin,moodlePassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/moodle ``` @@ -530,4 +520,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/mxnet/README.md b/bitnami/mxnet/README.md index 557600797b..ff60270268 100644 --- a/bitnami/mxnet/README.md +++ b/bitnami/mxnet/README.md @@ -387,7 +387,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set mode=distributed \ --set server.replicaCount=2 \ --set worker.replicaCount=3 \ diff --git a/bitnami/mysql/README.md b/bitnami/mysql/README.md index 07050531ff..7695ab0ee8 100644 --- a/bitnami/mysql/README.md +++ b/bitnami/mysql/README.md @@ -361,7 +361,7 @@ The above parameters map to the env variables defined in [bitnami/mysql](https:/ Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.rootPassword=secretpassword,auth.database=app_database \ my-repo/mysql ``` @@ -434,7 +434,7 @@ The chart mounts a [Persistent Volume](https://kubernetes.io/docs/concepts/stora If you encounter errors when working with persistent volumes, refer to our [troubleshooting guide for persistent volumes](https://docs.bitnami.com/kubernetes/faq/troubleshooting/troubleshooting-persistence-volumes/). -## Network Policy +## Network Policy config To enable network policy for MySQL, install [a networking plugin that implements the Kubernetes NetworkPolicy spec](https://kubernetes.io/docs/tasks/administer-cluster/declare-network-policy#before-you-begin), and set `networkPolicy.enabled` to `true`. diff --git a/bitnami/nats/README.md b/bitnami/nats/README.md index 0620f01cf9..ac1c909110 100644 --- a/bitnami/nats/README.md +++ b/bitnami/nats/README.md @@ -260,7 +260,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.enabled=true,auth.user=my-user,auth.password=T0pS3cr3t \ my-repo/nats ``` diff --git a/bitnami/nginx-ingress-controller/README.md b/bitnami/nginx-ingress-controller/README.md index 4551bfa6d1..7f60fd68ff 100644 --- a/bitnami/nginx-ingress-controller/README.md +++ b/bitnami/nginx-ingress-controller/README.md @@ -329,7 +329,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set image.pullPolicy=Always \ my-repo/nginx-ingress-controller ``` diff --git a/bitnami/nginx/README.md b/bitnami/nginx/README.md index b484ce68cf..18b08b7645 100644 --- a/bitnami/nginx/README.md +++ b/bitnami/nginx/README.md @@ -275,7 +275,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set imagePullPolicy=Always \ my-repo/nginx ``` diff --git a/bitnami/oauth2-proxy/README.md b/bitnami/oauth2-proxy/README.md index 0c66178b1e..4ddcff6f84 100644 --- a/bitnami/oauth2-proxy/README.md +++ b/bitnami/oauth2-proxy/README.md @@ -248,7 +248,7 @@ The above parameters map to the env variables defined in [bitnami/oauth2-proxy]( Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set replicaCount=2 \ my-repo/oauth2-proxy ``` diff --git a/bitnami/odoo/README.md b/bitnami/odoo/README.md index a88dc67347..cc0b89ba42 100644 --- a/bitnami/odoo/README.md +++ b/bitnami/odoo/README.md @@ -285,7 +285,7 @@ The above parameters map to the env variables defined in [bitnami/odoo](https:// Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set odooPassword=password,postgresql.postgresPassword=secretpassword \ my-repo/odoo ``` diff --git a/bitnami/opencart/README.md b/bitnami/opencart/README.md index b34ceb8525..0fdc63acdc 100644 --- a/bitnami/opencart/README.md +++ b/bitnami/opencart/README.md @@ -309,7 +309,7 @@ The above parameters map to the env variables defined in [bitnami/opencart](http Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set opencartUsername=admin,opencartPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/opencart ``` @@ -343,14 +343,14 @@ The `image` parameter allows specifying which image will be pulled for the chart If you configure the `image` value to one in a private registry, you will need to [specify an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). 1. Manually create image pull secret(s) in the namespace. See [this YAML example reference](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config). Consult your image registry's documentation about getting the appropriate secret. -1. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: +2. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: -```yaml -imagePullSecrets: - - name: SECRET_NAME -``` + ```yaml + imagePullSecrets: + - name: SECRET_NAME + ``` -1. Install the chart +3. Install the chart ### Setting Pod's affinity @@ -368,8 +368,8 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per ### Existing PersistentVolumeClaim 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/prestashop @@ -385,14 +385,14 @@ helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/prestas #### Mounting steps 1. The specified `hostPath` directory must already exist (create one if it does not). -1. Install the chart +2. Install the chart ```console helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT my-repo/prestashop ``` This will mount the `prestashop-data` volume into the `hostPath` directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. -1. Because the container cannot control the host machine's directory permissions, you must set the PrestaShop file directory permissions yourself and disable or clear PrestaShop cache. +3. Because the container cannot control the host machine's directory permissions, you must set the PrestaShop file directory permissions yourself and disable or clear PrestaShop cache. ## Troubleshooting diff --git a/bitnami/osclass/README.md b/bitnami/osclass/README.md index f1e12681ef..35149724aa 100644 --- a/bitnami/osclass/README.md +++ b/bitnami/osclass/README.md @@ -320,7 +320,7 @@ The above parameters map to the env variables defined in [bitnami/osclass](https Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set osclassUsername=admin,osclassPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/osclass ``` diff --git a/bitnami/parse/README.md b/bitnami/parse/README.md index a518fae1af..dd3d852945 100644 --- a/bitnami/parse/README.md +++ b/bitnami/parse/README.md @@ -61,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common Parameters | Name | Description | Value | @@ -77,7 +76,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### Parse server parameters | Name | Description | Value | @@ -162,7 +160,6 @@ The command removes all the Kubernetes components associated with the chart and | `server.service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` | | `server.service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` | - ### Dashboard Parameters | Name | Description | Value | @@ -247,7 +244,6 @@ The command removes all the Kubernetes components associated with the chart and | `dashboard.service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` | | `dashboard.service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -271,7 +267,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | If you're providing your own certificates, please use this to add the certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Persistence Parameters | Name | Description | Value | @@ -285,7 +280,6 @@ The command removes all the Kubernetes components associated with the chart and | `persistence.dataSource` | Custom PVC data source | `{}` | | `persistence.annotations` | Persistent Volume Claim annotations | `{}` | - ### Volume Permissions parameters | Name | Description | Value | @@ -303,7 +297,6 @@ The command removes all the Kubernetes components associated with the chart and | `serviceAccount.annotations` | Additional Service Account annotations (evaluated as a template) | `{}` | | `serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` | - ### MongoDB® Parameters | Name | Description | Value | @@ -319,8 +312,6 @@ The command removes all the Kubernetes components associated with the chart and | `mongodb.persistence.accessMode` | PVC Access Mode for MongoDB® volume | `ReadWriteOnce` | | `mongodb.persistence.size` | PVC Storage Request for MongoDB® volume | `8Gi` | - - > **Note**: > > For the Parse application function correctly, you should specify the `parseHost` parameter to specify the FQDN (recommended) or the public IP address of the Parse service. @@ -338,7 +329,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set dashboard.username=admin,dashboard.password=password \ my-repo/parse ``` @@ -556,4 +547,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/phpbb/README.md b/bitnami/phpbb/README.md index 1a8b508a6c..89e219c7ac 100644 --- a/bitnami/phpbb/README.md +++ b/bitnami/phpbb/README.md @@ -263,7 +263,7 @@ The above parameters map to the env variables defined in [bitnami/phpbb](https:/ Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set phpbbUsername=admin,phpbbPassword=password,mariadb.mariadbRootPassword=secretpassword \ my-repo/phpbb ``` diff --git a/bitnami/phpmyadmin/README.md b/bitnami/phpmyadmin/README.md index e10954b5cf..e6b6870180 100644 --- a/bitnami/phpmyadmin/README.md +++ b/bitnami/phpmyadmin/README.md @@ -265,7 +265,7 @@ For more information please refer to the [bitnami/phpmyadmin](https://github.com Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set db.host=mymariadb,db.port=3306 my-repo/phpmyadmin ``` diff --git a/bitnami/pinniped/README.md b/bitnami/pinniped/README.md index 00f0fb5977..7c24837117 100644 --- a/bitnami/pinniped/README.md +++ b/bitnami/pinniped/README.md @@ -316,7 +316,7 @@ The above parameters map to the env variables defined in [bitnami/pinniped](http Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set supervisor.enabled=false \ my-repo/pinniped ``` diff --git a/bitnami/postgresql-ha/README.md b/bitnami/postgresql-ha/README.md index d404582b10..7b23c6037e 100644 --- a/bitnami/postgresql-ha/README.md +++ b/bitnami/postgresql-ha/README.md @@ -570,7 +570,7 @@ Additionally, if `persistence.resourcePolicy` is set to `keep`, you should manua Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set postgresql.password=password \ my-repo/postgresql-ha ``` @@ -582,7 +582,7 @@ The above command sets the password for user `postgres` to `password`. Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, ```console -$ helm install my-release \ +helm install my-release \ -f values.yaml \ bitnami/postgresql-ha ``` @@ -754,7 +754,7 @@ Find more information about how to deal with common errors related to Bitnami's It's necessary to specify the existing passwords while performing a upgrade to ensure the secrets are not updated with invalid randomly generated passwords. Remember to specify the existing values of the `postgresql.password` and `postgresql.repmgrPassword` parameters when upgrading the chart: ```console -$ helm upgrade my-release my-repo/postgresql-ha \ +helm upgrade my-release my-repo/postgresql-ha \ --set postgresql.password=[POSTGRES_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] ``` @@ -795,7 +795,7 @@ A new major version of repmgr (5.3) was included. To upgrade to this major versi - Reduce your PostgreSQL setup to one replica (primary node) and upgrade to `8.0.0`, enabling the repmgr extension upgrade: ```console -$ helm upgrade my-release --version 8.0.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 8.0.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=1 \ @@ -805,7 +805,7 @@ $ helm upgrade my-release --version 8.0.0 my-repo/postgresql-ha \ - Scale your PostgreSQL setup to the original number of replicas: ```console -$ helm upgrade my-release --version 8.0.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 8.0.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=[NUMBER_OF_REPLICAS] @@ -848,7 +848,7 @@ A new version of repmgr (5.2.0) was included. To upgrade to this version, it's - Reduce your PostgreSQL setup to one replica (primary node) and upgrade to `5.2.0`, enabling the repmgr extension upgrade: ```console -$ helm upgrade my-release --version 5.2.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 5.2.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=1 \ @@ -858,7 +858,7 @@ $ helm upgrade my-release --version 5.2.0 my-repo/postgresql-ha \ - Scale your PostgreSQL setup to the original number of replicas: ```console -$ helm upgrade my-release --version 5.2.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 5.2.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=[NUMBER_OF_REPLICAS] @@ -875,17 +875,17 @@ This version is next major version to v3.x.y ```console $ # e.g. Previous deployment v3.9.1 -$ helm install my-release \ +helm install my-release \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ my-repo/postgresql-ha --version 3.9.1 $ # Update repository information -$ helm repo update +helm repo update $ # upgrade to v5.0.0 -$ helm delete my-release -$ helm install my-release \ +helm delete my-release +helm install my-release \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ my-repo/postgresql-ha --version 5.0.0 @@ -902,7 +902,7 @@ A new major version of repmgr (5.1.0) was included. To upgrade to this major ver - Reduce your PostgreSQL setup to one replica (primary node) and upgrade to `3.0.0`, enabling the repmgr extension upgrade: ```console -$ helm upgrade my-release --version 3.0.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 3.0.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=1 \ @@ -912,7 +912,7 @@ $ helm upgrade my-release --version 3.0.0 my-repo/postgresql-ha \ - Scale your PostgreSQL setup to the original number of replicas: ```console -$ helm upgrade my-release --version 3.0.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 3.0.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=[NUMBER_OF_REPLICAS] @@ -936,7 +936,7 @@ A new major version of repmgr (5.0.0) was included. To upgrade to this major ver - Reduce your PostgreSQL setup to one replica (primary node) and upgrade to `1.0.0`, enabling the repmgr extension upgrade: ```console -$ helm upgrade my-release --version 1.0.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 1.0.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=1 \ @@ -946,7 +946,7 @@ $ helm upgrade my-release --version 1.0.0 my-repo/postgresql-ha \ - Scale your PostgreSQL setup to the original number of replicas: ```console -$ helm upgrade my-release --version 1.0.0 my-repo/postgresql-ha \ +helm upgrade my-release --version 1.0.0 my-repo/postgresql-ha \ --set postgresql.password=[POSTGRESQL_PASSWORD] \ --set postgresql.repmgrPassword=[REPMGR_PASSWORD] \ --set postgresql.replicaCount=[NUMBER_OF_REPLICAS] diff --git a/bitnami/postgresql/README.md b/bitnami/postgresql/README.md index 482428131f..821089f5d0 100644 --- a/bitnami/postgresql/README.md +++ b/bitnami/postgresql/README.md @@ -468,7 +468,7 @@ kubectl delete pvc -l release=my-release ```console -$ helm install my-release \ +helm install my-release \ --set auth.postgresPassword=secretpassword my-repo/postgresql ``` diff --git a/bitnami/prestashop/README.md b/bitnami/prestashop/README.md index 0d8a1d2105..453b7ddec5 100644 --- a/bitnami/prestashop/README.md +++ b/bitnami/prestashop/README.md @@ -316,7 +316,7 @@ The above parameters map to the env variables defined in [bitnami/prestashop](ht Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set prestashopUsername=admin,prestashopPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/prestashop ``` @@ -350,14 +350,14 @@ The `image` parameter allows specifying which image will be pulled for the chart If you configure the `image` value to one in a private registry, you will need to [specify an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). 1. Manually create image pull secret(s) in the namespace. See [this YAML example reference](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config). Consult your image registry's documentation about getting the appropriate secret. -1. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: +2. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: -```yaml -imagePullSecrets: - - name: SECRET_NAME -``` + ```yaml + imagePullSecrets: + - name: SECRET_NAME + ``` -1. Install the chart +3. Install the chart ### Setting Pod's affinity @@ -375,8 +375,8 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per ### Existing PersistentVolumeClaim 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/prestashop @@ -392,7 +392,7 @@ helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/prestas #### Mounting steps 1. The specified `hostPath` directory must already exist (create one if it does not). -1. Install the chart +2. Install the chart ```console helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT my-repo/prestashop @@ -400,7 +400,7 @@ helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/prestas This will mount the `prestashop-data` volume into the `hostPath` directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. -1. Because the container cannot control the host machine's directory permissions, you must set the PrestaShop file directory permissions yourself and disable or clear PrestaShop cache. +3. Because the container cannot control the host machine's directory permissions, you must set the PrestaShop file directory permissions yourself and disable or clear PrestaShop cache. ### SSL diff --git a/bitnami/pytorch/README.md b/bitnami/pytorch/README.md index a5b46765ca..47744fb735 100644 --- a/bitnami/pytorch/README.md +++ b/bitnami/pytorch/README.md @@ -209,7 +209,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set mode=distributed \ --set worldSize=4 \ my-repo/pytorch diff --git a/bitnami/rabbitmq-cluster-operator/README.md b/bitnami/rabbitmq-cluster-operator/README.md index 7b3c080beb..9d02f4f42b 100644 --- a/bitnami/rabbitmq-cluster-operator/README.md +++ b/bitnami/rabbitmq-cluster-operator/README.md @@ -390,7 +390,7 @@ The above parameters map to the env variables defined in [bitnami/rabbitmq-clust Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set livenessProbe.enabled=false \ my-repo/rabbitmq-cluster-operator ``` diff --git a/bitnami/rabbitmq/README.md b/bitnami/rabbitmq/README.md index ade7c10c77..a3a75b2081 100644 --- a/bitnami/rabbitmq/README.md +++ b/bitnami/rabbitmq/README.md @@ -365,7 +365,7 @@ The above parameters map to the env variables defined in [bitnami/rabbitmq](http Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.username=admin,auth.password=secretpassword,auth.erlangCookie=secretcookie \ my-repo/rabbitmq ``` @@ -509,7 +509,7 @@ This happens if the pod management policy of the statefulset is not `Parallel` a ```console $ kubectl delete statefulset STATEFULSET_NAME --cascade=false -$ helm upgrade RELEASE_NAME my-repo/rabbitmq \ +helm upgrade RELEASE_NAME my-repo/rabbitmq \ --set podManagementPolicy=Parallel \ --set replicaCount=NUMBER_OF_REPLICAS \ --set auth.password=PASSWORD \ @@ -521,7 +521,7 @@ For a faster resyncronization of the nodes, you can temporarily disable the read If the steps above don't bring the cluster to a healthy state, it could be possible that none of the RabbitMQ nodes think they were the last node to be up during the shutdown. In those cases, you can force the boot of the nodes by specifying the `clustering.forceBoot=true` parameter (which will execute [`rabbitmqctl force_boot`](https://www.rabbitmq.com/rabbitmqctl.8.html#force_boot) in each pod): ```console -$ helm upgrade RELEASE_NAME my-repo/rabbitmq \ +helm upgrade RELEASE_NAME my-repo/rabbitmq \ --set podManagementPolicy=Parallel \ --set clustering.forceBoot=true \ --set replicaCount=NUMBER_OF_REPLICAS \ @@ -544,8 +544,8 @@ The chart mounts a [Persistent Volume](https://kubernetes.io/docs/concepts/stora ### Use existing PersistentVolumeClaims 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/rabbitmq diff --git a/bitnami/redis-cluster/README.md b/bitnami/redis-cluster/README.md index c13258082a..8ca02156d2 100644 --- a/bitnami/redis-cluster/README.md +++ b/bitnami/redis-cluster/README.md @@ -344,7 +344,7 @@ The command removes all the Kubernetes components associated with the chart and ```console -$ helm install my-release \ +helm install my-release \ --set password=secretpassword \ my-repo/redis-cluster ``` diff --git a/bitnami/redis/README.md b/bitnami/redis/README.md index ee27f47c26..275e6f163c 100644 --- a/bitnami/redis/README.md +++ b/bitnami/redis/README.md @@ -551,7 +551,7 @@ The command removes all the Kubernetes components associated with the chart and ```console -$ helm install my-release \ +helm install my-release \ --set auth.password=secretpassword \ my-repo/redis ``` diff --git a/bitnami/redmine/README.md b/bitnami/redmine/README.md index b44ca38f0e..3735c59946 100644 --- a/bitnami/redmine/README.md +++ b/bitnami/redmine/README.md @@ -366,7 +366,7 @@ The above parameters map to the env variables defined in [bitnami/redmine](https Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set redmineUsername=admin,redminePassword=password,mariadb.mariadb.auth.rootPassword=secretpassword \ my-repo/redmine ``` @@ -488,9 +488,9 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per The following example includes two PVCs, one for Redmine and another for MariaDB. 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Create the directory, on a worker -1. Install the chart +2. Create the PersistentVolumeClaim +3. Create the directory, on a worker +4. Install the chart ```console helm install test --set persistence.existingClaim=PVC_REDMINE,mariadb.persistence.existingClaim=PVC_MARIADB my-repo/redmine diff --git a/bitnami/schema-registry/README.md b/bitnami/schema-registry/README.md index 4fb06cbe31..a30f79fc44 100644 --- a/bitnami/schema-registry/README.md +++ b/bitnami/schema-registry/README.md @@ -249,7 +249,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set replicaCount=2 \ my-repo/schema-registry ``` diff --git a/bitnami/sealed-secrets/README.md b/bitnami/sealed-secrets/README.md index bb36676945..a99aee15ed 100644 --- a/bitnami/sealed-secrets/README.md +++ b/bitnami/sealed-secrets/README.md @@ -218,7 +218,7 @@ The command removes all the Kubernetes components associated with the chart and ```console -$ helm install my-release \ +helm install my-release \ --set livenessProbe.successThreshold=5 \ my-repo/sealed-secrets ``` diff --git a/bitnami/solr/README.md b/bitnami/solr/README.md index b74e17aa94..f5eacda54d 100644 --- a/bitnami/solr/README.md +++ b/bitnami/solr/README.md @@ -348,7 +348,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set cloudEnabled=true my-repo/solr ``` diff --git a/bitnami/sonarqube/README.md b/bitnami/sonarqube/README.md index cdcb250d1b..95618ca728 100644 --- a/bitnami/sonarqube/README.md +++ b/bitnami/sonarqube/README.md @@ -366,7 +366,7 @@ The above parameters map to the env variables defined in [bitnami/sonarqube](htt Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set sonarqubeUsername=admin \ --set sonarqubePassword=password \ --set postgresql.auth.password=secretpassword \ diff --git a/bitnami/spark/README.md b/bitnami/spark/README.md index ec0b0764ca..8f1bafa66d 100644 --- a/bitnami/spark/README.md +++ b/bitnami/spark/README.md @@ -327,7 +327,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set master.webPort=8081 my-repo/spark ``` diff --git a/bitnami/spring-cloud-dataflow/README.md b/bitnami/spring-cloud-dataflow/README.md index 3f1406d72e..d2fe515031 100644 --- a/bitnami/spring-cloud-dataflow/README.md +++ b/bitnami/spring-cloud-dataflow/README.md @@ -703,22 +703,22 @@ To upgrade to *6.0.0* from *5.x* using Kafka as messaging solution, it should be 1. Obtain the credentials on your current release: -```console -export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default scdf-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 -d) -export MARIADB_PASSWORD=$(kubectl get secret --namespace default scdf-mariadb -o jsonpath="{.data.mariadb-password}" | base64 -d) -``` + ```console + export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default scdf-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 -d) + export MARIADB_PASSWORD=$(kubectl get secret --namespace default scdf-mariadb -o jsonpath="{.data.mariadb-password}" | base64 -d) + ``` -1. Upgrade your release using the same Kafka version: +2. Upgrade your release using the same Kafka version: -```console -$ export CURRENT_KAFKA_VERSION=$(kubectl exec scdf-kafka-0 -- bash -c 'echo $BITNAMI_IMAGE_VERSION') -$ helm upgrade scdf my-repo/spring-cloud-dataflow \ - --set rabbitmq.enabled=false \ - --set kafka.enabled=true \ - --set kafka.image.tag=$CURRENT_KAFKA_VERSION \ - --set mariadb.auth.password=$MARIADB_PASSWORD \ - --set mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD -``` + ```console + $ export CURRENT_KAFKA_VERSION=$(kubectl exec scdf-kafka-0 -- bash -c 'echo $BITNAMI_IMAGE_VERSION') + helm upgrade scdf my-repo/spring-cloud-dataflow \ + --set rabbitmq.enabled=false \ + --set kafka.enabled=true \ + --set kafka.image.tag=$CURRENT_KAFKA_VERSION \ + --set mariadb.auth.password=$MARIADB_PASSWORD \ + --set mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD + ``` ### To 5.0.0 @@ -796,7 +796,7 @@ export RABBITMQ_ERLANG_COOKIE=$(kubectl get secret --namespace default dataflow- Upgrade your release (maintaining the version) disabling MariaDB and scaling Data Flow replicas to 0: ```console -$ helm upgrade dataflow my-repo/spring-cloud-dataflow --version 0.7.4 \ +helm upgrade dataflow my-repo/spring-cloud-dataflow --version 0.7.4 \ --set server.replicaCount=0 \ --set skipper.replicaCount=0 \ --set mariadb.enabled=false \ @@ -807,7 +807,7 @@ $ helm upgrade dataflow my-repo/spring-cloud-dataflow --version 0.7.4 \ Finally, upgrade you release to 1.0.0 reusing the existing PVC, and enabling back MariaDB: ```console -$ helm upgrade dataflow my-repo/spring-cloud-dataflow \ +helm upgrade dataflow my-repo/spring-cloud-dataflow \ --set mariadb.primary.persistence.existingClaim=$MARIADB_PVC \ --set mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD \ --set mariadb.auth.password=$MARIADB_PASSWORD \ diff --git a/bitnami/suitecrm/README.md b/bitnami/suitecrm/README.md index 2f6270d87a..07bbd9d61f 100644 --- a/bitnami/suitecrm/README.md +++ b/bitnami/suitecrm/README.md @@ -326,7 +326,7 @@ The above parameters map to the env variables defined in [bitnami/suitecrm](http Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set suitecrmUsername=admin,suitecrmPassword=password,mariadb.auth.rootPassword=secretpassword \ my-repo/suitecrm ``` @@ -360,14 +360,14 @@ The `image` parameter allows specifying which image will be pulled for the chart If you configure the `image` value to one in a private registry, you will need to [specify an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). 1. Manually create image pull secret(s) in the namespace. See [this YAML example reference](https://kubernetes.io/docs/concepts/containers/images/#creating-a-secret-with-a-docker-config). Consult your image registry's documentation about getting the appropriate secret. -1. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: +2. Note that the `imagePullSecrets` configuration value cannot currently be passed to helm using the `--set` parameter, so you must supply these using a `values.yaml` file, such as: ```yaml imagePullSecrets: - name: SECRET_NAME ``` -1. Install the chart +3. Install the chart ### Setting Pod's affinity @@ -385,8 +385,8 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per ### Existing PersistentVolumeClaim 1. Create the PersistentVolume -1. Create the PersistentVolumeClaim -1. Install the chart +2. Create the PersistentVolumeClaim +3. Install the chart ```console helm install my-release --set persistence.existingClaim=PVC_NAME my-repo/suitecrm @@ -402,14 +402,14 @@ See the [Parameters](#parameters) section to configure the PVC or to disable per #### Mounting steps 1. The specified `hostPath` directory must already exist (create one if it does not). -1. Install the chart +2. Install the chart ```console helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT my-repo/suitecrm ``` This will mount the `suitecrm-data` volume into the `hostPath` directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. -1. Because the container cannot control the host machine's directory permissions, you must set the SuiteCRM file directory permissions yourself and disable or clear SuiteCRM cache. +3. Because the container cannot control the host machine's directory permissions, you must set the SuiteCRM file directory permissions yourself and disable or clear SuiteCRM cache. ## Troubleshooting diff --git a/bitnami/thanos/README.md b/bitnami/thanos/README.md index 6851d79489..c5a78bfa65 100644 --- a/bitnami/thanos/README.md +++ b/bitnami/thanos/README.md @@ -1369,11 +1369,11 @@ For Helm 3: ```console $ kubectl create namespace monitoring -$ helm install kube-prometheus \ +helm install kube-prometheus \ --set prometheus.thanos.create=true \ --namespace monitoring \ bitnami/kube-prometheus -$ helm install thanos \ +helm install thanos \ --values values.yaml \ --namespace monitoring \ my-repo/thanos diff --git a/bitnami/tomcat/README.md b/bitnami/tomcat/README.md index 777bd5d1d6..9e54bb89a4 100644 --- a/bitnami/tomcat/README.md +++ b/bitnami/tomcat/README.md @@ -248,7 +248,7 @@ The above parameters map to the env variables defined in [bitnami/tomcat](https: Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set tomcatUsername=manager,tomcatPassword=password my-repo/tomcat ``` diff --git a/bitnami/wavefront-hpa-adapter/README.md b/bitnami/wavefront-hpa-adapter/README.md index 017f196b34..89a67b7ff9 100644 --- a/bitnami/wavefront-hpa-adapter/README.md +++ b/bitnami/wavefront-hpa-adapter/README.md @@ -174,7 +174,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set livenessProbe.successThreshold=5 \ my-repo/wavefront-hpa-adapter ``` diff --git a/bitnami/wavefront-prometheus-storage-adapter/README.md b/bitnami/wavefront-prometheus-storage-adapter/README.md index ae031792fc..1e9fba4200 100644 --- a/bitnami/wavefront-prometheus-storage-adapter/README.md +++ b/bitnami/wavefront-prometheus-storage-adapter/README.md @@ -180,7 +180,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set livenessProbe.successThreshold=5 \ my-repo/wavefront-prometheus-storage-adapter ``` diff --git a/bitnami/wavefront/README.md b/bitnami/wavefront/README.md index 182c1d40b6..36f79ef29d 100644 --- a/bitnami/wavefront/README.md +++ b/bitnami/wavefront/README.md @@ -9,8 +9,8 @@ Wavefront is a high-performance streaming analytics platform for monitoring and ## TL;DR ```console -$ helm repo add my-repo https://charts.bitnami.com/bitnami -$ helm install my-release my-repo/wavefront --namespace wavefront --create-namespace \ +helm repo add my-repo https://charts.bitnami.com/bitnami +helm install my-release my-repo/wavefront --namespace wavefront --create-namespace \ --set clusterName= \ --set wavefront.url=https://.wavefront.com \ --set wavefront.token= @@ -35,8 +35,8 @@ Bitnami charts can be used with [Kubeapps](https://kubeapps.dev/) for deployment To install the chart with the release name `my-release`: ```console -$ helm repo add my-repo https://charts.bitnami.com/bitnami -$ helm install my-release my-repo/wavefront --namespace wavefront --create-namespace\ +helm repo add my-repo https://charts.bitnami.com/bitnami +helm install my-release my-repo/wavefront --namespace wavefront --create-namespace\ --set clusterName= \ --set wavefront.url=https://.wavefront.com \ --set wavefront.token= @@ -269,7 +269,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set proxy.replicaCount=3 \ my-repo/wavefront ``` diff --git a/bitnami/wildfly/README.md b/bitnami/wildfly/README.md index 8978da2657..206de628aa 100644 --- a/bitnami/wildfly/README.md +++ b/bitnami/wildfly/README.md @@ -228,7 +228,7 @@ The above parameters map to the env variables defined in [bitnami/wildfly](https Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set wildflyUser=manager,wildflyPassword=password \ my-repo/wildfly ``` diff --git a/bitnami/wordpress/README.md b/bitnami/wordpress/README.md index 154582e1cb..1c144be528 100644 --- a/bitnami/wordpress/README.md +++ b/bitnami/wordpress/README.md @@ -6,8 +6,6 @@ WordPress is the world's most popular blogging and content management platform. [Overview of WordPress](http://www.wordpress.org) - - ## TL;DR ```console @@ -63,7 +61,6 @@ The command removes all the Kubernetes components associated with the chart and | `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` | | `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` | - ### Common parameters | Name | Description | Value | @@ -79,7 +76,6 @@ The command removes all the Kubernetes components associated with the chart and | `diagnosticMode.command` | Command to override all containers in the deployment | `["sleep"]` | | `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` | - ### WordPress Image parameters | Name | Description | Value | @@ -92,7 +88,6 @@ The command removes all the Kubernetes components associated with the chart and | `image.pullSecrets` | WordPress image pull secrets | `[]` | | `image.debug` | Specify if debug values should be set | `false` | - ### WordPress Configuration parameters | Name | Description | Value | @@ -132,7 +127,6 @@ The command removes all the Kubernetes components associated with the chart and | `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars | `""` | | `extraEnvVarsSecret` | Name of existing Secret containing extra env vars | `""` | - ### WordPress Multisite Configuration parameters | Name | Description | Value | @@ -142,7 +136,6 @@ The command removes all the Kubernetes components associated with the chart and | `multisite.networkType` | WordPress Multisite network type to enable. Allowed values: `subfolder`, `subdirectory` or `subdomain`. | `subdomain` | | `multisite.enableNipIoRedirect` | Whether to enable IP address redirection to nip.io wildcard DNS. Useful when running on an IP address with subdomain network type. | `false` | - ### WordPress deployment parameters | Name | Description | Value | @@ -205,7 +198,6 @@ The command removes all the Kubernetes components associated with the chart and | `customStartupProbe` | Custom startupProbe that overrides the default one | `{}` | | `lifecycleHooks` | for the WordPress container(s) to automate configuration before or after startup | `{}` | - ### Traffic Exposure Parameters | Name | Description | Value | @@ -240,7 +232,6 @@ The command removes all the Kubernetes components associated with the chart and | `ingress.secrets` | Custom TLS certificates as secrets | `[]` | | `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` | - ### Persistence Parameters | Name | Description | Value | @@ -265,7 +256,6 @@ The command removes all the Kubernetes components associated with the chart and | `volumePermissions.resources.requests` | The requested resources for the init container | `{}` | | `volumePermissions.containerSecurityContext.runAsUser` | User ID for the init container | `0` | - ### Other Parameters | Name | Description | Value | @@ -283,7 +273,6 @@ The command removes all the Kubernetes components associated with the chart and | `autoscaling.targetCPU` | Target CPU utilization percentage | `50` | | `autoscaling.targetMemory` | Target Memory utilization percentage | `50` | - ### Metrics Parameters | Name | Description | Value | @@ -332,7 +321,6 @@ The command removes all the Kubernetes components associated with the chart and | `metrics.serviceMonitor.honorLabels` | Specify honorLabels parameter to add the scrape endpoint | `false` | | `metrics.serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in prometheus. | `""` | - ### NetworkPolicy parameters | Name | Description | Value | @@ -353,7 +341,6 @@ The command removes all the Kubernetes components associated with the chart and | `networkPolicy.egressRules.denyConnectionsToExternal` | Enable egress rule that denies outgoing traffic outside the cluster, except for DNS (port 53). | `false` | | `networkPolicy.egressRules.customRules` | Custom network policy rule | `{}` | - ### Database Parameters | Name | Description | Value | @@ -382,12 +369,10 @@ The command removes all the Kubernetes components associated with the chart and | `externalCache.host` | External cache server host | `localhost` | | `externalCache.port` | External cache server port | `11211` | - - Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set wordpressUsername=admin \ --set wordpressPassword=password \ --set mariadb.auth.rootPassword=secretpassword \ @@ -644,4 +629,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/bitnami/zookeeper/README.md b/bitnami/zookeeper/README.md index e80547dbb9..4b6104d025 100644 --- a/bitnami/zookeeper/README.md +++ b/bitnami/zookeeper/README.md @@ -317,7 +317,7 @@ The command removes all the Kubernetes components associated with the chart and Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console -$ helm install my-release \ +helm install my-release \ --set auth.clientUser=newUser \ my-repo/zookeeper ``` @@ -352,7 +352,7 @@ First, ensure that you are not getting metrics via the deprecated pattern of pol Second, to avoid the connection/disconnection messages from the probes, you can set custom values for these checks which direct them to the ZooKeeper Admin Server instead of the client port. By default, an Admin Server will be started that listens on `localhost` at port `8080`. The following is an example of this use of the Admin Server for probes: -``` +```yaml livenessProbe: enabled: false readinessProbe: