From 0df2a94af6f7991d347c25fe1e3b46a5212b5ef6 Mon Sep 17 00:00:00 2001 From: CrystalL <110531738+TalktoCrystal@users.noreply.github.com> Date: Thu, 21 Dec 2023 18:27:34 +0800 Subject: [PATCH] docs: fix conflicts --- .../install-kubeblocks-with-helm.md | 41 +++++++--- .../uninstall-kbcli-and-kubeblocks.md | 2 + .../cluster-management/expand-volume.md | 4 +- .../cluster-management/scale.md | 14 ++-- .../cluster-management/expand-volume.md | 4 +- .../configuration/configuration.md | 2 +- .../configuration/configuration.md | 2 +- .../scale-for-a-postgresql-cluster.md | 2 +- .../cluster-management/expand-volume.md | 76 +++++++++---------- .../manage-vector-databases.md | 2 +- 10 files changed, 85 insertions(+), 64 deletions(-) diff --git a/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md b/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md index 5a723b436e7..4e654641287 100644 --- a/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md +++ b/docs/user_docs/installation/install-with-helm/install-kubeblocks-with-helm.md @@ -12,7 +12,7 @@ KubeBlocks is kubernetes-native, you can use Helm to install it. :::note 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/) and [Helm](https://helm.sh/docs/intro/install/) installed. ::: @@ -46,17 +46,20 @@ If you install KubeBlocks with Helm, to uninstall it, you have to use Helm too. ## Installation steps + **Use Helm to install KubeBlocks** Run the following command: + ```bash helm repo add kubeblocks https://apecloud.github.io/helm-charts helm repo update helm install kubeblocks kubeblocks/kubeblocks \ --namespace kb-system --create-namespace -```` +``` If you want to install KubeBlocks with custom tolerations, you can use the following command: + ```bash helm install kubeblocks kubeblocks/kubeblocks \ --namespace kb-system --create-namespace \ @@ -64,21 +67,37 @@ helm install kubeblocks kubeblocks/kubeblocks \ --set-json 'dataPlane.tolerations=[{ "key": "data-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" } ]' ``` +If you want to install KubeBlocks with a specified version, follow the steps below. + +1. View the available versions in [KubeBlocks Release](https://github.com/apecloud/kubeblocks/releases/). +2. Specify a version with `--version` and run the command below. + + ```bash + helm install kubeblocks kubeblocks/kubeblocks \ + --namespace kb-system --create-namespace --version="x.x.x" + ``` + + :::note + + By default, the latest release version is installed. + + ::: + ## Verify KubeBlocks installation Run the following command to check whether KubeBlocks is installed successfully. ```bash -kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubeblocks" -w - -NAME READY STATUS RESTARTS AGE -kubeblocks-846b8878d9-q8g2w 1/1 Running 0 98s +kubectl -n kb-system get pods ``` -If the operator pods are all `Running`, KubeBlocks has been installed successfully. You can cancel the above command by typing `Ctrl+C`. +***Result*** -:::note - -Clusters installed through `helm` need to be deleted using `helm` to avoid resource residue. +If the KubeBlocks Workloads are all ready, KubeBlocks has been installed successfully. -::: \ No newline at end of file +```bash +NAME READY STATUS RESTARTS AGE +kb-addon-snapshot-controller-649f8b9949-2wzzk 1/1 Running 2 (24m ago) 147d +kubeblocks-dataprotection-f6dbdbf7f-5fdr9 1/1 Running 2 (24m ago) 147d +kubeblocks-6497f7947-mc7vc 1/1 Running 2 (24m ago) 147d +``` diff --git a/docs/user_docs/installation/uninstall-kbcli-and-kubeblocks.md b/docs/user_docs/installation/uninstall-kbcli-and-kubeblocks.md index c70f4f6fa0a..37ead47562a 100644 --- a/docs/user_docs/installation/uninstall-kbcli-and-kubeblocks.md +++ b/docs/user_docs/installation/uninstall-kbcli-and-kubeblocks.md @@ -39,6 +39,8 @@ kbcli kubeblocks uninstall +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 ``` diff --git a/docs/user_docs/kubeblocks-for-kafka/cluster-management/expand-volume.md b/docs/user_docs/kubeblocks-for-kafka/cluster-management/expand-volume.md index d26e46a4b9a..e3d3f06ff51 100644 --- a/docs/user_docs/kubeblocks-for-kafka/cluster-management/expand-volume.md +++ b/docs/user_docs/kubeblocks-for-kafka/cluster-management/expand-volume.md @@ -23,10 +23,10 @@ kbcli cluster list kafka Use `kbcli cluster volume-expand` command, configure the resources required and enter the cluster name again to expand the volume. ```bash -kbcli cluster volume-expand --storage=30G --component-names=kafka --volume-claim-templates=data kafka +kbcli cluster volume-expand --storage=30G --components=kafka --volume-claim-templates=data kafka ``` -- `--component-names` describes the component name for volume expansion. +- `--components` describes the component name for volume expansion. - `--volume-claim-templates` describes the VolumeClaimTemplate names in components. - `--storage` describes the volume storage size. diff --git a/docs/user_docs/kubeblocks-for-kafka/cluster-management/scale.md b/docs/user_docs/kubeblocks-for-kafka/cluster-management/scale.md index 3c2a4c8463c..860defa65a9 100644 --- a/docs/user_docs/kubeblocks-for-kafka/cluster-management/scale.md +++ b/docs/user_docs/kubeblocks-for-kafka/cluster-management/scale.md @@ -6,7 +6,7 @@ sidebar_position: 3 sidebar_label: Scale --- -# Scale a Kafka cluster +# Scale for a Kafka cluster You can scale a Kafka cluster in two ways, vertical scaling and horizontal scaling. @@ -146,12 +146,12 @@ Horizontal scaling changes the amount of pods. For example, you can apply horizo - You are not recommended to perform horizontal scaling on the controller node, including the controller node both in combined mode and separated node. - When scaling in horizontally, you must know the topic partition storage. If the topic has only one replication, data loss may caused when you scale in broker. - ```bash -kbcli cluster list -> -NAME NAMESPACE CLUSTER-DEFINITION VERSION TERMINATION-POLICY STATUS CREATED-TIME -ivy85 default kafka kafka-3.3.2 Delete Running Jul 19,2023 18:01 UTC+0800 -``` + ```bash + kbcli cluster list + > + NAME NAMESPACE CLUSTER-DEFINITION VERSION TERMINATION-POLICY STATUS CREATED-TIME + ivy85 default kafka kafka-3.3.2 Delete Running Jul 19,2023 18:01 UTC+0800 + ``` ### Steps diff --git a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/expand-volume.md b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/expand-volume.md index 37e4d452de1..86d31535dcc 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/expand-volume.md +++ b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/expand-volume.md @@ -23,13 +23,13 @@ kbcli cluster list mongodb-cluster Use `kbcli cluster volume-expand` command, configure the resources required and enter the cluster name again to expand the volume. ```bash -kbcli cluster volume-expand --storage=30G --component-names=mongodb --volume-claim-templates=data mongodb-cluster +kbcli cluster volume-expand --storage=30G --components=mongodb --volume-claim-templates=data mongodb-cluster > OpsRequest mongodb-cluster-volumeexpansion-gcfzp created successfully, you can view the progress: kbcli cluster describe-ops mongodb-cluster-volumeexpansion-gcfzp -n default ``` -- `--component-names` describes the component name for volume expansion. +- `--components` describes the component name for volume expansion. - `--volume-claim-templates` describes the VolumeClaimTemplate names in components. - `--storage` describes the volume storage size. diff --git a/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md b/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md index a562b85274b..2538b74304c 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md @@ -97,7 +97,7 @@ For Linux and macOS, you can edit configuration files by vi. For Windows, you ca If there are multiple components in a cluster, use `--component` to specify a component. - :: + ::: 2. View the status of the parameter configuration. diff --git a/docs/user_docs/kubeblocks-for-mysql/configuration/configuration.md b/docs/user_docs/kubeblocks-for-mysql/configuration/configuration.md index c3ac4c62ba3..7a4a8b6a1bc 100644 --- a/docs/user_docs/kubeblocks-for-mysql/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-mysql/configuration/configuration.md @@ -140,7 +140,7 @@ The example below takes configuring `max_connections` and `innodb_buffer_pool_si Name: mysql-cluster-reconfiguring-z2wvn NameSpace: default Cluster: mysql-cluster Type: Reconfiguring Command: - kbcli cluster configure mysql-cluster --component-names=mysql --template-name=mysql-consensusset-config --config-file=my.cnf --set innodb_buffer_pool_size=512M --set max_connections=600 + kbcli cluster configure mysql-cluster --components=mysql --template-name=mysql-consensusset-config --config-file=my.cnf --set innodb_buffer_pool_size=512M --set max_connections=600 Status: Start Time: Mar 13,2023 02:55 UTC+0800 diff --git a/docs/user_docs/kubeblocks-for-postgresql/cluster-management/scale-for-a-postgresql-cluster.md b/docs/user_docs/kubeblocks-for-postgresql/cluster-management/scale-for-a-postgresql-cluster.md index 850f2a8edea..5f0ef8c3d0e 100644 --- a/docs/user_docs/kubeblocks-for-postgresql/cluster-management/scale-for-a-postgresql-cluster.md +++ b/docs/user_docs/kubeblocks-for-postgresql/cluster-management/scale-for-a-postgresql-cluster.md @@ -6,7 +6,7 @@ sidebar_position: 2 sidebar_label: Scale --- -# Scale for PostgreSQL +# Scale for a PostgreSQL cluster Currently, only vertical scaling for PostgreSQL is supported. diff --git a/docs/user_docs/kubeblocks-for-pulsar/cluster-management/expand-volume.md b/docs/user_docs/kubeblocks-for-pulsar/cluster-management/expand-volume.md index c17a8b58884..7bf88d28669 100644 --- a/docs/user_docs/kubeblocks-for-pulsar/cluster-management/expand-volume.md +++ b/docs/user_docs/kubeblocks-for-pulsar/cluster-management/expand-volume.md @@ -25,56 +25,56 @@ kbcli cluster list pulsar Configure the values of `--components`, `--volume-claim-templates`, and `--storage`, and run the command below to expand the volume. - :::note + :::note - Expand volume for `journal` first. `ledger` volume expansion must be performed after the `journal` volume expansion. + Expand volume for `journal` first. `ledger` volume expansion must be performed after the `journal` volume expansion. - ::: + ::: - - Expand volume for `journal`. + - Expand volume for `journal`. - ```bash - kbcli cluster volume-expand pulsar --storage=40Gi --components=bookies -t journal - ``` + ```bash + kbcli cluster volume-expand pulsar --storage=40Gi --components=bookies -t journal + ``` - - `--components` describes the component name for volume expansion. - - `--volume-claim-templates` describes the VolumeClaimTemplate names in components. - - `--storage` describes the volume storage size. + - `--components` describes the component name for volume expansion. + - `--volume-claim-templates` describes the VolumeClaimTemplate names in components. + - `--storage` describes the volume storage size. - - Expand volume for `ledger`. + - Expand volume for `ledger`. - ```bash - kbcli cluster volume-expand pulsar --storage=200Gi --components=bookies -t ledgers - ``` + ```bash + kbcli cluster volume-expand pulsar --storage=200Gi --components=bookies -t ledgers + ``` - **Option 2.** Create an OpsRequest + **Option 2.** Create an OpsRequest - Change the value of storage according to your need and run the command below to expand the volume of a cluster. + Change the value of storage according to your need and run the command below to expand the volume of a cluster. - ```bash - kubectl apply -f - <