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:
- Kubernetes 1.15.11+. For instructions on how to install Kubernetes for your particular environment, see the Kubernetes Install Tools page.
- Access to the clickhouse-operator-install.yaml file.
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 https://raw.githubusercontent.com/Altinity/clickhouse-operator/master/deploy/operator/clickhouse-operator-install.yaml
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
customresourcedefinition.apiextensions.k8s.io/clickhouseinstallations.clickhouse.altinity.com created customresourcedefinition.apiextensions.k8s.io/clickhouseinstallationtemplates.clickhouse.altinity.com created customresourcedefinition.apiextensions.k8s.io/clickhouseoperatorconfigurations.clickhouse.altinity.com created serviceaccount/clickhouse-operator created clusterrolebinding.rbac.authorization.k8s.io/clickhouse-operator-kube-system 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
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