From 77fffba5cb6086497fc4d5722c2cffccc1400a61 Mon Sep 17 00:00:00 2001 From: BohuTANG Date: Tue, 14 Mar 2023 16:40:12 +0800 Subject: [PATCH] docs(deploy): short the object storage provider name --- docs/doc/10-deploy/02-deploying-databend.md | 222 +++++++++++--------- 1 file changed, 117 insertions(+), 105 deletions(-) diff --git a/docs/doc/10-deploy/02-deploying-databend.md b/docs/doc/10-deploy/02-deploying-databend.md index 0bda1928cf7a1..c42a903ca9684 100644 --- a/docs/doc/10-deploy/02-deploying-databend.md +++ b/docs/doc/10-deploy/02-deploying-databend.md @@ -21,33 +21,6 @@ import TabItem from '@theme/TabItem'; - - -a. Follow the [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide.html) to download and install the MinIO package to your local machine. - -b. Open a terminal window and navigate to the folder where MinIO is stored. - -c. Run the command `vim server.sh` to create a file with the following content: - -```shell -~/minio$ cat server.sh -export MINIO_ROOT_USER=minioadmin -export MINIO_ROOT_PASSWORD=minioadmin -./minio server --address :9900 ./data -``` - -d. Run the following commands to start the MinIO server: - -```shell -chmod +x server.sh -./server.sh -``` - -e. In your browser, go to and enter the credentials (`minioadmin` / `minioadmin`) to log in to the MinIO Console. - -f. In the MinIO Console, create a bucket named `databend`. - - @@ -78,7 +51,7 @@ For information about how to manage buckets and OAuth2 credentials in Google Clo - + Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed: @@ -88,12 +61,12 @@ Before deploying Databend, make sure you have successfully set up your object st For information about how to manage buckets and Access Keys for your cloud object storage, refer to the user manual from the solution provider. Here are some useful links you may need: -- -- +- +- - + Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed: @@ -103,12 +76,12 @@ Before deploying Databend, make sure you have successfully set up your object st For information about how to manage buckets and Access Keys for your cloud object storage, refer to the user manual from the solution provider. Here are some useful links you may need: -- -- +- +- - + Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed: @@ -118,11 +91,12 @@ Before deploying Databend, make sure you have successfully set up your object st For information about how to manage buckets and Access Keys for your cloud object storage, refer to the user manual from the solution provider. Here are some useful links you may need: -- -- +- +- + Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed: @@ -138,7 +112,8 @@ For information about how to manage buckets and Access Keys for your cloud objec - + + Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed: @@ -148,12 +123,12 @@ Before deploying Databend, make sure you have successfully set up your object st For information about how to manage buckets and Access Keys for your cloud object storage, refer to the user manual from the solution provider. Here are some useful links you may need: -- -- +- +- - + Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed: @@ -163,10 +138,39 @@ Before deploying Databend, make sure you have successfully set up your object st For information about how to manage buckets and Access Keys for your cloud object storage, refer to the user manual from the solution provider. Here are some useful links you may need: -- -- +- +- + + + +a. Follow the [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide.html) to download and install the MinIO package to your local machine. + +b. Open a terminal window and navigate to the folder where MinIO is stored. + +c. Run the command `vim server.sh` to create a file with the following content: + +```shell +~/minio$ cat server.sh +export MINIO_ROOT_USER=minioadmin +export MINIO_ROOT_PASSWORD=minioadmin +./minio server --address :9900 ./data +``` + +d. Run the following commands to start the MinIO server: + +```shell +chmod +x server.sh +./server.sh +``` + +e. In your browser, go to and enter the credentials (`minioadmin` / `minioadmin`) to log in to the MinIO Console. + +f. In the MinIO Console, create a bucket named `databend`. + + + Before deploying Databend, make sure you have successfully set up your Hadoop environment, and the following tasks have been completed: @@ -326,21 +330,7 @@ secret_access_key = "" d. Set your values in the `[storage.s3]`, `[storage.azblob]`, `[storage.gcs]`, `[storage.obs]` or `[storage.webhdfs]` block. Please note that the field `endpoint_url` refers to the service URL of your storage region and varies depending on the object storage solution you use: - - -```toml -[storage] -# s3 -type = "s3" - -[storage.s3] -bucket = "databend" -endpoint_url = "http://127.0.0.1:9900" -access_key_id = "minioadmin" -secret_access_key = "minioadmin" -``` - @@ -392,6 +382,27 @@ credential = "" + + +```toml +[storage] +# azblob +type = "azblob" + +[storage.azblob] +endpoint_url = "https://.blob.core.windows.net" + +# https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container +container = "" +account_name = "" + +# https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys +account_key = "" +``` + + + + ```toml @@ -458,35 +469,6 @@ In this example OSS region id is `oss-cn-beijing-internal`. - - -```toml -[storage] -# s3 -type = "s3" - -[storage.s3] -# How to create a bucket: -// highlight-next-line -bucket = "" - -# You can get the URL from: -# https://wasabi-support.zendesk.com/hc/en-us/articles/360015106031-What-are-the-service-URLs-for-Wasabi-s-different-regions- -// highlight-next-line -endpoint_url = "https://s3.us-east-2.wasabisys.com" - -# How to get access_key_id and secret_access_key: -// highlight-next-line -access_key_id = "" -// highlight-next-line -secret_access_key = "" -``` - -:::tip -In this example Wasabi region is `us-east-2`. -::: - - @@ -514,27 +496,8 @@ In this example QingStor region is `pek3b`. - -```toml -[storage] -# azblob -type = "azblob" - -[storage.azblob] -endpoint_url = "https://.blob.core.windows.net" - -# https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container -container = "" -account_name = "" - -# https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys -account_key = "" -``` - - - - + ```toml [storage] @@ -564,6 +527,55 @@ In this example OBS region is `cn-north-4`. ::: + + + +```toml +[storage] +# s3 +type = "s3" + +[storage.s3] +# How to create a bucket: +// highlight-next-line +bucket = "" + +# You can get the URL from: +# https://wasabi-support.zendesk.com/hc/en-us/articles/360015106031-What-are-the-service-URLs-for-Wasabi-s-different-regions- +// highlight-next-line +endpoint_url = "https://s3.us-east-2.wasabisys.com" + +# How to get access_key_id and secret_access_key: +// highlight-next-line +access_key_id = "" +// highlight-next-line +secret_access_key = "" +``` + +:::tip +In this example Wasabi region is `us-east-2`. +::: + + + + + + +```toml +[storage] +# s3 +type = "s3" + +[storage.s3] +bucket = "databend" +endpoint_url = "http://127.0.0.1:9900" +access_key_id = "minioadmin" +secret_access_key = "minioadmin" +``` + + + + ```toml