# milvus-operator

**Repository Path**: hspghost/milvus-operator

## Basic Information

- **Project Name**: milvus-operator
- **Description**: milvus-operator
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: beta
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-06-06
- **Last Updated**: 2023-06-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Milvus Operator

[![CI Pipeline](https://github.com/milvus-io/milvus-operator/actions/workflows/ci.yml/badge.svg)](https://github.com/milvus-io/milvus-operator/actions/workflows/ci.yml/badge.svg)
[![codecov](https://codecov.io/gh/milvus-io/milvus-operator/branch/main/graph/badge.svg?token=DAXmgusBQq)](https://codecov.io/gh/milvus-io/milvus-operator)
[![Go Reference](https://pkg.go.dev/badge/github.com/milvus-io/milvus-operator.svg)](https://pkg.go.dev/github.com/milvus-io/milvus-operator)
<img src="https://img.shields.io/github/license/milvus-io/milvus" alt="license">


> **ATTENTIONS:** THE `MAIN` BRANCH MAY BE IN AN UNSTABLE OR EVEN BROKEN STATE DURING DEVELOPMENT.

## Overview
[Milvus](https://milvus.io) 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](https://kubernetes.io/) clusters in a scalable and high-available way. The Milvus Operator defines a milvuscluster custom resources on top of Kubernetes [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/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 or upgrade to latest version with helm:

```shell
helm repo add milvus-operator https://milvus-io.github.io/milvus-operator/
helm repo update milvus-operator
helm -n milvus-operator upgrade --install milvus-operator milvus-operator/milvus-operator
```

Or with kubectl & raw manifests:

```shell
kubectl apply -f https://github.com/milvus-io/milvus-operator/raw/main/deploy/manifests/deployment.yaml
```

For more infomation Check [instructions on how to install/uninstall milvus operator](docs/installation/installation.md)

## Create milvus cluster
```shell
kubectl apply -f https://raw.githubusercontent.com/milvus-io/milvus-operator/main/config/samples/milvus_cluster_default.yaml
```

# Versioning

Versions of the underlying components are listed below:

<!-- source csv for table
Components, Milvus, Pulsar / Kafka, Etcd, MinIO
Versions, v2.2.0 `[1]`, 2.8.2 / 3.1.0, 3.5.0, RELEASE.2022-03-17T06-34-49Z -->

|Components| Milvus| Pulsar / Kafka| Etcd| MinIO|
|---|---|---|---|---|
|Versions| v2.2.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

<!-- source csv for table
Milvus Versions, <=v2.0.0-rc8, v2.0.0-pre-ga, >=v2.0.0
Compatibility, :heavy_multiplication_x:, :heavy_check_mark:, :heavy_check_mark:  -->

|Milvus Versions| <=v2.0.0-rc8| v2.0.0-pre-ga| >=v2.0.0|
|---|---|---|---|
|Compatibility| :heavy_multiplication_x:| :heavy_check_mark:| :heavy_check_mark:|

## Compatibility With Milvus-Operator Earlier Releases

<!-- source csv for table
Milvus Operator Versions, <0.4.0, >=0.4.0
Compatibility, :heavy_multiplication_x:, :heavy_check_mark:  -->

|Milvus Operator Versions| <0.4.0| >=0.4.0|
|---|---|---|
|Compatibility| :heavy_multiplication_x:| :heavy_check_mark:|

**NOTES:**

  :heavy_check_mark: : support
  :heavy_multiplication_x: : not support

# Install / upgrade milvus-operator of a specific version

Use helm:

```shell
helm upgrade --install milvus-operator \
  -n milvus-operator --create-namespace \
  https://github.com/milvus-io/milvus-operator/releases/download/v0.7.0/milvus-operator-0.7.0.tgz
```

Or use kubectl & raw manifests:

```shell
kubectl apply -f https://raw.githubusercontent.com/milvus-io/milvus-operator/v0.7.0/deploy/manifests/deployment.yaml
```


# Documentation
- [How it works](docs/arch/arch.md)
- [Installation](docs/installation/installation.md)
- [How to configure the MilvusCluster](docs/CRD/milvus-cluster.md)
- [How to configure the standalone Milvus](docs/CRD/milvus.md)
- [Install KinD for development](docs/installation/kind-installation.md)