milvus-logo
LFAI
Home
  • Administration Guide

minio-related Configurations

Related configuration of MinIO/S3/GCS or any other service supports S3 API, which is responsible for data persistence for Milvus.

We refer to the storage service as MinIO/S3 in the following description for simplicity.

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.
    		•  localhost

    minio.port

    Description Default Value
    Port of MinIO or S3 service. 9000

    minio.accessKeyID

    Description Default Value
  • Access key ID that MinIO or S3 issues to user for authorized access.
  • Environment variable: MINIO_ACCESS_KEY_ID or minio.accessKeyID
  • 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_ID, 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_ACCESS_KEY or minio.secretAccessKey
  • 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_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.useSSL

    Description Default Value
    Switch value to control if to access the MinIO or S3 service through SSL. false

    minio.ssl.tlsCACert

    Description Default Value
    path to your CACert file /path/to/public.crt

    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.
  • To share an MinIO instance among multiple Milvus instances, consider changing this to a different value for each Milvus instance before you start them. For details, see Operation FAQs.
  • 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.
  • It is recommended to change this parameter before starting Milvus for the first time.
  • To share an MinIO instance among multiple Milvus instances, consider changing this to a different value for each Milvus instance before you start them. For details, see Operation FAQs.
  • Set an easy-to-identify root key prefix for Milvus if etcd service already exists.
  • Changing this for an already running Milvus instance may result in failures to read legacy data.
    		•  files

    minio.useIAM

    Description Default Value
  • Whether to useIAM role to access S3/GCS instead of access/secret keys
  • For more information, refer to
  • aws: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
  • gcp: https://cloud.google.com/storage/docs/access-control/iam
  • aliyun (ack): https://www.alibabacloud.com/help/en/container-service-for-kubernetes/latest/use-rrsa-to-enforce-access-control
  • aliyun (ecs): https://www.alibabacloud.com/help/en/elastic-compute-service/latest/attach-an-instance-ram-role
    		•  false

    minio.cloudProvider

    Description Default Value
  • Cloud Provider of S3. Supports: "aws", "gcp", "aliyun".
  • You can use "aws" for other cloud provider supports S3 API with signature v4, e.g.: minio
  • You can use "gcp" for other cloud provider supports S3 API with signature v2
  • You can use "aliyun" for other cloud provider uses virtual host style bucket
  • When useIAM enabled, only "aws", "gcp", "aliyun" is supported for now
    		•  aws

    minio.iamEndpoint

    Description Default Value
  • Custom endpoint for fetch IAM role credentials. when useIAM is true & cloudProvider is "aws".
  • Leave it empty if you want to use AWS default endpoint
    		•

    minio.logLevel

    Description Default Value
    Log level for aws sdk log. Supported level: off, fatal, error, warn, info, debug, trace fatal

    minio.region

    Description Default Value
    Specify minio storage system location region

    minio.useVirtualHost

    Description Default Value
    Whether use virtual host mode for bucket false

    minio.requestTimeoutMs

    Description Default Value
    minio timeout for request time in milliseconds 10000

    minio.listObjectsMaxKeys

    Description Default Value
  • The maximum number of objects requested per batch in minio ListObjects rpc,
  • 0 means using oss client by default, decrease these configration if ListObjects timeout
    		•  0
    Table of contents
    Feedback

    Was this page helpful?