mirror of
https://github.com/bitnami/charts.git
synced 2026-04-01 06:47:23 +08:00
[bitnami/*] Fix markdown linter issues (#14874)
* [bitnami/*] Fix markdown linter issues Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Fix more issues Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Fix petetes Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Update README.md with readme-generator-for-helm Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com> --------- Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com> Co-authored-by: Bitnami Containers <bitnami-bot@vmware.com>
This commit is contained in:
Carlos Rodríguez Hernández
committed by
GitHub
GitHub
parent
f7f24d66da
commit
a51e0e8d35
@@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
$ helm repo add my-repo https://charts.bitnami.com/bitnami
|
||||
$ helm install my-release my-repo/sonarqube
|
||||
helm repo add my-repo https://charts.bitnami.com/bitnami
|
||||
helm install my-release my-repo/sonarqube
|
||||
```
|
||||
|
||||
## Introduction
|
||||
@@ -31,8 +31,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/sonarqube
|
||||
helm repo add my-repo https://charts.bitnami.com/bitnami
|
||||
helm install my-release my-repo/sonarqube
|
||||
```
|
||||
|
||||
The command deploys SonarQube™ on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
|
||||
@@ -44,7 +44,7 @@ The command deploys SonarQube™ on the Kubernetes cluster in the default co
|
||||
To uninstall/delete the `my-release` deployment:
|
||||
|
||||
```console
|
||||
$ helm delete my-release
|
||||
helm delete my-release
|
||||
```
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
||||
@@ -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 deployment | `["sleep"]` |
|
||||
| `diagnosticMode.args` | Args to override all containers in the deployment | `["infinity"]` |
|
||||
|
||||
|
||||
### SonarQube™ Image parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -88,7 +86,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `image.pullSecrets` | SonarQube™ image pull secrets | `[]` |
|
||||
| `image.debug` | Enable SonarQube™ image debug mode | `false` |
|
||||
|
||||
|
||||
### SonarQube™ Configuration parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -110,8 +107,8 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `ldap.url` | URL of the LDAP server. If you are using ldaps, you should install the server certificate into the Java truststore | `""` |
|
||||
| `ldap.bindDn` | The username of an LDAP user to connect (or bind) with. Leave this blank for anonymous access to the LDAP directory. | `""` |
|
||||
| `ldap.bindPassword` | The password of the user to connect with. Leave this blank for anonymous access to the LDAP directory. | `""` |
|
||||
| `ldap.authentication` | Possible values: simple, CRAM-MD5, DIGEST-MD5, GSSAPI. See the tutorial on authentication mechanisms (http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html) | `simple` |
|
||||
| `ldap.realm` | See Digest-MD5 Authentication, CRAM-MD5 Authentication (http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html) | `""` |
|
||||
| `ldap.authentication` | Possible values: simple, CRAM-MD5, DIGEST-MD5, GSSAPI. See the tutorial on authentication mechanisms (<http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html>) | `simple` |
|
||||
| `ldap.realm` | See Digest-MD5 Authentication, CRAM-MD5 Authentication (<http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html>) | `""` |
|
||||
| `ldap.contextFactoryClass` | Context factory class. | `com.sun.jndi.ldap.LdapCtxFactory` |
|
||||
| `ldap.StartTLS` | Enable use of StartTLS | `false` |
|
||||
| `ldap.followReferrals` | Follow referrals or not | `true` |
|
||||
@@ -134,7 +131,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars for SonarQube™ nodes | `""` |
|
||||
| `extraEnvVarsSecret` | Name of existing Secret containing extra env vars for SonarQube™ nodes | `""` |
|
||||
|
||||
|
||||
### SonarQube™ deployment parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -190,7 +186,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `sidecars` | Add additional sidecar containers to the SonarQube™ pod(s) | `[]` |
|
||||
| `initContainers` | Add additional init containers to the SonarQube™ pod(s) | `[]` |
|
||||
|
||||
|
||||
### Traffic Exposure Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -223,7 +218,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 | `[]` |
|
||||
|
||||
|
||||
### SonarQube caCerts provisioning parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -240,7 +234,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `caCerts.resources.requests` | The requested resources for the init container | `{}` |
|
||||
| `caCerts.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` |
|
||||
|
||||
|
||||
### SonarQube plugin provisioning parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -258,7 +251,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `plugins.resources.requests` | The requested resources for the init container | `{}` |
|
||||
| `plugins.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` |
|
||||
|
||||
|
||||
### Persistence Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -281,7 +273,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` |
|
||||
|
||||
|
||||
### Sysctl Image parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -296,7 +287,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `sysctl.resources.limits` | The resources limits for the init container | `{}` |
|
||||
| `sysctl.resources.requests` | The requested resources for the init container | `{}` |
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -312,7 +302,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 |
|
||||
@@ -344,7 +333,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 | `{}` |
|
||||
|
||||
|
||||
### PostgreSQL subchart settings
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -362,7 +350,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `postgresql.primary.persistence.accessMode` | PVC Access Mode for PostgreSQL volume | `ReadWriteOnce` |
|
||||
| `postgresql.primary.persistence.size` | PVC Storage Request for PostgreSQL volume | `8Gi` |
|
||||
|
||||
|
||||
### External Database settings
|
||||
|
||||
| Name | Description | Value |
|
||||
@@ -374,7 +361,6 @@ The command removes all the Kubernetes components associated with the chart and
|
||||
| `externalDatabase.database` | Database inside an external PostgreSQL to connect (only if postgresql.enabled=false) | `sonarqube` |
|
||||
| `externalDatabase.port` | Port of an external PostgreSQL to connect (only if postgresql.enabled=false) | `5432` |
|
||||
|
||||
|
||||
The above parameters map to the env variables defined in [bitnami/sonarqube](https://github.com/bitnami/containers/tree/main/bitnami/sonarqube). For more information please refer to the [bitnami/sonarqube](https://github.com/bitnami/containers/tree/main/bitnami/sonarqube) image documentation.
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
||||
@@ -394,7 +380,7 @@ The above command sets the sonarqube administrator account username and 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 -f values.yaml my-repo/sonarqube
|
||||
helm install my-release -f values.yaml my-repo/sonarqube
|
||||
```
|
||||
|
||||
> **Tip**: You can use the default [values.yaml](values.yaml)
|
||||
@@ -489,7 +475,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
<http://www.apache.org/licenses/LICENSE-2.0>
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
|
||||
Reference in New Issue
Block a user