Kubernetes Blueprints for ClickHouse

Collection of samples to getting started with ClickHouse and ClickHouse Keeper

These samples demonstrate straightforward Helm charts that can be used to deploy ClickHouse and ClickHouse Keeper. The examples are intended as starting points for more complex configurations and do not cover all possible uses cases.

⚠️ Important notes:

1. ClickHouse Keeper resources (CHK) are not stable yet and should not be used in production environments.
2. Connections are unencrypted. Avoid using them for sensitive data.
3. Selecting the external LoadBalancer service type in values.yaml will expose one or more ports to the Internet, which can pose security risks.

Prerequisites

To get started, you'll need to:

• Get administrative access to Kubernetes. For testing, Minikube will do the job.
• Install kubectl
• Install helm
• (Optional) Use helm to install the clickhouse-operator using the commands shown below.

Installing the Operator first provides better control when uninstalling clusters.

helm repo add clickhouse-operator https://docs.altinity.com/clickhouse-operator/
helm install clickhouse-operator clickhouse-operator/altinity-clickhouse-operator

Please refer to the Altinity Operator project instructions for details on operator upgrade with Helm, including running custom resource definition files independently.

Helm Charts

• clickhouse: Deploys a ClickHouse cluster with dependencies.
• clickhouse-keeper-sts: Deploys ClickHouse Keeper using StatefulSets for better data persistence.

How to Install a Chart

# add the kubernetes-blueprints-for-clickhouse chart repository
helm repo add altinity https://helm.altinity.com

# use this command to install any of the avaiable charts
helm install release-name altinity/[chart-name] --namespace clickhouse --create-namespace

# check chart release status
helm status release-name --namespace clickhouse

Using Examples

There are several examples available. You can use them with a command like:

helm install release-name --namespace clickhouse --create-namespace -f path/to/examples/values-simple.yaml 

Please refer to any of helm charts README file for detailed instructions about each of the them.

Contributing

We welcome contributions from the community! If you encounter issues or have improvements to suggest, please log an issue or submit a PR.

Legal

All code, unless specified otherwise, is licensed under the Apache-2.0 license. Copyright (c) 2024 Altinity, Inc.