Add Doc-Deploy ClickHouse (#1371)
* Add Doc-Deploy ClickHouse Signed-off-by: Felixnoo <felixliu@yunify.com> * wording updated Signed-off-by: Felixnoo <felixliu@yunify.com>
Felixnoo
GitHub
|
|
@ -0,0 +1,174 @@
|
|||
---
|
||||
title: "Deploy ClickHouse Operator and a ClickHouse Cluster on KubeSphere"
|
||||
keywords: 'KubeSphere, Kubernetes, ClickHouse, ClickHouse Operator, ClickHouse Cluster'
|
||||
description: 'Learn how to deploy ClickHouse Operator and a ClickHouse Cluster on KubeSphere.'
|
||||
linkTitle: "Deploy ClickHouse Operator and a ClickHouse Cluster on KubeSphere"
|
||||
weight: 14340
|
||||
---
|
||||
|
||||
[ClickHouse](https://clickhouse.tech/) is a column-oriented database management system (DBMS) for online analytical processing of queries (OLAP). ClickHouse on QingCloud is a deeply customized ClickHouse cluster application maintaining ClickHouse cluster functions and featuring automated cluster management, data redistribution in clusters, and excellent performance with less cost.
|
||||
|
||||
This tutorial demonstrates how to deploy ClickHouse Operator and a ClickHouse Cluster on KubeSphere.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- You need to enable [the OpenPitrix system](../../../pluggable-components/app-store/).
|
||||
- You need to create a workspace, a project, and two user accounts (`ws-admin` and `project-regular`) for this tutorial. The account `ws-admin` must be granted the role of `workspace-admin` in the workspace, and the account `project-regular` must be invited to the project with the role of `operator`. This tutorial uses `demo-workspace` and `demo-project` for demonstration. If they are not ready, refer to [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/).
|
||||
|
||||
## Hands-on Lab
|
||||
|
||||
### Step 1: Deploy ClickHouse Operator
|
||||
|
||||
1. Log in to the KubeSphere Web console as `admin`, and use **Kubectl** from the **Toolbox** in the bottom right corner to run the following command to install ClickHouse Operator. It is recommended that you have at least two worker nodes available in your cluster.
|
||||
|
||||
```bash
|
||||
kubectl apply -f https://raw.githubusercontent.com/radondb/radondb-clickhouse-kubernetes/master/clickhouse-operator-install.yml
|
||||
```
|
||||
|
||||
{{< notice note >}}
|
||||
|
||||
This command will install ClickHouse Operator in the namespace `kube-system`. Therefore, ClickHouse Operator only needs to be installed once in a Kubernetes cluster.
|
||||
|
||||
{{</ notice >}}
|
||||
|
||||
2. You can see the expected output as below if the installation is successful.
|
||||
|
||||
```
|
||||
customresourcedefinition.apiextensions.k8s.io/clickhouseinstallations.clickhouse.qingcloud.com created
|
||||
customresourcedefinition.apiextensions.k8s.io/clickhouseinstallationtemplates.clickhouse.qingcloud.com created
|
||||
customresourcedefinition.apiextensions.k8s.io/clickhouseoperatorconfigurations.clickhouse.qingcloud.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. You can run the following command to view the status of ClickHouse Operator resources.
|
||||
|
||||
```bash
|
||||
kubectl get all --selector=app=clickhouse-operator -n kube-system
|
||||
```
|
||||
|
||||
Expected output:
|
||||
|
||||
```
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
pod/clickhouse-operator-6b8494c8f-tmkmn 2/2 Running 0 6m34s
|
||||
|
||||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
|
||||
service/clickhouse-operator-metrics ClusterIP 10.233.51.66 <none> 8888/TCP 6m34s
|
||||
|
||||
NAME READY UP-TO-DATE AVAILABLE AGE
|
||||
deployment.apps/clickhouse-operator 1/1 1 1 6m34s
|
||||
|
||||
NAME DESIRED CURRENT READY AGE
|
||||
replicaset.apps/clickhouse-operator-6b8494c8f 1 1 1 6m34s
|
||||
```
|
||||
|
||||
### Step 2: Add an app repository
|
||||
|
||||
1. Log out of KubeSphere and log back in as `ws-admin`. In `demo-workspace`, go to **App Repositories** under **App Management**, and then click **Add**.
|
||||
|
||||
|
||||
|
||||
2. In the dialog that appears, enter `clickhouse` for the app repository name and `https://radondb.github.io/radondb-clickhouse-kubernetes/` for the repository URL. Click **Validate** to verify the URL and you will see a green check mark next to the URL if it is available. Click **OK** to continue.
|
||||
|
||||
|
||||
|
||||
3. Your repository displays in the list after successfully imported to KubeSphere.
|
||||
|
||||
|
||||
|
||||
### Step 3: Deploy a ClickHouse Cluster
|
||||
|
||||
1. Log out of KubeSphere and log back in as `project-regular`. In `demo-project`, go to **Apps** under **Application Workloads** and click **Deploy New App**.
|
||||
|
||||
|
||||
|
||||
2. In the dialog that appears, select **From App Templates**.
|
||||
|
||||
|
||||
|
||||
3. On the new page that appears, select **clickhouse** from the drop-down list and then click **clickhouse-cluster**.
|
||||
|
||||
|
||||
|
||||
4. In the **Chart Files** tab, you can view the configuration and download the `values.yaml` file. Click **Deploy** to continue.
|
||||
|
||||
|
||||
|
||||
5. On the **Basic Information** page, confirm the app name, app version, and deployment location. Click **Next** to continue.
|
||||
|
||||
|
||||
|
||||
6. In the **App Configurations** tab, you can change the YAML file to customize configurations. In this tutorial, click **Deploy** to use the default configurations.
|
||||
|
||||
|
||||
|
||||
7. After a while, you can see the app status shown as **Running**.
|
||||
|
||||
|
||||
|
||||
### Step 4: View ClickHouse Cluster status
|
||||
|
||||
1. In **Workloads** under **Application Workloads**, click the **StatefulSets** tab and you can see the StatefulSets are up and running.
|
||||
|
||||
|
||||
|
||||
3. Click a single StatefulSet to go to its detail page. You can see the metrics in line charts over a period of time under the **Monitoring** tab.
|
||||
|
||||
|
||||
|
||||
3. In **Pods** under **Application Workloads**, you can see all the Pods are up and running.
|
||||
|
||||
|
||||
|
||||
4. In **Volumes** under **Storage**, you can see the ClickHouse Cluster components are using persistent volumes.
|
||||
|
||||
|
||||
|
||||
5. Volume usage is also monitored. Click a volume item to go to its detail page. Here is an example of one of the data nodes.
|
||||
|
||||
|
||||
|
||||
6. On the **Overview** page of the project, you can see a list of resource usage in the current project.
|
||||
|
||||
|
||||
|
||||
### Step 5: Access the ClickHouse Cluster
|
||||
|
||||
1. Log out of KubeSphere and log back in as `admin`. Hover your cursor over the hammer icon in the bottom right corner and then select **Kubectl**.
|
||||
|
||||
2. In the window that appears, run the following command and then navigate to the username and password of the ClickHouse cluster.
|
||||
|
||||
```bash
|
||||
kubectl edit chi clickho-749j8s -n demo-project
|
||||
```
|
||||
|
||||
|
||||
|
||||
{{< notice note >}}
|
||||
|
||||
In the above command, `clickho-749j8s` is the ClickHouse application name and `demo-project` is the project name. Make sure you use your own application name and project name.
|
||||
|
||||
{{</ notice >}}
|
||||
|
||||
3. Run the following command to access the ClickHouse cluster, and then you can use command like `show databases` to interact with it.
|
||||
|
||||
```bash
|
||||
kubectl exec -it chi-clickho-749j8s-all-nodes-0-0-0 -n demo-project -- clickhouse-client --user=clickhouse --password=c1ickh0use0perator
|
||||
```
|
||||
|
||||
|
||||
|
||||
{{< notice note >}}
|
||||
|
||||
In the above command, `chi-clickho-749j8s-all-nodes-0-0-0` is the Pod name and you can find it in **Pods** under **Application Workloads**. Make sure you use your own Pod name, project name, username and password.
|
||||
|
||||
{{</ notice >}}
|
||||
|
||||
|
After Width: | Height: | Size: 239 KiB |
|
After Width: | Height: | Size: 664 KiB |
|
After Width: | Height: | Size: 120 KiB |
|
After Width: | Height: | Size: 575 KiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 838 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 726 KiB |
|
After Width: | Height: | Size: 478 KiB |
|
After Width: | Height: | Size: 366 KiB |
|
After Width: | Height: | Size: 60 KiB |
|
After Width: | Height: | Size: 365 KiB |
|
After Width: | Height: | Size: 869 KiB |
|
After Width: | Height: | Size: 948 KiB |
|
After Width: | Height: | Size: 90 KiB |
|
After Width: | Height: | Size: 331 KiB |
|
After Width: | Height: | Size: 815 KiB |
|
After Width: | Height: | Size: 168 KiB |
|
After Width: | Height: | Size: 358 KiB |
|
After Width: | Height: | Size: 396 KiB |