Skip to content

Commit 77fffba

Browse files
BohuTANGBohuTANG
committed
docs(deploy): short the object storage provider name
1 parent 9f48c03 commit 77fffba

File tree

1 file changed

+117
-105
lines changed

1 file changed

+117
-105
lines changed

‎docs/doc/10-deploy/02-deploying-databend.md‎

Lines changed: 117 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,6 @@ import TabItem from '@theme/TabItem';
2121

2222
<Tabs groupId="operating-systems">
2323

24-
<TabItem value="MinIO" label="MinIO">
25-
26-
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.
27-
28-
b. Open a terminal window and navigate to the folder where MinIO is stored.
29-
30-
c. Run the command `vim server.sh` to create a file with the following content:
31-
32-
```shell
33-
~/minio$ cat server.sh
34-
export MINIO_ROOT_USER=minioadmin
35-
export MINIO_ROOT_PASSWORD=minioadmin
36-
./minio server --address :9900 ./data
37-
```
38-
39-
d. Run the following commands to start the MinIO server:
40-
41-
```shell
42-
chmod +x server.sh
43-
./server.sh
44-
```
45-
46-
e. In your browser, go to <http://127.0.0.1:9900> and enter the credentials (`minioadmin` / `minioadmin`) to log in to the MinIO Console.
47-
48-
f. In the MinIO Console, create a bucket named `databend`.
49-
50-
</TabItem>
5124

5225
<TabItem value="Amazon S3" label="Amazon S3">
5326

@@ -78,7 +51,7 @@ For information about how to manage buckets and OAuth2 credentials in Google Clo
7851

7952
</TabItem>
8053

81-
<TabItem value="Tencent COS" label="Tencent COS">
54+
<TabItem value="Azure Blob" label="Azure Blob">
8255

8356
Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed:
8457

@@ -88,12 +61,12 @@ Before deploying Databend, make sure you have successfully set up your object st
8861

8962
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:
9063

91-
- <https://cloud.tencent.com/document/product/436/13309>
92-
- <https://cloud.tencent.com/document/product/436/68282>
64+
- <https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container>
65+
- <https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys>
9366

9467
</TabItem>
9568

96-
<TabItem value="Alibaba OSS" label="Alibaba OSS">
69+
<TabItem value="Tencent COS" label="Tencent COS">
9770

9871
Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed:
9972

@@ -103,12 +76,12 @@ Before deploying Databend, make sure you have successfully set up your object st
10376

10477
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:
10578

106-
- <https://www.alibabacloud.com/help/zh/object-storage-service/latest/create-buckets-2>
107-
- <https://help.aliyun.com/document_detail/53045.htm>
79+
- <https://cloud.tencent.com/document/product/436/13309>
80+
- <https://cloud.tencent.com/document/product/436/68282>
10881

10982
</TabItem>
11083

111-
<TabItem value="Wasabi" label="Wasabi">
84+
<TabItem value="Alibaba OSS" label="Alibaba OSS">
11285

11386
Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed:
11487

@@ -118,11 +91,12 @@ Before deploying Databend, make sure you have successfully set up your object st
11891

11992
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:
12093

121-
- <https://docs.wasabi.com/docs/creating-a-bucket>
122-
- <https://docs.wasabi.com/docs/access-keys-1>
94+
- <https://www.alibabacloud.com/help/zh/object-storage-service/latest/create-buckets-2>
95+
- <https://help.aliyun.com/document_detail/53045.htm>
12396

12497
</TabItem>
12598

99+
126100
<TabItem value="QingCloud QingStor" label="QingCloud QingStor">
127101

128102
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
138112

139113
</TabItem>
140114

141-
<TabItem value="Azure Blob Storage" label="Azure Blob Storage">
115+
116+
<TabItem value="Huawei OBS" label="Huawei OBS">
142117

143118
Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed:
144119

@@ -148,12 +123,12 @@ Before deploying Databend, make sure you have successfully set up your object st
148123

149124
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:
150125

151-
- <https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container>
152-
- <https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys>
126+
- <https://support.huaweicloud.com/intl/en-us/usermanual-obs/en-us_topic_0045853662.html>
127+
- <https://support.huaweicloud.com/intl/en-us/api-obs/obs_04_0116.html>
153128

154129
</TabItem>
155130

156-
<TabItem value="Huawei Cloud OBS" label="Huawei Cloud OBS">
131+
<TabItem value="Wasabi" label="Wasabi">
157132

158133
Before deploying Databend, make sure you have successfully set up your object storage environment in the cloud, and the following tasks have been completed:
159134

@@ -163,10 +138,39 @@ Before deploying Databend, make sure you have successfully set up your object st
163138

164139
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:
165140

166-
- <https://support.huaweicloud.com/intl/en-us/usermanual-obs/en-us_topic_0045853662.html>
167-
- <https://support.huaweicloud.com/intl/en-us/api-obs/obs_04_0116.html>
141+
- <https://docs.wasabi.com/docs/creating-a-bucket>
142+
- <https://docs.wasabi.com/docs/access-keys-1>
168143

169144
</TabItem>
145+
146+
<TabItem value="MinIO" label="MinIO">
147+
148+
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.
149+
150+
b. Open a terminal window and navigate to the folder where MinIO is stored.
151+
152+
c. Run the command `vim server.sh` to create a file with the following content:
153+
154+
```shell
155+
~/minio$ cat server.sh
156+
export MINIO_ROOT_USER=minioadmin
157+
export MINIO_ROOT_PASSWORD=minioadmin
158+
./minio server --address :9900 ./data
159+
```
160+
161+
d. Run the following commands to start the MinIO server:
162+
163+
```shell
164+
chmod +x server.sh
165+
./server.sh
166+
```
167+
168+
e. In your browser, go to <http://127.0.0.1:9900> and enter the credentials (`minioadmin` / `minioadmin`) to log in to the MinIO Console.
169+
170+
f. In the MinIO Console, create a bucket named `databend`.
171+
172+
</TabItem>
173+
170174
<TabItem value="WebHDFS" label="WebHDFS">
171175

