From 698654c1223240ae88289d29153441cd3df16e7b Mon Sep 17 00:00:00 2001 From: Milvus-doc-bot Date: Thu, 23 Jan 2025 10:31:35 +0000 Subject: [PATCH] Generate en docs --- .../upgrade_milvus_cluster-operator.json | 2 +- .../upgrade_milvus_cluster-operator.md | 8 +-- .../upgrade_milvus_standalone-operator.json | 2 +- .../upgrade_milvus_standalone-operator.md | 8 +-- .../install_cluster-milvusoperator.json | 2 +- .../install_cluster-milvusoperator.md | 50 ++----------------- 6 files changed, 16 insertions(+), 56 deletions(-) diff --git a/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.json b/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.json index 0e3e72478..1415aac8e 100644 --- a/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.json +++ b/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.json @@ -1 +1 @@ -{"codeList":["helm repo add zilliztech-milvus-operator https://zilliztech.github.io/milvus-operator/\nhelm repo update zilliztech-milvus-operator\nhelm -n milvus-operator upgrade milvus-operator zilliztech-milvus-operator/milvus-operator\n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n components:\n enableRollingUpdate: true\n imageUpdateMode: rollingUpgrade # Default value, can be omitted\n image: milvusdb/milvus:v2.5.3\n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n components:\n enableRollingUpdate: true\n imageUpdateMode: all\n image: milvusdb/milvus:v2.5.3\n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n components:\n enableRollingUpdate: true\n imageUpdateMode: rollingDowngrade\n image: milvusdb/milvus:\n","kubectl patch -f milvusupgrade.yml\n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n # Omit other fields ...\n components:\n image: milvusdb/milvus:v2.5.3\n","kubectl patch -f milvusupgrade.yaml\n","apiVersion: milvus.io/v1beta1\nkind: MilvusUpgrade\nmetadata:\n name: my-release-upgrade\nspec:\n milvus:\n namespace: default\n name: my-release\n sourceVersion: \"v2.1.4\"\n targetVersion: \"v2.5.3\"\n # below are some omit default values:\n # targetImage: \"milvusdb/milvus:v2.5.3\"\n # toolImage: \"milvusdb/meta-migration:v2.2.0\"\n # operation: upgrade\n # rollbackIfFailed: true\n # backupPVC: \"\"\n # maxRetry: 3\n","$ kubectl create -f https://github.com/zilliztech/milvus-operator/blob/main/config/samples/beta/milvusupgrade.yaml\n","kubectl describe milvus release-name\n"],"headingContent":"Upgrade Milvus Cluster with Milvus Operator","anchorList":[{"label":"Upgrade Milvus Cluster with Milvus Operator","href":"Upgrade-Milvus-Cluster-with-Milvus-Operator","type":1,"isActive":false},{"label":"Upgrade your Milvus operator","href":"Upgrade-your-Milvus-operator","type":2,"isActive":false},{"label":"Conduct a rolling upgrade","href":"Conduct-a-rolling-upgrade","type":2,"isActive":false},{"label":"Upgrade Milvus by changing its image","href":"Upgrade-Milvus-by-changing-its-image","type":2,"isActive":false},{"label":"Migrate the metadata","href":"Migrate-the-metadata","type":2,"isActive":false}]} \ No newline at end of file +{"codeList":["helm repo add zilliztech-milvus-operator https://zilliztech.github.io/milvus-operator/\nhelm repo update zilliztech-milvus-operator\nhelm -n milvus-operator upgrade milvus-operator zilliztech-milvus-operator/milvus-operator\n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n components:\n enableRollingUpdate: true\n imageUpdateMode: rollingUpgrade # Default value, can be omitted\n image: milvusdb/milvus:v2.5.3\n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n components:\n enableRollingUpdate: true\n imageUpdateMode: all\n image: milvusdb/milvus:v2.5.3\n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n components:\n enableRollingUpdate: true\n imageUpdateMode: rollingDowngrade\n image: milvusdb/milvus:\n","kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge \n","apiVersion: milvus.io/v1beta1\nkind: Milvus\nmetadata:\n name: my-release\nspec:\n # Omit other fields ...\n components:\n image: milvusdb/milvus:v2.5.3\n","kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge \n","apiVersion: milvus.io/v1beta1\nkind: MilvusUpgrade\nmetadata:\n name: my-release-upgrade\nspec:\n milvus:\n namespace: default\n name: my-release\n sourceVersion: \"v2.1.4\"\n targetVersion: \"v2.5.3\"\n # below are some omit default values:\n # targetImage: \"milvusdb/milvus:v2.5.3\"\n # toolImage: \"milvusdb/meta-migration:v2.2.0\"\n # operation: upgrade\n # rollbackIfFailed: true\n # backupPVC: \"\"\n # maxRetry: 3\n","$ kubectl create -f https://github.com/zilliztech/milvus-operator/blob/main/config/samples/beta/milvusupgrade.yaml\n","kubectl describe milvus release-name\n"],"headingContent":"Upgrade Milvus Cluster with Milvus Operator","anchorList":[{"label":"Upgrade Milvus Cluster with Milvus Operator","href":"Upgrade-Milvus-Cluster-with-Milvus-Operator","type":1,"isActive":false},{"label":"Upgrade your Milvus operator","href":"Upgrade-your-Milvus-operator","type":2,"isActive":false},{"label":"Conduct a rolling upgrade","href":"Conduct-a-rolling-upgrade","type":2,"isActive":false},{"label":"Upgrade Milvus by changing its image","href":"Upgrade-Milvus-by-changing-its-image","type":2,"isActive":false},{"label":"Migrate the metadata","href":"Migrate-the-metadata","type":2,"isActive":false}]} \ No newline at end of file diff --git a/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.md b/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.md index a8837179a..64e9b601d 100644 --- a/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.md +++ b/localization/v2.5.x/site/en/adminGuide/upgrade_milvus_cluster-operator.md @@ -39,7 +39,7 @@ title: Upgrade Milvus Cluster with Milvus Operator d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > -

