bitnamicharts/clickhouse-operator repository overview

⁠Bitnami Secure Images Helm chart for ClickHouse Operator

ClickHouse Operator is a production-ready operator that manages ClickHouse databases delivering robust features required for cost-efficient, real-time analytic applications.

Overview of ClickHouse Operator⁠

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

⁠ TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/clickhouse-operator

⁠ 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.

This chart bootstraps a ClickHouse Operator⁠ Deployment in a Kubernetes⁠ cluster using the Helm⁠ package manager.

⁠ Before you begin

• Kubernetes 1.23+
• Helm 3.8.0+
• PV provisioner support in the underlying infrastructure
• ReadWriteMany volumes for deployment scaling

⁠ Installing the Chart

To install the chart with the release name my-release:

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/clickhouse-operator

The command deploys ClickHouse Operator on the Kubernetes cluster in the default configuration. The Parameters⁠ section lists the parameters that can be configured during installation.

⁠ Configuration and installation details

This section describes credentials, configuration, and other installation options.

⁠ Configure the operator

The ClickHouse Operator chart is designed to be easily configurable. The default configuration is suitable for most use cases, but you can customize it to suit your needs.

The configuration parameter allows you to specify the content of the ClickHouse Operator configuration. By default, it is auto-generated based on other values. You can also use the overrideConfiguration parameter to override specific values in the configuration. You can also use the chiTemplate and chkTemplate parameters to specify the templates for ClickHouse installations and ClickHouse Keeper installation, respectively.

As an alternative, existing ConfigMaps containing the configuration can be used. To do so, the chart exposes parameter such as existingConfigmap, existingChiTemplatesConfigmap or existingChkTemplatesConfigmap.

Please refer to the official documentation⁠ to learn more about the configuration options available for ClickHouse Operator.

⁠ Additional environment variables

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property.

extraEnvVars:
  - name: LOG_LEVEL
    value: error

⁠ Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart⁠. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation⁠.

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values.

⁠ Rolling VS Immutable tags⁠

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

⁠ Sidecars

If additional containers are needed in the same pod as ClickHouse Operator (such as additional logging exporters), they can be defined using the sidecars parameter.

sidecars:
- name: your-image-name
  image: your-image
  imagePullPolicy: Always
  ports:
  - name: portname
    containerPort: 1234

If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts parameter (where available), as shown in the example below:

service:
  extraPorts:
  - name: extraPort
    port: 11311
    targetPort: 11311

If additional init containers are needed in the same pod, they can be defined using the initContainers parameter. Here is an example:

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Learn more about sidecar containers⁠ and init containers⁠.

⁠ Pod affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod affinity in the kubernetes documentation⁠.

As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common⁠ chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

⁠ Prometheus metrics

This chart can be integrated with Prometheus by setting metrics.enabled to true. This will deploy a sidecar container with ClickHouse Operator Metrics exporter⁠ in all pods and a K8s service, which can be configured under the service section. This service will have the necessary annotations to be automatically scraped by Prometheus.

⁠Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart⁠ or the Bitnami Kube Prometheus helm chart⁠ to easily have a working Prometheus in your cluster.

⁠Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true. Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart⁠ for having the necessary CRDs and the Prometheus Operator.

⁠ Deploying extra resources

Apart from the Operator, you may want to deploy ClickHouse Installation or ClickHouse Keeper Installation objects. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy parameter. The following examples creates a ClickHouse Installation using the default-clickhouse pod template and a ClickHouse Keeper Installation using the default-keeper pod template:

extraDeploy:
- apiVersion: clickhouse.altinity.com/v1
  kind: ClickHouseInstallation
  metadata:
    name: test
  spec:
    defaults:
      storageManagement:
        provisioner: Operator
      templates:
        podTemplate: default-clickhouse
        dataVolumeClaimTemplate: default-volume-claim
    configuration:
      settings:
        http_port: 8123
        tcp_port: 9000
        interserver_http_port: 9009
      users:
        default/networks/ip:
        - 0.0.0.0/0
        - '::/0'
      clusters:
      - name: cluster
        layout:
          replicasCount: 1
      zookeeper:
        nodes:
          - host: chk-test-cluster
            port: 2181
    templates:
      podTemplates:
      - name: default-clickhouse
        distribution: Unspecified
        spec:
          containers:
          - name: clickhouse
            image: docker.io/bitnami/clickhouse
            volumeMounts:
            - name: default-volume-claim
              mountPath: /bitnami/clickhouse
      volumeClaimTemplates:
      - name: default-volume-claim
        spec:
          accessModes:
          - ReadWriteOnce
          resources:
            requests:
              storage: 8Gi
- apiVersion: clickhouse-keeper.altinity.com/v1
  kind: ClickHouseKeeperInstallation
  metadata:
    name: test
  spec:
    defaults:
      storageManagement:
        provisioner: Operator
      templates:
        podTemplate: default-keeper
        dataVolumeClaimTemplate: default-volume-claim
    configuration:
      clusters:
        - name: cluster
          layout:
            replicasCount: 1
    templates:
      podTemplates:
      - name: default-keeper
        distribution: Unspecified
        spec:
          containers:
          - name: clickhouse-keeper
            image: docker.io/bitnami/clickhouse-keeper
            workingDir: /var/lib/clickhouse-keeper
            env:
            - name: CLICKHOUSE_KEEPER_SERVER_ID
              valueFrom:
                fieldRef:
                  fieldPath: metadata.name
            volumeMounts:
            - name: default-volume-claim
              mountPath: /bitnami/clickhouse-keeper
      volumeClaimTemplates:
      - name: default-volume-claim
        spec:
          accessModes:
          - ReadWriteOnce
          resources:
            requests:
              storage: 8Gi
- apiVersion: v1
  kind: Service
  metadata:
    name: chk-test-cluster
    labels:
      clickhouse-keeper.altinity.com/chk: test
      clickhouse-keeper.altinity.com/cluster: cluster
  spec:
    ports:
      - port: 2181
        name: client
    selector:
      clickhouse-keeper.altinity.com/chk: test
      clickhouse-keeper.altinity.com/cluster: cluster
      clickhouse-keeper.altinity.com/ready: "yes"

Check the official quickstart guide⁠ for more examples of how to deploy ClickHouse Installations.

⁠ FIPS parameters

The FIPS parameters only have effect if you are using images from the Bitnami Secure Images catalog⁠.

For more information on this new support, please refer to the FIPS Compliance section⁠.

⁠ Parameters

The following subsections list global, common, and component-specific parameters.

⁠ Global parameters

⁠ Common parameters

⁠ ClickHouse Operator Parameters

Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://techdocs.broadcom.com/us/en/vmware-tanzu/bitnami-secure-images/bitnami-secure-images/services/bsi-app-doc/apps-charts-clickhouse-operator-index.html⁠