Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #2425

Merged
merged 2 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion site/en/getstarted/standalone/install_standalone-aptyum.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: install_standalone-aptyum.md
label: Dpkg
related_key: Install
order: 1
order: 3
group: install_standalone-docker.md
summary: Learn how to install Milvus stanalone with dpkg.
---
Expand Down
135 changes: 135 additions & 0 deletions site/en/getstarted/standalone/install_standalone-docker-compose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
---
id: install_standalone-docker-compose.md
label: Docker
related_key: Docker
order: 4
group: install_standalone-docker.md
summary: Learn how to install Milvus standalone with Docker Compose.
---

{{tab}}

# Install Milvus Standalone with Docker Compose

This topic describes how to install Milvus standalone with Docker Compose.

## Prerequisites

- Check whether [Docker and Docker Compose](https://docs.docker.com/compose/install/) are installed on your machine.
- Check [the requirements](prerequisite-docker.md) for hardware and software requirements before installing Milvus.

- For the users using MacOS 10.14 or later, set the Docker virtual machine (VM) to use a minimum of 2 virtual CPUs (vCPUs) and 8 GB of initial memory. Otherwise, the installation might fail.

## Procedure

To install Milvus standalone with Docker Compose, follow these steps:

1. Start Milvus.

```
sudo docker run -d \
--name milvus-standalone \
--security-opt seccomp:unconfined \
-e ETCD_USE_EMBED=true \
-e ETCD_DATA_DIR=/var/lib/milvus/etcd \
-e ETCD_CONFIG_PATH=/milvus/configs/embedEtcd.yaml \
-e COMMON_STORAGETYPE=local \
-v ${DOCKER_VOLUME_DIRECTORY:-.}/volumes/milvus:/var/lib/milvus \
-v ${DOCKER_VOLUME_DIRECTORY:-.}/embedEtcd.yaml:/milvus/configs/embedEtcd.yaml \
-p 19530:19530 \
-p 9091:9091 \
-p 2379:2379 \
--health-cmd="curl -f http://localhost:9091/healthz" \
--health-interval=30s \
--health-start-period=90s \
--health-timeout=20s \
--health-retries=3 \
milvusdb/milvus:v2.3.5 \
milvus run standalone
```

### Download the `YAML` file

[Download](https://github.com/milvus-io/milvus/releases/download/v{{var.milvus_release_tag}}/milvus-standalone-docker-compose.yml) `milvus-standalone-docker-compose.yml` and save it as `docker-compose.yml` manually, or with the following command.

```shell
$ wget https://github.com/milvus-io/milvus/releases/download/v{{var.milvus_release_tag}}/milvus-standalone-docker-compose.yml -O docker-compose.yml
```


### Start Milvus

In the directory that holds `docker-compose.yml`, start Milvus by running:

```shell
$ sudo docker compose up -d
```

<div class="alert note">

If you failed to run the above command, please check whether your system has Docker Compose V1 installed. If this is the case, you are advised to migrate to Docker Compose V2 due to the notes on [this page](https://docs.docker.com/compose/).

</div>

```text
Creating milvus-etcd ... done
Creating milvus-minio ... done
Creating milvus-standalone ... done
```

## Verify the Installation

Now check if the containers are up and running.

```shell
$ sudo docker compose ps
```

After Milvus standalone starts, there will be three docker containers running, including the Milvus standalone service and its two dependencies.

```
Name Command State Ports
--------------------------------------------------------------------------------------------------------------------
milvus-etcd etcd -advertise-client-url ... Up 2379/tcp, 2380/tcp
milvus-minio /usr/bin/docker-entrypoint ... Up (healthy) 9000/tcp
milvus-standalone /tini -- milvus run standalone Up 0.0.0.0:19530->19530/tcp, 0.0.0.0:9091->9091/tcp
```

### Connect to Milvus

Verify which local port the Milvus server is listening on. Replace the container name with your own.

```bash
$ docker port milvus-standalone 19530/tcp
```

Please refer to [Hello Milvus](https://milvus.io/docs/example_code.md), then run the example code.

## Stop Milvus

To stop Milvus standalone, run:
```
sudo docker compose down
```

To delete data after stopping Milvus, run:
```
sudo rm -rf volumes
```

## What's next

Having installed Milvus, you can:
- Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
- Check [In-memory Index](index.md) for more about CPU-compatible index types.
- Learn the basic operations of Milvus:
- [Connect to Milvus server](manage_connection.md)
- [Manage Databases](manage_databases.md)
- [Create a collection](create_collection.md)
- [Create a partition](create_partition.md)
- [Insert data](insert_data.md)
- [Conduct a vector search](search.md)
- Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
- Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
- Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.
- [Monitor Milvus with Prometheus](monitor.md)
2 changes: 1 addition & 1 deletion site/en/getstarted/standalone/install_standalone-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ Having installed Milvus, you can:
- Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
- Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
- Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.
- [Monitor Milvus with Prometheus](monitor.md)
- [Monitor Milvus with Prometheus](monitor.md)
2 changes: 1 addition & 1 deletion site/en/getstarted/standalone/install_standalone-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: install_standalone-helm.md
label: Helm
related_key: Helm
order: 3
order: 2
group: install_standalone-docker.md
summary: Learn how to install Milvus standalone on Kubernetes.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: install_standalone-operator.md
label: Milvus Operator
order: 2
order: 1
group: install_standalone-docker.md
summary: Learn how to install Milvus stanalone with Milvus Operator.
---
Expand Down
4 changes: 2 additions & 2 deletions site/en/getstarted/with_gpu/install_cluster-helm-gpu.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: install_cluster-helm-gpu.md
label: Cluster
label: Cluster (Helm)
related_key: Kubernetes
order: 1
order: 2
group: install_standalone-helm-gpu.md
summary: Learn how to install Milvus cluster on Kubernetes.
---
Expand Down
170 changes: 170 additions & 0 deletions site/en/getstarted/with_gpu/install_standalone-docker-compose-gpu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
---
id: install_standalone-docker-compose-gpu.md
label: Standalone (Docker)
related_key: Kubernetes
order: 1
group: install_standalone-helm-gpu.md
summary: Learn how to install Milvus cluster on Kubernetes.
---

# Install Milvus Cluster with Docker Compose

This topic describes how to install a Milvus cluster with GPU support using Docker Compose.

## Prerequisites

Before installing Milvus with GPU support, make sure you have the following prerequisites:

- The compute capability of your GPU device is 6.1, 7.0, 7.5, or 8.0. To check whether your GPU device suffices the requirement, check [Your GPU Compute Capability](https://developer.nvidia.com/cuda-gpus) on the NVIDIA developer website.

- You have installed the NVIDIA driver for your GPU device on one of [the supported Linux distributions](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#linux-distributions) and then the NVIDIA Container Toolkit following [this guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html).

- You have installed a Kubernetes cluster, and the `kubectl` command-line tool has been configured to communicate with your cluster. It is recommended to run this tutorial on a cluster with at least two nodes that are not acting as control plane hosts.

- You have installed Docker and Docker Compose on your local machine.
- Check [the requirements](prerequisite-docker.md) for hardware and software requirements before installing Milvus.

- For the users using MacOS 10.14 or later, set the Docker virtual machine (VM) to use a minimum of 2 virtual CPUs (vCPUs) and 8 GB of initial memory. Otherwise, the installation might fail.

## Install Milvus Standalone with Docker Compose

[Download](https://github.com/milvus-io/milvus/releases/download/v{{var.milvus_release_tag}}/milvus-standalone-docker-compose-gpu.yml) `milvus-standalone-docker-compose-gpu.yml` and save it as `docker-compose.yml` manually, or with the following command.

```
$ wget https://github.com/milvus-io/milvus/releases/download/v{{var.milvus_release_tag}}/milvus-standalone-docker-compose-gpu.yml -O docker-compose.yml
```

You need to make some changes to the environment variables of the standalone service in the YAML file as follows:

- To assign a specific GPU device to Milvus, locate the `deploy.resources.reservations.devices[0].devices_ids` field in the definition of the `standalone` service and replace its value with the ID of the desired GPU. You can use the `nvidia-smi` tool, included with NVIDIA GPU display drivers, to determine the ID of a GPU device. Milvus supports multiple GPU devices.

- Add `KNOWHERE_GPU_MEM_POOL_SIZE` in the `environment` section of the `standalone` service and set its value to reflect the size of a shared display memory pool. The format for the size is `initialSize;maximumSize`, where `initialSize` represents the initial size of the memory pool and `maximumSize` represents its maximum size. Both values should be integers set in MB joined by a semicolon(`;`). Milvus uses this field to allocate display memory to each process.

Assign a single GPU device to Milvus:

```yaml
...
standalone:
environment:
...
KNOWHERE_GPU_MEM_POOL_SIZE: 2048;4096
...
deploy:
resources:
reservations:
devices:
- driver: nvidia
capabilities: ["gpu"]
device_ids: ["0"]
...
```

Assign multiple GPU devices to Milvus:

```yaml
...
standalone:
environment:
...
KNOWHERE_GPU_MEM_POOL_SIZE: 2048;4096
...
deploy:
resources:
reservations:
devices:
- driver: nvidia
capabilities: ["gpu"]
device_ids: ['0', '1']
...
```

### Start Milvus

In the directory that holds `docker-compose.yml`, start Milvus by running:

```shell
$ sudo docker compose up -d
```

<div class="alert note">

If you failed to run the above command, please check whether your system has Docker Compose V1 installed. If this is the case, you are advised to migrate to Docker Compose V2 due to the notes on [this page](https://docs.docker.com/compose/).

</div>

```text
Creating milvus-etcd ... done
Creating milvus-minio ... done
Creating milvus-standalone ... done
```

Now check if the containers are up and running.

```
$ sudo docker compose ps
```

## Verify the Installation

After Milvus standalone starts, there will be three docker containers running, including the Milvus standalone service and its two dependencies.

```
Name Command State Ports
--------------------------------------------------------------------------------------------------------------------
milvus-etcd etcd -advertise-client-url ... Up 2379/tcp, 2380/tcp
milvus-minio /usr/bin/docker-entrypoint ... Up (healthy) 9000/tcp
milvus-standalone /tini -- milvus run standalone Up 0.0.0.0:19530->19530/tcp, 0.0.0.0:9091->9091/tcp
```

If you have assigned multiple GPU devices to Milvus in `docker-compose.yml`, you can specify which GPU device is visible or available for use.

Make GPU device `0` visible to Milvus:

```shell
CUDA_VISIBLE_DEVICES=0 ./milvus run standalone
```

Make GPU devices `0` and `1` visible to Milvus:

```shell
CUDA_VISIBLE_DEVICES=0,1 ./milvus run standalone
```

### Connect to Milvus

Verify which local port the Milvus server is listening on. Replace the container name with your own.

```bash
$ docker port milvus-standalone 19530/tcp
```

Please refer to [Hello Milvus](https://milvus.io/docs/example_code.md), then run the example code.

## Stop Milvus

To stop Milvus standalone, run:
```
sudo docker compose down
```

To delete data after stopping Milvus, run:
```
sudo rm -rf volumes
```

## What's next

Having installed Milvus, you can:
- Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
- Check [In-memory Index](index.md) for more about CPU-compatible index types.
- Learn the basic operations of Milvus:
- [Connect to Milvus server](manage_connection.md)
- [Manage Databases](manage_databases.md)
- [Create a collection](create_collection.md)
- [Create a partition](create_partition.md)
- [Insert data](insert_data.md)
- [Conduct a vector search](search.md)
- Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
- Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
- Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.
- [Monitor Milvus with Prometheus](monitor.md)
2 changes: 1 addition & 1 deletion site/en/getstarted/with_gpu/install_standalone-helm-gpu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: install_standalone-helm-gpu.md
label: Standalone
label: Standalone (Helm)
order: 0
group: install_standalone-helm-gpu.md
related_key: Docker
Expand Down