Skip to content

Commit

Permalink
Merge pull request #2997 from haorenfsa/operator-2.4
Browse files Browse the repository at this point in the history
update operator docs
  • Loading branch information
AnthonyTsu1984 authored Jan 23, 2025
2 parents e88b902 + 810b6a9 commit d9834b8
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 64 deletions.
2 changes: 1 addition & 1 deletion site/en/Variables.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"milvus_csharp_sdk_real_version": "2.2.14",
"milvus_restful_sdk_version": "2.4.x",
"milvus_restful_sdk_real_version": "2.4.1",
"milvus_operator_version": "1.0.1",
"milvus_operator_version": "1.1.9",
"milvus_helm_chart_version": "4.1.24",
"milvus_image": "2.4.1",
"attu_release": "2.3.10",
Expand Down
6 changes: 3 additions & 3 deletions site/en/adminGuide/upgrade_milvus_cluster-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ spec:
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:
Then save your configuration as a YAML file (for example, `milvusupgrade.yaml`) and patch this configuration file to your Milvus instance as follows:

```shell
kubectl patch -f milvusupgrade.yml
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
```


Expand All @@ -107,7 +107,7 @@ spec:
Then run the following to perform the upgrade:

```shell
kubectl patch -f milvusupgrade.yaml
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
```

## Migrate the metadata
Expand Down
6 changes: 3 additions & 3 deletions site/en/adminGuide/upgrade_milvus_standalone-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ spec:
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:
Then save your configuration as a YAML file (for example, `milvusupgrade.yaml`) and patch this configuration file to your Milvus instance as follows:

```shell
kubectl patch -f milvusupgrade.yml
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
```

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

```shell
kubectl patch -f milvusupgrade.yaml
kubectl patch -f milvusupgrade.yaml --patch-file milvusupgrade.yaml --type merge
```

## Migrate the metadata
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,63 +40,12 @@ If you encounter any issues pulling the image, contact us at <a href="mailto:com
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.
### 1. Install cert-manager
Milvus Operator uses [cert-manager](https://cert-manager.io/docs/installation/supported-releases/) to provide a certificate for the webhook server.
<div class="alert note">
- You can safely skip this step if you choose to [deploy Milvus Operator using Helm](install_cluster-helm.md).
- Milvus Operator requires cert-manager 1.1.3 or above.
</div>
Run the following command to install cert-manager.
```shell
$ 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.
```shell
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:
```shell
$ 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:
- [With Helm](#Install-with-Helm)
- [With kubectl](#Install-with-kubectl)
#### Install with Helm
### Install with Helm
Run the following command to install Milvus Operator with Helm.
Expand Down Expand Up @@ -125,7 +74,7 @@ More samples can be found in https://github.com/zilliztech/milvus-operator/tree/
CRD Documentation can be found in https://github.com/zilliztech/milvus-operator/tree/main/docs/CRD
```

#### Install with kubectl
### Install with kubectl

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

Expand All @@ -150,10 +99,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:
Expand Down

0 comments on commit d9834b8

Please sign in to comment.