About Milvus
Get Started
User Guide
Administration Guide
Tools
Reference
Example Applications
FAQs
API Reference

Set Up Storage

Milvus supports using Amazon Simple Storage Service (S3) as persistent storage for log and index files. This topic describes how to set up S3 for Milvus.

You can set up S3 with Docker Compose or on K8s.

Set up with Docker Compose

1. Configure S3

MinIO is compatible with S3. To set up S3 with Docker Compose, provide your values for the minio section in the milvus.yaml file on the milvus/configs path.

minio:
  address: <your_s3_endpoint>
  port: <your_s3_port>
  accessKeyID: <your_s3_access_key_id>
  secretAccessKey: <your_s3_secret_access_key>
  useSSL: <true/false>
  bucketName: "<your_bucket_name>"

See MinIO/S3 Configurations for more information.

2. Run Milvus

Run the following command to start Milvus that uses the S3 configurations.

docker-compose up

Configurations only take effect after Milvus starts. See Start Milvus for more information.

Set up on K8s

For Milvus clusters on K8s, you can configure S3 in the same command that starts Milvus. Alternatively, you can configure S3 using the values.yml file on the /charts/milvus path in the milvus-helm repository before you start Milvus.

The following table lists the keys for configuring S3 in the YAML file.

Key	Description	Value
`externalS3.enabled`	Enables or disables S3.	`true`/`false`
`externalS3.host`	The endpoint to access S3.
`externalS3.port`	The port to access S3.
`externalS3.accessKey`	The access key ID for S3.
`externalS3.secretKey`	The secret access key for S3.
`externalS3.bucketName`	The name of the S3 bucket.
`minio.enabled`	Enables or disables MinIO.	`true`/`false`

Using the YAML file

Configure the minio section in the values.yaml file.

minio:
  enabled: false

Configure the externalS3 section using your values in the values.yaml file.

externalS3:
  enabled: true
  host: "<your_s3_endpoint>"
  port: "<your_s3_port>"
  accessKey: "<your_s3_access_key_id>"
  secretKey: "<your_s3_secret_key>"
  useSSL: <true/false>
  bucketName: "<your_bucket_name>"

After configuring the preceding sections and saving the values.yaml file, run the following command to install Milvus that uses the S3 configurations.

helm install <your_release_name> milvus/milvus -f values.yaml

Using a command

To install Milvus and configure S3, run the following command using your values.

helm install <your_release_name> milvus/milvus --set cluster.enabled=true --set externalS3.enabled=true --set externalS3.host='<your_s3_endpoint>' --set externalS3.port=<your_s3_port> --set externalS3.accessKey=<your_s3_access_key_id> --set externalS3.secretKey=<your_s3_secret_key> --set externalS3.bucketName=<your_bucket_name> --set minio.enabled=false

What's next

If you want to learn how to use storage from other cloud providers:

Set Up Storage
Set up with Docker Compose
Set up on K8s
What's next

Feedback

Was this page helpful?