Milvus Helm Charts

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

Prerequisites

• Kubernetes >= 1.20.0
• Helm >= 3.14.0

Compatibility Notice

• IMPORTANT For users using pulsar2. Please don't use version 4.2.21～4.2.29 for upgrading, there're some known issues. 4.2.30 or later version is recommended. Remember to add --set pulsar.enabled=true,pulsarv3.enabled=false or set them in your values file when upgrading.

• 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.

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.

Publishing a new version of a chart

When a commit to master includes a new version of a chart, a GitHub action will make it available on the charts repository.

Detailed explanation of publish procedure

With each commit to master, a GitHub action will compare all charts versions at the charts folder on master branch with published versions at the index.yaml chart list on gh-pages branch.

When it detects that the version in the folder doesn't exist in index.yaml, it will create a release with the packaged chart content on the GitHub repository, and update index.yaml to include it on the charts repository.

index.yaml is accesible from zilliztech.github.io/milvus-helm/index.yaml and is the list of all charts and their versions available when you interact with the charts repository using Helm.

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.

More information

You can find more information at:

• zilliztech.github.io/milvus-helm
• The Helm package manager
• Chart Releaser
• Chart Releaser GitHub Action

---