Run the following command to upgrade the version of your Milvus Operator to v1.0.1.

+

Run the following command to upgrade the version of your Milvus Operator to v1.2.0.

helm repo add zilliztech-milvus-operator https://zilliztech.github.io/milvus-operator/
 helm repo update zilliztech-milvus-operator
 helm -n milvus-operator upgrade milvus-operator zilliztech-milvus-operator/milvus-operator
@@ -101,8 +101,8 @@ spec:
     imageUpdateMode: rollingDowngrade
     image: milvusdb/milvus:<some-old-version>
-

Then save your configuration as a YAML file (for example, milvusupgrade.yml) and patch this configuration file to your Milvus instance as follows:

-
kubectl patch -f milvusupgrade.yml
+
Then save your configuration as a YAML file (for example, milvusupgrade.yaml) and patch this configuration file to your Milvus instance as follows:

+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge 
 

 
Upgrade Milvus by changing its image

Then run the following to perform the upgrade:

-
kubectl patch -f milvusupgrade.yaml
+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge 
 

 
Migrate the metadata
Run the following command to upgrade the version of your Milvus operator to v1.0.1.

+    
Run the following command to upgrade the version of your Milvus operator to v1.2.0.

 
helm repo add zilliztech-milvus-operator https://zilliztech.github.io/milvus-operator/
 helm repo update zilliztech-milvus-operator
 helm -n milvus-operator upgrade milvus-operator zilliztech-milvus-operator/milvus-operator
@@ -101,8 +101,8 @@ spec:
     imageUpdateMode: rollingDowngrade
     image: milvusdb/milvus:<some-older-version>
 

-
Then save your configuration as a YAML file (for example, milvusupgrade.yml) and patch this configuration file to your Milvus instance as follows:

-
kubectl patch -f milvusupgrade.yml
+
Then save your configuration as a YAML file (for example, milvusupgrade.yaml) and patch this configuration file to your Milvus instance as follows:

+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge 
 

 
Upgrade Milvus by changing its image

 
Then run the following to perform the upgrade:

-
kubectl patch -f milvusupgrade.yaml
+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
 

 
Migrate the metadata
Milvus Operator defines a Milvus cluster custom resources on top of Kubernetes Custom Resources. When custom resources are defined, you can use K8s APIs in a declarative way and manage the Milvus deployment stack to ensure its scalability and high availability.

-
1. Install cert-manager
Milvus Operator uses cert-manager to provide a certificate for the webhook server.

-

-
-

