diff --git a/site/en/deploy_and_maintain/deploy_s3.md b/site/en/deploy_and_maintain/deploy_s3.md index 16dace769..34c7fbb21 100644 --- a/site/en/deploy_and_maintain/deploy_s3.md +++ b/site/en/deploy_and_maintain/deploy_s3.md @@ -2,13 +2,13 @@ id: deploy_s3.md --- -# Deploy Amazon S3 Storage +# Set up S3 Storage for Milvus -Milvus supports Amazon Simple Storage Service (S3) for data persistence of insert log files and index files. This page shows you how to deploy S3 storage for Milvus. +Milvus supports Amazon Simple Storage Service (S3) for data persistence of insert log files and index files. This page shows you how to set up S3 storage for Milvus. -## Deploy S3 on Milvus installed with Docker Compose +## Set Up S3 with Docker Compose -To deploy S3 on Milvus installed with Docker Compose, you need to change the MinIO/S3 configurations in the **milvus.yaml** under **milvus/configs** directory. +To set up S3 for Milvus with Docker Compose, you need to change the MinIO/S3 configurations in the **milvus.yaml** under **milvus/configs** directory. Whereas MinIO is the de facto standard for S3 compatibility, you can configure S3 parameters directly under MinIO section. @@ -21,18 +21,17 @@ minio: useSSL: bucketName: "" ``` - -For more details, see [MinIO/S3 Configurations](configuration_standalone-advanced.md#MinIO-Configurations). +> For more details, see [MinIO/S3 Configurations](configuration_standalone-advanced.md#MinIOS3-Configurations).
All parameters take effect only after being configured at the startup of Milvus.
-## Deploy S3 on Milvus installed with Docker Compose +## Set up S3 on Kubernetes -For Milvus installed on Kubernetes, you can either configure the parameters at the Milvus startup using Helm Charts or compile the the parameters in the **values.yml** file under **/charts/milvus** directory of [milvus-helm](https://github.com/milvus-io/milvus-helm) repository. +For Milvus cluster on Kubernetes, you can either configure the parameters in command line while booting up Milvus or in the **values.yml** file under **/charts/milvus** directory of [milvus-helm](https://github.com/milvus-io/milvus-helm) repository before Milvus startup. -### S3 configurations for Helm Charts installation +Below are S3 configurations for Helm Charts installation: | Parameter | Description | Note | | --------------------- | ------------------------------------ | ------------------------------------ | @@ -44,24 +43,24 @@ For Milvus installed on Kubernetes, you can either configure the parameters at t | externalS3.bucketName | S3 bucket name | | | minio.enabled | Enable or disable MinIO | true/false | -#### Deploy S3 using command line at startup +### Set up S3 using command line at startup -To deploy S3 for Milvus at the startup, run +To deploy S3 for Milvus at the startup, run: ```shell -helm install milvus/milvus --set cluster.enabled=true --set externalS3.enabled=true --set externalS3.host='' --set externalS3.port= --set externalS3.accessKey= --set externalS3.secretKey= --set externalS3.bucketName= --set minio.enabled=False +helm install milvus/milvus --set cluster.enabled=true --set externalS3.enabled=true --set externalS3.host='' --set externalS3.port= --set externalS3.accessKey= --set externalS3.secretKey= --set externalS3.bucketName= --set minio.enabled=false ``` -#### Deploy S3 via compiling **values.yaml** +### Set up S3 via configuring **values.yaml** -Compile the `minio` section in the **values.yaml** file as follow: +Configure the `minio` section in the **values.yaml** file as follow: ```yaml minio: enabled: false ``` -Compile the `externalS3` section in the **values.yaml** file as follow: +Configure the `externalS3` section in the **values.yaml** file as follow: ```yaml externalS3: @@ -70,7 +69,7 @@ externalS3: port: "" accessKey: "" secretKey: "" - useSSL: false + useSSL: bucketName: "" ``` diff --git a/site/en/menuStructure/en.json b/site/en/menuStructure/en.json index 987bc7f94..580b2e1a6 100644 --- a/site/en/menuStructure/en.json +++ b/site/en/menuStructure/en.json @@ -211,7 +211,7 @@ }, { "id": "deploy_s3.md", - "title": "Deploy S3 Storage", + "title": "Set Up S3 Storage", "label1": "deploy_and_maintain", "label2": "", "label3": "",