README
¶
Milvus Operator
ATTENTIONS: THE
MAINBRANCH MAY BE IN AN UNSTABLE OR EVEN BROKEN STATE DURING DEVELOPMENT.
Overview
Milvus is a cloud-native, open-source vector database built to manage embedding vectors generated by machine learning models and neural networks. It extends the capabilities of best-in-class approximate nearest neighbor (ANN) search libraries (e.g. Faiss, NMSLIB, Annoy) and features on-demand scalability, and high availability.
The Milvus Operator provides an easy and solid solution to deploy and manage a full Milvus service stack including both the milvus components and its relevant dependencies such as etcd, pulsar and minio to the target Kubernetes clusters in a scalable and high-available way. The Milvus Operator defines a milvuscluster custom resources on top of Kubernetes Custom Resources. The Kubernetes API can then be used in a declarative way to manage Milvus deployment stack and ensure its scalability and high-availability operation.
Getting started
Deploy milvus operator
Install with helm:
helm install milvus-operator \
-n milvus-operator --create-namespace \
https://github.com/milvus-io/milvus-operator/releases/download/v0.6.2/milvus-operator-0.6.2.tgz
Or install with kubectl & raw manifests:
kubectl apply -f https://raw.githubusercontent.com/milvus-io/milvus-operator/v0.6.2/deploy/manifests/deployment.yaml
For more infomation Check instructions on how to install/uninstall milvus operator
Create milvus cluster
kubectl apply -f https://raw.githubusercontent.com/milvus-io/milvus-operator/main/config/samples/milvuscluster_default.yaml
Versioning
Versions of the underlying components are listed below:
| Components | Milvus | Pulsar / Kafka | Etcd | MinIO |
|---|---|---|---|---|
| Versions | v2.1.0 [1] |
2.8.2 / 3.1.0 | 3.5.0 | RELEASE.2022-03-17T06-34-49Z |
NOTES:
[1] Version of milvus is the default version we will use, you can set it to other version. The Compatibility with milvus releases is showed below.
Compatibility With Milvus Releases
| Milvus Versions | <=v2.0.0-rc8 | v2.0.0-pre-ga | >=v2.0.0 |
|---|---|---|---|
| Compatibility | ✖ | ✔ | ✔ |
Compatibility With Milvus-Operator Earlier Releases
| Milvus Operator Versions | <0.4.0 | >=0.4.0 |
|---|---|---|
| Compatibility | ✖ | ✔ |
NOTES:
✔ : support ✖ : not support
Documentation
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
milvus.io/v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=milvus.io
|
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=milvus.io |
|
milvus.io/v1beta1
package v1beta1 contains API Schema definitions for the v1beta1 API group +kubebuilder:object:generate=true +groupName=milvus.io
|
package v1beta1 contains API Schema definitions for the v1beta1 API group +kubebuilder:object:generate=true +groupName=milvus.io |
|
pkg
|
|
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/milvus.io/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/milvus.io/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
tool
|
|