-
Run the following command to install cert-manager.

-
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.3/cert-manager.yaml
-

-
You will see the output similar to the following after the installation process ends.

-
customresourcedefinition.apiextensions.k8s.io/certificaterequests.cert-manager.io created
-customresourcedefinition.apiextensions.k8s.io/certificates.cert-manager.io created
-customresourcedefinition.apiextensions.k8s.io/challenges.acme.cert-manager.io created
-customresourcedefinition.apiextensions.k8s.io/clusterissuers.cert-manager.io created
-customresourcedefinition.apiextensions.k8s.io/issuers.cert-manager.io created
-customresourcedefinition.apiextensions.k8s.io/orders.acme.cert-manager.io created
-namespace/cert-manager created
-serviceaccount/cert-manager-cainjector created
-...
-service/cert-manager created
-service/cert-manager-webhook created
-deployment.apps/cert-manager-cainjector created
-deployment.apps/cert-manager created
-deployment.apps/cert-manager-webhook created
-mutatingwebhookconfiguration.admissionregistration.k8s.io/cert-manager-webhook created
-validatingwebhookconfiguration.admissionregistration.k8s.io/cert-manager-webhook created
-

-
You can check if cert-manager pods are running as follows:

-
$ kubectl get pods -n cert-manager
-
-NAME                                      READY   STATUS    RESTARTS   AGE
-cert-manager-848f547974-gccz8             1/1     Running   0          70s
-cert-manager-cainjector-54f4cc6b5-dpj84   1/1     Running   0          70s
-cert-manager-webhook-7c9588c76-tqncn      1/1     Running   0          70s
-

-
2. Install Milvus Operator
You can install Milvus Operator in either of the following ways:

+
You can install Milvus Operator in either of the following ways:

 
-
Install with Helm
Run the following command to install Milvus Operator with Helm.

+
Install with Helm
Run the following command to install Milvus Operator with Helm.

 
$ helm install milvus-operator \
   -n milvus-operator --create-namespace \
   --wait --wait-for-jobs \
-  https://github.com/zilliztech/milvus-operator/releases/download/v1.0.1/milvus-operator-1.0.1.tgz
+  https://github.com/zilliztech/milvus-operator/releases/download/v1.2.0/milvus-operator-1.2.0.tgz
 

 
You will see the output similar to the following after the installation process ends.

 
NAME: milvus-operator
@@ -144,7 +108,7 @@ Quick start with `kubectl apply -f https://raw.githubusercontent.com/zilliztech/
 More samples can be found in https://github.com/zilliztech/milvus-operator/tree/main/config/samples
 CRD Documentation can be found in https://github.com/zilliztech/milvus-operator/tree/main/docs/CRD
 

-
Install with kubectl
Run the following command to install Milvus Operator with kubectl.

+
Install with kubectl
Run the following command to install Milvus Operator with kubectl.

 
$ kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/main/deploy/manifests/deployment.yaml
 

 
You will see the output similar to the following after the installation process ends.

@@ -162,10 +126,6 @@ configmap/milvus-operator-manager-config created
 service/milvus-operator-controller-manager-metrics-service created
 service/milvus-operator-webhook-service created
 deployment.apps/milvus-operator-controller-manager created
-certificate.cert-manager.io/milvus-operator-serving-cert created
-issuer.cert-manager.io/milvus-operator-selfsigned-issuer created
-mutatingwebhookconfiguration.admissionregistration.k8s.io/milvus-operator-mutating-webhook-configuration created
-validatingwebhookconfiguration.admissionregistration.k8s.io/milvus-operator-validating-webhook-configuration created
 

 
You can check if the Milvus Operator pod is running as follows:

 
$ kubectl get pods -n milvus-operator
@@ -347,7 +307,7 @@ my-release-pulsar-zookeeper-2
 
 
Uninstall with Helm
$ helm -n milvus-operator uninstall milvus-operator
 

-
Uninstall with kubectl
$ kubectl delete -f https://raw.githubusercontent.com/zilliztech/milvus-operator/v1.0.1/deploy/manifests/deployment.yaml
+
Uninstall with kubectl
$ kubectl delete -f https://raw.githubusercontent.com/zilliztech/milvus-operator/v1.2.0/deploy/manifests/deployment.yaml
 

 
What’s next