From d2a351e40cdda863d69799680ff975f68c09d799 Mon Sep 17 00:00:00 2001 From: yuanyuan zhang Date: Thu, 21 Nov 2024 18:00:39 +0800 Subject: [PATCH 1/4] docs: merge installation docs --- docs/user_docs/installation/install-addons.md | 172 ++++++++++++++++++ .../{install-with-kbcli => }/install-kbcli.md | 2 +- .../install-kubeblocks.md | 85 ++++++++- .../install-with-helm/_category_.yml | 4 - .../install-with-helm/install-addons.md | 52 ------ .../install-with-helm/uninstall-kubeblocks.md | 54 ------ .../install-with-kbcli/_category_.yml | 4 - .../install-with-kbcli/install-addons.md | 103 ----------- .../install-kubeblocks-with-kbcli.md | 101 ---------- ...s.md => uninstall-kubeblocks-and-kbcli.md} | 47 ++++- .../user-docs/installation/install-addons.md | 168 +++++++++++++++++ .../{install-with-kbcli => }/install-kbcli.md | 0 .../install-kubeblocks.md | 83 ++++++++- .../install-with-helm/_category_.yml | 4 - .../install-with-helm/install-addons.md | 52 ------ .../install-with-helm/uninstall-kubeblocks.md | 54 ------ .../install-with-kbcli/_category_.yml | 4 - .../install-with-kbcli/install-addons.md | 103 ----------- .../install-kubeblocks-with-kbcli.md | 104 ----------- ...s.md => uninstall-kubeblocks-and-kbcli.md} | 49 +++-- 20 files changed, 572 insertions(+), 673 deletions(-) create mode 100644 docs/user_docs/installation/install-addons.md rename docs/user_docs/installation/{install-with-kbcli => }/install-kbcli.md (99%) rename docs/user_docs/installation/{install-with-helm => }/install-kubeblocks.md (64%) delete mode 100644 docs/user_docs/installation/install-with-helm/_category_.yml delete mode 100644 docs/user_docs/installation/install-with-helm/install-addons.md delete mode 100644 docs/user_docs/installation/install-with-helm/uninstall-kubeblocks.md delete mode 100644 docs/user_docs/installation/install-with-kbcli/_category_.yml delete mode 100644 docs/user_docs/installation/install-with-kbcli/install-addons.md delete mode 100644 docs/user_docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md rename docs/user_docs/installation/{install-with-kbcli/uninstall-kbcli-and-kubeblocks.md => uninstall-kubeblocks-and-kbcli.md} (68%) create mode 100644 i18n/zh-cn/user-docs/installation/install-addons.md rename i18n/zh-cn/user-docs/installation/{install-with-kbcli => }/install-kbcli.md (100%) rename i18n/zh-cn/user-docs/installation/{install-with-helm => }/install-kubeblocks.md (65%) delete mode 100644 i18n/zh-cn/user-docs/installation/install-with-helm/_category_.yml delete mode 100644 i18n/zh-cn/user-docs/installation/install-with-helm/install-addons.md delete mode 100644 i18n/zh-cn/user-docs/installation/install-with-helm/uninstall-kubeblocks.md delete mode 100644 i18n/zh-cn/user-docs/installation/install-with-kbcli/_category_.yml delete mode 100644 i18n/zh-cn/user-docs/installation/install-with-kbcli/install-addons.md delete mode 100644 i18n/zh-cn/user-docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md rename i18n/zh-cn/user-docs/installation/{install-with-kbcli/uninstall-kbcli-and-kubeblocks.md => uninstall-kubeblocks-and-kbcli.md} (69%) diff --git a/docs/user_docs/installation/install-addons.md b/docs/user_docs/installation/install-addons.md new file mode 100644 index 00000000000..ae01a43f99c --- /dev/null +++ b/docs/user_docs/installation/install-addons.md @@ -0,0 +1,172 @@ +--- +title: Install Addons +description: Install KubeBlocks addons with Helm +keywords: [addon, helm, KubeBlocks] +sidebar_position: 4 +sidebar_label: Install Addons +--- + +# Install Addons + +With the release of KubeBlocks v0.8.0, Addons are decoupled from KubeBlocks and some Addons are not installed by default. If you want to use these Addons, install Addons first by index. Or if you uninstalled some Addons, you can follow the steps in this tutorial to install them again. + +This tutorial takes etcd as an example. You can replace etcd with the Addon you need. + +The official index repo is [KubeBlocks index](https://github.com/apecloud/block-index). Addons are maintained in the [KubeBlocks Addon repo](https://github.com/apecloud/kubeblocks-addons). + + + + + +1. (Optional) Add the KubeBlocks repo. If you install KubeBlocks with Helm, just run `helm repo update`. + + ```bash + helm repo add kubeblocks https://apecloud.github.io/helm-charts + helm repo update + ``` + +2. View the Addon versions. + + ```bash + helm search repo kubeblocks/etcd --devel --versions + ``` + +3. Install the Addon (take etcd as example). Specify a version with `--version`. + + ```bash + helm install etcd kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z + ``` + +4. Verify whether this Addon is installed. + + The STATUS is `deployed` and this Addon is installed successfully. + + ```bash + helm list -A + > + NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION + ...... + etcd kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 + ``` + +5. (Optional) You can run the command below to disable the Addon. + + If you have created a related cluster, delete the cluster first. + + ```bash + helm uninstall etcd --namespace kb-system + ``` + + + + + +1. View the index. + + kbcli creates an index named `kubeblocks` by default and you can check whether this index is created by running `kbcli addon index list`. + + ```bash + kbcli addon index list + > + INDEX URL + kubeblocks https://github.com/apecloud/block-index.git + ``` + + If the list is empty or you want to add your index, you can add the index manually by using `kbcli addon index add `. For example, + + ```bash + kbcli addon index add kubeblocks https://github.com/apecloud/block-index.git + ``` + + If you are not sure whether the kubeblocks index is the latest version, you can update it. + + ```bash + kbcli addon index update kubeblocks + ``` + +2. (Optional) Search whether the Addon exists in the index. + + ```bash + kbcli addon search etcd + > + ADDON VERSION INDEX + etcd 0.7.0 kubeblocks + etcd 0.8.0 kubeblocks + etcd 0.9.0 kubeblocks + ``` + +3. Install the Addon. + + If there are multiple index sources and versions for an Addon, you can specify an index by `--index` and a version by `--version`. The system installs the latest version in the `kubeblocks` index by default. + + ```bash + kbcli addon install etcd --index kubeblocks --version x.y.z + ``` + +4. Verify whether this Addon is installed. + + The STATUS is `Enabled` and this Addon is installed successfully. + + ```bash + kbcli addon list + > + NAME VERSION PROVIDER STATUS AUTO-INSTALL + etcd 0.9.0 apecloud Enabled true + ``` + +5. (Optional) You can run the command below to disable the Addon. + + If you have created a related cluster, delete the cluster first. + + ```bash + kbcli addon uninstall etcd + ``` + +:::note + +kbcli supports enable/disable an Addon. When installing KubeBlocks by kbcli, some Addons are installed but remain disabled by default, with their status shown as `Disabled`. For example, + +```bash +kbcli addon list +> +NAME VERSION PROVIDER STATUS AUTO-INSTALL +alertmanager-webhook-adaptor 0.1.4 apecloud Disabled false +apecloud-otel-collector 0.1.2-beta.3 apecloud Disabled false +aws-load-balancer-controller 1.4.8 community Disabled false +csi-driver-nfs 4.5.0 community Disabled false +csi-hostpath-driver 0.7.0 community Disabled false +grafana 6.43.5 community Disabled false +llm 0.9.0 community Disabled false +prometheus 15.16.1 community Disabled false +qdrant 0.9.1 community Disabled false +victoria-metrics-agent 0.8.41 community Disabled false +``` + +You can enable them according to your needs. + +* Enable an Addon. + + ```bash + kbcli addon enable qdrant + ``` + +* Disable an Addon. + + ```bash + kbcli addon disable qdrant + ``` + +After enabling/disabling an Addon, check the Addon list to verify whether the Addon's staus changes as required. + +```bash +kbcli addon list +> +NAME VERSION PROVIDER STATUS AUTO-INSTALL +qdrant 0.9.1 community Enabled false +``` + +::: + + + + diff --git a/docs/user_docs/installation/install-with-kbcli/install-kbcli.md b/docs/user_docs/installation/install-kbcli.md similarity index 99% rename from docs/user_docs/installation/install-with-kbcli/install-kbcli.md rename to docs/user_docs/installation/install-kbcli.md index ffda34b30b6..a2eddb6d3e6 100644 --- a/docs/user_docs/installation/install-with-kbcli/install-kbcli.md +++ b/docs/user_docs/installation/install-kbcli.md @@ -2,7 +2,7 @@ title: Install kbcli description: Install kbcli keywords: [install, kbcli,] -sidebar_position: 1 +sidebar_position: 2 sidebar_label: Install kbcli --- diff --git a/docs/user_docs/installation/install-with-helm/install-kubeblocks.md b/docs/user_docs/installation/install-kubeblocks.md similarity index 64% rename from docs/user_docs/installation/install-with-helm/install-kubeblocks.md rename to docs/user_docs/installation/install-kubeblocks.md index e76fc51b674..4844f3c0407 100644 --- a/docs/user_docs/installation/install-with-helm/install-kubeblocks.md +++ b/docs/user_docs/installation/install-kubeblocks.md @@ -1,25 +1,27 @@ --- title: Install KubeBlocks description: Install KubeBlocks on the existing Kubernetes clusters with Helm -keywords: [taints, affinity, tolerance, install, kbcli, KubeBlocks] -sidebar_position: 1 +keywords: [taints, affinity, tolerance, install, kbcli, KubeBlocks, helm] +sidebar_position: 3 sidebar_label: Install KubeBlocks --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Install KubeBlocks +# Install KubeBlocks -KubeBlocks is Kubernetes-native, you can use Helm or kubectl with a YAML file to install it. +The quickest way to try out KubeBlocks is to create a new Kubernetes cluster and install KubeBlocks using the playground. However, production environments are more complex, with applications running in different namespaces and with resource or permission limitations. This document explains how to deploy KubeBlocks on an existing Kubernetes cluster. + +KubeBlocks is Kubernetes-native, you can use Helm or kubectl with a YAML file to install it. You can also use kbcli, an intuitive CLI tool, to install KubeBlocks. To try out KubeBlocks on your local host, you can use the [Playground](./../../try-out-on-playground/try-kubeblocks-on-your-laptop.md) or [create a local Kubernetes test cluster first](./../prerequisite/prepare-a-local-k8s-cluster.md) and then follow the steps in this tutorial to install KubeBlocks. :::note -If you install KubeBlocks with Helm, to uninstall it, you have to use Helm too. +- Note that you install and uninstall KubeBlocks with the same tool. For example, if you install KubeBlocks with Helm, to uninstall it, you have to use Helm too. +- Make sure you have [kubectl](https://kubernetes.io/docs/tasks/tools/), [Helm](https://helm.sh/docs/intro/install/), or [kbcli](./install-kbcli.md) installed. -Make sure you have [kubectl](https://kubernetes.io/docs/tasks/tools/) and [Helm](https://helm.sh/docs/intro/install/) installed. ::: ## Environment preparation @@ -64,9 +66,11 @@ Use Helm and follow the steps below to install KubeBlocks. ```bash kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/vx.y.z/kubeblocks_crds.yaml ``` + You can view all versions of kubeblocks, including alpha and beta releases, on the [kubeblocks releases list](https://github.com/apecloud/kubeblocks/releases). To get stable releases, use this command: + ```bash curl -s "https://api.github.com/repos/apecloud/kubeblocks/releases?per_page=100&page=1" | jq -r '.[] | select(.prerelease == false) | .tag_name' | sort -V -r ``` @@ -122,12 +126,55 @@ Like any other resource in Kubernetes, KubeBlocks can be installed through a YAM + + +The command `kbcli kubeblocks install` installs KubeBlocks in the `kb-system` namespace, or you can use the `--namespace` flag to specify one. + +```bash +kbcli kubeblocks install +``` + +If you want to install KubeBlocks with a specified version, follow the steps below. + +1. View the available versions. + + ```bash + kbcli kubeblocks list-versions + ``` + + To include alpha and beta releases, use: + + ```bash + kbcli kb list-versions --devel --limit=100 + ``` + + Or you can view all available versions in [KubeBlocks Release](https://github.com/apecloud/kubeblocks/releases/). +2. Specify a version with `--version` and run the command below. + + ```bash + kbcli kubeblocks install --version=x.y.z + ``` + + :::note + + By default, when installing KubeBlocks, kbcli installs the corresponding version of KubeBlocks. It's important to ensure the major versions of kbcli and KubeBlocks are the same, if you specify a different version explicitly here. + + For example, you can install kbcli v0.8.3 with KubeBlocks v0.8.1, but using mismatched major versions, such as kbcli v0.8.3 with KubeBlocks v0.9.0, may lead to errors. + + ::: + + + ## Verify KubeBlocks installation Run the following command to check whether KubeBlocks is installed successfully. + + + + ```bash kubectl -n kb-system get pods ``` @@ -149,3 +196,29 @@ prometheus-node-exporter-r6kvl 1/1 Running 0 prometheus-pushgateway-8555888c7d-xkgfc 1/1 Running 0 3m56s prometheus-server-5759b94fc8-686xp 2/2 Running 0 3m56s ``` + + + + + +```bash +kbcli kubeblocks status +``` + +***Result*** + +If the KubeBlocks Workloads are all ready, KubeBlocks has been installed successfully. + +```bash +KubeBlocks is deployed in namespace: kb-system,version: x.y.z +> +KubeBlocks Workloads: +NAMESPACE KIND NAME READY PODS CPU(CORES) MEMORY(BYTES) CREATED-AT +kb-system Deployment kb-addon-snapshot-controller 1/1 N/A N/A Oct 13,2023 14:27 UTC+0800 +kb-system Deployment kubeblocks 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 +kb-system Deployment kubeblocks-dataprotection 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 +``` + + + + diff --git a/docs/user_docs/installation/install-with-helm/_category_.yml b/docs/user_docs/installation/install-with-helm/_category_.yml deleted file mode 100644 index 4803e6977f9..00000000000 --- a/docs/user_docs/installation/install-with-helm/_category_.yml +++ /dev/null @@ -1,4 +0,0 @@ -position: 3 -label: Install with helm -collapsible: true -collapsed: true \ No newline at end of file diff --git a/docs/user_docs/installation/install-with-helm/install-addons.md b/docs/user_docs/installation/install-with-helm/install-addons.md deleted file mode 100644 index a42f9851ce8..00000000000 --- a/docs/user_docs/installation/install-with-helm/install-addons.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Install Addons -description: Install KubeBlocks addons with Helm -keywords: [addon, helm, KubeBlocks] -sidebar_position: 3 -sidebar_label: Install Addons ---- - -# Install Addons - -With the release of KubeBlocks v0.8.0, Addons are decoupled from KubeBlocks and some Addons are not installed by default. If you want to use these Addons, install Addons first by index. Or if you uninstalled some Addons, you can follow the steps in this tutorial to install them again. - -This tutorial takes etcd as an example. You can replace etcd with the Addon you need. - -The official index repo is [KubeBlocks index](https://github.com/apecloud/block-index). The code of all Addons is maintained in the [KubeBlocks Addon repo](https://github.com/apecloud/kubeblocks-addons). - -1. (Optional) Add the KubeBlocks repo. If you install KubeBlocks with Helm, just run `helm repo update`. - - ```bash - helm repo add kubeblocks https://apecloud.github.io/helm-charts - helm repo update - ``` - -2. View the Addon versions. - - ```bash - helm search repo kubeblocks/etcd --devel --versions - ``` - -3. Install the Addon (take etcd as example). Specify a version with `--version`. - - ```bash - helm install etcd kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z - ``` - -4. Verify whether this Addon is installed. - - The STATUS is `deployed` and this Addon is installed successfully. - - ```bash - helm list -A - > - NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION - ...... - etcd kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 - ``` - -5. (Optional) You can run the command below to disable the Addon. - - ```bash - helm uninstall etcd --namespace kb-system - ``` diff --git a/docs/user_docs/installation/install-with-helm/uninstall-kubeblocks.md b/docs/user_docs/installation/install-with-helm/uninstall-kubeblocks.md deleted file mode 100644 index 78ff4f42ee0..00000000000 --- a/docs/user_docs/installation/install-with-helm/uninstall-kubeblocks.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Uninstall KubeBlocks -description: Handle exception and uninstall KubeBlocks -keywords: [kubeblocks, exception, uninstall] -sidebar_position: 5 -sidebar_label: Uninstall KubeBlocks ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# Uninstall KubeBlocks - -Uninstallation order: - -1. Delete your cluster if you have created a cluster. - - ```bash - kubebctl delete cluster -n namespace - ``` - -2. Uninstall KubeBlocks. - -## Uninstall KubeBlocks - - - - - -Delete all the clusters and resources created before performing the following command, otherwise the uninstallation may not be successful. - -```bash -helm uninstall kubeblocks --namespace kb-system -``` - -Helm does not delete CRD objects. You can delete the ones KubeBlocks created with the following commands: - -```bash -kubectl get crd -o name | grep kubeblocks.io | xargs kubectl delete -``` - - - - - -You can generate YAMLs from the KubeBlocks chart and uninstall using `kubectl`. Use `--version x.y.z` to specify a version and make sure the uninstalled version is the same as the installed one. - -```bash -helm template kubeblocks kubeblocks/kubeblocks --namespace kb-system --version x.y.z | kubectl delete -f - -``` - - - - diff --git a/docs/user_docs/installation/install-with-kbcli/_category_.yml b/docs/user_docs/installation/install-with-kbcli/_category_.yml deleted file mode 100644 index 4e70f760f93..00000000000 --- a/docs/user_docs/installation/install-with-kbcli/_category_.yml +++ /dev/null @@ -1,4 +0,0 @@ -position: 2 -label: Install with kbcli -collapsible: true -collapsed: true \ No newline at end of file diff --git a/docs/user_docs/installation/install-with-kbcli/install-addons.md b/docs/user_docs/installation/install-with-kbcli/install-addons.md deleted file mode 100644 index ad70dafa4ab..00000000000 --- a/docs/user_docs/installation/install-with-kbcli/install-addons.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: Install Addons -description: Install KubeBlocks Addons -keywords: [kbcli, kubeblocks, addons, install] -sidebar_position: 3 -sidebar_label: Install Addons ---- - -# Install Addons - -## Use the index to install an Addon - -With the release of KubeBlocks v0.8.0, Addons are decoupled from KubeBlocks and some Addons are not installed by default. If you want to use these Addons, install Addons first by index. Or if you uninstalled some Addons, you can follow the steps in this tutorial to install them again. - -This tutorial takes etcd as an example. You can replace etcd with the Addon you need. - -The official index repo is [KubeBlocks index](https://github.com/apecloud/block-index). The code of all Addons is maintained in the [KubeBlocks Addon repo](https://github.com/apecloud/kubeblocks-addons). - -1. View the index. - - kbcli creates an index named `kubeblocks` by default and you can check whether this index is created by running `kbcli addon index list`. - - ```bash - kbcli addon index list - > - INDEX URL - kubeblocks https://github.com/apecloud/block-index.git - ``` - - If the list is empty or you want to add your index, you can add the index manually by using `kbcli addon index add `. For example, - - ```bash - kbcli addon index add kubeblocks https://github.com/apecloud/block-index.git - ``` - - If you are not sure whether the kubeblocks index is the latest version, you can update it. - - ```bash - kbcli addon index update kubeblocks - ``` - -2. (Optional) Search whether the Addon exists in the index. - - ```bash - kbcli addon search etcd - > - ADDON VERSION INDEX - etcd 0.7.0 kubeblocks - etcd 0.8.0 kubeblocks - etcd 0.9.0 kubeblocks - ``` - -3. Install the Addon. - - If there are multiple index sources and versions for an Addon, you can specify an index by `--index` and a version by `--version`. The system installs the latest version in the `kubeblocks` index by default. - - ```bash - kbcli addon install etcd --index kubeblocks --version x.y.z - ``` - - **What's next** - - After the Addon is installed, you can list and enable it. - -## List Addons - -To list supported Addons, run `kbcli addon list` command. - -## Enable/Disable Addons - -To manually enable or disable Addons, follow the steps below. - -***Steps:*** - -1. To enable an Addon, use `kbcli addon enable`. - - ***Example*** - - ```bash - kbcli addon enable etcd - ``` - - To disable an Addon, use `kbcli addon disable`. - -2. List the Addons again to check whether it is enabled. - - ```bash - kbcli addon list - ``` - -## Uninstall Addons - -You can also uninstall the Addons. If you have created a related cluster, delete the cluster first. - -```bash -kbcli cluster delete -``` - -Uninstall an Addon. - -```bash -kbcli addon uninstall etcd -``` diff --git a/docs/user_docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md b/docs/user_docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md deleted file mode 100644 index 9e42f356ddd..00000000000 --- a/docs/user_docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Install KubeBlocks with kbcli -description: Install KubeBlocks on the existing Kubernetes clusters -keywords: [taints, affinity, tolerance, install, kbcli, KubeBlocks] -sidebar_position: 2 -sidebar_label: Install KubeBlocks ---- - -# Install KubeBlocks with kbcli - -The quickest way to try out KubeBlocks is to create a new Kubernetes cluster and install KubeBlocks using the playground. However, production environments are more complex, with applications running in different namespaces and with resource or permission limitations. This document explains how to deploy KubeBlocks on an existing Kubernetes cluster. - -To try out KubeBlocks on your local host, you can use the [Playground](./../../try-out-on-playground/try-kubeblocks-on-your-laptop.md) or [create a local Kubernetes test cluster first](./../prerequisite/prepare-a-local-k8s-cluster.md) and then follow the steps in this tutorial to install KubeBlocks. - -## Environment preparation - -Prepare an accessible Kubernetes cluster with the version 1.22 or above, and this cluster should meet the following requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
Resource Requirements
Control PlaneIt is recommended to create 1 node with 4 cores, 4GB memory and 50GB storage.
Data Plane MySQL It is recommended to create at least 3 nodes with 2 cores, 4GB memory and 50GB storage.
PostgreSQL It is recommended to create at least 2 nodes with 2 cores, 4GB memory and 50GB storage.
Redis It is recommended to create at least 2 nodes with 2 cores, 4GB memory and 50GB storage.
MongoDB It is recommended to create at least 3 nodes with 2 cores, 4GB memory and 50GB storage.
- -## Installation steps - -The command `kbcli kubeblocks install` installs KubeBlocks in the `kb-system` namespace, or you can use the `--namespace` flag to specify one. - -```bash -kbcli kubeblocks install -``` - -If you want to install KubeBlocks with a specified version, follow the steps below. - -1. View the available versions. - - ```bash - kbcli kubeblocks list-versions - ``` - - To include alpha and beta releases, use: - ```bash - kbcli kb list-versions --devel --limit=100 - ``` - - Or you can view all available versions in [KubeBlocks Release](https://github.com/apecloud/kubeblocks/releases/). -2. Specify a version with `--version` and run the command below. - - ```bash - kbcli kubeblocks install --version=x.y.z - ``` - :::note - - By default, when installing KubeBlocks, kbcli installs the corresponding version of KubeBlocks. It's important to ensure the major versions of kbcli and KubeBlocks are the same, if you specify a different version explicitly here. - - For example, you can install kbcli v0.8.3 with KubeBlocks v0.8.1, but using mismatched major versions, such as kbcli v0.8.3 with KubeBlocks v0.9.0, may lead to errors. - - ::: - -## Verify KubeBlocks installation - -Run the following command to check whether KubeBlocks is installed successfully. - -```bash -kbcli kubeblocks status -``` - -***Result*** - -If the KubeBlocks Workloads are all ready, KubeBlocks has been installed successfully. - -```bash -KubeBlocks is deployed in namespace: kb-system,version: x.y.z -> -KubeBlocks Workloads: -NAMESPACE KIND NAME READY PODS CPU(CORES) MEMORY(BYTES) CREATED-AT -kb-system Deployment kb-addon-snapshot-controller 1/1 N/A N/A Oct 13,2023 14:27 UTC+0800 -kb-system Deployment kubeblocks 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 -kb-system Deployment kubeblocks-dataprotection 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 -``` diff --git a/docs/user_docs/installation/install-with-kbcli/uninstall-kbcli-and-kubeblocks.md b/docs/user_docs/installation/uninstall-kubeblocks-and-kbcli.md similarity index 68% rename from docs/user_docs/installation/install-with-kbcli/uninstall-kbcli-and-kubeblocks.md rename to docs/user_docs/installation/uninstall-kubeblocks-and-kbcli.md index a43ecafb5d5..6cc25c22e95 100644 --- a/docs/user_docs/installation/install-with-kbcli/uninstall-kbcli-and-kubeblocks.md +++ b/docs/user_docs/installation/uninstall-kubeblocks-and-kbcli.md @@ -1,8 +1,8 @@ --- -title: Uninstall kbcli and KubeBlocks -description: Handle exception and uninstall kbcli and KubeBlocks -keywords: [kbcli, kubeblocks, exception, uninstall] -sidebar_position: 4 +title: Uninstall KubeBlocks +description: Uninstall KubeBlocks by Helm, applying a YAML file, or kbcli. +keywords: [kubeblocks, uninstall, helm, kbcli] +sidebar_position: 5 sidebar_label: Uninstall KubeBlocks and kbcli --- @@ -16,26 +16,57 @@ Uninstallation order: 1. Delete your cluster if you have created a cluster. ```bash - kbcli cluster delete + kubebctl delete cluster -n namespace ``` 2. Uninstall KubeBlocks. -3. Uninstall kbcli. - ## Uninstall KubeBlocks -Uninstall KubeBlocks if you want to delete KubeBlocks after your trial. + + + + +Delete all the clusters and resources created before performing the following command, otherwise the uninstallation may not be successful. + +```bash +helm uninstall kubeblocks --namespace kb-system +``` + +Helm does not delete CRD objects. You can delete the ones KubeBlocks created with the following commands: + +```bash +kubectl get crd -o name | grep kubeblocks.io | xargs kubectl delete +``` + + + + + +You can generate YAMLs from the KubeBlocks chart and uninstall using `kubectl`. Use `--version x.y.z` to specify a version and make sure the uninstalled version is the same as the installed one. + +```bash +helm template kubeblocks kubeblocks/kubeblocks --namespace kb-system --version x.y.z | kubectl delete -f - +``` + + + + ```bash kbcli kubeblocks uninstall ``` + + + + ## Uninstall kbcli Uninstall kbcli if you want to delete kbcli after your trial. Use the same option as the way you install kbcli. + For `curl`, run diff --git a/i18n/zh-cn/user-docs/installation/install-addons.md b/i18n/zh-cn/user-docs/installation/install-addons.md new file mode 100644 index 00000000000..997c491971d --- /dev/null +++ b/i18n/zh-cn/user-docs/installation/install-addons.md @@ -0,0 +1,168 @@ +--- +title: 安装引擎 +description: 使用 Helm 安装 KubeBlocks 支持的引擎 +keywords: [引擎, helm, KubeBlocks] +sidebar_position: 4 +sidebar_label: 安装引擎 +--- + +# 安装引擎 + +KubeBlocks v0.8.0 发布后，数据库引擎插件（Addon）与 KubeBlocks 解耦，KubeBlocks 默认安装了部分引擎，如需体验其它引擎，需通过索引安装。如果您卸载了部分引擎，也可通过本文步骤，重新安装。 + +本文以 etcd 为例，可根据实际情况替换引擎名称。 + +官网引擎索引仓库为 [KubeBlocks 索引](https://github.com/apecloud/block-index)。引擎代码维护在 [KubeBlocks 引擎插件仓库](https://github.com/apecloud/kubeblocks-addons)。 + + + + + +1. （可选）添加 KubeBlocks 仓库。如果您使用 Helm 安装了 KubeBlocks 或此前已添加过该仓库，只需执行 `helm repo update`。 + + ```bash + helm repo add kubeblocks https://apecloud.github.io/helm-charts + helm repo update + ``` + +2. 查看引擎版本。 + + ```bash + helm search repo kubeblocks/etcd --devel --versions + ``` + +3. 以 etcd 为例，安装引擎。使用 `--version` 指定版本。 + + ```bash + helm install etcd kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z + ``` + +4. 验证该引擎是否安装成功。 + + 如果状态显示为 `deployed`，则表明该引擎已成功安装。 + + ```bash + helm list -A + > + NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION + ...... + etcd kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 + ``` + +5. （可选）您可以执行以下命令卸载引擎。如果您已使用该引擎创建集群，请先删除集群。 + + ```bash + helm uninstall etcd --namespace kb-system + ``` + + + + + +1. 查看引擎仓库索引。 + + kbcli 默认创建名为 `kubeblocks` 的索引，可使用 `kbcli addon index list` 查看该索引。 + + ```bash + kbcli addon index list + > + INDEX URL + kubeblocks https://github.com/apecloud/block-index.git + ``` + + 如果命令执行结果未显示或者你想要添加自定义索引仓库，则表明索引未建立，可使用 `kbcli addon index add ` 命令手动添加索引。例如， + + ```bash + kbcli addon index add kubeblocks https://github.com/apecloud/block-index.git + ``` + + 如果不确定索引是否为最新版本，可使用如下命令更新索引。 + + ```bash + kbcli addon index update kubeblocks + ``` + +2. （可选）索引建立后，可以通过 `addon search` 命令检查想要安装的引擎是否在索引信息中存在。 + + ```bash + kbcli addon search etcd + > + ADDON VERSION INDEX + etcd 0.7.0 kubeblocks + etcd 0.8.0 kubeblocks + etcd 0.9.0 kubeblocks + ``` + +3. 安装引擎。 + + 当引擎有多个版本和索引源时，可使用 `--index` 指定索引源，`--version` 指定安装版本。系统默认以 `kubeblocks` 索引仓库 为索引源，安装最新版本。 + + ```bash + kbcli addon install etcd --index kubeblocks --version x.y.z + ``` + +4. 验证该引擎是否安装成功。 + + 如果状态显示为 `Enabled`，则表明该引擎已成功安装。 + + ```bash + kbcli addon list + > + NAME VERSION PROVIDER STATUS AUTO-INSTALL + etcd 0.9.0 apecloud Enabled true + ``` + +5. （可选）您可以执行以下命令卸载引擎。如果您已使用该引擎创建集群，请先删除集群。 + + ```bash + kbcli addon uninstall etcd + ``` + +:::note + +kbcli 支持启用/禁用引擎。使用 kbcli 安装 KubeBlocks 时，系统默认安装但禁用了部分引擎，这类引擎的状态为 `Disabled`。例如， + +```bash +kbcli addon list +> +NAME VERSION PROVIDER STATUS AUTO-INSTALL +alertmanager-webhook-adaptor 0.1.4 apecloud Disabled false +apecloud-otel-collector 0.1.2-beta.3 apecloud Disabled false +aws-load-balancer-controller 1.4.8 community Disabled false +csi-driver-nfs 4.5.0 community Disabled false +csi-hostpath-driver 0.7.0 community Disabled false +grafana 6.43.5 community Disabled false +llm 0.9.0 community Disabled false +prometheus 15.16.1 community Disabled false +qdrant 0.9.1 community Disabled false +victoria-metrics-agent 0.8.41 community Disabled false +``` + +您可通过执行以下命令启用引擎。 + +* 启用引擎。 + + ```bash + kbcli addon enable qdrant + ``` + +* 禁用引擎。 + + ```bash + kbcli addon disable qdrant + ``` + +启用/禁用引擎后，查看引擎列表，检查引擎状态是否按需变更。 + +```bash +kbcli addon list +> +NAME VERSION PROVIDER STATUS AUTO-INSTALL +qdrant 0.9.1 community Enabled false +``` + +::: + + + + diff --git a/i18n/zh-cn/user-docs/installation/install-with-kbcli/install-kbcli.md b/i18n/zh-cn/user-docs/installation/install-kbcli.md similarity index 100% rename from i18n/zh-cn/user-docs/installation/install-with-kbcli/install-kbcli.md rename to i18n/zh-cn/user-docs/installation/install-kbcli.md diff --git a/i18n/zh-cn/user-docs/installation/install-with-helm/install-kubeblocks.md b/i18n/zh-cn/user-docs/installation/install-kubeblocks.md similarity index 65% rename from i18n/zh-cn/user-docs/installation/install-with-helm/install-kubeblocks.md rename to i18n/zh-cn/user-docs/installation/install-kubeblocks.md index 895e93561ab..25da8e756e4 100644 --- a/i18n/zh-cn/user-docs/installation/install-with-helm/install-kubeblocks.md +++ b/i18n/zh-cn/user-docs/installation/install-kubeblocks.md @@ -2,24 +2,25 @@ title: 安装 KubeBlocks description: 在现有的 Kubernetes 集群上使用 Helm 安装 KubeBlocks keywords: [污点, 亲和性, 容忍, 安装, kbcli, KubeBlocks] -sidebar_position: 1 +sidebar_position: 3 sidebar_label: 安装 KubeBlocks --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# 安装 KubeBlocks +# 安装 KubeBlocks -KubeBlocks 是 Kubernetes 原生 operator，可通过 Helm 或者 kubectl 应用 YAML 文件安装 KubeBlocks。本文将介绍如何在现有的 Kubernetes 集群上部署 KubeBlocks。 +使用 Playground 创建一个新的 Kubernetes 集群并安装 KubeBlocks，是快速上手的一种方法。然而，在实际生产环境中，情况会复杂得多，应用程序在不同的命名空间中运行，还存在资源或权限限制。本文档将介绍如何在现有的 Kubernetes 集群上部署 KubeBlocks。 + +KubeBlocks 是 Kubernetes 原生 operator，可通过 Helm、 kubectl 应用 YAML 文件或者 kbcli 安装 KubeBlocks。 如果您想要在本地环境试用 KubeBlocks，可通过 [Playground](./../../try-out-on-playground/try-kubeblocks-on-local-host.md) 试用，或者[先在本地创建 Kubernetes 测试集群](./../prerequisite/prepare-a-local-k8s-cluster.md)，然后按照本文操作步骤安装 KubeBlocks。 :::note -如果您使用 Helm 安装 KubeBlocks，卸载时也需使用 Helm。 - -请确保您已安装 [kubectl](https://kubernetes.io/docs/tasks/tools/) 和 [Helm](https://helm.sh/docs/intro/install/)。 +- 请确保您安装和卸载 KubeBlocks 使用的方式保持一致，例如，如果您使用 Helm 安装 KubeBlocks，卸载时也需使用 Helm。 +- 请确保您已安装 [kubectl](https://kubernetes.io/docs/tasks/tools/)，[Helm](https://helm.sh/docs/intro/install/) 或 [kbcli](./install-kbcli.md)。 ::: @@ -128,12 +129,56 @@ KubeBlocks 是 Kubernetes 原生 operator，可通过 Helm 或者 kubectl 应用 + + +执行 `kbcli kubeblocks install` 将 KubeBlocks 安装在 `kb-system` 命名空间中，或者使用 `--namespace` 指定一个命名空间。 + +```bash +kbcli kubeblocks install +``` + +如果想安装 KubeBlocks 的指定版本，请按照以下步骤操作： + +1. 查看可用的版本。 + + ```bash + kbcli kubeblocks list-versions + ``` + + 如需查看包含 alpha 和 beta 在内的版本，可执行以下命令。 + + ```bash + kbcli kb list-versions --devel --limit=100 + ``` + + 或者，你可以在 [KubeBlocks Release 页面](https://github.com/apecloud/kubeblocks/releases/)中查看可用的版本。 + +2. 使用 `--version` 指定版本。 + + ```bash + kbcli kubeblocks install --version=x.x.x + ``` + + :::note + + kbcli 默认安装最新版本。如果您的环境中已有正在运行的 KubeBlocks 实例，则需要安装与之匹配的 kbcli 版本。 + + 例如，如果您当前使用的 KubeBlocks 版本是 v0.8.3，kbcli 应安装对应的 v0.8.3，而不是更高版本（如 v0.9.0），否则系统将因版本不匹配产生报错。 + + ::: + + + ## 验证 KubeBlocks 安装 执行以下命令，检查 KubeBlocks 是否已成功安装。 + + + + ```bash kubectl -n kb-system get pods ``` @@ -155,3 +200,29 @@ prometheus-node-exporter-r6kvl 1/1 Running 0 prometheus-pushgateway-8555888c7d-xkgfc 1/1 Running 0 3m56s prometheus-server-5759b94fc8-686xp 2/2 Running 0 3m56s ``` + + + + + +```bash +kbcli kubeblocks status +``` + +***结果*** + +如果工作负载都显示已准备就绪，则表明已成功安装 KubeBlocks。 + +```bash +KubeBlocks is deployed in namespace: kb-system,version: x.x.x +> +KubeBlocks Workloads: +NAMESPACE KIND NAME READY PODS CPU(CORES) MEMORY(BYTES) CREATED-AT +kb-system Deployment kb-addon-snapshot-controller 1/1 N/A N/A Oct 13,2023 14:27 UTC+0800 +kb-system Deployment kubeblocks 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 +kb-system Deployment kubeblocks-dataprotection 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 +``` + + + + diff --git a/i18n/zh-cn/user-docs/installation/install-with-helm/_category_.yml b/i18n/zh-cn/user-docs/installation/install-with-helm/_category_.yml deleted file mode 100644 index 1444f832e04..00000000000 --- a/i18n/zh-cn/user-docs/installation/install-with-helm/_category_.yml +++ /dev/null @@ -1,4 +0,0 @@ -position: 3 -label: 使用 Helm 安装 -collapsible: true -collapsed: true \ No newline at end of file diff --git a/i18n/zh-cn/user-docs/installation/install-with-helm/install-addons.md b/i18n/zh-cn/user-docs/installation/install-with-helm/install-addons.md deleted file mode 100644 index c4c152e15f5..00000000000 --- a/i18n/zh-cn/user-docs/installation/install-with-helm/install-addons.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: 安装引擎 -description: 使用 Helm 安装 KubeBlocks 支持的引擎 -keywords: [引擎, helm, KubeBlocks] -sidebar_position: 3 -sidebar_label: 安装引擎 ---- - -# 安装引擎 - -KubeBlocks v0.8.0 发布后，数据库引擎插件（Addon）与 KubeBlocks 解耦，KubeBlocks 默认安装了部分引擎，如需体验其它引擎，需通过索引安装。如果您卸载了部分引擎，也可通过本文步骤，重新安装。 - -本文以 etcd 为例，可根据实际情况替换引擎名称。 - -官网引擎索引仓库为 [KubeBlocks 索引](https://github.com/apecloud/block-index)。引擎代码维护在 [KubeBlocks 引擎插件仓库](https://github.com/apecloud/kubeblocks-addons)。 - -1. （可选）添加 KubeBlocks 仓库。如果您使用 Helm 安装了 KubeBlocks 或此前已添加过该仓库，只需执行 `helm repo update`。 - - ```bash - helm repo add kubeblocks https://apecloud.github.io/helm-charts - helm repo update - ``` - -2. 查看引擎版本。 - - ```bash - helm search repo kubeblocks/etcd --devel --versions - ``` - -3. 以 etcd 为例，安装引擎。使用 `--version` 指定版本。 - - ```bash - helm install etcd kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z - ``` - -4. 验证该引擎是否安装成功。 - - 如果状态显示为 `deployed`，则表明该引擎已成功安装。 - - ```bash - helm list -A - > - NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION - ...... - etcd kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 - ``` - -5. （可选）您可以执行以下命令禁用引擎。 - - ```bash - helm uninstall etcd --namespace kb-system - ``` diff --git a/i18n/zh-cn/user-docs/installation/install-with-helm/uninstall-kubeblocks.md b/i18n/zh-cn/user-docs/installation/install-with-helm/uninstall-kubeblocks.md deleted file mode 100644 index 06d96c78c43..00000000000 --- a/i18n/zh-cn/user-docs/installation/install-with-helm/uninstall-kubeblocks.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: 卸载 KubeBlocks -description: 卸载 KubeBlocks -keywords: [kubeblocks, 卸载] -sidebar_position: 5 -sidebar_label: 卸载 KubeBlocks ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# 卸载 KubeBlocks - -卸载顺序： - -1. 如果已经创建了集群，请先删除集群。 - - ```bash - kubebctl delete cluster -n namespace - ``` - -2. 卸载 KubeBlocks。 - -## 卸载 KubeBlocks - - - - - -在执行以下命令前，请删除之前创建的所有集群和资源，否则卸载可能无法成功。 - -```bash -helm uninstall kubeblocks --namespace kb-system -``` - -Helm 不会删除 CRD 对象。请使用以下命令删除 KubeBlocks 创建的对象。 - -```bash -kubectl get crd -o name | grep kubeblocks.io | xargs kubectl delete -``` - - - - - -从 KubeBlocks chart 生成 YAML 文件，并使用 `kubectl` 进行卸载。使用 `--version x.y.z` 指定版本，确保卸载的版本与安装的版本相同。 - -```bash -helm template kubeblocks kubeblocks/kubeblocks --version x.y.z --namespace kb-system | kubectl delete -f - -``` - - - - diff --git a/i18n/zh-cn/user-docs/installation/install-with-kbcli/_category_.yml b/i18n/zh-cn/user-docs/installation/install-with-kbcli/_category_.yml deleted file mode 100644 index 45c03fec690..00000000000 --- a/i18n/zh-cn/user-docs/installation/install-with-kbcli/_category_.yml +++ /dev/null @@ -1,4 +0,0 @@ -position: 2 -label: 使用 kbcli 安装 -collapsible: true -collapsed: true \ No newline at end of file diff --git a/i18n/zh-cn/user-docs/installation/install-with-kbcli/install-addons.md b/i18n/zh-cn/user-docs/installation/install-with-kbcli/install-addons.md deleted file mode 100644 index 0db1b02f682..00000000000 --- a/i18n/zh-cn/user-docs/installation/install-with-kbcli/install-addons.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: 安装引擎 -description: 安装 KubeBlocks 引擎 -keywords: [kbcli, kubeblocks, addons, 安装，引擎] -sidebar_position: 3 -sidebar_label: 安装引擎 ---- - -# 安装引擎 - -KubeBlocks v0.8.0 发布后，引擎（Addon）与 KubeBlocks 解耦，KubeBlocks 默认安装了部分引擎，如需体验其它引擎，需通过索引安装相关引擎。如果您卸载了部分引擎，也可通过本文步骤，重新安装。 - -本文以 etcd 为例，可根据实际情况替换引擎名称。 - -官网引擎索引仓库为 [KubeBlocks index](https://github.com/apecloud/block-index)。引擎代码维护在 [KubeBlocks addon repo](https://github.com/apecloud/kubeblocks-addons)。 - -## 使用索引安装引擎 - -1. 查看引擎仓库索引。 - - kbcli 默认创建名为 `kubeblocks` 的索引，可使用 `kbcli addon index list` 查看该索引。 - - ```bash - kbcli addon index list - > - INDEX URL - kubeblocks https://github.com/apecloud/block-index.git - ``` - - 如果命令执行结果未显示或者你想要添加自定义索引仓库，则表明索引未建立，可使用 `kbcli addon index add ` 命令手动添加索引。例如， - - ```bash - kbcli addon index add kubeblocks https://github.com/apecloud/block-index.git - ``` - - 如果不确定索引是否为最新版本，可使用如下命令更新索引。 - - ```bash - kbcli addon index update kubeblocks - ``` - -2. （可选）索引建立后，可以通过 `addon search` 命令检查想要安装的引擎是否在索引信息中存在。 - - ```bash - kbcli addon search etcd - > - ADDON VERSION INDEX - etcd 0.7.0 kubeblocks - etcd 0.8.0 kubeblocks - etcd 0.9.0 kubeblocks - ``` - -3. 安装引擎。 - - 当引擎有多个版本和索引源时，可使用 `--index` 指定索引源，`--version` 指定安装版本。系统默认以 `kubeblocks` 索引仓库 为索引源，安装最新版本。 - - ```bash - kbcli addon install etcd --index kubeblocks --version x.y.z - ``` - - **后续操作** - - 引擎安装完成后，可查看引擎列表、启用引擎。 - -## 查看引擎列表 - -执行 `kbcli addon list` 命令查看已经支持的引擎。 - -## 启用/禁用引擎 - -请按照以下步骤手动启用或禁用引擎。 - -***步骤：*** - -1. 执行 `kbcli addon enable` 启用引擎。 - - ***示例*** - - ```bash - kbcli addon enable etcd - ``` - - 执行 `kbcli addon disable` 禁用引擎。 - -2. 再次查看引擎列表，检查是否已启用引擎。 - - ```bash - kbcli addon list - ``` - -## 卸载引擎 - -您也可卸载已安装的引擎。如果已经创建了相关集群，请先删除集群。 - -```bash -kbcli cluster delete -``` - -卸载已安装的引擎。 - -```bash -kbcli addon uninstall etcd -``` diff --git a/i18n/zh-cn/user-docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md b/i18n/zh-cn/user-docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md deleted file mode 100644 index 6cc48b87e5f..00000000000 --- a/i18n/zh-cn/user-docs/installation/install-with-kbcli/install-kubeblocks-with-kbcli.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: 用 kbcli 安装 KubeBlocks -description: 如何用 kbcli 安装 KubeBlocksInstall KubeBlocks -keywords: [taints, affinity, tolerance, 安装, kbcli, KubeBlocks] -sidebar_position: 2 -sidebar_label: 用 kbcli 安装 KubeBlocks ---- - -# 用 kbcli 安装 KubeBlocks - -使用 Playground 创建一个新的 Kubernetes 集群并安装 KubeBlocks，是快速上手的一种方法。然而，在实际生产环境中，情况会复杂得多，应用程序在不同的命名空间中运行，还存在资源或权限限制。本文档将介绍如何在现有的 Kubernetes 集群上部署 KubeBlocks。 - -如果您想要在本地环境试用 KubeBlocks，可通过 [Playground](./../../try-out-on-playground/try-kubeblocks-on-local-host.md) 试用，或者[先在本地创建 Kubernetes 测试集群](./../prerequisite/prepare-a-local-k8s-cluster.md)，然后按照本文操作步骤安装 KubeBlocks。 - -## 环境准备 - -准备一个可访问的 Kubernetes 集群，版本要求 1.22 及以上。该集群应满足如下要求。 - - - - - - - - - - - - - - - - - - - - - - - - - - -
资源要求
控制面建议创建 1 个具有 4 核 CPU、4 GB 内存和 50 GB 存储空间的节点。
数据面 MySQL 建议至少创建 3 个具有 2 核 CPU、4 GB 内存和 50 GB 存储空间的节点。
PostgreSQL 建议至少创建 2 个具有 2 核 CPU、4 GB 内存和 50 GB 存储空间的节点。
Redis 建议至少创建 2 个具有 2 核 CPU、4 GB 内存和 50 GB 存储空间的节点。
MongoDB 建议至少创建 3 个具有 2 核 CPU、4 GB 内存和 50 GB 存储空间的节点。
- -## 安装步骤 - -执行 `kbcli kubeblocks install` 将 KubeBlocks 安装在 `kb-system` 命名空间中，或者使用 `--namespace` 指定一个命名空间。 - -```bash -kbcli kubeblocks install -``` - -如果想安装 KubeBlocks 的指定版本，请按照以下步骤操作： - -1. 查看可用的版本。 - - ```bash - kbcli kubeblocks list-versions - ``` - - 如需查看包含 alpha 和 beta 在内的版本，可执行以下命令。 - - ```bash - kbcli kb list-versions --devel --limit=100 - ``` - - 或者，你可以在 [KubeBlocks Release 页面](https://github.com/apecloud/kubeblocks/releases/)中查看可用的版本。 - -2. 使用 `--version` 指定版本。 - - ```bash - kbcli kubeblocks install --version=x.x.x - ``` - - :::note - - kbcli 默认安装最新版本。如果您的环境中已有正在运行的 KubeBlocks 实例，则需要安装与之匹配的 kbcli 版本。 - - 例如，如果您当前使用的 KubeBlocks 版本是 v0.8.3，kbcli 应安装对应的 v0.8.3，而不是更高版本（如 v0.9.0），否则系统将因版本不匹配产生报错。 - - ::: - -## 验证 KubeBlocks 安装 - -执行以下命令来检查 KubeBlocks 是否已成功安装。 - -```bash -kbcli kubeblocks status -``` - -***结果*** - -如果工作负载都显示已准备就绪，则表明已成功安装 KubeBlocks。 - -```bash -KubeBlocks is deployed in namespace: kb-system,version: x.x.x -> -KubeBlocks Workloads: -NAMESPACE KIND NAME READY PODS CPU(CORES) MEMORY(BYTES) CREATED-AT -kb-system Deployment kb-addon-snapshot-controller 1/1 N/A N/A Oct 13,2023 14:27 UTC+0800 -kb-system Deployment kubeblocks 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 -kb-system Deployment kubeblocks-dataprotection 1/1 N/A N/A Oct 13,2023 14:26 UTC+0800 -``` diff --git a/i18n/zh-cn/user-docs/installation/install-with-kbcli/uninstall-kbcli-and-kubeblocks.md b/i18n/zh-cn/user-docs/installation/uninstall-kubeblocks-and-kbcli.md similarity index 69% rename from i18n/zh-cn/user-docs/installation/install-with-kbcli/uninstall-kbcli-and-kubeblocks.md rename to i18n/zh-cn/user-docs/installation/uninstall-kubeblocks-and-kbcli.md index 7bb0fa52593..24da23137e8 100644 --- a/i18n/zh-cn/user-docs/installation/install-with-kbcli/uninstall-kbcli-and-kubeblocks.md +++ b/i18n/zh-cn/user-docs/installation/uninstall-kubeblocks-and-kbcli.md @@ -1,36 +1,58 @@ --- -title: 卸载 kbcli 和 KubeBlocks -description: 卸载 kbcli 和 KubeBlocks -keywords: [kbcli, kubeblocks, 卸载] -sidebar_position: 4 -sidebar_label: 卸载 KubeBlocks 和 kbcli +title: 卸载 KubeBlocks +description: 卸载 KubeBlocks +keywords: [kubeblocks, 卸载] +sidebar_position: 5 +sidebar_label: 卸载 KubeBlocks 及 kbcli --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# 卸载 KubeBlocks 和 kbcli +# 卸载 KubeBlocks 及 kbcli 卸载顺序： 1. 如果已经创建了集群，请先删除集群。 - ```bash - kbcli cluster delete - ``` + ```bash + kubebctl delete cluster -n namespace + ``` 2. 卸载 KubeBlocks。 -3. 卸载 kbcli。 - ## 卸载 KubeBlocks -如果想在试用结束后删除 KubeBlocks，请执行以下操作： + + + + +在执行以下命令前，请删除之前创建的所有集群和资源，否则卸载可能无法成功。 + +```bash +helm uninstall kubeblocks --namespace kb-system +``` + +Helm 不会删除 CRD 对象。请使用以下命令删除 KubeBlocks 创建的对象。 + +```bash +kubectl get crd -o name | grep kubeblocks.io | xargs kubectl delete +``` + + + + + +从 KubeBlocks chart 生成 YAML 文件，并使用 `kubectl` 进行卸载。使用 `--version x.y.z` 指定版本，确保卸载的版本与安装的版本相同。 ```bash -kbcli kubeblocks uninstall +helm template kubeblocks kubeblocks/kubeblocks --version x.y.z --namespace kb-system | kubectl delete -f - ``` + + + + ## 卸载 kbcli 如果想在试用结束后删除 kbcli，请选择与安装 kbcli 时所使用的相同选项。 @@ -90,3 +112,4 @@ kbcli 会在 HOME 目录下创建一个名为 `~/.kbcli` 的隐藏文件夹， + From fa326671cd8a7c1ddf6f76d39c9c3fc45da262f6 Mon Sep 17 00:00:00 2001 From: yuanyuan zhang Date: Thu, 21 Nov 2024 18:02:52 +0800 Subject: [PATCH 2/4] docs: fix typos --- docs/user_docs/installation/install-addons.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_docs/installation/install-addons.md b/docs/user_docs/installation/install-addons.md index ae01a43f99c..8ae0fe49466 100644 --- a/docs/user_docs/installation/install-addons.md +++ b/docs/user_docs/installation/install-addons.md @@ -156,7 +156,7 @@ You can enable them according to your needs. kbcli addon disable qdrant ``` -After enabling/disabling an Addon, check the Addon list to verify whether the Addon's staus changes as required. +After enabling/disabling an Addon, check the Addon list to verify whether the Addon's status changes as required. ```bash kbcli addon list From 977c9792da5115380012b14d557dfcec4f2e6da9 Mon Sep 17 00:00:00 2001 From: yuanyuan zhang Date: Tue, 26 Nov 2024 17:57:49 +0800 Subject: [PATCH 3/4] docs: update related links --- .../create-and-connect-an-apecloud-mysql-cluster.md | 6 +++--- .../high-availability/high-availability.md | 2 +- .../proxy/apecloud-mysql-proxy.md | 4 ++-- .../kubeblocks-for-elasticsearch/manage-elasticsearch.md | 6 +++--- .../cluster-management/create-a-kafka-cluster.md | 6 +++--- docs/user_docs/kubeblocks-for-milvus/manage-milvus.md | 6 +++--- .../create-and-connect-to-a-mongodb-cluster.md | 6 +++--- .../create-and-connect-a-mysql-cluster.md | 6 +++--- .../high-availability/high-availability.md | 2 +- .../create-and-connect-a-postgresql-cluster.md | 6 +++--- .../high-availability/high-availability.md | 4 ++-- .../create-pulsar-cluster-on-kubeblocks.md | 5 +++-- docs/user_docs/kubeblocks-for-qdrant/manage-qdrant.md | 6 +++--- docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md | 4 ++-- .../create-and-connect-a-redis-cluster.md | 6 +++--- .../high-availability/high-availability.md | 2 +- docs/user_docs/kubeblocks-for-redis/redis-cluster-mode.md | 2 +- .../kubeblocks-for-starrocks/manage-starrocks.md | 6 +++--- .../maintenance/backup-and-restore/backup/backup-repo.md | 4 ++-- .../try-out-on-playground/try-kubeblocks-on-cloud.md | 8 ++++---- .../try-kubeblocks-on-your-laptop.md | 2 +- .../create-and-connect-a-mysql-cluster.md | 6 +++--- .../high-availability/high-availability.md | 2 +- .../proxy/apecloud-mysql-proxy.md | 4 ++-- .../kubeblocks-for-elasticsearch/manage-elasticsearch.md | 6 +++--- .../cluster-management/create-a-kafka-cluster.md | 6 +++--- .../user-docs/kubeblocks-for-milvus/manage-milvus.md | 6 +++--- .../create-and-connect-to-a-mongodb-cluster.md | 6 +++--- .../create-and-connect-a-mysql-cluster.md | 6 +++--- .../high-availability/high-availability.md | 2 +- .../create-and-connect-a-postgresql-cluster.md | 6 +++--- .../high-availability/high-availability.md | 2 +- .../cluster-management/create-pulsar-cluster-on-kb.md | 6 +++--- .../user-docs/kubeblocks-for-qdrant/manage-qdrant.md | 6 +++--- .../create-and-connect-to-a-redis-cluster.md | 6 +++--- .../high-availability/high-availability.md | 2 +- .../kubeblocks-for-starrocks/manage-starrocks.md | 6 +++--- .../maintenance/backup-and-restore/backup/backup-repo.md | 4 ++-- i18n/zh-cn/user-docs/observability/monitor-database.md | 2 +- .../try-out-on-playground/try-kubeblocks-on-cloud.md | 8 ++++---- .../try-out-on-playground/try-kubeblocks-on-local-host.md | 2 +- 41 files changed, 97 insertions(+), 96 deletions(-) diff --git a/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md b/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md index fd05e9943c5..0a07921c19c 100644 --- a/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md +++ b/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md @@ -17,9 +17,9 @@ This tutorial shows how to create and connect to an ApeCloud MySQL cluster. ### Before you start -* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md) if you want to create and connect a MySQL cluster by `kbcli`. -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). -* Check whether the ApeCloud MySQL Addon is enabled. The ApeCloud MySQL Addon is enabled by KubeBlocks by default. If you disable it when installing KubeBlocks,[enable it](./../../installation/install-with-kbcli/install-addons.md#enabledisable-addons) first. +* [Install kbcli](./../../installation/install-kbcli.md) if you want to create and connect a MySQL cluster by `kbcli`. +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). +* Check whether the ApeCloud MySQL Addon is enabled. The ApeCloud MySQL Addon is enabled by KubeBlocks by default. If you disable it when installing KubeBlocks,[enable it](./../../installation/install-addons.md) first. diff --git a/docs/user_docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md b/docs/user_docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md index 1275a1c2470..3fcb4b4d728 100644 --- a/docs/user_docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md +++ b/docs/user_docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md @@ -24,7 +24,7 @@ The faults here are all simulated by deleting a pod. When there are sufficient r ### Before you start -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). * Create an ApeCloud MySQL RaftGroup, refer to [Create a MySQL cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md). * Run `kubectl get cd apecloud-mysql -o yaml` to check whether _rolechangedprobe_ is enabled in the ApeCloud MySQL RaftGroup (it is enabled by default). If the following configuration exists, it indicates that it is enabled: diff --git a/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md b/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md index ee758a460c2..e49025e4939 100644 --- a/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md +++ b/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; ## Before you start -1. [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md). +1. [Install kbcli](./../../installation/install-kbcli.md). 2. [Install Helm](https://helm.sh/docs/intro/install/). 3. Install KubeBlocks. @@ -26,7 +26,7 @@ import TabItem from '@theme/TabItem'; kbcli playground init --version='x.y.z' ``` - Or if you already have a Kubernetes cluster, you can install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md) directly. + Or if you already have a Kubernetes cluster, you can [install KubeBlocks](./../../installation/install-kubeblocks.md)directly. 4. Prepare an ApeCloud MySQL RaftGroup named `mycluster` for demonstrating how to enable the proxy function for an existing cluster. Refer to [Create a MySQL cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md) for details. ## Create a Proxy Cluster diff --git a/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md b/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md index bbc4da8588b..06b22d98620 100644 --- a/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md +++ b/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md @@ -17,9 +17,9 @@ KubeBlocks supports the management of Elasticsearch. This tutorial illustrates h ## Before you start -- [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md) if you want to manage your Elasticsearch cluster with `kbcli`. -- Install KubeBlocks [by kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../installation/install-with-helm/install-kubeblocks.md). -- Install and enable the elasticsearch Addon [by kbcli](./../installation/install-with-kbcli/install-addons.md) or [by Helm](./../installation/install-with-helm/install-addons.md). +- [Install kbcli](./../installation/install-kbcli.md) if you want to manage your Elasticsearch cluster with `kbcli`. +- [Install KubeBlocks](./../installation/install-kubeblocks.md). +- [Install and enable the elasticsearch Addon](./../installation/install-addons.md). - To keep things isolated, create a separate namespace called `demo` throughout this tutorial. ```bash diff --git a/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md b/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md index 05243f80714..2efeae8e80b 100644 --- a/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md +++ b/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md @@ -15,9 +15,9 @@ This document shows how to create a Kafka cluster. ## Before you start -* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md) if you want to create a Kafka cluster by `kbcli`. -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). -* Make sure Kafka Addon is enabled with `kbcli addon list`. If this Addon is not enabled, enable it first. Both [kbccli](./../../installation/install-with-kbcli/install-addons.md) and [Helm](./../../installation/install-with-helm/install-addons.md) options are available. +* [Install kbcli](./../../installation/install-kbcli.md) if you want to create a Kafka cluster by `kbcli`. +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). +* Make sure Kafka Addon is enabled with `kbcli addon list`. If this Addon is not enabled, [enable it](./../../installation/install-addons.md) first. diff --git a/docs/user_docs/kubeblocks-for-milvus/manage-milvus.md b/docs/user_docs/kubeblocks-for-milvus/manage-milvus.md index 43e227ee056..5f0459478b2 100644 --- a/docs/user_docs/kubeblocks-for-milvus/manage-milvus.md +++ b/docs/user_docs/kubeblocks-for-milvus/manage-milvus.md @@ -19,9 +19,9 @@ This tutorial illustrates how to create and manage a Milvus cluster by `kbcli`, ## Before you start -- [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md) if you want to manage the Milvus cluster with `kbcli`. -- Install KubeBlocks [by kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md). -- Install and enable the milvus Addon [by kbcli](./../installation/install-with-kbcli/install-addons.md) or [by Helm](./../installation/install-with-helm/install-addons.md). +- [Install kbcli](./../installation/install-kbcli.md) if you want to manage the Milvus cluster with `kbcli`. +- [Install KubeBlocks](./../installation/install-kubeblocks.md). +- [Install and enable the milvus Addon](./../installation/install-addons.md). - To keep things isolated, create a separate namespace called `demo` throughout this tutorial. ```bash diff --git a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md index f7b5ffcff47..258199444f7 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md +++ b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md @@ -17,9 +17,9 @@ This tutorial shows how to create and connect to a MongoDB cluster. ### Before you start -* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md) if you want to create and connect a MySQL cluster by `kbcli`. -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). -* Make sure the MongoDB Addon is enabled. If this addon is not enabled, enable it first. Both [kbcli](./../../installation/install-with-kbcli/install-addons.md) and [Helm](./../../installation/install-with-helm/install-addons.md) options are available. +* [Install kbcli](./../../installation/install-kbcli.md) if you want to create and connect a MySQL cluster by `kbcli`. +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). +* Make sure the MongoDB Addon is enabled. If this addon is not enabled, [enable it](./../../installation/install-addons.md) first. diff --git a/docs/user_docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md b/docs/user_docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md index e1b546c5e50..2db1083e05b 100644 --- a/docs/user_docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md +++ b/docs/user_docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md @@ -17,9 +17,9 @@ This tutorial shows how to create and connect to a MySQL cluster. ### Before you start -* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md). -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). -* Make sure the MySQL Addon is enabled. The MySQL Addon is installed and enabled by KubeBlocks by default. If you disable it when installing KubeBlocks, [enable it](./../../installation/install-with-kbcli/install-addons.md) first. +* [Install kbcli](./../../installation/install-kbcli.md). +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). +* Make sure the MySQL Addon is enabled. The MySQL Addon is installed and enabled by KubeBlocks by default. If you disable it when installing KubeBlocks, [enable it](./../../installation/install-addons.md) first. diff --git a/docs/user_docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md b/docs/user_docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md index 83613e94cba..0502026718f 100644 --- a/docs/user_docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md +++ b/docs/user_docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md @@ -24,7 +24,7 @@ The faults here are all simulated by deleting a pod. When there are sufficient r ### Before you start -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). * Create a MySQL Replication Cluster, refer to [Create a MySQL cluster](./../cluster-management/create-and-connect-a-mysql-cluster.md). * Run `kubectl get cd mysql -o yaml` to check whether _rolechangedprobe_ is enabled in the MySQL Replication (it is enabled by default). If the following configuration exists, it indicates that it is enabled: diff --git a/docs/user_docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md b/docs/user_docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md index a582d886d6a..da0048345ba 100644 --- a/docs/user_docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md +++ b/docs/user_docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md @@ -17,9 +17,9 @@ This tutorial shows how to create and connect to a PostgreSQL cluster. ### Before you start -* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md) if you want to manage the PostgreSQL cluster by `kbcli`. -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). -* Make sure the PostgreSQL Addon is enabled. The PostgreSQL Addon is installed and enabled by KubeBlocks by default. But if you disable it when installing KubeBlocks, [enable it](./../../installation/install-with-kbcli/install-addons.md) first. +* [Install kbcli](./../../installation/install-kbcli.md) if you want to manage the PostgreSQL cluster by `kbcli`. +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). +* Make sure the PostgreSQL Addon is enabled. The PostgreSQL Addon is installed and enabled by KubeBlocks by default. But if you disable it when installing KubeBlocks, [enable it](./../../installation/install-addons.md) first. diff --git a/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md b/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md index 9eaa9dfa912..48552eff946 100644 --- a/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md +++ b/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md @@ -14,8 +14,8 @@ KubeBlocks integrates [the open-source Patroni solution](https://patroni.readthe ## Before you start -* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md) if you want to manage the PostreSQL cluster with `kbcli`. -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). +* [Install kbcli](./../../installation/install-kbcli.md) if you want to manage the PostreSQL cluster with `kbcli`. +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). * [Create a PostgreSQL Replication Cluster](./../cluster-management/create-and-connect-a-postgresql-cluster.md#create-a-postgresql-cluster). * Check whether the following role probe parameters exist to verify the role probe is enabled. diff --git a/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md b/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md index b4fe2ddd1b8..268dc31c843 100644 --- a/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md +++ b/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md @@ -29,8 +29,9 @@ Refer to the [Pulsar official document](https://pulsar.apache.org/docs/3.1.x/) f ## Before you start -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](../../../user_docs/installation/install-with-helm/install-kubeblocks.md). -* Check whether the Pulsar Addon is enabled. If this Addon is disabled, [enable it](./../../installation/install-with-kbcli/install-addons.md#enabledisable-addons) first. +* [Install kbcli](./../../installation/install-kbcli.md) if you want to manage the StarRocks cluster with `kbcli`. +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). +* Check whether the Pulsar Addon is enabled. If this Addon is disabled, [enable it](./../../installation/install-addons.md) first. * View all the database types and versions available for creating a cluster. diff --git a/docs/user_docs/kubeblocks-for-qdrant/manage-qdrant.md b/docs/user_docs/kubeblocks-for-qdrant/manage-qdrant.md index e121d10b33b..9fe611c714c 100644 --- a/docs/user_docs/kubeblocks-for-qdrant/manage-qdrant.md +++ b/docs/user_docs/kubeblocks-for-qdrant/manage-qdrant.md @@ -17,9 +17,9 @@ KubeBlocks supports the management of Qdrant. This tutorial illustrates how to c ## Before you start -- [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md) if you want to manage the Qdrant cluster with `kbcli`. -- Install KubeBlocks [by kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../installation/install-with-helm/install-kubeblocks.md). -- Install and enable the Qdrant Addon [by kbcli](./../installation/install-with-kbcli/install-addons.md) or [by Helm](./../installation/install-with-helm/install-addons.md). +- [Install kbcli](./../installation/install-kbcli.md) if you want to manage the Qdrant cluster with `kbcli`. +- [Install KubeBlocks](./../installation/install-kubeblocks.md). +- [Install and enable the Qdrant Addon](./../installation/install-addons.md). - To keep things isolated, create a separate namespace called `demo` throughout this tutorial. ```bash diff --git a/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md b/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md index aca7cd46740..cd9b5c6fc73 100644 --- a/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md +++ b/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md @@ -20,8 +20,8 @@ Currently, KubeBlocks only supports managing RabbitMQ by `kubectl`. ## Before you start -- Install KubeBlocks [by kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../installation/install-with-helm/install-kubeblocks.md). -- Install and enable the rabbitmq addon [by kbcli](./../installation/install-with-kbcli/install-addons.md) or [by Helm](./../installation/install-with-helm/install-addons.md). +- [Install KubeBlocks](./../installation/install-kubeblocks.md). +- [Install and enable the rabbitmq addon](./../installation/install-addons.md). ## Create a cluster diff --git a/docs/user_docs/kubeblocks-for-redis/cluster-management/create-and-connect-a-redis-cluster.md b/docs/user_docs/kubeblocks-for-redis/cluster-management/create-and-connect-a-redis-cluster.md index 96e9c0ba53c..37ba5704f05 100644 --- a/docs/user_docs/kubeblocks-for-redis/cluster-management/create-and-connect-a-redis-cluster.md +++ b/docs/user_docs/kubeblocks-for-redis/cluster-management/create-and-connect-a-redis-cluster.md @@ -17,9 +17,9 @@ This tutorial shows how to create and connect to a Redis cluster. ### Before you start -* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md) if you want to create a Redis cluster by `kbcli`. -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). -* Make sure the Redis Addon is enabled. The Redis Addon is enabled by KubeBlocks by default. If you disable it when installing KubeBlocks, [enable it](./../../installation/install-with-kbcli/install-addons.md) first. +* [Install kbcli](./../../installation/install-kbcli.md) if you want to create a Redis cluster by `kbcli`. +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). +* Make sure the Redis Addon is enabled. The Redis Addon is enabled by KubeBlocks by default. If you disable it when installing KubeBlocks, [enable it](./../../installation/install-addons.md) first. diff --git a/docs/user_docs/kubeblocks-for-redis/high-availability/high-availability.md b/docs/user_docs/kubeblocks-for-redis/high-availability/high-availability.md index abd9f188f5f..28efeb3e543 100644 --- a/docs/user_docs/kubeblocks-for-redis/high-availability/high-availability.md +++ b/docs/user_docs/kubeblocks-for-redis/high-availability/high-availability.md @@ -18,7 +18,7 @@ In the Redis Replication Cluster provided by KubeBlocks, Sentinel is deployed as ## Before you start -* Install KubeBlocks [by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../../installation/install-with-helm/install-kubeblocks.md). +* [Install KubeBlocks](./../../installation/install-kubeblocks.md). * [Create a Redis Replication Cluster](./../cluster-management/create-and-connect-a-redis-cluster.md#create-a-redis-cluster). * Check the Switch Policy and the role probe. * Check whether the switch policy is `Noop`. diff --git a/docs/user_docs/kubeblocks-for-redis/redis-cluster-mode.md b/docs/user_docs/kubeblocks-for-redis/redis-cluster-mode.md index 0f771fcbfbe..b0c1ea2e317 100644 --- a/docs/user_docs/kubeblocks-for-redis/redis-cluster-mode.md +++ b/docs/user_docs/kubeblocks-for-redis/redis-cluster-mode.md @@ -30,7 +30,7 @@ Below is a brief introduction to the basic operations of Redis Cluster Mode. ### Before you start -* Install KubeBlocks [by kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](../../user_docs/installation/install-with-helm/install-kubeblocks.md). +* [Install KubeBlocks](./../installation/install-kubeblocks.md). Make sure your KubeBlocks and addon are version 0.9 or above. * Make sure the Redis Addon is enabled. * View all the database types and versions available for creating a cluster. diff --git a/docs/user_docs/kubeblocks-for-starrocks/manage-starrocks.md b/docs/user_docs/kubeblocks-for-starrocks/manage-starrocks.md index 3475270d334..2756c7b2a3a 100644 --- a/docs/user_docs/kubeblocks-for-starrocks/manage-starrocks.md +++ b/docs/user_docs/kubeblocks-for-starrocks/manage-starrocks.md @@ -17,9 +17,9 @@ This tutorial illustrates how to create and manage a StarRocks cluster by `kbcli ## Before you start -- [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md) if you want to manage the StarRocks cluster with `kbcli`. -- Install KubeBlocks [by kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) or [by Helm](./../installation/install-with-helm/install-kubeblocks.md). -- Install and enable the starrocks Addon [by kbcli](./../installation/install-with-kbcli/install-addons.md) or [by Helm](./../installation/install-with-helm/install-addons.md). +- [Install kbcli](./../installation/install-kbcli.md) if you want to manage the StarRocks cluster with `kbcli`. +- [Install KubeBlocks](./../installation/install-kubeblocks.md). +- [Install and enable the starrocks Addon](./../installation/install-addons.md). - To keep things isolated, create a separate namespace called `demo` throughout this tutorial. ```bash diff --git a/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md b/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md index 43322cd7253..59b5d679750 100644 --- a/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md +++ b/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md @@ -19,10 +19,10 @@ You can create multiple BackupRepos to suit different scenarios. For example, ba Make sure you have all the following prepared. -* [Install kbcli](./../../../installation/install-with-kbcli/install-kbcli.md). +* [Install kbcli](./../../../installation/install-kbcli.md). * [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl). * [Install Helm](https://helm.sh/docs/intro/install/). -* Install KubeBlocks by [kbcli](./../../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md). +* [Install KubeBlocks](./../../../installation/install-kubeblocks.md). ## Install MinIO diff --git a/docs/user_docs/try-out-on-playground/try-kubeblocks-on-cloud.md b/docs/user_docs/try-out-on-playground/try-kubeblocks-on-cloud.md index d2c0138ce6a..694b6ee5cdc 100644 --- a/docs/user_docs/try-out-on-playground/try-kubeblocks-on-cloud.md +++ b/docs/user_docs/try-out-on-playground/try-kubeblocks-on-cloud.md @@ -26,7 +26,7 @@ Make sure you have all the followings prepared. * [Install AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) * [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) -* [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md) +* [Install kbcli](./../installation/install-kbcli.md) ### Configure access key @@ -85,7 +85,7 @@ Make sure you have all the followings prepared. * Google Cloud account * [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) -* [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md) +* [Install kbcli](./../installation/install-kbcli.md) ### Configure GCP environment @@ -156,7 +156,7 @@ Make sure you have all the followings prepared. * Tencent Cloud account * [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) -* [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md) +* [Install kbcli](./../installation/install-kbcli.md) ### Configure TKE environment @@ -209,7 +209,7 @@ Make sure you have all the followings prepared. * Alibaba Cloud account. * [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl). -* [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md). +* [Install kbcli](./../installation/install-kbcli.md). ### Configure ACK environment diff --git a/docs/user_docs/try-out-on-playground/try-kubeblocks-on-your-laptop.md b/docs/user_docs/try-out-on-playground/try-kubeblocks-on-your-laptop.md index 730d499f8ab..201383eafb3 100644 --- a/docs/user_docs/try-out-on-playground/try-kubeblocks-on-your-laptop.md +++ b/docs/user_docs/try-out-on-playground/try-kubeblocks-on-your-laptop.md @@ -21,7 +21,7 @@ Meet the following requirements for a smooth user experience: * Make sure the following tools are installed on your laptop: * [Docker](https://docs.docker.com/get-docker/): v20.10.5 (runc ≥ v1.0.0-rc93) or above; * [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl): it is used to interact with Kubernetes clusters; - * [kbcli](./../installation/install-with-kbcli/install-kbcli.md): it is used for the interaction between Playground and KubeBlocks. + * [kbcli](./../installation/install-kbcli.md): it is used for the interaction between Playground and KubeBlocks. ## Initialize Playground diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-a-mysql-cluster.md b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-a-mysql-cluster.md index 5c52dd7840b..6878db39579 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-a-mysql-cluster.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/cluster-management/create-and-connect-a-mysql-cluster.md @@ -17,9 +17,9 @@ import TabItem from '@theme/TabItem'; ### 开始之前 -* 如果您想通过 `kbcli` 创建并连接 ApeCloud MySQL 集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或者 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 -* 确保 ApeCloud MySQL 引擎已启用。KubeBlocks 默认已安装 ApeCloud MySQL，如果您在安装 KubeBlocks 关闭/卸载了该引擎，可参考相关文档，再次启用/安装该引擎，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或者 [Helm](./../../installation/install-with-helm/install-addons.md) 操作。 +* 如果您想通过 `kbcli` 创建并连接 ApeCloud MySQL 集群，请先[安装 kbcli](./../../installation/install-kbcli.md)。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 +* 确保 ApeCloud MySQL 引擎已启用。KubeBlocks 默认已安装 ApeCloud MySQL，如果您在安装 KubeBlocks 关闭/卸载了该引擎，可参考相关文档，再次[启用/安装该引擎](./../../installation/install-addons.md)。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md index e0e97084fcc..27b766b772a 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md @@ -24,7 +24,7 @@ import TabItem from '@theme/TabItem'; ### 开始之前 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 * 创建一个 ApeCloud MySQL 集群版，详情可参考[创建 MySQL 集群](./../cluster-management/create-and-connect-a-mysql-cluster.md)。 * 执行 `kubectl get cd apecloud-mysql -o yaml` 检查 ApeCloud MySQL 集群版是否已启用 _rolechangedprobe_（默认情况下是启用的）。如果出现以下配置信息，则表明已启用： diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md index 4441aa7308c..906b3d8f32a 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; ## 开始之前 -1. [安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 +1. [安装 kbcli](./../../installation/install-kbcli.md)。 2. [安装 Helm](https://helm.sh/docs/intro/install/)。 3. 安装 KubeBlocks。 @@ -26,7 +26,7 @@ import TabItem from '@theme/TabItem'; kbcli playground init --version='x.y.z' ``` - 如果已经有 Kubernetes 集群，可以通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装 KubeBlocks。 + 如果已经有 Kubernetes 集群，可以直接[安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 4. 准备一个名为 mycluster 的 ApeCloud MySQL 集群版集群，用于演示如何为现有集群启用代理功能。详情请参考[创建并连接到 MySQL 集群](./../cluster-management/create-and-connect-a-mysql-cluster.md)。 ## 创建代理集群 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md b/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md index 7ec3f015720..0048f142b13 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md @@ -17,9 +17,9 @@ Elasticsearch 是一个分布式、RESTful 风格的搜索和数据分析引擎 ## 开始之前 -- 如果您想通过 `kbcli` 创建并连接 Elasticsearch 集群，请先[安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 -- 安装 KubeBlocks，可通过 [kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../installation/install-with-helm/install-kubeblocks.md) 安装。 -- 安装并启用 elasticsearch 引擎，可通过 [kbcli](./../installation/install-with-kbcli/install-addons.md) 或 [Helm](./../installation/install-with-helm/install-addons.md) 操作。 +- 如果您想通过 `kbcli` 创建并连接 Elasticsearch 集群，请先[安装 kbcli](./../installation/install-kbcli.md)。 +- [安装 KubeBlocks](./../installation/install-kubeblocks.md)。 +- [安装并启用 elasticsearch 引擎](./../installation/install-addons.md)。 ## 创建集群 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md b/i18n/zh-cn/user-docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md index 71813cc23c5..14176e94901 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md @@ -15,9 +15,9 @@ import TabItem from '@theme/TabItem'; ## 开始之前 -* 如果您想通过 `kbcli` 创建和管理集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 -* 确保 Kafka 引擎 已启用。如果引擎未启用，可参考相关文档，启用该引擎，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或 [Helm](./../../installation/install-with-kbcli/install-addons.md) 操作。 +* 如果您想通过 `kbcli` 创建和管理集群，请先[安装 kbcli](./../../installation/install-kbcli.md)。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 +* 确保 Kafka 引擎 已启用。如果引擎未启用，可参考相关文档，[启用该引擎](./../../installation/install-addons.md)。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-milvus/manage-milvus.md b/i18n/zh-cn/user-docs/kubeblocks-for-milvus/manage-milvus.md index 508f03145e8..faa21bdacc2 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-milvus/manage-milvus.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-milvus/manage-milvus.md @@ -19,9 +19,9 @@ Milvus 是高度灵活、可靠且速度极快的云原生开源矢量数据库 ## 开始之前 -- 如果您想通过 `kbcli` 创建并连接 Milvus 集群，请先[安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 -- 安装 KubeBlocks，可通过 [kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../installation/install-with-helm/install-kubeblocks.md) 安装。 -- 安装并启用 milvus 引擎，可通过 [kbcli](./../installation/install-with-kbcli/install-addons.md) 或 [Helm](./../installation/install-with-helm/install-addons.md) 操作。 +- 如果您想通过 `kbcli` 创建并连接 Milvus 集群，请先[安装 kbcli](./../installation/install-kbcli.md)。 +- [安装 KubeBlocks](./../installation/install-kubeblocks.md)。 +- [安装并启用 milvus 引擎](./../installation/install-addons.md)。 - 为了保持隔离，本文档中创建一个名为 `demo` 的独立命名空间。 ```bash diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md b/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md index e7b3265c0ca..6a12e758d21 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md @@ -17,9 +17,9 @@ import TabItem from '@theme/TabItem'; ### 开始之前 -* 如果您想通过 `kbcli` 创建并连接 MongoDB 集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md)。 -* 确保 MongoDB 引擎已启用。如果引擎未安装/启用，可参考相关文档，安装/启用该引擎，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或者 [Helm](./../../installation/install-with-helm/install-addons.md) 操作。 +* 如果您想通过 `kbcli` 创建并连接 MongoDB 集群，请先[安装 kbcli](./../../installation/install-kbcli.md)。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 +* 确保 MongoDB 引擎已启用。如果引擎未安装/启用，可参考相关文档，[安装/启用该引擎](./../../installation/install-addons.md)。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md b/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md index 63c0e277554..b3939e4c0da 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md @@ -17,9 +17,9 @@ import TabItem from '@theme/TabItem'; ### 开始之前 -* 如果您想通过 `kbcli` 创建并连接 ApeCloud MySQL 集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 -* 确保 MySQL 引擎已启用。KubeBlocks 默认已安装 MySQL，如果您在安装 KubeBlocks 关闭/卸载了该引擎，可参考相关文档，再次启用/安装该引擎，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或者 [Helm](./../../installation/install-with-helm/install-addons.md) 操作。 +* 如果您想通过 `kbcli` 创建并连接 ApeCloud MySQL 集群，请先[安装 kbcli](./../../installation/install-kbcli.md)。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 +* 确保 MySQL 引擎已启用。KubeBlocks 默认已安装 MySQL，如果您在安装 KubeBlocks 关闭/卸载了该引擎，可参考相关文档，再次[启用/安装该引擎](./../../installation/install-addons.md)。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md b/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md index 42d78667c8e..2a2d7a22481 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md @@ -24,7 +24,7 @@ import TabItem from '@theme/TabItem'; ### 开始之前 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 * 创建 MySQL 主备版集群，详情可参考 [创建 MySQL 集群](./../cluster-management/create-and-connect-a-mysql-cluster.md)。 * 执行 `kubectl get cd mysql -o yaml` 检查 MySQL 集群版是否已启用 _rolechangedprobe_（默认情况下是启用的）。如果出现以下配置信息，则表明已启用： diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md b/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md index 588cd8c6442..6b30bebb92a 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md @@ -17,9 +17,9 @@ import TabItem from '@theme/TabItem'; ### 开始之前 -* 如果您想通过 `kbcli` 创建并连接 PostgreSQL 集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 -* 确保 PostgreSQL 引擎已启用。KubeBlocks 默认已安装 PostreSQL，如果您在安装 KubeBlocks 时关闭/卸载了该引擎，可参考相关文档，再次启用/安装该引擎，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或者 [Helm](./../../installation/install-with-helm/install-addons.md) 操作。 +* 如果您想通过 `kbcli` 创建并连接 PostgreSQL 集群，请先[安装 kbcli](./../../installation/install-kbcli.md)。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 +* 确保 PostgreSQL 引擎已启用。KubeBlocks 默认已安装 PostreSQL，如果您在安装 KubeBlocks 时关闭/卸载了该引擎，可参考相关文档，再次[启用/安装该引擎](./../../installation/install-addons.md)。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/high-availability/high-availability.md b/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/high-availability/high-availability.md index 8d3f720f4f4..2e4f54b71a2 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/high-availability/high-availability.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/high-availability/high-availability.md @@ -14,7 +14,7 @@ KubeBlocks 集成[开源的 Patroni 方案](https://patroni.readthedocs.io/en/la ## 开始之前 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 * [创建 PostgreSQL 主备版](./../cluster-management/create-and-connect-a-postgresql-cluster.md)。 * 检查切换策略和角色探测参数。 * 检查切换策略是否为 `Noop`。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kb.md b/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kb.md index c32650b8a6d..b7122fed3b9 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kb.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kb.md @@ -29,9 +29,9 @@ KubeBlocks 可以通过良好的抽象快速集成新引擎，并支持 Pulsar ### 开始之前 -* 如果您想通过 `kbcli` 创建和管理集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 -* 确保 Pulsar 引擎已启用。如果引擎未启用，可参考相关文档，启用该引擎，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或 [Helm](./../../installation/install-with-helm/install-addons.md) 操作。 +* 如果您想通过 `kbcli` 创建和管理集群，请先[安装 kbcli](./../../installation/install-kbcli.md)。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 +* 确保 Pulsar 引擎已启用。如果引擎未启用，可参考相关文档，[启用该引擎](./../../installation/install-addons.md)。 * 查看可用于创建集群的数据库类型和版本。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/manage-qdrant.md b/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/manage-qdrant.md index d0c7897653d..24d27cd2d5a 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/manage-qdrant.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/manage-qdrant.md @@ -19,9 +19,9 @@ Qdrant（读作：quadrant）是向量相似性搜索引擎和向量数据库。 ## 开始之前 -- 如果您想通过 `kbcli` 创建和管理集群，请先[安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 -- 安装 KubeBlocks，可通过 [kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../installation/install-with-helm/install-kubeblocks.md) 安装。 -- 安装并启用 qdrant 引擎，可通过 [kbcli](./../installation/install-with-kbcli/install-addons.md) 或 [Helm](./../installation/install-with-helm/install-addons.md) 操作。 +- 如果您想通过 `kbcli` 创建和管理集群，请先[安装 kbcli](./../installation/install-kbcli.md)。 +- [安装 KubeBlocks](./../installation/install-kubeblocks.md)。 +- [安装并启用 qdrant 引擎](./../installation/install-addons.md)。 - 为了保持隔离，本文档中创建一个名为 `demo` 的独立命名空间。 ```bash diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-redis/cluster-management/create-and-connect-to-a-redis-cluster.md b/i18n/zh-cn/user-docs/kubeblocks-for-redis/cluster-management/create-and-connect-to-a-redis-cluster.md index 0f2f4636aeb..6fc662dca70 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-redis/cluster-management/create-and-connect-to-a-redis-cluster.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-redis/cluster-management/create-and-connect-to-a-redis-cluster.md @@ -17,9 +17,9 @@ import TabItem from '@theme/TabItem'; ### 开始之前 -* 如果您想通过 `kbcli` 创建并连接 MongoDB 集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md)。 -* 确保 Redis 引擎已启用。如果未启用，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或者 [Helm](./../../installation/install-with-helm/install-addons.md) 操作。 +* 如果您想通过 `kbcli` 创建并连接 MongoDB 集群，请先[安装 kbcli](./../../installation/install-kbcli.md)。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 +* 确保 Redis 引擎已启用。如果未启用，请先[启用该引擎](./../../installation/install-addons.md)。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-redis/high-availability/high-availability.md b/i18n/zh-cn/user-docs/kubeblocks-for-redis/high-availability/high-availability.md index 13141146f62..75557c155f9 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-redis/high-availability/high-availability.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-redis/high-availability/high-availability.md @@ -18,7 +18,7 @@ Redis Sentinel 是 Redis 官方推荐的主备集群高可用性解决方案， ## 开始之前 -* 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 +* [安装 KubeBlocks](./../../installation/install-kubeblocks.md)。 * [创建 Redis 主备版集群](./../../kubeblocks-for-redis/cluster-management/create-and-connect-to-a-redis-cluster.md#创建集群)。 * 检查切换策略和角色探测参数。 * 检查切换策略是否为 `Noop`。 diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/manage-starrocks.md b/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/manage-starrocks.md index 94f1cedd441..f9b076ef519 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/manage-starrocks.md +++ b/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/manage-starrocks.md @@ -17,9 +17,9 @@ StarRocks 是一款高性能分析型数据仓库，使用向量化、MPP 架构 ## 开始之前 -- 如果您想通过 `kbcli` 创建并连接 StarRocks 集群，请先[安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 -- 安装 KubeBlocks，可通过 [kbcli](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../installation/install-with-helm/install-kubeblocks.md) 安装。 -- 安装并启用 starrocks 引擎，可通过 [kbcli](./../installation/install-with-kbcli/install-addons.md) 或 [Helm](./../installation/install-with-helm/install-addons.md) 操作。 +- 如果您想通过 `kbcli` 创建并连接 StarRocks 集群，请先[安装 kbcli](./../installation/install-kbcli.md)。 +- [安装 KubeBlocks](./../installation/install-kubeblocks.md)。 +- [安装并启用 starrocks 引擎](./../installation/install-addons.md)。 ## 创建集群 diff --git a/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md b/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md index 6c781d86746..3eeddb30c07 100644 --- a/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md +++ b/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md @@ -21,10 +21,10 @@ BackupRepo 是备份数据的存储仓库，支持配置 OSS（阿里云对象 请确保你已经： -* [安装 kbcli](./../../../installation/install-with-kbcli/install-kbcli.md)。 +* [安装 kbcli](./../../../installation/install-kbcli.md)。 * [安装 kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)。 * [安装 Helm](https://helm.sh/docs/intro/install/)。 -* 安装 KubeBlocks。如果未安装，可通过 [kbcli](./../../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或 [Helm](./../../../installation/install-with-helm/install-kubeblocks.md) 进行安装。 +* [安装 KubeBlocks](./../../../installation/install-kubeblocks.md)。 ## 安装 MinIO diff --git a/i18n/zh-cn/user-docs/observability/monitor-database.md b/i18n/zh-cn/user-docs/observability/monitor-database.md index 120adc69042..a477a4687d7 100644 --- a/i18n/zh-cn/user-docs/observability/monitor-database.md +++ b/i18n/zh-cn/user-docs/observability/monitor-database.md @@ -31,7 +31,7 @@ KubeBlocks 以插件（Addon）形式集成了许多开源监控组件，如 Pro -1. 查看所有支持的引擎，确保监控引擎已启用。可参考[此文档](./../installation/install-with-kbcli/install-kbcli.md)，查看安装或启用引擎的详细说明。 +1. 查看所有支持的引擎，确保监控引擎已启用。可参考[此文档](./../installation/install-addons.md)，查看安装或启用引擎的详细说明。 ```bash # 查看内置支持的所有引擎 diff --git a/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-cloud.md b/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-cloud.md index 382a71f0842..1645c293805 100644 --- a/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-cloud.md +++ b/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-cloud.md @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem'; - [安装 AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)。 - [安装 kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)。 -- [安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 +- [安装 kbcli](./../installation/install-kbcli.md)。 ### 配置访问密钥 @@ -85,7 +85,7 @@ kbcli cluster list 请确保已经： - 拥有 Google Cloud 账户。 - [安装 kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)。 -- [安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 +- [安装 kbcli](./../installation/install-kbcli.md)。 ### 配置 GCP 环境 @@ -156,7 +156,7 @@ kbcli cluster list 请确保已经： - 拥有腾讯云账户。 - [安装 kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)。 -- [安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 +- [安装 kbcli](./../installation/install-kbcli.md)。 ### 配置 TKE 环境 @@ -208,7 +208,7 @@ kbcli cluster list 请确保已经： - 拥有阿里云账户。 - [安装 kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)。 -- [安装 kbcli](./../installation/install-with-kbcli/install-kbcli.md)。 +- [安装 kbcli](./../installation/install-kbcli.md)。 ### 配置 ACK 环境 diff --git a/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-local-host.md b/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-local-host.md index 91286456f7f..73e297da52e 100644 --- a/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-local-host.md +++ b/i18n/zh-cn/user-docs/try-out-on-playground/try-kubeblocks-on-local-host.md @@ -22,7 +22,7 @@ sidebar_label: 在本地使用 KubeBlocks * 在电脑上已安装： * [Docker](https://docs.docker.com/get-docker/)：v20.10.5（runc ≥ v1.0.0-rc93）或更高版本； * [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)：用于与 Kubernetes 集群进行交互； - * [kbcli](./../installation/install-with-kbcli/install-kbcli.md)：用于 Playground 和 KubeBlocks 之间的交互。 + * [kbcli](./../installation/install-kbcli.md)：用于 Playground 和 KubeBlocks 之间的交互。 ## 初始化 Playground From c80ebbd45d57207ad073a45a7fdc00501c494a0a Mon Sep 17 00:00:00 2001 From: yuanyuan zhang Date: Tue, 26 Nov 2024 18:19:05 +0800 Subject: [PATCH 4/4] docs: fix bugs --- docs/user_docs/installation/install-addons.md | 6 +++--- .../installation/uninstall-kubeblocks-and-kbcli.md | 2 +- i18n/zh-cn/user-docs/installation/install-addons.md | 6 +++--- .../installation/uninstall-kubeblocks-and-kbcli.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/user_docs/installation/install-addons.md b/docs/user_docs/installation/install-addons.md index 8ae0fe49466..409e14e422b 100644 --- a/docs/user_docs/installation/install-addons.md +++ b/docs/user_docs/installation/install-addons.md @@ -34,7 +34,7 @@ The official index repo is [KubeBlocks index](https://github.com/apecloud/block- 3. Install the Addon (take etcd as example). Specify a version with `--version`. ```bash - helm install etcd kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z + helm install kb-etcd-addon kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z ``` 4. Verify whether this Addon is installed. @@ -46,7 +46,7 @@ The official index repo is [KubeBlocks index](https://github.com/apecloud/block- > NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION ...... - etcd kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 + kb-etcd-addon kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 ``` 5. (Optional) You can run the command below to disable the Addon. @@ -54,7 +54,7 @@ The official index repo is [KubeBlocks index](https://github.com/apecloud/block- If you have created a related cluster, delete the cluster first. ```bash - helm uninstall etcd --namespace kb-system + helm uninstall kb-etcd-addon --namespace kb-system ``` diff --git a/docs/user_docs/installation/uninstall-kubeblocks-and-kbcli.md b/docs/user_docs/installation/uninstall-kubeblocks-and-kbcli.md index 6cc25c22e95..27f8bb48357 100644 --- a/docs/user_docs/installation/uninstall-kubeblocks-and-kbcli.md +++ b/docs/user_docs/installation/uninstall-kubeblocks-and-kbcli.md @@ -16,7 +16,7 @@ Uninstallation order: 1. Delete your cluster if you have created a cluster. ```bash - kubebctl delete cluster -n namespace + kubectl delete cluster -n namespace ``` 2. Uninstall KubeBlocks. diff --git a/i18n/zh-cn/user-docs/installation/install-addons.md b/i18n/zh-cn/user-docs/installation/install-addons.md index 997c491971d..545351aafe6 100644 --- a/i18n/zh-cn/user-docs/installation/install-addons.md +++ b/i18n/zh-cn/user-docs/installation/install-addons.md @@ -34,7 +34,7 @@ KubeBlocks v0.8.0 发布后，数据库引擎插件（Addon）与 KubeBlocks 解 3. 以 etcd 为例，安装引擎。使用 `--version` 指定版本。 ```bash - helm install etcd kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z + helm install kb-etcd-addon kubeblocks/etcd --namespace kb-system --create-namespace --version x.y.z ``` 4. 验证该引擎是否安装成功。 @@ -46,13 +46,13 @@ KubeBlocks v0.8.0 发布后，数据库引擎插件（Addon）与 KubeBlocks 解 > NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION ...... - etcd kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 + kb-etcd-addon kb-system 1 2024-10-25 07:18:35.294326176 +0000 UTC deployed etcd-0.9.0 v3.5.6 ``` 5. （可选）您可以执行以下命令卸载引擎。如果您已使用该引擎创建集群，请先删除集群。 ```bash - helm uninstall etcd --namespace kb-system + helm uninstall kb-etcd-addon --namespace kb-system ``` diff --git a/i18n/zh-cn/user-docs/installation/uninstall-kubeblocks-and-kbcli.md b/i18n/zh-cn/user-docs/installation/uninstall-kubeblocks-and-kbcli.md index 24da23137e8..846a60e1b2a 100644 --- a/i18n/zh-cn/user-docs/installation/uninstall-kubeblocks-and-kbcli.md +++ b/i18n/zh-cn/user-docs/installation/uninstall-kubeblocks-and-kbcli.md @@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem'; 1. 如果已经创建了集群，请先删除集群。 ```bash - kubebctl delete cluster -n namespace + kubectl delete cluster -n namespace ``` 2. 卸载 KubeBlocks。