Altinity Kubernetes Operator for ClickHouse®

Running ClickHouse® on Kubernetes

Running ClickHouse on Kubernetes is easy with the open-source Altinity Kubernetes Operator for ClickHouse. This documentation will get you up and running as quickly as possible.

We’ll focus on the basics here: Using the operator to install, configure, and run a ClickHouse cluster in a Kubernetes cluster, including things like Zookeeper that ClickHouse needs. Be aware that the GitHub repo for the project has in-depth technical details on a number of advanced topics when you’re ready to go beyond what we’ll do here.

We’ll also be careful with the word “cluster.” When you have everything up and running, you’ll have a ClickHouse cluster running inside a Kubernetes cluster. Most of the time it’ll be obvious what the word “cluster” refers to, but if there’s any chance it’s not clear, we’ll say “ClickHouse cluster” or “Kubernetes cluster.”

As of this time, the current version of the Altinity Kubernetes Operator is 0.25.0. You can always find the latest released version on the project’s releases page. The operator is released under the Apache 2.0 license.


Installing the Operator

Getting the operator installed

Quick Start Guide

Setting up a ClickHouse® cluster quickly with the Altinity Kubernetes Operator

Configuring the Operator

Installation and Management of the Altinity Kubernetes Operator for ClickHouse®

Upgrading the Operator

How to move to a different version of the Altinity Kubernetes Operator for ClickHouse®

Uninstalling the Operator

How to uninstall the Altinity Kubernetes Operator for ClickHouse®