Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/examples/milvus/quickstart/distributed.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
apiVersion: kubedb.com/v1alpha2
kind: Milvus
metadata:
name: milvus-cluster
namespace: demo
spec:
version: "2.6.11"
objectStorage:
configSecret:
name: my-release-minio
topology:
mode: Distributed
distributed:
mixcoord:
replicas: 2
storageType: Durable
storage:
accessModes:
- ReadWriteOnce
storageClassName: local-path
resources:
requests:
storage: 10Gi
72 changes: 72 additions & 0 deletions docs/guides/milvus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Milvus
menu:
docs_{{ .version }}:
identifier: milvus-readme
name: Milvus
parent: milvus-guides
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
url: /docs/{{ .version }}/guides/milvus/
aliases:
- /docs/{{ .version }}/guides/milvus/README/
---

> New to KubeDB? Please start [here](/docs/README.md).

# Overview

KubeDB supports vector database deployment with Milvus using the `Milvus` CRD.

## Supported Milvus Features

| Features | Availability |
|----------------------------------|:------------:|
| Standalone provisioning | ✓ |
| Distributed provisioning | ✓ |
| Monitoring | ✓ |
| TLS | No |
| Ops Requests | No |

## Example Milvus Manifest

```yaml
apiVersion: kubedb.com/v1alpha2
kind: Milvus
metadata:
name: milvus-cluster
namespace: demo
spec:
version: "2.6.11"
objectStorage:
configSecret:
name: "my-release-minio"
topology:
mode: Distributed
distributed:
mixcoord:
replicas: 2
storageType: Durable
storage:
accessModes:
- ReadWriteOnce
storageClassName: local-path
resources:
requests:
storage: 10Gi
```

## User Guide

- [Quickstart Milvus](/docs/guides/milvus/quickstart/quickstart.md) with KubeDB operator.
- [Milvus CRD Concept](/docs/guides/milvus/concepts/milvus.md).
- [MilvusVersion CRD Concept](/docs/guides/milvus/concepts/catalog.md).
- [MilvusOpsRequest CRD Concept](/docs/guides/milvus/concepts/opsrequest.md).
- [RBAC Quickstart](/docs/guides/milvus/quickstart/rbac.md)
- [Private Registry](/docs/guides/milvus/private-registry/using-private-registry.md)
- [Custom RBAC](/docs/guides/milvus/custom-rbac/using-custom-rbac.md)
- [Custom Configuration](/docs/guides/milvus/configuration/using-config-file.md)
- [Monitoring](/docs/guides/milvus/monitoring/overview.md) for metrics collection guidance.
- [Builtin Prometheus Monitoring](/docs/guides/milvus/monitoring/using-builtin-prometheus.md)
- [Prometheus Operator Monitoring](/docs/guides/milvus/monitoring/using-prometheus-operator.md)
10 changes: 10 additions & 0 deletions docs/guides/milvus/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Milvus
menu:
docs_{{ .version }}:
identifier: milvus-guides
name: Milvus
parent: guides
weight: 15
menu_name: docs_{{ .version }}
---
10 changes: 10 additions & 0 deletions docs/guides/milvus/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Milvus Concepts
menu:
docs_{{ .version }}:
identifier: milvus-concepts
name: Concepts
parent: milvus-guides
weight: 15
menu_name: docs_{{ .version }}
---
48 changes: 48 additions & 0 deletions docs/guides/milvus/concepts/catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: MilvusVersion CRD
menu:
docs_{{ .version }}:
identifier: milvus-catalog-concepts
name: MilvusVersion
parent: milvus-concepts-milvus
weight: 15
menu_name: docs_{{ .version }}
section_menu_id: guides
---

> New to KubeDB? Please start [here](/docs/README.md).

# MilvusVersion

## What is MilvusVersion

`MilvusVersion` is the catalog CRD that defines the Milvus engine image and related metadata for KubeDB-managed Milvus deployments.

KubeDB uses this CRD when resolving `Milvus.spec.version`.

## MilvusVersion Specification

```yaml
apiVersion: catalog.kubedb.com/v1alpha1
kind: MilvusVersion
metadata:
name: "2.6.11"
spec:
version: "2.6.11"
db:
image: "kubedb/milvus:2.6.11"
etcdVersion: v3.5.21
deprecated: false
```

## Key fields

- `metadata.name` is referenced from `Milvus.spec.version`.
- `spec.version` is the Milvus release version.
- `spec.db.image` is the image used for Milvus components.
- `spec.deprecated` indicates whether the entry is deprecated.

## Next Steps

- Read the [Milvus CRD concept](/docs/guides/milvus/concepts/milvus.md).
- Run the [Milvus quickstart](/docs/guides/milvus/quickstart/quickstart.md).
Loading