Release new docs

milvus-io · Nov 21, 2024 · 95de2ce · 95de2ce
1 parent fafe01b
commit 95de2ce
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 16 deletions.
diff --git a/v2.4.x/site/en/adminGuide/upgrade_milvus_cluster-helm.md b/v2.4.x/site/en/adminGuide/upgrade_milvus_cluster-helm.md
@@ -14,12 +14,22 @@ title: Upgrade Milvus Cluster with Helm Chart
 
 This guide describes how to upgrade your Milvus cluster with Milvus Helm charts. 
 
+## Prerequisites
+- Helm version >= 3.14.0
+- Kubernetes version >= 1.20.0
+
+<div class="alert note">
+
+Since Milvus-Helm chart version 4.2.21, we introduced pulsar-v3.x chart as dependency. For backward compatibility, please upgrade your helm to v3.14 or later version, and be sure to add the `--reset-then-reuse-values` option whenever you use `helm upgrade`.
+
+</div>
+
 ## Check Milvus Helm Chart
 
 Run the following commands to check new Milvus versions. 
 
 ```
-$ helm repo update
+$ helm repo update zilliztech
 $ helm search repo zilliztech/milvus --versions
 ```
 
@@ -31,7 +41,7 @@ The Milvus Helm Charts repo at `https://milvus-io.github.io/milvus-helm/` has be
 helm repo add zilliztech https://zilliztech.github.io/milvus-helm
 helm repo update
 # upgrade existing helm release
-helm upgrade my-release zilliztech/milvus
+helm upgrade my-release zilliztech/milvus --reset-then-reuse-values
 ```
 
 The archived repo is still available for the charts up to 4.0.31. For later releases, use the new repo instead.
@@ -122,8 +132,8 @@ sh rollingUpdate.sh -n default -i my-release -o update -t 2.4.15 -w 'milvusdb/mi
 To upgrade Milvus from a minor release before v2.2.3 to the latest, run the following commands:
 
 ```shell
-helm repo update
-helm upgrade my-release zilliztech/milvus --reuse-values --version=4.1.24 # use the helm chart version here
+helm repo update zilliztech
+helm upgrade my-release zilliztech/milvus --reset-then-reuse-values --version=4.1.24 # use the helm chart version here
 ```
 
 Use the Helm chart version in the preceding command. For details on how to obtain the Helm chart version, refer to [Check the Milvus version](#Check-the-Milvus-version).

diff --git a/v2.4.x/site/en/adminGuide/upgrade_milvus_cluster-operator.md b/v2.4.x/site/en/adminGuide/upgrade_milvus_cluster-operator.md
@@ -80,10 +80,10 @@ spec:
     image: milvusdb/milvus:<some-old-version>
 ```
 
-Then save your configuration as a YAML file (for example, `milvusupgrade.yml`) and apply this configuration file to your Milvus instance as follows:
+Then save your configuration as a YAML file (for example, `milvusupgrade.yml`) and patch this configuration file to your Milvus instance as follows:
 
 ```shell
-kubectl apply -f milvusupgrade.yml
+kubectl patch -f milvusupgrade.yml
 ```
 
 
@@ -107,7 +107,7 @@ spec:
 Then run the following to perform the upgrade:
 
 ```shell
-kubectl apply -f milvusupgrade.yaml
+kubectl patch -f milvusupgrade.yaml
 ```
 
 ## Migrate the metadata
@@ -142,10 +142,10 @@ spec:
 
 ### 2. Apply the new configuration
 
-Run the following command to apply the new configuration.
+Run the following command to create the new configuration.
 
 ```
-$ kubectl apply -f https://github.com/zilliztech/milvus-operator/blob/main/config/samples/beta/milvusupgrade.yaml
+$ kubectl create -f https://github.com/zilliztech/milvus-operator/blob/main/config/samples/beta/milvusupgrade.yaml
 ```
 
 

diff --git a/v2.4.x/site/en/adminGuide/upgrade_milvus_standalone-helm.md b/v2.4.x/site/en/adminGuide/upgrade_milvus_standalone-helm.md
@@ -15,6 +15,16 @@ title: Upgrade Milvus Standalone with Helm Chart
 
 This guide describes how to upgrade your Milvus standalone with Milvus Helm charts. 
 
+## Prerequisites
+- Helm version >= 3.14.0
+- Kubernetes version >= 1.20.0
+
+<div class="alert note">
+
+Since Milvus-Helm chart version 4.2.21, we introduced pulsar-v3.x chart as dependency. For backward compatibility, please upgrade your helm to v3.14 or later version, and be sure to add the `--reset-then-reuse-values` option whenever you use `helm upgrade`.
+
+</div>
+
 ## Check the Milvus version
 
 Run the following commands to check new Milvus versions. 
@@ -30,9 +40,9 @@ The Milvus Helm Charts repo at `https://milvus-io.github.io/milvus-helm/` has be
 
 ```shell
 helm repo add zilliztech https://zilliztech.github.io/milvus-helm
-helm repo update
+helm repo update zilliztech
 # upgrade existing helm release
-helm upgrade my-release zilliztech/milvus
+helm upgrade my-release zilliztech/milvus --reset-then-reuse-values
 ```
 
 The archived repo is still available for the charts up to 4.0.31. For later releases, use the new repo instead.
@@ -125,7 +135,7 @@ To upgrade Milvus from a minor release before v2.2.3 to the latest, run the foll
 
 ```shell
 helm repo update
-helm upgrade my-release milvus/milvus --reuse-values --version=4.1.24 # use the helm chart version here
+helm upgrade my-release milvus/milvus --reset-then-reuse-values --version=4.1.24 # use the helm chart version here
 ```
 
 Use the Helm chart version in the preceding command. For details on how to obtain the Helm chart version, refer to [Check the Milvus version](#Check-the-Milvus-version).

diff --git a/v2.4.x/site/en/adminGuide/upgrade_milvus_standalone-operator.md b/v2.4.x/site/en/adminGuide/upgrade_milvus_standalone-operator.md
@@ -80,10 +80,10 @@ spec:
     image: milvusdb/milvus:<some-older-version>
 ```
 
-Then save your configuration as a YAML file (for example, `milvusupgrade.yml`) and apply this configuration file to your Milvus instance as follows:
+Then save your configuration as a YAML file (for example, `milvusupgrade.yml`) and patch this configuration file to your Milvus instance as follows:
 
 ```shell
-kubectl apply -f milvusupgrade.yml
+kubectl patch -f milvusupgrade.yml
 ```
 
 ## Upgrade Milvus by changing its image
@@ -108,7 +108,7 @@ spec:
 Then run the following to perform the upgrade:
 
 ```shell
-kubectl apply -f milvusupgrade.yaml
+kubectl patch -f milvusupgrade.yaml
 ```
 
 ## Migrate the metadata
@@ -144,7 +144,7 @@ spec:
 Run the following command to apply the new configuration.
 
 ```
-$ kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/main/config/samples/milvusupgrade.yaml
+$ kubectl create -f https://raw.githubusercontent.com/zilliztech/milvus-operator/main/config/samples/milvusupgrade.yaml
 ```