[inlong-website] branch master updated: [INLONG-501][Doc] Add documentation for Open API authentication (#502)

[he...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

healchow pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 61f4c76c1 [INLONG-501][Doc] Add documentation for Open API authentication (#502)
61f4c76c1 is described below

commit 61f4c76c16237504fa29218a6497ad1f74c6bfd7
Author: woofyzhao <49...@qq.com>
AuthorDate: Thu Aug 25 10:56:52 2022 +0800

    [INLONG-501][Doc] Add documentation for Open API authentication (#502)
---
 docs/modules/manager/quick_start.md                | 28 ++++++++++++++++++++++
 .../current/modules/manager/quick_start.md         | 28 ++++++++++++++++++++++
 2 files changed, 56 insertions(+)

diff --git a/docs/modules/manager/quick_start.md b/docs/modules/manager/quick_start.md
index ac1763091..59e68080e 100644
--- a/docs/modules/manager/quick_start.md
+++ b/docs/modules/manager/quick_start.md
@@ -89,3 +89,31 @@ Similar to the above entry for adding a Pulsar cluster, the filling example is a
 
 ![](img/tube_cluster_save.png)
 
+## (Optional) Enable OpenAPI Authentication
+
+### Enable Authentication
+Manager supports the option to authenticate client component access to its open APIs. To enable authentication modify `conf/application.properties`：
+
+```properties
+# Manager open api authentication enabled
+openapi.auth.enabled=true
+```
+
+### Authentication Configuration
+Components that access manager must be authenticated by secret id and secret key if enabled, for example (please configure user's own instead of the example) :
+
+Modify `agent.properties` in agent's conf directory:
+```properties
+agent.manager.auth.secretId=admin
+agent.manager.auth.secretKey=87haw3VYTPqK5fK0
+```
+
+Modify `common.properties` in dataproxy's conf directory:
+```properties
+manager.auth.secretId=admin
+manager.auth.secretKey=87haw3VYTPqK5fK0
+```
+
+### Authentication Key Generation
+Admin user can log in inlong dashboard to allocate secret ids and keys: **System->User->Create**.
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
index 8f8b6ec3a..f91cf2e85 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
@@ -85,3 +85,31 @@ bash +x bin/startup.sh
 与上述 Pulsar 集群的添加入口相似，填写示例如下：
 
 ![](img/tube_cluster_save_cn.png)
+
+## (可选) 开启OpenAPI认证
+
+### 开启认证
+Manager 提供 OpenAPI 安全访问认证，默认关闭。如需开启，在 `conf/application.properties` 打开：
+
+```properties
+# Manager OpenAPI安全认证开关
+openapi.auth.enabled=true
+```
+
+### 配置认证
+相关组件需配置由 Manager 分配的认证 secret id 和 secret key，例如 (建议使用新分配的替代默认值)：
+
+`Agent` conf 目录下 `agent.properties`：
+```properties
+agent.manager.auth.secretId=admin
+agent.manager.auth.secretKey=87haw3VYTPqK5fK0
+```
+
+`Dataproxy` conf 目录下 `common.properties`：
+```properties
+manager.auth.secretId=admin
+manager.auth.secretKey=87haw3VYTPqK5fK0
+```
+
+### 创建认证Key
+管理员可以登录应龙 Dashboard 管理端来创建 secret id 和 secret key： **系统管理->用户管理->新建账号**.