The Altinity Kubernetes 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 Altinity Kubernetes 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
- Access to the clickhouse-operator-install-bundle.yaml file.
To install the Altinity Kubernetes Operator into your existing Kubernetes environment, run the following or download the Altinity Kubernetes Operator install file to modify it as best fits your needs. For more information custom Altinity Kubernetes Operator settings that can be applied, see the Operator Guide.
We recommend that when installing the Altinity Kubernetes Operator, specify the version to be installed. This insures maximum compatibility with applications and established Kubernetes environments running your ClickHouse clusters. For more information on installing other versions of the Altinity Kubernetes Operator, see the specific Version Installation Guide.
The most current version is
kubectl apply -f https://github.com/Altinity/clickhouse-operator/raw/0.18.3/deploy/operator/clickhouse-operator-install-bundle.yaml
Never delete the operator or run the following command while there are live ClickHouse clusters managed by the operator:
kubectl delete -f https://raw.githubusercontent.com/Altinity/clickhouse-operator/master/deploy/operator/clickhouse-operator-install-bundle.yaml
The command will hang due to the live clusters. If you then re-install the operator, those clusters will be deleted and the operator will not work correctly.
See Altinity/clickhouse-operator#830 for more details.
Output similar to the following will be displayed on a successful installation. For more information on the resources created in the installation, see Altinity Kubernetes 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 clusterrole.rbac.authorization.k8s.io/clickhouse-operator-kube-system 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 pod under the NAME column.
kubectl get pods --namespace kube-system
NAME READY STATUS RESTARTS AGE clickhouse-operator-857c69ffc6-dq2sz 2/2 Running 0 5s coredns-78fcd69978-nthp2 1/1 Running 4 (110s ago) 50d etcd-minikube 1/1 Running 4 (115s ago) 50d kube-apiserver-minikube 1/1 Running 4 (105s ago) 50d kube-controller-manager-minikube 1/1 Running 4 (115s ago) 50d kube-proxy-lsggn 1/1 Running 4 (115s ago) 50d kube-scheduler-minikube 1/1 Running 4 (105s ago) 50d storage-provisioner 1/1 Running 8 (115s ago) 50d