bitnamicharts/milvus
Bitnami Helm chart for Milvus
100K+
Milvus is a cloud-native, open-source vector database solution for AI applications and similarity search. Features high scalability, hibrid search and unified lambda structure.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/milvus
Looking to use Milvus in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
This chart bootstraps a Milvus Deployment in a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/milvus
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys milvus on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
This chart can be integrated with Prometheus by setting *.metrics.enabled
(under the dataCoord
, dataNode
, indexCoord
, indexNode
, proxy
, queryCoord
, queryNode
and rootCoord
sections) to true. This will expose the Milvus native Prometheus port in both the containers and services. The services will also have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value *.metrics.serviceMonitor.enabled=true
(under the dataCoord
, dataNode
, indexCoord
, indexNode
, proxy
, queryCoord
, queryNode
and rootCoord
sections). Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
The Milvus configuration file milvus.yaml
is shared across the different components: rootCoord
, dataCoord
, indexCoord
, dataNode
and indexNode
. This is set in the milvus.defaultConfig
value. This configuration can be extended with extra settings using the milvus.extraConfig
value. For specific component configuration edit the extraConfig
section inside each of the previously mentioned components. Check the official Milvis documentation for the list of possible configurations.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property inside each of the subsections: rootCoord
, dataCoord
, indexCoord
, dataNode
, indexNode
, attu
and queryNode
.
dataCoord:
extraEnvVars:
- name: LOG_LEVEL
value: error
rootCoord:
extraEnvVars:
- name: LOG_LEVEL
value: error
indexCoord:
extraEnvVars:
- name: LOG_LEVEL
value: error
dataNode:
extraEnvVars:
- name: LOG_LEVEL
value: error
indexNode:
extraEnvVars:
- name: LOG_LEVEL
value: error
queryNode:
extraEnvVars:
- name: LOG_LEVEL
value: error
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values.
If additional containers are needed in the same pod as milvus (such as additional metrics or logging exporters), they can be defined using the sidecars
parameter inside each of the subsections: rootCoord
, dataCoord
, indexCoord
, dataNode
, indexNode
, attu
and queryNode
.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
Bitnami charts configure credentials at first boot. Any further change in the secrets or credentials require manual intervention. Follow these instructions:
kubectl create secret generic SECRET_NAME --from-literal=password=PASSWORD --from-literal=root-password=ROOT_PASSWORD --dry-run -o yaml | kubectl apply -f -
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters inside each of the subsections: rootCoord
, dataCoord
, indexCoord
, dataNode
, indexNode
, attu
and queryNode
.
You may want to have Milvus connect to an external kafka rather than installing one inside your cluster. Typical reasons for this are to use a managed database service, or to share a common database server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the externalKafka
parameter. You should also disable the etcd installation with the etcd.enabled
option. Here is an example:
kafka:
enabled: false
externalKafka:
hosts:
- externalhost
You may want to have Milvus connect to an external etcd rather than installing one inside your cluster. Typical reasons for this are to use a managed database service, or to share a common database server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the externalEtcd
parameter. You should also disable the etcd installation with the etcd.enabled
option. Here is an example:
etcd:
enabled: false
externalEtcd:
hosts:
- externalhost
You may want to have Milvus connect to an external storage streaming rather than installing MiniIO(TM) inside your cluster. To achieve this, the chart allows you to specify credentials for an external storage streaming with the externalS3
parameter. You should also disable the MinIO(TM) installation with the minio.enabled
option. Here is an example:
minio.enabled=false
externalS3.host=myexternalhost
externalS3.accessKeyID=accesskey
externalS3.accessKeySecret=secret
This chart provides support for Ingress resources. If you have an ingress controller installed on your cluster, such as nginx-ingress-controller or contour you can utilize the ingress controller to serve your application.To enable Ingress integration, set attu.ingress.enabled
to true
.
The most common scenario is to have one host name mapped to the deployment. In this case, the attu.ingress.hostname
property can be used to set the host name. The attu.ingress.tls
parameter can be used to add the TLS configuration for this host.
However, it is also possible to have more than one host. To facilitate this, the attu.ingress.extraHosts
parameter (if available) can be set with the host names specified as an array. The attu.ingress.extraTLS
parameter (if available) can also be used to add the TLS configuration for extra hosts.
NOTE: For each host specified in the
attu.ingress.extraHosts
parameter, it is necessary to set a name, path, and any annotations that the Ingress controller should know about. Not all annotations are supported by all Ingress controllers, but this annotation reference document lists the annotations supported by many popular Ingress controllers.
Adding the TLS parameter (where available) will cause the chart to generate HTTPS URLs, and the application will be available on port 443. The actual TLS secrets do not have to be generated by this chart. However, if TLS is enabled, the Ingress record will not work until the TLS secret exists.
Learn more about Ingress controllers.
This chart facilitates the creation of TLS secrets for use with the Ingress controller (although this is not mandatory). There are several common use cases:
In the first two cases, a certificate and a key are needed. Files are expected in .pem
format.
Here is an example of a certificate file:
NOTE: There may be more than one certificate if there is a certificate chain.
-----BEGIN CERTIFICATE-----
MIID6TCCAtGgAwIBAgIJAIaCwivkeB5EMA0GCSqGSIb3DQEBCwUAMFYxCzAJBgNV
...
jScrvkiBO65F46KioCL9h5tDvomdU1aqpI/CBzhvZn1c0ZTf87tGQR8NK7v7
-----END CERTIFICATE-----
Here is an example of a certificate key:
-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAvLYcyu8f3skuRyUgeeNpeDvYBCDcgq+LsWap6zbX5f8oLqp4
...
wrj2wDbCDCFmfqnSJ+dKI3vFLlEz44sAV8jX/kd4Y6ZTQhlLbYc=
-----END RSA PRIVATE KEY-----
certificate
and key
values for a given *.ingress.secrets
entry.INGRESS_HOSTNAME-tls
(where INGRESS_HOSTNAME is a placeholder to be replaced with the hostname you set using the *.ingress.hostname
parameter).*.ingress.annotations
the corresponding ones for cert-manager.*.ingress.tls
and *.ingress.selfSigned
to true
.Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.fullname | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Kubernetes cluster domain name | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
enableServiceLinks | Whether information about services should be injected into all pods' environment variable | false |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployments/statefulsets | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployments/statefulsets | ["infinity"] |
Name | Description | Value |
---|---|---|
milvus.image.registry | Milvus image registry | REGISTRY_NAME |
milvus.image.repository | Milvus image repository | REPOSITORY_NAME/milvus |
milvus.image.digest | Milvus image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
milvus.image.pullPolicy | Milvus image pull policy | IfNotPresent |
milvus.image.pullSecrets | Milvus image pull secrets | [] |
milvus.image.debug | Enable debug mode | false |
milvus.auth.enabled | enable Milvus authentication | false |
milvus.auth.username | Milvus username | user |
milvus.auth.password | Milvus username password | "" |
milvus.auth.rootPassword | Milvus root password | "" |
milvus.auth.existingSecret | Name of a secret containing the Milvus password | "" |
milvus.auth.existingSecretPasswordKey | Name of the secret key containing the Milvus password | "" |
milvus.defaultConfig | Milvus components default configuration | "" |
milvus.extraConfig | Extra configuration parameters | {} |
milvus.existingConfigMap | name of a ConfigMap with existing configuration for the default configuration | "" |
milvus.extraConfigExistingConfigMap | name of a ConfigMap with existing configuration for the Dashboard | "" |
initJob.forceRun | Force the run of the credential job | false |
initJob.image.registry | PyMilvus image registry | REGISTRY_NAME |
initJob.image.repository | PyMilvus image repository |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/milvus/README.md