milvus-logo
LFAI
Home
  • Reference

MinIO-related Configurations

This topic introduces the MinIO-related configurations of Milvus.

Milvus supports MinIO and Amazon S3 as the storage engine for data persistence of insert log files and index files. Whereas MinIO is the de facto standard for S3 compatibility, you can configure S3 parameters directly under MinIO section.

Under this section, you can configure MinIO or S3 address, relevant access keys, etc.

minio.address

Description Default Value
  • IP address of MinIO or S3 service.
  • Environment variable: MINIO_ADDRESS
  • minio.address and minio.port together generate the valid access to MinIO or S3 service.
  • MinIO preferentially acquires the valid IP address from the environment variable MINIO_ADDRESS when Milvus is started.
  • Default value applies when MinIO or S3 is running on the same network with Milvus.
  • Milvus 2.0 does not support secure access to MinIO or S3 service. Future releases will support secure access to MinIO.
  • localhost

    minio.port

    Description Default Value
  • Port of MinIO or S3 service.
  • Environment variable: MINIO_ADDRESS
  • minio.address and minio.port together generate the valid access to MinIO or S3 service.
  • MinIO preferentially acquires the valid port from the environment variable MINIO_ADDRESS when Milvus is started.
  • 9000

    minio.accessKeyID

    Description Default Value
  • Access key ID that MinIO or S3 issues to user for authorized access.
  • Environment variable: MINIO_ACCESS_KEY
  • minio.accessKeyID and minio.secretAccessKey together are used for identity authentication to access the MinIO or S3 service.
  • This configuration must be set identical to the environment variable MINIO_ACCESS_KEY, which is necessary for starting MinIO or S3.
  • The default value applies to MinIO or S3 service that started with the default docker-compose.yml file.
  • minioadmin

    minio.secretAccessKey

    Description Default Value
  • Secret key used to encrypt the signature string and verify the signature string on server. It must be kept strictly confidential and accessible only to the MinIO or S3 server and users.
  • Environment variable: MINIO_SECRET_KEY
  • minio.accessKeyID and minio.secretAccessKey together are used for identity authentication to access the MinIO or S3 service.
  • This configuration must be set identical to the environment variable MINIO_SECRET_KEY, which is necessary for starting MinIO or S3.
  • The default value applies to MinIO or S3 service that started with the default docker-compose.yml file.
  • minioadmin

    minio.useSSL

    Description Default Value
  • Switch value to control if to access the MinIO or S3 service through SSL.
  • Milvus 2.0.0 does not support secure access to MinIO or S3 service. Future releases will support secure access to MinIO.
  • false

    minio.bucketName

    Description Default Value
  • Name of the bucket where Milvus stores data in MinIO or S3.
  • Milvus 2.0.0 does not support storing data in multiple buckets.
  • Bucket with this name will be created if it does not exist. If the bucket already exists and is accessible, it will be used directly. Otherwise, there will be an error.
  • The data will be stored in the local Docker if Docker is used to start the MinIO service locally. Ensure that there is sufficient storage space.
  • A bucket name is globally unique in one MinIO or S3 instance.
  • "a-bucket"

    minio.rootPath

    Description Default Value
  • Root prefix of the key to where Milvus stores data in MinIO or S3.
  • Caution: Changing this parameter after using Milvus for a period of time will affect your access to old data.
  • It is recommended to change this parameter before starting Milvus for the first time.
  • Set an easy-to-identify root key prefix for Milvus if etcd service already exists.
  • files

    Try Managed Milvus for Free

    Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

    Get Started
    Feedback

    Was this page helpful?