docs: update 0.8 docs (#6496)

(cherry picked from commit dc757f4)
apecloud · Jan 22, 2024 · 7e264e1 · 7e264e1
1 parent 440474b
commit 7e264e1
Show file tree

Hide file tree

Showing 4 changed files with 129 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@
 
 KubeBlocks is an open-source control plane software that runs and manages databases, message queues and other data infrastructure on K8s. The name KubeBlocks is inspired by Kubernetes and LEGO blocks, signifying that running and managing data infrastructure on K8s can be standard and productive, like playing with LEGO blocks. 
 
-KubeBlocks could manage various type of engines, including RDBMSs (MySQL, PostgreSQL), Caches(Redis), NoSQLs (MongoDB), MQs(Kafka, Pulsar), and vector databases(Milvus, Qdrant, Weaviate), and the community is actively integrating more types of engines into KubeBlocks. Currently it has supported 32 types of engines!
+KubeBlocks could manage various type of engines, including RDBMSs (MySQL, PostgreSQL), Caches(Redis), NoSQLs (MongoDB), MQs(Kafka, Pulsar), and vector databases(Milvus, Qdrant, Weaviate), and the community is actively integrating more types of engines into KubeBlocks. Currently it has supported 32 types of engines.
 
 The core of KubeBlocks is a K8s operator, which defines a set of CRDs to abstract the common attributes of various engines. KubeBlocks helps developers, SREs, and platform engineers deploy and maintain dedicated DBPaaS, and supports both public cloud vendors and on-premise environments.
 

diff --git a/docs/user_docs/installation/upgrade/upgrade-kubeblocks-to-0.7.md b/docs/user_docs/installation/upgrade/upgrade-kubeblocks-to-0.7.md
diff --git a/docs/user_docs/installation/upgrade/upgrade-kubeblocks-to-0.8.md b/docs/user_docs/installation/upgrade/upgrade-kubeblocks-to-0.8.md
@@ -0,0 +1,123 @@
+---
+title: Upgrade to KubeBlocks v0.8
+description: Upgrade to KubeBlocks v0.8, operation, tips and notes
+keywords: [upgrade, 0.8]
+sidebar_position: 1
+sidebar_label: Upgrade to KubeBlocks v0.8
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+# Upgrade to KubeBlocks v0.8
+
+In this tutorial, you will learn how to upgrade to KubeBlocks v0.8.
+
+
+:::note
+
+Execute `kbcli version` to check the current KubeBlocks version you are running, and then upgrade.
+
+
+:::
+
+## Upgrade from KubeBlocks v0.6
+
+If you are currently running KubeBlocks v0.6, please upgrade to v0.7.2 first.
+
+
+1. Download kbcli v0.7.2.
+
+    ```shell
+    curl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash -s 0.7.2
+    ```
+
+2. Upgrade to KubeBlocks v0.7.2.
+
+    ```shell
+    kbcli kb upgrade --version 0.7.2
+    ```
+
+## Upgrade from KubeBlocks v0.7
+
+<Tabs>
+
+<TabItem value="Helm" label="Helm" default>
+
+1. Set keepAddons.
+
+    KubeBlocks v0.8 streamlines the default installed engines and separates the addons from KubeBlocks operators to KubeBlocks-Addons repo, such as greptime, influxdb, neon, oracle-mysql, orioledb, tdengine, mariadb, nebula, risingwave, starrocks, tidb, and zookeeper. To avoid deleting addon resources that are already in use during the upgrade, execute the following commands:
+
+- Check the current KubeBlocks version.
+
+    ```shell
+    helm -n kb-system list | grep kubeblocks
+    ```
+
+- Set the value of keepAddons as true.
+
+    ```shell
+    helm repo add kubeblocks https://apecloud.github.io/helm-charts
+    helm repo update kubeblocks
+    helm -n kb-system upgrade kubeblocks kubeblocks/kubeblocks --version {VERSION} --set keepAddons=true
+    ```
+
+    Replace {VERSION} with your current KubeBlocks version, such as 0.7.2.
+
+- Check addons.
+
+    Execute the following command to ensure that the addon annotations contain `"helm.sh/resource-policy": "keep"`.
+
+    ```shell
+    kubectl get addon -o json | jq '.items[] | {name: .metadata.name, annotations: .metadata.annotations}'
+    ```
+
+2. Install CRD.
+
+    To reduce the size of Helm chart, KubeBlocks v0.8 removes CRD from the Helm chart. Before upgrading, you need to install CRD.
+
+    ```shell
+    kubectl replace -f https://github.com/apecloud/kubeblocks/releases/download/v0.8.1/kubeblocks_crds.yaml
+    ```
+
+3. Upgrade KubeBlocks.
+
+    ```shell
+    helm -n kb-system upgrade kubeblocks kubeblocks/kubeblocks --version 0.8.1 --set dataProtection.image.datasafed.tag=0.1.0
+    ```
+
+    :::note
+
+    To avoid affecting existing database clusters, when upgrading to KubeBlocks v0.8, the versions of already-installed addons will not be upgraded by default. If you want to upgrade the addons to the versions built into KubeBlocks v0.8, execute the following command. Note that this may restart existing clusters and affect availability. Please proceed with caution.
+
+    ```shell
+
+    helm -n kb-system upgrade kubeblocks kubeblocks/kubeblocks --version 0.8.1 --set upgradeAddons=true
+
+    ```
+    :::
+
+</TabItem>
+
+<TabItem value="kbcli" label="kbcli" default>
+
+1. Download kbcli v0.8.
+
+    ```shell
+    curl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash -s 0.8.1
+    ```
+
+2. Upgrade KubeBlocks.
+
+    ```shell
+
+    kbcli kb upgrade --version 0.8.1 --set dataProtection.image.datasafed.tag=0.1.0
+
+    ```
+
+    kbcli will automatically add the annotation `"helm.sh/resource-policy": "keep"` to ensure that existing addons are not deleted during the upgrade.
+
+</TabItem>
+
+</Tabs>
diff --git a/docs/user_docs/overview/introduction.md b/docs/user_docs/overview/introduction.md
@@ -9,7 +9,11 @@ sidebar_position: 1
 
 ## What is KubeBlocks
 
-The name KubeBlocks is derived from Kubernetes and LEGO blocks, which indicates that building database and analytical workloads on Kubernetes can be both productive and enjoyable, like playing with construction toys. KubeBlocks combines the large-scale production experiences of top cloud service providers with enhanced usability and stability.
+KubeBlocks is an open-source control plane software that runs and manages databases, message queues and other data infrastructure on K8s. The name KubeBlocks is inspired by Kubernetes and LEGO blocks, signifying that running and managing data infrastructure on K8s can be standard and productive, like playing with LEGO blocks.
+
+KubeBlocks could manage various type of engines, including RDBMSs (MySQL, PostgreSQL), Caches(Redis), NoSQLs (MongoDB), MQs(Kafka, Pulsar), and vector databases(Milvus, Qdrant, Weaviate), and the community is actively integrating more types of engines into KubeBlocks. Currently it has supported 32 types of engines!
+
+The core of KubeBlocks is a K8s operator, which defines a set of CRDs to abstract the common attributes of various engines. KubeBlocks helps developers, SREs, and platform engineers deploy and maintain dedicated DBPaaS, and supports both public cloud vendors and on-premise environments.
 
 ## Why you need KubeBlocks