Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-03-27 15:27:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/*] Standardize documentation (#19835)

Browse Source 
Signed-off-by: Jota Martos <jotamartos@vmware.com>
This commit is contained in:
Juan José Martos
2023-10-20 08:18:30 +02:00
committed by GitHub
parent 3e0672c0ad
commit af5f7530c1
216 changed files with 14699 additions and 13690 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
bitnami/clickhouse/README.md
View File

@@ -11,9 +11,11 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/clickhouse
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/clickhouse
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
## Introduction
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
@@ -42,9 +44,11 @@ Looking to use ClickHouse in production? Try [VMware Application Catalog](https:
To install the chart with the release name `my-release`:
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/clickhouse
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/clickhouse
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
The command deploys ClickHouse on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list`
@@ -87,65 +91,65 @@ The command removes all the Kubernetes components associated with the chart and
### ClickHouse Parameters
| Name | Description | Value |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | --------------------- |
| `image.registry` | ClickHouse image registry | `docker.io` |
| `image.repository` | ClickHouse image repository | `bitnami/clickhouse` |
| `image.tag` | ClickHouse image tag (immutable tags are recommended) | `23.9.2-debian-11-r0` |
| `image.digest` | ClickHouse image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | ClickHouse image pull policy | `IfNotPresent` |
| `image.pullSecrets` | ClickHouse image pull secrets | `[]` |
| `image.debug` | Enable ClickHouse image debug mode | `false` |
| `shards` | Number of ClickHouse shards to deploy | `2` |
| `replicaCount` | Number of ClickHouse replicas per shard to deploy | `3` |
| `distributeReplicasByZone` | Schedules replicas of the same shard to different availability zones | `false` |
| `containerPorts.http` | ClickHouse HTTP container port | `8123` |
| `containerPorts.https` | ClickHouse HTTPS container port | `8443` |
| `containerPorts.tcp` | ClickHouse TCP container port | `9000` |
| `containerPorts.tcpSecure` | ClickHouse TCP (secure) container port | `9440` |
| `containerPorts.keeper` | ClickHouse keeper TCP container port | `2181` |
| `containerPorts.keeperSecure` | ClickHouse keeper TCP (secure) container port | `3181` |
| `containerPorts.keeperInter` | ClickHouse keeper interserver TCP container port | `9444` |
| `containerPorts.mysql` | ClickHouse MySQL container port | `9004` |
| `containerPorts.postgresql` | ClickHouse PostgreSQL container port | `9005` |
| `containerPorts.interserver` | ClickHouse Interserver container port | `9009` |
| `containerPorts.metrics` | ClickHouse metrics container port | `8001` |
| `livenessProbe.enabled` | Enable livenessProbe on ClickHouse containers | `true` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `10` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `1` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `3` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `readinessProbe.enabled` | Enable readinessProbe on ClickHouse containers | `true` |
| `readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `10` |
| `readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `1` |
| `readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `3` |
| `readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `startupProbe.enabled` | Enable startupProbe on ClickHouse containers | `false` |
| `startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `10` |
| `startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `1` |
| `startupProbe.failureThreshold` | Failure threshold for startupProbe | `3` |
| `startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `customLivenessProbe` | Custom livenessProbe that overrides the default one | `{}` |
| `customReadinessProbe` | Custom readinessProbe that overrides the default one | `{}` |
| `customStartupProbe` | Custom startupProbe that overrides the default one | `{}` |
| `resources.limits` | The resources limits for the ClickHouse containers | `{}` |
| `resources.requests` | The requested resources for the ClickHouse containers | `{}` |
| `podSecurityContext.enabled` | Enabled ClickHouse pods' Security Context | `true` |
| `podSecurityContext.fsGroup` | Set ClickHouse pod's Security Context fsGroup | `1001` |
| `podSecurityContext.seccompProfile.type` | Set ClickHouse container's Security Context seccomp profile | `RuntimeDefault` |
| `containerSecurityContext.enabled` | Enabled ClickHouse containers' Security Context | `true` |
| `containerSecurityContext.runAsUser` | Set ClickHouse containers' Security Context runAsUser | `1001` |
| `containerSecurityContext.runAsNonRoot` | Set ClickHouse containers' Security Context runAsNonRoot | `true` |
| `containerSecurityContext.allowPrivilegeEscalation` | Set ClickHouse container's privilege escalation | `false` |
| `containerSecurityContext.capabilities.drop` | Set ClickHouse container's Security Context runAsNonRoot | `["ALL"]` |
| `auth.username` | ClickHouse Admin username | `default` |
| `auth.password` | ClickHouse Admin password | `""` |
| `auth.existingSecret` | Name of a secret containing the Admin password | `""` |
| `auth.existingSecretKey` | Name of the key inside the existing secret | `""` |
| `logLevel` | Logging level | `information` |
| Name | Description | Value |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `image.registry` | ClickHouse image registry | `REGISTRY_NAME` |
| `image.repository` | ClickHouse image repository | `REPOSITORY_NAME/clickhouse` |
| `image.tag` | ClickHouse image tag (immutable tags are recommended) | `23.9.2-debian-11-r0` |
| `image.digest` | ClickHouse image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | ClickHouse image pull policy | `IfNotPresent` |
| `image.pullSecrets` | ClickHouse image pull secrets | `[]` |
| `image.debug` | Enable ClickHouse image debug mode | `false` |
| `shards` | Number of ClickHouse shards to deploy | `2` |
| `replicaCount` | Number of ClickHouse replicas per shard to deploy | `3` |
| `distributeReplicasByZone` | Schedules replicas of the same shard to different availability zones | `false` |
| `containerPorts.http` | ClickHouse HTTP container port | `8123` |
| `containerPorts.https` | ClickHouse HTTPS container port | `8443` |
| `containerPorts.tcp` | ClickHouse TCP container port | `9000` |
| `containerPorts.tcpSecure` | ClickHouse TCP (secure) container port | `9440` |
| `containerPorts.keeper` | ClickHouse keeper TCP container port | `2181` |
| `containerPorts.keeperSecure` | ClickHouse keeper TCP (secure) container port | `3181` |
| `containerPorts.keeperInter` | ClickHouse keeper interserver TCP container port | `9444` |
| `containerPorts.mysql` | ClickHouse MySQL container port | `9004` |
| `containerPorts.postgresql` | ClickHouse PostgreSQL container port | `9005` |
| `containerPorts.interserver` | ClickHouse Interserver container port | `9009` |
| `containerPorts.metrics` | ClickHouse metrics container port | `8001` |
| `livenessProbe.enabled` | Enable livenessProbe on ClickHouse containers | `true` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `10` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `1` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `3` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `readinessProbe.enabled` | Enable readinessProbe on ClickHouse containers | `true` |
| `readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `10` |
| `readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `1` |
| `readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `3` |
| `readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `startupProbe.enabled` | Enable startupProbe on ClickHouse containers | `false` |
| `startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `10` |
| `startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `1` |
| `startupProbe.failureThreshold` | Failure threshold for startupProbe | `3` |
| `startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `customLivenessProbe` | Custom livenessProbe that overrides the default one | `{}` |
| `customReadinessProbe` | Custom readinessProbe that overrides the default one | `{}` |
| `customStartupProbe` | Custom startupProbe that overrides the default one | `{}` |
| `resources.limits` | The resources limits for the ClickHouse containers | `{}` |
| `resources.requests` | The requested resources for the ClickHouse containers | `{}` |
| `podSecurityContext.enabled` | Enabled ClickHouse pods' Security Context | `true` |
| `podSecurityContext.fsGroup` | Set ClickHouse pod's Security Context fsGroup | `1001` |
| `podSecurityContext.seccompProfile.type` | Set ClickHouse container's Security Context seccomp profile | `RuntimeDefault` |
| `containerSecurityContext.enabled` | Enabled ClickHouse containers' Security Context | `true` |
| `containerSecurityContext.runAsUser` | Set ClickHouse containers' Security Context runAsUser | `1001` |
| `containerSecurityContext.runAsNonRoot` | Set ClickHouse containers' Security Context runAsNonRoot | `true` |
| `containerSecurityContext.allowPrivilegeEscalation` | Set ClickHouse container's privilege escalation | `false` |
| `containerSecurityContext.capabilities.drop` | Set ClickHouse container's Security Context runAsNonRoot | `["ALL"]` |
| `auth.username` | ClickHouse Admin username | `default` |
| `auth.password` | ClickHouse Admin password | `""` |
| `auth.existingSecret` | Name of a secret containing the Admin password | `""` |
| `auth.existingSecretKey` | Name of the key inside the existing secret | `""` |
| `logLevel` | Logging level | `information` |
### ClickHouse keeper configuration parameters
@@ -295,17 +299,17 @@ The command removes all the Kubernetes components associated with the chart and
### Init Container Parameters
| Name | Description | Value |
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | ------------------ |
| `volumePermissions.enabled` | Enable init container that changes the owner/group of the PV mount point to `runAsUser:fsGroup` | `false` |
| `volumePermissions.image.registry` | OS Shell + Utility image registry | `docker.io` |
| `volumePermissions.image.repository` | OS Shell + Utility image repository | `bitnami/os-shell` |
| `volumePermissions.image.tag` | OS Shell + Utility image tag (immutable tags are recommended) | `11-debian-11-r90` |
| `volumePermissions.image.pullPolicy` | OS Shell + Utility image pull policy | `IfNotPresent` |
| `volumePermissions.image.pullSecrets` | OS Shell + Utility image pull secrets | `[]` |
| `volumePermissions.resources.limits` | The resources limits for the init container | `{}` |
| `volumePermissions.resources.requests` | The requested resources for the init container | `{}` |
| `volumePermissions.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` |
| Name | Description | Value |
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -------------------------- |
| `volumePermissions.enabled` | Enable init container that changes the owner/group of the PV mount point to `runAsUser:fsGroup` | `false` |
| `volumePermissions.image.registry` | OS Shell + Utility image registry | `REGISTRY_NAME` |
| `volumePermissions.image.repository` | OS Shell + Utility image repository | `REPOSITORY_NAME/os-shell` |
| `volumePermissions.image.tag` | OS Shell + Utility image tag (immutable tags are recommended) | `11-debian-11-r90` |
| `volumePermissions.image.pullPolicy` | OS Shell + Utility image pull policy | `IfNotPresent` |
| `volumePermissions.image.pullSecrets` | OS Shell + Utility image pull secrets | `[]` |
| `volumePermissions.resources.limits` | The resources limits for the init container | `{}` |
| `volumePermissions.resources.requests` | The requested resources for the init container | `{}` |
| `volumePermissions.containerSecurityContext.runAsUser` | Set init container's Security Context runAsUser | `0` |
### Other Parameters
@@ -342,15 +346,15 @@ The command removes all the Kubernetes components associated with the chart and
### Zookeeper subchart parameters
| Name | Description | Value |
| -------------------------------- | ---------------------------------------------------- | -------------------- |
| `zookeeper.enabled` | Deploy Zookeeper subchart | `true` |
| `zookeeper.replicaCount` | Number of Zookeeper instances | `3` |
| `zookeeper.service.ports.client` | Zookeeper client port | `2181` |
| `zookeeper.image.registry` | Zookeeper image registry | `docker.io` |
| `zookeeper.image.repository` | Zookeeper image repository | `bitnami/zookeeper` |
| `zookeeper.image.tag` | Zookeeper image tag (immutable tags are recommended) | `3.8.3-debian-11-r1` |
| `zookeeper.image.pullPolicy` | Zookeeper image pull policy | `IfNotPresent` |
| Name | Description | Value |
| -------------------------------- | ---------------------------------------------------- | --------------------------- |
| `zookeeper.enabled` | Deploy Zookeeper subchart | `true` |
| `zookeeper.replicaCount` | Number of Zookeeper instances | `3` |
| `zookeeper.service.ports.client` | Zookeeper client port | `2181` |
| `zookeeper.image.registry` | Zookeeper image registry | `REGISTRY_NAME` |
| `zookeeper.image.repository` | Zookeeper image repository | `REPOSITORY_NAME/zookeeper` |
| `zookeeper.image.tag` | Zookeeper image tag (immutable tags are recommended) | `3.8.3-debian-11-r1` |
| `zookeeper.image.pullPolicy` | Zookeeper image pull policy | `IfNotPresent` |
See <https://github.com/bitnami-labs/readme-generator-for-helm> to create the table.
@@ -362,9 +366,11 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
helm install my-release \
--set auth.username=admin \
--set auth.password=password \
oci://registry-1.docker.io/bitnamicharts/clickhouse
oci://REGISTRY_NAME/REPOSITORY_NAME/clickhouse
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
The above command sets the ClickHouse administrator account username and password to `admin` and `password` respectively.
> NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.
@@ -372,9 +378,10 @@ The above command sets the ClickHouse administrator account username and passwor
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 oci://registry-1.docker.io/bitnamicharts/clickhouse
helm install my-release -f values.yaml oci://REGISTRY_NAME/REPOSITORY_NAME/clickhouse
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
> **Tip**: You can use the default [values.yaml](values.yaml)
## Configuration and installation details

12
bitnami/clickhouse/values.yaml
View File

@@ -68,8 +68,8 @@ diagnosticMode:
## Bitnami ClickHouse image
## ref: https://hub.docker.com/r/bitnami/clickhouse/tags/
## @param image.registry ClickHouse image registry
## @param image.repository ClickHouse image repository
## @param image.registry [default: REGISTRY_NAME] ClickHouse image registry
## @param image.repository [default: REPOSITORY_NAME/clickhouse] ClickHouse image repository
## @param image.tag ClickHouse image tag (immutable tags are recommended)
## @param image.digest ClickHouse image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param image.pullPolicy ClickHouse image pull policy
@@ -957,8 +957,8 @@ volumePermissions:
enabled: false
## OS Shell + Utility image
## ref: https://hub.docker.com/r/bitnami/os-shell/tags/
## @param volumePermissions.image.registry OS Shell + Utility image registry
## @param volumePermissions.image.repository OS Shell + Utility image repository
## @param volumePermissions.image.registry [default: REGISTRY_NAME] OS Shell + Utility image registry
## @param volumePermissions.image.repository [default: REPOSITORY_NAME/os-shell] OS Shell + Utility image repository
## @param volumePermissions.image.tag OS Shell + Utility image tag (immutable tags are recommended)
## @param volumePermissions.image.pullPolicy OS Shell + Utility image pull policy
## @param volumePermissions.image.pullSecrets OS Shell + Utility image pull secrets
@@ -1112,8 +1112,8 @@ zookeeper:
enabled: true
## Override zookeeper default image as 3.9 is not supported https://github.com/ClickHouse/ClickHouse/issues/53749
## ref: https://github.com/bitnami/containers/tree/main/bitnami/zookeeper
## @param zookeeper.image.registry Zookeeper image registry
## @param zookeeper.image.repository Zookeeper image repository
## @param zookeeper.image.registry [default: REGISTRY_NAME] Zookeeper image registry
## @param zookeeper.image.repository [default: REPOSITORY_NAME/zookeeper] Zookeeper image repository
## @param zookeeper.image.tag Zookeeper image tag (immutable tags are recommended)
## @param zookeeper.image.pullPolicy Zookeeper image pull policy
image: