Skip to content

Commit

Permalink
Release v1.0.3
Browse files Browse the repository at this point in the history
Signed-off-by: haorenfsa <[email protected]>
  • Loading branch information
haorenfsa committed Aug 16, 2024
1 parent 85b4f27 commit e903051
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 9 deletions.
50 changes: 41 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,38 @@

The Milvus Operator provides an easy and solid solution to deploy and manage a full Milvus service stack including both the milvus components and its relevant dependencies such as etcd, pulsar and minio to the target [Kubernetes](https://kubernetes.io/) clusters in a scalable and high-available way. The Milvus Operator defines a `Milvus` custom resources on top of Kubernetes [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). The Kubernetes API can then be used in a declarative way to manage Milvus deployment stack and ensure its scalability and high-availability operation.

# Milvus Operator VS Helm

In general, Milvus Operator is recommanded for production. Helm is recommanded for beginners.

Milvus Operator provides more features for production. But you need to install it in your kubernetes before you start your first Milvus instance. If you are new to Milvus and Kubernetes. Helm is easier to use and you can start your first Milvus instance in minutes.

For more details, please check the table below:

<!-- source csv for table
Advantages, Milvus Operator, Milvus Helm
Recommended for Beginners , , ✅
Quick Start , , ✅
Recommended for Production , ✅,
Better Managed Rolling Upgrade, ✅,
Dynamic Configuration Reload , ✅,
Health Check Metrics , ✅,
Diagnose Message When Unhealthy, ✅,
Quick Suspending Instance, ✅,
Cleanup Resources after Deletion, ✅, -->

|Advantages| Milvus Operator| Milvus Helm|
|---|---|---|
|Recommended for Beginners | ||
|Quick Start | ||
|Recommended for Production || |
|Better Managed Rolling Upgrade|| |
|Dynamic Configuration Reload || |
|Health Check Metrics || |
|Diagnose Message When Unhealthy|| |
|Quick Suspend Running Instance|| |
|Cleanup Resources after Deletion|| |

# Documentations
- [Installation](docs/installation/installation.md)
- [Install KinD for development](docs/installation/kind-installation.md)
Expand Down Expand Up @@ -46,7 +78,7 @@ helm -n milvus-operator upgrade --install --create-namespace milvus-operator mil
Or with kubectl & raw manifests:

```shell
kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/v1.0.2/deploy/manifests/deployment.yaml
kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/v1.0.3/deploy/manifests/deployment.yaml
```

For more infomation Check [Installation Instructions](docs/installation/installation.md)
Expand All @@ -64,11 +96,11 @@ Versions of the underlying components are listed below:

<!-- source csv for table
Components, Milvus, Pulsar / Kafka, Etcd, MinIO
Versions, v2.4.7 `[1]`, 2.8.2 / 3.1.0, 3.5.14, RELEASE.2023-03-20T20-16-18Z -->
Versions, v2.4.8 `[1]`, 2.8.2 / 3.1.0, 3.5.14, RELEASE.2023-03-20T20-16-18Z -->

|Components| Milvus| Pulsar / Kafka| Etcd| MinIO|
|---|---|---|---|---|
|Versions| v2.4.7 `[1]`| 2.8.2 / 3.1.0 | 3.5.14 |RELEASE.2023-03-20T20-16-18Z|
|Versions| v2.4.8 `[1]`| 2.8.2 / 3.1.0 | 3.5.14 |RELEASE.2023-03-20T20-16-18Z|


> `[1]` Version of milvus is the default version we will use, you can set it to other version. The Compatibility with milvus releases is showed below.
Expand All @@ -77,21 +109,21 @@ Versions, v2.4.7 `[1]`, 2.8.2 / 3.1.0, 3.5.14, RELEASE.2023-03-20T20-16-18Z -->

<!-- source csv for table
Milvus Versions, <=v2.0.0-rc8, v2.0.0-pre-ga, >=v2.0.0
Compatibility, ✖️, ✔️, ✔️ -->
Compatibility, ❌, ✅, ✅ -->

|Milvus Versions| <=v2.0.0-rc8| v2.0.0-pre-ga| >=v2.0.0|
|---|---|---|---|
|Compatibility| ✖️| ✔️| ✔️|
|Compatibility| |||

## Compatibility With Milvus-Operator Earlier Releases

<!-- source csv for table
Milvus Operator Versions, <0.4.0, >=0.4.0
Compatibility, ✖️, ✔️ -->
Compatibility, ❌, ✅ -->

|Milvus Operator Versions| <0.4.0| >=0.4.0|
|---|---|---|
|Compatibility| ✖️| ✔️|
|Compatibility| ||


# Install / upgrade milvus-operator of a specific version
Expand All @@ -101,11 +133,11 @@ Use helm:
```shell
helm upgrade --install milvus-operator \
-n milvus-operator --create-namespace \
https://github.com/zilliztech/milvus-operator/releases/download/v1.0.2/milvus-operator-1.0.2.tgz
https://github.com/zilliztech/milvus-operator/releases/download/v1.0.3/milvus-operator-1.0.3.tgz
```

Or use kubectl & raw manifests:

```shell
kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/v1.0.2/deploy/manifests/deployment.yaml
kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/v1.0.3/deploy/manifests/deployment.yaml
```
16 changes: 16 additions & 0 deletions index.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
apiVersion: v1
entries:
milvus-operator:
- apiVersion: v2
appVersion: 1.0.3
created: "2024-08-15T15:32:51.031297+08:00"
description: A Helm chart for deploying Milvus Operator
digest: 270a604fbbf617da319beea5a0b7fbdd345833336f8c251a022dcb1d4df95a34
home: https://github.com/zilliztech/milvus-operator
kubeVersion: '>= 1.16.0-0'
maintainers:
- email: [email protected]
name: zilliztech
url: https://zilliz.com
name: milvus-operator
type: application
urls:
- https://github.com/zilliztech/milvus-operator/releases/download/v1.0.3/milvus-operator-1.0.3.tgz
version: 1.0.3
- apiVersion: v2
appVersion: 1.0.2
created: "2024-08-08T19:07:50.608706+08:00"
Expand Down

0 comments on commit e903051

Please sign in to comment.