Configure Milvus with Helm Charts

This topic describes how to configure Milvus components and its third-party dependencies with Helm Charts.

Configure Milvus via configuration file

You can configure Milvus with a configuration file values.yaml.

Download a configuration file

Download values.yaml directly or with the following command.

$ wget https://raw.githubusercontent.com/milvus-io/milvus-helm/master/charts/milvus/values.yaml

Modify the configuration file

Configure your Milvus instance to suit your application scenarios by adjusting corresponding parameters in values.yaml.

Specifically, search for extraConfigFiles in values.yaml and put your configurations in this section as follows:

# Extra configs for milvus.yaml
# If set, this config will merge into milvus.yaml
# Please follow the config structure in the milvus.yaml
# at https://github.com/milvus-io/milvus/blob/master/configs/milvus.yaml
# Note: this config will be the top priority which will override the config
# in the image and helm chart.
extraConfigFiles:
  user.yaml: |+
    #    For example to set the graceful time for query nodes
    #    queryNodes:
    #      gracefulTime: 10

Check the following links for more information about each parameter.

Sorted by:

For other parameters specifically to Kubernetes installation, See Milvus Helm Chart Configuration.

Start Milvus

Having finished modifying the configuration file, you can then start Milvus with the file.

$ helm upgrade my-release milvus/milvus -f values.yaml

Configure Milvus via command line

Alternatively, you can upgrade Milvus configurations directly with the Helm command.

Check the configurable parameters

Before upgrade, you can check the configurable parameters with Helm charts.

$ helm show values milvus/milvus

Start Milvus

Configure and start Milvus by adding --values or --set in the command for upgrade.

# For instance, upgrade the Milvus cluster with compaction disabled
$ helm upgrade my-release milvus/milvus --set dataCoord.enableCompaction=false

What's next

• If you want to learn how to monitor the Milvus services and create alerts:

  • Learn Monitor Milvus with Prometheus Operator on Kubernetes
  • Learn Visualize Milvus Metrics in Grafana.

• If you are looking for instructions on how to allocate resources:

  • Allocate Resources on Kubernetes