From 522f6ff43751eb493cb5baa390cd3a805708bbac Mon Sep 17 00:00:00 2001 From: "L.Dongming" Date: Tue, 13 Feb 2024 22:08:02 +0800 Subject: [PATCH] chore: improve installation document (#6616) --- .../install-kubeblocks-with-helm.md | 55 ++++++++++--------- 1 file changed, 30 insertions(+), 25 deletions(-) diff --git a/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md b/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md index 9f168016ba7..2bf04aaa1cf 100644 --- a/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md +++ b/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md @@ -48,41 +48,46 @@ Make sure you have [kubectl](https://kubernetes.io/docs/tasks/tools/) and [Helm] ## Installation steps -**Use Helm to install KubeBlocks** +Use Helm and follow the steps below to install KubeBlocks. -Run the following command: - -```bash -helm repo add kubeblocks https://apecloud.github.io/helm-charts -helm repo update -helm install kubeblocks kubeblocks/kubeblocks \ - --namespace kb-system --create-namespace -``` - -If you want to install KubeBlocks with custom tolerations, you can use the following command: +1. Create dependent CRDs. + ```bash + kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/v0.8.1/kubeblocks_crds.yaml + ``` -```bash -helm install kubeblocks kubeblocks/kubeblocks \ - --namespace kb-system --create-namespace \ - --set-json 'tolerations=[ { "key": "control-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" } ]' \ - --set-json 'dataPlane.tolerations=[{ "key": "data-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" } ]' -``` +2. Add Helm repo. + ```bash + helm repo add kubeblocks https://apecloud.github.io/helm-charts + helm repo update + ``` -If you want to install KubeBlocks with a specified version, follow the steps below. +3. Install KubeBlocks. + ```bash + helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace + ``` -1. View the available versions in [KubeBlocks Release](https://github.com/apecloud/kubeblocks/releases/). -2. Specify a version with `--version` and run the command below. + If you want to install KubeBlocks with custom tolerations, you can use the following command: ```bash - helm install kubeblocks kubeblocks/kubeblocks \ - --namespace kb-system --create-namespace --version="x.x.x" + helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace \ + --set-json 'tolerations=[ { "key": "control-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" } ]' \ + --set-json 'dataPlane.tolerations=[{ "key": "data-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" }]' ``` - :::note + If you want to install KubeBlocks with a specified version, follow the steps below. + + 1. View the available versions in [KubeBlocks Release](https://github.com/apecloud/kubeblocks/releases/). + 2. Specify a version with `--version` and run the command below. + + ```bash + helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace --version="x.x.x" + ``` + + :::note - By default, the latest release version is installed. + By default, the latest release version is installed. - ::: + ::: ## Verify KubeBlocks installation