Skip to content

Latest commit

 

History

History
132 lines (83 loc) · 7.34 KB

README.md

File metadata and controls

132 lines (83 loc) · 7.34 KB
Raw

Milvus

Milvus is Vector database built for scalable similarity search. It is "Open-source, highly scalable, and blazing fast".

As Milvus supports meany features, the easiest way to understand what it can do is to head to the relevant documentation.

Milvus also provides great documentation, starting with a full description of its architecture.

Architecture

Container image

Milvus currently has a small shortcoming that prevents it to run natively on OpenShift. The fix is pretty straightforward and featured in the provided Containerfile.

A PR has already been made to fix this issue and is now merged. It should be available in a coming release. Meanwhile, a compatible image is available here.

Deployment

Requirements

  • Access to the OpenShift cluster.
  • A default StorageClass must be configured.

Deployment Options

The following recipes will deploy a default installation of Milvus, either standalone or in cluster mode, with authentication enabled. However, many things can be modified in this configuration, through the provided openshift-values.yaml file.

  • The default Milvus deployment leverages Minio to store logs and index files. This can be replaced by another S3 storage system
  • Default configuration uses Pulsar for managing logs of recent changes, outputting stream logs, and providing log subscriptions. This can be replaced by Kafka

To modify those components, as well many other configuration parameters, please refer to the configuration documentation and modify the values file according to your needs.

Deployment procedure

Milvus can be deployed in Standalone or Cluster mode. Cluster mode, leveraging Pulsar, etcd and Minio for data persistency, will bring redundancy, as well as easy scale up and down of the different components.

Although Milvus features an operator to easily deploy it in a Kubernetes environment, this method has not been tested yet, while waiting for the different corrections to be made to the deployment code for OpenShift specificities.

Instead, this deployment method is based on the Offline installation that purely rely on Helm Charts.

  • Log into your OpenShift cluster, and create a new project to host your Milvus installation:
oc new-project milvus
  • Add and update Milvus Helm repository locally:
helm repo add milvus https://zilliztech.github.io/milvus-helm/
helm repo update

  • Fetch the file openshift-values.yaml from this repo. This file is really important as it sets specific values for OpenShift compatibility. You can also modify some of the values in this file to adapt the deployment to your requirements, notably modify the Minio admin user and password.

    wget https://raw.githubusercontent.com/rh-aiservices-bu/llm-on-openshift/main/vector-databases/milvus/openshift-values.yaml

  • Create the manifest:

    • For Milvus standalone:

      helm template -f openshift-values.yaml vectordb --set cluster.enabled=false --set etcd.replicaCount=1 --set minio.mode=standalone --set pulsar.enabled=false milvus/milvus > milvus_manifest_standalone.yaml

    • For Milvus cluster:

      helm template -f openshift-values.yaml vectordb milvus/milvus > milvus_manifest_cluster.yaml

  • VERY IMPORTANT: you must patch the generated manifest, as some settings are incompatible with OpenShift. Those commands are using the yq tool (beware, the real one, not the Python version):

    • For Milvus Standalone:

      yq '(select(.kind == "StatefulSet" and .metadata.name == "vectordb-etcd") | .spec.template.spec.securityContext) = {}' -i milvus_manifest_standalone.yaml
yq '(select(.kind == "StatefulSet" and .metadata.name == "vectordb-etcd") | .spec.template.spec.containers[0].securityContext) = {"capabilities": {"drop": ["ALL"]}, "runAsNonRoot": true, "allowPrivilegeEscalation": false}' -i milvus_manifest_standalone.yaml
yq '(select(.kind == "Deployment" and .metadata.name == "vectordb-minio") | .spec.template.spec.securityContext) = {"capabilities": {"drop": ["ALL"]}, "runAsNonRoot": true, "allowPrivilegeEscalation": false}' -i milvus_manifest_standalone.yaml

    • For Milvus Cluster:

      yq '(select(.kind == "StatefulSet" and .metadata.name == "vectordb-etcd") | .spec.template.spec.securityContext) = {}' -i milvus_manifest_cluster.yaml
yq '(select(.kind == "StatefulSet" and .metadata.name == "vectordb-etcd") | .spec.template.spec.containers[0].securityContext) = {"capabilities": {"drop": ["ALL"]}, "runAsNonRoot": true, "allowPrivilegeEscalation": false}' -i milvus_manifest_cluster.yaml
yq '(select(.kind == "StatefulSet" and .metadata.name == "vectordb-minio") | .spec.template.spec.securityContext) = {"capabilities": {"drop": ["ALL"]}, "runAsNonRoot": true, "allowPrivilegeEscalation": false}' -i milvus_manifest_cluster.yaml

  • Deploy Milvus (eventually change the name of the manifest)!

    • For Milvus Standalone:

      oc apply -f milvus_manifest_standalone.yaml

    • For Milvus Cluster:

      oc apply -f milvus_manifest_cluster.yaml

  • To deploy the management UI for Milvus, called Attu, apply the file attu-deployment.yaml:

oc apply -f https://raw.githubusercontent.com/rh-aiservices-bu/llm-on-openshift/main/vector-databases/milvus/attu-deployment.yaml

NOTE: Attu deployment could have been done through the Helm chart, but this would not properly create the access Route.

Milvus is now deployed, with authentication enabled. The default and only admin user is root, with the default password Milvus. Please see the following section to modify this root access and create the necessary users and roles.

Day-2 operations

Milvus implements a full RBAC system to control access to its databases and collections. It is recommended to:

  • Change the default password
  • Create collections
  • Create users and roles to give read/write or read access to the different collections

All of this can be done either using the PyMilvus library, or the Attu UI deployed in the last step.

Milvus features an awesome documentation, detailing all the configuration, maintenance, and operations procedure. This is a must-read to grasp all aspects of its architecture and usage.

Usage

Several example notebooks are available to show how to use Milvus: