diff --git a/README.md b/README.md index 14fe0d8..45a45bd 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,18 @@ This GitHub repository is the official source for Milvus's Helm charts. For instructions about how to install charts from this repository, visit the public website at: [Milvus Helm Charts](https://artifacthub.io/packages/helm/milvus-helm/milvus) +## Prerequisites + +- Kubernetes >= 1.20.0 +- Helm >= 3.14.0 + +## Compatibility Notice +- As of version 4.2.21, the Milvus Helm chart 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`. + +- As of version 4.2.0, the Milvus Helm chart no longer supports Milvus v2.3.x. If you need to deploy Milvus v2.3.x using Helm, please use Milvus Helm chart version less than 4.2.0 (e.g 4.1.36). + +> **IMPORTANT** The master branch is for the development of Milvus v2.x. On March 9th, 2021, we released Milvus v1.0, the first stable version of Milvus with long-term support. To use Milvus v1.x, switch to [branch 1.1](https://github.com/zilliztech/milvus-helm/tree/1.1). + ## Make changes to an existing chart without publishing If you make changes to an existing chart, but do not change its version, nothing new will be published to the _charts repository_. @@ -26,13 +38,6 @@ When it detects that the version in the folder doesn't exist in `index.yaml`, i The packaged referenced in `index.yaml`, when it's updated using the GitHub action, will link for download to the URL provided by the _GitHub repository_ release files. -## Add a new chart - -To add a new chart, create a directory inside _charts_ with it contents at _master_ branch. - -When you commit it, it will be picked up by the GitHub action, and if it contains a chart and version that doesn't already exist in the _charts repository_, a new release with the package for the chart will be published on the _GitHub repository_, -and the list of all charts at `index.yaml` on _gh-pages_ branch will be updated on the _charts repository_. - ## More information You can find more information at: diff --git a/charts/milvus/Chart.yaml b/charts/milvus/Chart.yaml index 78e58ac..cc7baa8 100644 --- a/charts/milvus/Chart.yaml +++ b/charts/milvus/Chart.yaml @@ -3,7 +3,7 @@ name: milvus appVersion: "2.4.16" kubeVersion: "^1.10.0-0" description: Milvus is an open-source vector database built to power AI applications and vector similarity search. -version: 4.2.21 +version: 4.2.22 keywords: - milvus - elastic diff --git a/charts/milvus/README.md b/charts/milvus/README.md index 0f5bc15..8ec7fda 100644 --- a/charts/milvus/README.md +++ b/charts/milvus/README.md @@ -9,11 +9,13 @@ This chart bootstraps Milvus deployment on a Kubernetes cluster using the Helm p ## Prerequisites -- Kubernetes 1.20+ -- Helm >= 3.12.3 +- Kubernetes >= 1.20.0 +- Helm >= 3.14.0 ## Compatibility Notice -As of version 4.2.0, the Milvus Helm chart no longer supports Milvus v2.3.x. If you need to deploy Milvus v2.3.x using Helm, please use Milvus Helm chart version less than 4.2.0 (e.g 4.1.36). +- As of version 4.2.21, the Milvus Helm chart 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`. + +- As of version 4.2.0, the Milvus Helm chart no longer supports Milvus v2.3.x. If you need to deploy Milvus v2.3.x using Helm, please use Milvus Helm chart version less than 4.2.0 (e.g 4.1.36). > **IMPORTANT** The master branch is for the development of Milvus v2.x. On March 9th, 2021, we released Milvus v1.0, the first stable version of Milvus with long-term support. To use Milvus v1.x, switch to [branch 1.1](https://github.com/zilliztech/milvus-helm/tree/1.1). @@ -133,8 +135,8 @@ $ helm upgrade --install my-release milvus/milvus -f values-custom.yaml E.g. to scale out query node from 1(default) to 2: ```bash -# Helm v3.x -$ helm upgrade --install --set queryNode.replicas=2 my-release milvus/milvus +# Helm v3.14.0+ +$ helm upgrade --reset-then-reuse-values --install --set queryNode.replicas=2 my-release milvus/milvus ``` ### Milvus Coordinator Active Standby