Basic Installation Guide

Requirements

The clickhouse-operator for Kubernetes has the following requirements:

• 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.

Instructions

To install the clickhouse-operator for Kubernetes:

1. Deploy the clickhouse-operator from the manifest directly from GitHub. This insures the most current version is installed:

   kubectl apply -f https://raw.githubusercontent.com/Altinity/clickhouse-operator/master/deploy/operator/clickhouse-operator-install.yaml
   

2. 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
   

3. Verify the installation by running:

   kubectl get pods --namespace kube-system
   

   The following will be displayed on a successful installation, with your particular image:

   NAME                                     READY   STATUS    RESTARTS   AGE
   clickhouse-operator-679d4bd556-dwwwg     2/2     Running   0          9m4s