Install and Verify the clickhouse-operator.

The Kubernetes clickhouse-operator can be installed in just a few minutes with a single command into your existing Kubernetes environment.

For those who need a more customized installation or want to build the clickhouse-operator themselves can do so through the Operator Installation Guide.


Before starting, make sure you have the following installed:

Quick Install

To install the clickhouse-operator into your existing Kubernetes environment, run the following or download the clickhouse-operator install file to modify it as best fits your needs. For more information on the Kubernetes Custom Resources that can be applied, see the Operator Guide

kubectl apply -f

Output similar to the following will be displayed on a successful installation. For more information on the resources created in the installation, see clickhouse-operator Resources created created created
serviceaccount/clickhouse-operator created created
configmap/etc-clickhouse-operator-files created
configmap/etc-clickhouse-operator-confd-files created
configmap/etc-clickhouse-operator-configd-files created
configmap/etc-clickhouse-operator-templatesd-files created
configmap/etc-clickhouse-operator-usersd-files created
deployment.apps/clickhouse-operator created
service/clickhouse-operator-metrics created

Quick Verify

To verify that the installation was successful, run the following. On a successful installation you’ll be able to see the clickhouse-operator under the NAME column.

>> kubectl get pods --namespace kube-system
NAME                                     READY   STATUS    RESTARTS   AGE
clickhouse-operator-679d4bd556-dwwwg     2/2     Running   0          9m4s

Last modified 2021.10.25: documentation update.