[Doc] add aliyun credential info (StarRocks#5703)

Signed-off-by: miomiocat <284487410@qq.com> Co-authored-by: amber-create <48005258@qq.com>
wxl24life · Jun 15, 2023 · dec4c43 · dec4c43
1 parent bbad2c5
commit dec4c43
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 0 deletions.
diff --git a/data_source/catalog/deltalake_catalog.md b/data_source/catalog/deltalake_catalog.md
@@ -203,6 +203,22 @@ StarRocks 访问 Delta Lake 集群文件存储的相关参数配置。
 
 有关如何选择用于访问 AWS S3 的鉴权方式、以及如何在 AWS IAM 控制台配置访问控制策略，参见[访问 AWS S3 的认证参数](../../integrations/authenticate_to_aws_resources.md#访问-aws-s3-的认证参数)。
 
+##### 阿里云 OSS
+
+如果选择阿里云 OSS 作为 Delta Lake 集群的文件存储，需要在 `StorageCredentialParams` 中配置如下认证参数：
+
+```SQL
+"aliyun.oss.access_key" = "<user_access_key>",
+"aliyun.oss.secret_key" = "<user_secret_key>",
+"aliyun.oss.endpoint" = "<oss_endpoint>" 
+```
+
+| 参数                            | 是否必须 | 说明                                                         |
+| ------------------------------- | -------- | ------------------------------------------------------------ |
+| aliyun.oss.endpoint             | 是      | 阿里云 OSS Endpoint, 如 `oss-cn-beijing.aliyuncs.com`，您可根据 Endpoint 与地域的对应关系进行查找，请参见 [访问域名和数据中心](https://help.aliyun.com/document_detail/31837.html)。    |
+| aliyun.oss.access_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey ID，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。                                     |
+| aliyun.oss.secret_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey Secret，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。           ｜
+
 ##### 兼容 S3 协议的对象存储
 
 Delta Lake Catalog 从 2.5 版本起支持兼容 S3 协议的对象存储。

diff --git a/data_source/catalog/hive_catalog.md b/data_source/catalog/hive_catalog.md
@@ -208,6 +208,22 @@ StarRocks 访问 Hive 集群文件存储的相关参数配置。
 
 有关如何选择用于访问 AWS S3 的鉴权方式、以及如何在 AWS IAM 控制台配置访问控制策略，参见[访问 AWS S3 的认证参数](../../integrations/authenticate_to_aws_resources.md#访问-aws-s3-的认证参数)。
 
+##### 阿里云 OSS
+
+如果选择阿里云 OSS 作为 Hive 集群的文件存储，需要在 `StorageCredentialParams` 中配置如下认证参数：
+
+```SQL
+"aliyun.oss.access_key" = "<user_access_key>",
+"aliyun.oss.secret_key" = "<user_secret_key>",
+"aliyun.oss.endpoint" = "<oss_endpoint>" 
+```
+
+| 参数                            | 是否必须 | 说明                                                         |
+| ------------------------------- | -------- | ------------------------------------------------------------ |
+| aliyun.oss.endpoint             | 是      | 阿里云 OSS Endpoint, 如 `oss-cn-beijing.aliyuncs.com`，您可根据 Endpoint 与地域的对应关系进行查找，请参见 [访问域名和数据中心](https://help.aliyun.com/document_detail/31837.html)。    |
+| aliyun.oss.access_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey ID，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。                                     |
+| aliyun.oss.secret_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey Secret，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。      |
+
 ##### 兼容 S3 协议的对象存储
 
 Hive Catalog 从 2.5 版本起支持兼容 S3 协议的对象存储。

diff --git a/data_source/catalog/hudi_catalog.md b/data_source/catalog/hudi_catalog.md
@@ -203,6 +203,22 @@ StarRocks 访问 Hudi 集群文件存储的相关参数配置。
 
 有关如何选择用于访问 AWS S3 的鉴权方式、以及如何在 AWS IAM 控制台配置访问控制策略，参见[访问 AWS S3 的认证参数](../../integrations/authenticate_to_aws_resources.md#访问-aws-s3-的认证参数)。
 
+##### 阿里云 OSS
+
+如果选择阿里云 OSS 作为 Hudi 集群的文件存储，需要在 `StorageCredentialParams` 中配置如下认证参数：
+
+```SQL
+"aliyun.oss.access_key" = "<user_access_key>",
+"aliyun.oss.secret_key" = "<user_secret_key>",
+"aliyun.oss.endpoint" = "<oss_endpoint>" 
+```
+
+| 参数                            | 是否必须 | 说明                                                         |
+| ------------------------------- | -------- | ------------------------------------------------------------ |
+| aliyun.oss.endpoint             | 是      | 阿里云 OSS Endpoint, 如 `oss-cn-beijing.aliyuncs.com`，您可根据 Endpoint 与地域的对应关系进行查找，请参见 [访问域名和数据中心](https://help.aliyun.com/document_detail/31837.html)。    |
+| aliyun.oss.access_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey ID，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。                                     |
+| aliyun.oss.secret_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey Secret，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。            ｜
+
 ##### 兼容 S3 协议的对象存储
 
 Hudi Catalog 从 2.5 版本起支持兼容 S3 协议的对象存储。

diff --git a/data_source/catalog/iceberg_catalog.md b/data_source/catalog/iceberg_catalog.md
@@ -218,6 +218,22 @@ StarRocks 访问 Iceberg 集群文件存储的相关参数配置。
 
 有关如何选择用于访问 AWS S3 的鉴权方式、以及如何在 AWS IAM 控制台配置访问控制策略，参见[访问 AWS S3 的认证参数](../../integrations/authenticate_to_aws_resources.md#访问-aws-s3-的认证参数)。
 
+##### 阿里云 OSS
+
+如果选择阿里云 OSS 作为 Iceberg 集群的文件存储，需要在 `StorageCredentialParams` 中配置如下认证参数：
+
+```SQL
+"aliyun.oss.access_key" = "<user_access_key>",
+"aliyun.oss.secret_key" = "<user_secret_key>",
+"aliyun.oss.endpoint" = "<oss_endpoint>" 
+```
+
+| 参数                            | 是否必须 | 说明                                                         |
+| ------------------------------- | -------- | ------------------------------------------------------------ |
+| aliyun.oss.endpoint             | 是      | 阿里云 OSS Endpoint, 如 `oss-cn-beijing.aliyuncs.com`，您可根据 Endpoint 与地域的对应关系进行查找，请参见 [访问域名和数据中心](https://help.aliyun.com/document_detail/31837.html)。    |
+| aliyun.oss.access_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey ID，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。                                     |
+| aliyun.oss.secret_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey Secret，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。     |
+
 ##### 兼容 S3 协议的对象存储
 
 Iceberg Catalog 从 2.5 版本起支持兼容 S3 协议的对象存储。

diff --git a/data_source/file_external_table.md b/data_source/file_external_table.md
@@ -117,6 +117,22 @@ PROPERTIES
 
 有关如何选择用于访问 AWS S3 的鉴权方式、以及如何在 AWS IAM 控制台配置访问控制策略，参见[访问 AWS S3 的认证参数](../integrations/authenticate_to_aws_resources.md#访问-aws-s3-的认证参数)。
 
+##### 阿里云 OSS
+
+如果数据文件存储在阿里云 OSS 上，需要在 `StorageCredentialParams` 中配置如下认证参数：
+
+```SQL
+"aliyun.oss.access_key" = "<user_access_key>",
+"aliyun.oss.secret_key" = "<user_secret_key>",
+"aliyun.oss.endpoint" = "<oss_endpoint>" 
+```
+
+| 参数                            | 是否必须 | 说明                                                         |
+| ------------------------------- | -------- | ------------------------------------------------------------ |
+| aliyun.oss.endpoint             | 是      | 阿里云 OSS Endpoint, 如 `oss-cn-beijing.aliyuncs.com`，您可根据 Endpoint 与地域的对应关系进行查找，请参见 [访问域名和数据中心](https://help.aliyun.com/document_detail/31837.html)。    |
+| aliyun.oss.access_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey ID，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。                                     |
+| aliyun.oss.secret_key           | 是      | 指定阿里云账号或 RAM 用户的 AccessKey Secret，获取方式，请参见 [获取 AccessKey](https://help.aliyun.com/document_detail/53045.html)。                                     |
+
 ##### 兼容 S3 协议的对象存储
 
 如果数据文件存储在兼容 S3 协议的对象存储上（如 MinIO），需要在 `StorageCredentialParams` 中配置如下认证参数：