172176
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 = "<your-account-key>"
326330
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:
327331

328332
<Tabs groupId="operating-systems">
329-
<TabItem value="MinIO" label="MinIO">
330-
331-
```toml
332-
[storage]
333-
# s3
334-
type = "s3"
335-
336-
[storage.s3]
337-
bucket = "databend"
338-
endpoint_url = "http://127.0.0.1:9900"
339-
access_key_id = "minioadmin"
340-
secret_access_key = "minioadmin"
341-
```
342333

343-
</TabItem>
344334

345335
<TabItem value="Amazon S3" label="Amazon S3">
346336

@@ -392,6 +382,27 @@ credential = "<your-credential>"
392382

393383
</TabItem>
394384

385+
<TabItem value="Azure Blob" label="Azure Blob">
386+
387+
```toml
388+
[storage]
389+
# azblob
390+
type = "azblob"
391+
392+
[storage.azblob]
393+
endpoint_url = "https://<your-storage-account-name>.blob.core.windows.net"
394+
395+
# https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container
396+
container = "<your-azure-storage-container-name>"
397+
account_name = "<your-storage-account-name>"
398+
399+
# https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys
400+
account_key = "<your-account-key>"
401+
```
402+
403+
</TabItem>
404+
405+
395406
<TabItem value="Tencent COS" label="Tencent COS">
396407

397408
```toml
@@ -458,35 +469,6 @@ In this example OSS region id is `oss-cn-beijing-internal`.
458469

459470
</TabItem>
460471

461-
<TabItem value="Wasabi" label="Wasabi">
462-
463-
```toml
464-
[storage]
465-
# s3
466-
type = "s3"
467-
468-
[storage.s3]
469-
# How to create a bucket:
470-
// highlight-next-line
471-
bucket = "<your-bucket>"
472-
473-
# You can get the URL from:
474-
# https://wasabi-support.zendesk.com/hc/en-us/articles/360015106031-What-are-the-service-URLs-for-Wasabi-s-different-regions-
475-
// highlight-next-line
476-
endpoint_url = "https://s3.us-east-2.wasabisys.com"
477-
478-
# How to get access_key_id and secret_access_key:
479-
// highlight-next-line
480-
access_key_id = "<your-key-id>"
481-
// highlight-next-line
482-
secret_access_key = "<your-access-key>"
483-
```
484-
485-
:::tip
486-
In this example Wasabi region is `us-east-2`.
487-
:::
488-
489-
</TabItem>
490472

491473
<TabItem value="QingCloud QingStor" label="QingCloud QingStor">
492474

@@ -514,27 +496,8 @@ In this example QingStor region is `pek3b`.
514496

515497
</TabItem>
516498

517-
<TabItem value="Azure Blob Storage" label="Azure Blob Storage">
518499

519-
```toml
520-
[storage]
521-
# azblob
522-
type = "azblob"
523-
524-
[storage.azblob]
525-
endpoint_url = "https://<your-storage-account-name>.blob.core.windows.net"
526-
527-
# https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container
528-
container = "<your-azure-storage-container-name>"
529-
account_name = "<your-storage-account-name>"
530-
531-
# https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys
532-
account_key = "<your-account-key>"
533-
```
534-
535-
</TabItem>
536-
537-
<TabItem value="Huawei Cloud OBS" label="Huawei Cloud OBS">
500+
<TabItem value="Huawei OBS" label="Huawei OBS">
538501

539502
```toml
540503
[storage]
@@ -564,6 +527,55 @@ In this example OBS region is `cn-north-4`.
564527
:::
565528

566529
</TabItem>
530+
531+
<TabItem value="Wasabi" label="Wasabi">
532+
533+
```toml
534+
[storage]
535+
# s3
536+
type = "s3"
537+
538+
[storage.s3]
539+
# How to create a bucket:
540+
// highlight-next-line
541+
bucket = "<your-bucket>"
542+
543+
# You can get the URL from:
544+
# https://wasabi-support.zendesk.com/hc/en-us/articles/360015106031-What-are-the-service-URLs-for-Wasabi-s-different-regions-
545+
// highlight-next-line
546+
endpoint_url = "https://s3.us-east-2.wasabisys.com"
547+
548+
# How to get access_key_id and secret_access_key:
549+
// highlight-next-line
550+
access_key_id = "<your-key-id>"
551+
// highlight-next-line
552+
secret_access_key = "<your-access-key>"
553+
```
554+
555+
:::tip
556+
In this example Wasabi region is `us-east-2`.
557+
:::
558+
559+
</TabItem>
560+
561+
562+
<TabItem value="MinIO" label="MinIO">
563+
564+
```toml
565+
[storage]
566+
# s3
567+
type = "s3"
568+
569+
[storage.s3]
570+
bucket = "databend"
571+
endpoint_url = "http://127.0.0.1:9900"
572+
access_key_id = "minioadmin"
573+
secret_access_key = "minioadmin"
574+
```
575+
576+
</TabItem>
577+
578+
567579
<TabItem value="WebHDFS" label="WebHDFS">
568580

569581
```toml

0 commit comments

Comments
 (0)