Skip to content

Commit b7e084b

Browse files
Merge pull request #2996 from haorenfsa/operator
update operator docs
2 parents 9734ecd + f126a86 commit b7e084b

File tree

4 files changed

+9
-64
lines changed

4 files changed

+9
-64
lines changed

site/en/Variables.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"milvus_csharp_sdk_real_version": "2.2.14",
1616
"milvus_restful_sdk_version": "2.4.x",
1717
"milvus_restful_sdk_real_version": "2.4.1",
18-
"milvus_operator_version": "1.0.1",
18+
"milvus_operator_version": "1.2.0",
1919
"milvus_helm_chart_version": "4.1.24",
2020
"milvus_image": "2.4.1",
2121
"attu_release": "2.3.10",

site/en/adminGuide/upgrade_milvus_cluster-operator.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ spec:
8080
image: milvusdb/milvus:<some-old-version>
8181
```
8282

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

8585
```shell
86-
kubectl patch -f milvusupgrade.yml
86+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
8787
```
8888

8989

@@ -107,7 +107,7 @@ spec:
107107
Then run the following to perform the upgrade:
108108

109109
```shell
110-
kubectl patch -f milvusupgrade.yaml
110+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
111111
```
112112

113113
## Migrate the metadata

site/en/adminGuide/upgrade_milvus_standalone-operator.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ spec:
8080
image: milvusdb/milvus:<some-older-version>
8181
```
8282

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

8585
```shell
86-
kubectl patch -f milvusupgrade.yml
86+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
8787
```
8888

8989
## Upgrade Milvus by changing its image
@@ -108,7 +108,7 @@ spec:
108108
Then run the following to perform the upgrade:
109109

110110
```shell
111-
kubectl patch -f milvusupgrade.yaml
111+
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
112112
```
113113

114114
## Migrate the metadata

site/en/getstarted/run-milvus-k8s/install_cluster-milvusoperator.md

+2-57
Original file line numberDiff line numberDiff line change
@@ -40,63 +40,12 @@ If you encounter any issues pulling the image, contact us at <a href="mailto:com
4040
4141
Milvus Operator defines a Milvus cluster custom resources on top of [Kubernetes Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/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.
4242
43-
### 1. Install cert-manager
44-
45-
Milvus Operator uses [cert-manager](https://cert-manager.io/docs/installation/supported-releases/) to provide a certificate for the webhook server.
46-
47-
<div class="alert note">
48-
49-
- You can safely skip this step if you choose to [deploy Milvus Operator using Helm](install_cluster-helm.md).
50-
- Milvus Operator requires cert-manager 1.1.3 or above.
51-
52-
</div>
53-
54-
Run the following command to install cert-manager.
55-
56-
```shell
57-
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.3/cert-manager.yaml
58-
```
59-
60-
You will see the output similar to the following after the installation process ends.
61-
62-
```shell
63-
customresourcedefinition.apiextensions.k8s.io/certificaterequests.cert-manager.io created
64-
customresourcedefinition.apiextensions.k8s.io/certificates.cert-manager.io created
65-
customresourcedefinition.apiextensions.k8s.io/challenges.acme.cert-manager.io created
66-
customresourcedefinition.apiextensions.k8s.io/clusterissuers.cert-manager.io created
67-
customresourcedefinition.apiextensions.k8s.io/issuers.cert-manager.io created
68-
customresourcedefinition.apiextensions.k8s.io/orders.acme.cert-manager.io created
69-
namespace/cert-manager created
70-
serviceaccount/cert-manager-cainjector created
71-
...
72-
service/cert-manager created
73-
service/cert-manager-webhook created
74-
deployment.apps/cert-manager-cainjector created
75-
deployment.apps/cert-manager created
76-
deployment.apps/cert-manager-webhook created
77-
mutatingwebhookconfiguration.admissionregistration.k8s.io/cert-manager-webhook created
78-
validatingwebhookconfiguration.admissionregistration.k8s.io/cert-manager-webhook created
79-
```
80-
81-
You can check if cert-manager pods are running as follows:
82-
83-
```shell
84-
$ kubectl get pods -n cert-manager
85-
86-
NAME READY STATUS RESTARTS AGE
87-
cert-manager-848f547974-gccz8 1/1 Running 0 70s
88-
cert-manager-cainjector-54f4cc6b5-dpj84 1/1 Running 0 70s
89-
cert-manager-webhook-7c9588c76-tqncn 1/1 Running 0 70s
90-
```
91-
92-
### 2. Install Milvus Operator
93-
9443
You can install Milvus Operator in either of the following ways:
9544
9645
- [With Helm](#Install-with-Helm)
9746
- [With kubectl](#Install-with-kubectl)
9847
99-
#### Install with Helm
48+
### Install with Helm
10049
10150
Run the following command to install Milvus Operator with Helm.
10251
@@ -125,7 +74,7 @@ More samples can be found in https://github.com/zilliztech/milvus-operator/tree/
12574
CRD Documentation can be found in https://github.com/zilliztech/milvus-operator/tree/main/docs/CRD
12675
```
12776

128-
#### Install with kubectl
77+
### Install with kubectl
12978

13079
Run the following command to install Milvus Operator with `kubectl`.
13180

@@ -150,10 +99,6 @@ configmap/milvus-operator-manager-config created
15099
service/milvus-operator-controller-manager-metrics-service created
151100
service/milvus-operator-webhook-service created
152101
deployment.apps/milvus-operator-controller-manager created
153-
certificate.cert-manager.io/milvus-operator-serving-cert created
154-
issuer.cert-manager.io/milvus-operator-selfsigned-issuer created
155-
mutatingwebhookconfiguration.admissionregistration.k8s.io/milvus-operator-mutating-webhook-configuration created
156-
validatingwebhookconfiguration.admissionregistration.k8s.io/milvus-operator-validating-webhook-configuration created
157102
```
158103

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

0 commit comments

Comments
 (0)