You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by zi...@apache.org on 2022/03/30 07:27:52 UTC
[incubator-inlong-website] branch master updated: [INLONG-3461] optimize the bare mental deployment document

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 8dc470b  [INLONG-3461] optimize the bare mental deployment document
8dc470b is described below

commit 8dc470b0458aecc007cfeccf6c807e94cb7b688e
Author: dockerzhang <do...@apache.org>
AuthorDate: Wed Mar 30 15:27:47 2022 +0800

    [INLONG-3461] optimize the bare mental deployment document
---
 docs/deployment/bare_metal.md                      | 25 +++---
 docs/modules/agent/quick_start.md                  | 34 +++-----
 docs/modules/audit/quick_start.md                  | 13 +--
 docs/modules/dataproxy/quick_start.md              | 10 +--
 docs/modules/manager/quick_start.md                | 90 ++++++++++-----------
 docs/modules/tubemq/quick_start.md                 |  5 +-
 docs/modules/tubemq/tubemq-manager/quick_start.md  | 11 ++-
 .../current/deployment/bare_metal.md               | 29 +++----
 .../current/modules/agent/quick_start.md           | 38 +++------
 .../current/modules/audit/quick_start.md           | 20 +++--
 .../current/modules/dataproxy/quick_start.md       | 11 ++-
 .../current/modules/manager/quick_start.md         | 92 ++++++++++------------
 .../current/modules/tubemq/quick_start.md          |  4 +-
 .../modules/tubemq/tubemq-manager/quick_start.md   | 11 ++-
 14 files changed, 190 insertions(+), 203 deletions(-)

diff --git a/docs/deployment/bare_metal.md b/docs/deployment/bare_metal.md
index 923877a..befb234 100644
--- a/docs/deployment/bare_metal.md
+++ b/docs/deployment/bare_metal.md
@@ -4,25 +4,24 @@ sidebar_position: 4
 ---
 
 ## Environment Requirements
-- ZooKeeper 3.5+
 - MySQL 5.7+
 - Flink 1.13.5
-- Apache Pulsar 2.6+ (Optional)
 
-## Build
-you can refer to [How to Build](quick_start/how_to_build.md).
+## Prepare Message Queue
+InLong Support the following Message Queue services now, you can choose one of them.
+- [InLong TubeMQ](modules/tubemq/quick_start.md)
+- [Apache Pulsar 2.8.x](https://pulsar.apache.org/docs/en/2.8.1/standalone/)
+
+## Download the Binary Package
+You can get binary package from [Download Page](https://inlong.apache.org/download/main/) ,or you can build the InLong refer to [How to Build](quick_start/how_to_build.md).。
 
 ## Deploy
 | order |  component | dependencies | deploy guide                                                          | description |
-|  ----  | ----  | ----  |-----------------------------------------------------------------------| ---- |
-| 1 | inlong-tubemq-server | ZooKeeper | [InLong TubeMQ Server](modules/tubemq/quick_start.md)                 | If you use Apache Pulsar, you don’t need to install this component. |
-| 2 | inlong-tubemq-manager | MySQL | [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md) | If you use Apache Pulsar, you don’t need to install this component. |
-| 3 | inlong-audit | MySQL or Elasticsearch | [InLong Audit](modules/audit/quick_start.md)                          |  |
-| 4 | inlong-manager | MySQL, ZooKeeper  | [InLong Manager](modules/manager/quick_start.md)                      |  |
-| 5 | inlong-dashboard | Nginx or Docker | [InLong Dashboard](modules/dashboard/quick_start.md)                  | |
-| 6 | inlong-dataproxy |  | [InLong DataProxy](modules/dataproxy/quick_start.md)                  |  |
-| 7 | inlong-sort | ZooKeeper, Flink | [InLong Sort](modules/sort/quick_start.md)                            |  |
-| 8 | inlong-agent |  | [InLong Agent](modules/agent/quick_start.md)                          |  |
+| 1   | inlong-audit | MySQL or Elasticsearch | [InLong Audit](modules/audit/quick_start.md)                          |  |
+| 2   | inlong-manager | MySQL  | [InLong Manager](modules/manager/quick_start.md)                      |  |
+| 3   | inlong-dataproxy | None | [InLong DataProxy](modules/dataproxy/quick_start.md)                  |  |
+| 4   | inlong-agent | None | [InLong Agent](modules/agent/quick_start.md)                          |  |
+| 5   | inlong-dashboard | Nginx or Docker | [InLong Dashboard](modules/dashboard/quick_start.md)                    | |
 
 ## Create Data Stream
 After the InLong cluster deployed successfully, you can create a data stream refer to the [user manual](user_guide/user_manual.md) to start using.
\ No newline at end of file
diff --git a/docs/modules/agent/quick_start.md b/docs/modules/agent/quick_start.md
index e34441b..36ed9f1 100644
--- a/docs/modules/agent/quick_start.md
+++ b/docs/modules/agent/quick_start.md
@@ -3,46 +3,34 @@ title: Deployment
 sidebar_position: 2
 ---
 
-```
-cd inlong-agent
-```
-
-## Environment Preparation
-- Install and start MySQL 5.7+
-- Initialize the database
-  `sql/apache_tube_manager.sql` file, load this file through the command to complete the initialization of the table structure and basic data:
+All deploying files at `inlong-agent` directory.
 
-  ```` shell
-  # Create database and table with username and password:
-  mysql -uDB_USER -pDB_PASSWD < sql/apache_tube_manager.sql
-  ````
-  
 ## Configuration
-
-Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as follows:
+Agent needs to pull the configuration from Manager, the configuration conf/agent.properties is as follows:
 ```ini
-agent.local.ip=Write local ip
-agent.manager.vip.http.host=manager host
-agent.manager.vip.http.port=manager port
+# replace by real IP
+agent.local.ip=127.0.0.1
+# manager IP
+agent.manager.vip.http.host=127.0.0.1
+# manager port
+agent.manager.vip.http.port=8083
 # audit proxy address
 audit.proxys=127.0.0.1:10081
 ```
 
 ## Dependencies
-- If the backend database is MySQL, please download [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar) and put it into `lib/` directory.
+- If the backend database is MySQL, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar) and put it into `lib/` directory.
 
 - If the backend database is PostgreSQL, there's no need for additional dependencies.
 
 
 ## Start
-After decompression, run the following command
-
 ```bash
-sh agent.sh start
+bash +x bin/agent.sh start
 ```
 
 
-## Add job configuration in real time
+## Example: Add job configuration in real time
 
 ```bash
     curl --location --request POST 'http://localhost:8008/config/job' \
diff --git a/docs/modules/audit/quick_start.md b/docs/modules/audit/quick_start.md
index bfbc76d..bb1a191 100644
--- a/docs/modules/audit/quick_start.md
+++ b/docs/modules/audit/quick_start.md
@@ -3,6 +3,10 @@ title: Deployment
 ---
 
 All deploying files at `inlong-audit` directory, if you use MySQL to store audit data, you need to first create the database through `sql/apache_inlong_audit.sql`.
+  ```shell
+  # initialize database
+  mysql -uDB_USER -pDB_PASSWD < sql/apache_inlong_audit.sql
+  ```
 
 ## Audit Proxy
 ### Configure MessageQueue
@@ -30,8 +34,8 @@ agent1.sinks.tube-sink-msg2.topic = inlong-audit
 
 ### Start
 ```Shell
-#By default, pulsar is used as the MessageQueue, and the audit-proxy-pulsar.conf configuration file is loaded.
-sh ./bin/proxy-start.sh [pulsar｜tube]
+# By default, pulsar is used as the MessageQueue, and the audit-proxy-pulsar.conf configuration file is loaded.
+bash +x ./bin/proxy-start.sh [pulsar｜tube]
 ```
 
 ## Audit Store
@@ -62,14 +66,13 @@ spring.datasource.druid.password=inlong
 ```
 
 ### Dependencies
-- If the backend database is MySQL, please download [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar) and put it into `lib/` directory.
+- If the backend database is MySQL, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar) and put it into `lib/` directory.
 
 - If the backend database is PostgreSQL, there's no need for additional dependencies.
 
 ### Start
-The startup script file `./bin/store-start.sh`
 ```Shell
-sh ./bin/store-start.sh
+bash +x ./bin/store-start.sh
 ```
 
 The default listen port is `10081`.
\ No newline at end of file
diff --git a/docs/modules/dataproxy/quick_start.md b/docs/modules/dataproxy/quick_start.md
index 2030c91..41632b9 100644
--- a/docs/modules/dataproxy/quick_start.md
+++ b/docs/modules/dataproxy/quick_start.md
@@ -36,13 +36,13 @@ telnet 127.0.0.1 46801
 
 After installing the DataProxy, you need to add the IP of the DataProxy service into the InLong-Manager.
 
-- Modify the following information:
-  ```html
+- Modify the following information and execute command:
+  ```bash
   curl --header "Content-Type: application/json" --request POST http://your_manager_host:8083/api/inlong/manager/openapi/cluster/save --data '
   {
      "name": "default_dataproxy",
      "type": "DATA_PROXY",
-     "ip": "127.0.0.1:46800,127.0.0.2",
+     "ip": "your_dataproxy_ip",
      "port": 46801,
      "mqSetName": "default_set_name",
      "inCharges": "admin",
@@ -54,6 +54,4 @@ After installing the DataProxy, you need to add the IP of the DataProxy service
   >
   > Please modify the `ip` field to the real IP (or hostname) of the DataProxy, the format is `node1:port1,node2:port2`, and separate them with `,`.
   >
-  > If all nodes in the `ip` field have the same port, you can use `node1,node2` and modify the `port` field to the default port for those nodes.
-
-- Open your command line tool, copy the above info, and click the Enter key, the above info will be saved to InLong-Manager.
+  > If all nodes in the `ip` field have the same port, you can use `node1,node2` and modify the `port` field to the default port for those nodes.
\ No newline at end of file
diff --git a/docs/modules/manager/quick_start.md b/docs/modules/manager/quick_start.md
index 4dfc5ba..1c29965 100644
--- a/docs/modules/manager/quick_start.md
+++ b/docs/modules/manager/quick_start.md
@@ -13,6 +13,10 @@ title: Deployment
   mysql -uDB_USER -pDB_PASSWD < sql/apache_inlong_manager.sql
   ```
 
+## Dependencies
+- If the backend database is MySQL, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar) and put it into `lib/` directory.
+- If the backend database is PostgreSQL, there's no need for additional dependencies.
+
 ## Configuration
 
 Go to the decompressed `inlong-manager` directory and modify the `conf/application.properties` file:
@@ -26,69 +30,57 @@ spring.profiles.active=dev
 ```
 
 The dev configuration is specified above, then modify the `conf/application-dev.properties` file:
+```properties
+spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
+spring.datasource.druid.username=root
+spring.datasource.druid.password=inlong
+```
 
-1) Modify the database URL, username and password:
-
-   ```properties
-   spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
-   spring.datasource.druid.username=root
-   spring.datasource.druid.password=inlong
-   ```
- 
-2) Configure ZooKeeper clusters information:
-
-   ```properties
-   # ZK cluster, used to push the configuration of Sort
-   cluster.zk.url=127.0.0.1:2181
-   cluster.zk.root=inlong_hive
-   # application name, that is the cluster-id parameter of InLong Sort
-   sort.appName=inlong_app
-   ```
-
-## Dependencies
-- If the backend database is MySQL, please download [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar) and put it into `lib/` directory.
-
-- If the backend database is PostgreSQL, there's no need for additional dependencies.
-
-## Add Message Queue
-You can choose InLong TubeMQ or Apache Pulsar as Message Queue Service:
-- If using TubeMQ, the SQL statement is:
-
-```sql
-INSERT INTO apache_inlong_manager.third_party_cluster 
-(name, type, url, ext_params, mq_set_name, in_charges, creator)
-VALUES 
-('tube_cluster', 'TUBE', 'tubemq_master_list', 'tube_config', 'default_set_name', 'admin', 'admin');
+## 启动
+```shell
+bash +x bin/startup.sh
 ```
 
-- `tubemq_master_list`: the master address of your TubeMQ cluster. If there are multiple master nodes, addresses is separated by comma, such as `127.0.0.1:8000,127.0.0.1:8010`.
-- `tube_config`: the other info of your cluster. It is described in JSON format, for example:
+## Register Message Queue
+- If using InLong TubeMQ, the register command is:
+```bash
+curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
+{
+        "name": "tube_cluster",
+        "type": "TUBE",
+        "mqSetName": "default_set_name",
+        "extParams": "{\"cluster_tube_manager\": \"127.0.0.1:8080\", \"tube_masterUrl\": \"127.0.0.1:8715\", \"cluster_tube_clusterId\": \"1\"}",
+        "inCharges": "admin"
+}'
+```
 
+- `extParams`: the other info of your cluster. It is described in JSON format, for example:
 ```json
 {
   "cluster_tube_manager": "http://127.0.0.1:8081",
+  "tube_masterUrl": "127.0.0.1:8715",
   "cluster_tube_clusterId": "1"
 }
 ```
 
-- If using Pulsar, the SQL statement is:
-
-```sql
-INSERT INTO apache_inlong_manager.third_party_cluster 
-(name, type, url, token, ext_params, mq_set_name, in_charges, creator)
-VALUES 
-('pulsar_cluster', 'PULSAR', 'puslar_service_url', 'pulsar_token', 'pulsar_config', 'default_set_name', 'admin', 'admin');
-```
-
-- `puslar_service_url`: the address of your Pulsar cluster, such as `pulsar://127.0.0.1:6650,127.0.0.1:6650,127.0.0.1:6650`.
-- `pulsar_config`: the other info of your cluster. It is described in JSON format, for example:
-
-```json
+- If using Pulsar, the register command is:
+```bash
+curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
 {
-  "pulsar_adminUrl": "http://127.0.0.1:8080,127.0.0.2:8080,127.0.0.3:8080"
-}
+        "name": "pulsar_cluster",
+        "type": "PULSAR",
+        "url": "pulsar://pulsar:6650",
+        "token": "null",
+        "mqSetName": "default_set_name",
+        "extParams": "{\"pulsar_adminUrl\": \"http://pulsar:8080\"}",
+        "inCharges": "admin",
+        "creator": "admin"
+}'
 ```
 
+- `url`: the address of your Pulsar cluster, such as `pulsar://127.0.0.1:6650,127.0.0.1:6650,127.0.0.1:6650`
+- `pulsar_adminUrl`: the other info of your cluster
+
 ## Start
 
 Enter the decompressed directory, execute `sh bin/startup.sh` to start the service, and check the
diff --git a/docs/modules/tubemq/quick_start.md b/docs/modules/tubemq/quick_start.md
index 73bbb45..ae362e4 100644
--- a/docs/modules/tubemq/quick_start.md
+++ b/docs/modules/tubemq/quick_start.md
@@ -177,7 +177,10 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
 From the log, we can see the message received by the consumer.
 ![Demo 2](img/tubemq-consume-message.png)
 
-## 3 The End
+## 3 Deploy Manager
+You can refer to [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
+
+## 4 The End
 Here, the compilation, deployment, system configuration, startup, production and consumption of TubeMQ have been completed. If you need to understand more in-depth content, please check the relevant content in "TubeMQ HTTP API" and make the corresponding configuration settings.
 
 ---
diff --git a/docs/modules/tubemq/tubemq-manager/quick_start.md b/docs/modules/tubemq/tubemq-manager/quick_start.md
index d0bb10a..424a446 100644
--- a/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -4,6 +4,15 @@ title: Deployment
 
 All deploying files at `inlong-tubemq-manager` directory.
 
+## Environment Preparation
+- Install and start MySQL 5.7+
+- Load `sql/apache_tube_manager.sql` through the command to complete the initialization of the table structure and basic data:
+
+```` shell
+# Create database and table with username and password:
+mysql -uDB_USER -pDB_PASSWD < sql/apache_tube_manager.sql
+````
+  
 ## Configuration
 - create `tubemanager` and account in MySQL.
 - Add mysql information in conf/application.properties:
@@ -16,7 +25,7 @@ spring.datasource.password=mysql_password
 ```
 
 ## Dependencies
-- If the backend database is MySQL, please download [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar) and put it into `lib/` directory.
+- If the backend database is MySQL, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar) and put it into `lib/` directory.
 
 - If the backend database is PostgreSQL, there's no need for additional dependencies.
 
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
index 57176b1..b74388b 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
@@ -4,25 +4,26 @@ sidebar_position: 4
 ---
 
 ## 环境要求
-- ZooKeeper 3.5+
 - MySQL 5.7+
 - Flink 1.13.5
-- Apache Pulsar 2.6+ (可选)
 
-## 编译
-可以参考[如何编译](quick_start/how_to_build.md).
+## 准备消息队列
+InLong 当前支持以下消息队列，根据使用情况**选择其一**即可。
+- [InLong TubeMQ](modules/tubemq/quick_start.md)
+- [Apache Pulsar 2.8.x](https://pulsar.apache.org/docs/en/2.8.1/standalone/)
+
+## 下载安装包
+可以从 [下载页面](https://inlong.apache.org/download/main/) 获取二进制包，或参考 [如何编译](quick_start/how_to_build.md) 编译需要的版本。
 
 ## 安装
-| 顺序 |  组件 | 第三方依赖 | 部署指引                                                                  | 说明 |
-|  ----  | ----  | ----  |-----------------------------------------------------------------------| ---- |
-| 1 | inlong-tubemq-server | ZooKeeper | [InLong TubeMQ Server](modules/tubemq/quick_start.md)                 | 若使用Apache Pulsar，可不安装该组件 |
-| 2 | inlong-tubemq-manager | MySQL | [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md) | 若使用Apache Pulsar，可不安装该组件 |
-| 3 | inlong-audit | MySQL 或者 Elasticsearch | [InLong Audit](modules/audit/quick_start.md)                          |  |
-| 4 | inlong-manager | MySQL, ZooKeeper  | [InLong Manager](modules/manager/quick_start.md)                      |  |
-| 5 | inlong-dashboard | Nginx 或者 Docker | [InLong Dashboard](modules/dashboard/quick_start.md)                    | |
-| 6 | inlong-dataproxy | 无 | [InLong DataProxy](modules/dataproxy/quick_start.md)                  |  |
-| 7 | inlong-sort | ZooKeeper, Flink | [InLong Sort](modules/sort/quick_start.md)                            |  |
-| 8 | inlong-agent | 无 | [InLong Agent](modules/agent/quick_start.md)                          |  |
+| 顺序  |  组件 | 第三方依赖 | 部署指引                                                                  | 说明 |
+|-----| ----  | ----  |-----------------------------------------------------------------------| ---- |
+| 1   | inlong-audit | MySQL 或者 Elasticsearch | [InLong Audit](modules/audit/quick_start.md)                          |  |
+| 2   | inlong-manager | MySQL  | [InLong Manager](modules/manager/quick_start.md)                      |  |
+| 3   | inlong-dataproxy | 无 | [InLong DataProxy](modules/dataproxy/quick_start.md)                  |  |
+| 4   | inlong-agent | 无 | [InLong Agent](modules/agent/quick_start.md)                          |  |
+| 5   | inlong-dashboard | Nginx 或者 Docker | [InLong Dashboard](modules/dashboard/quick_start.md)                    | |
+
 ## 创建数据流
 InLong 集群部署成功后，你可以参考[用户手册](user_guide/user_manual.md)创建一个数据流开始使用。
 
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md
index 9b95bdf..a364609 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md
@@ -2,43 +2,31 @@
 title: 安装部署
 sidebar_position: 2
 ---
+安装文件在 `inlong-agent` 目录。
 
-```
-cd inlong-agent
-```
-
-## 环境准备
-- 安装并启动 MySQL 5.7+
-- 初始化数据库
-  `sql/apache_tube_manager.sql`文件，通过下述命令加载此文件，完成表结构及基础数据的初始化：
-
-  ```shell
-  # 通过用户名和密码，创建 DB 和表：
-  mysql -uDB_USER -pDB_PASSWD < sql/apache_tube_manager.sql
-  ```
-  
 ## 配置
-
-线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：
+Agent 需要从 Manager 拉取配置，配置conf/agent.properties如下：
 ```ini
-agent.local.ip=写入本机ip
-agent.manager.vip.http.host=manager host
-agent.manager.vip.http.port=manager port
-# audit proxy 地址
+# replace by real IP
+agent.local.ip=127.0.0.1
+# manager IP
+agent.manager.vip.http.host=127.0.0.1
+# manager port
+agent.manager.vip.http.port=8083
+# audit proxy address
 audit.proxys=127.0.0.1:10081
 ```
+
 ## 依赖
-- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar), 并将其放入 `lib/` 目录。
+- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar), 并将其放入 `lib/` 目录。
 - 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
 
 ## 启动
-
-解压后如下命令运行
 ```bash
-sh agent.sh start
+bash +x bin/agent.sh start
 ```
 
-## 实时添加job配置
+## 示例：实时添加job配置
 
 ```bash
 curl --location --request POST 'http://localhost:8008/config/job' \
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md
index 1d901ae..9775db3 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md
@@ -2,7 +2,15 @@
 title: 安装部署
 ---
 
-所有的安装文件都在 `inlong-audit` 目录下，如果使用 MySQL 存储审计数据，需要先通过`sql/apache_inlong_audit.sql`出生数据库。
+所有的安装文件都在 `inlong-audit` 目录下，如果使用 MySQL 存储审计数据，需要先通过`sql/apache_inlong_audit.sql`初始化数据库。
+  ```shell
+  # 初始化 database
+  mysql -uDB_USER -pDB_PASSWD < sql/apache_inlong_audit.sql
+  ```
+
+## 依赖
+- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar), 并将其放入 `lib/` 目录。
+- 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
 
 ## Audit Proxy
 ### 配置消息队列
@@ -28,10 +36,9 @@ agent1.sinks.tube-sink-msg2.topic = inlong-audit
 ```
 
 ### 启动
-
 ```Shell
-#默认使用 pulsar 作为消息队列，加载 audit-proxy-pulsar.conf 配置文件
-sh ./bin/proxy-start.sh [pulsar｜tube]
+# 默认使用 pulsar 作为消息队列，加载 audit-proxy-pulsar.conf 配置文件
+bash +x ./bin/proxy-start.sh [pulsar｜tube]
 ```
 
 ## Audit Store
@@ -62,13 +69,12 @@ spring.datasource.druid.password=inlong
 ```
 
 ### 依赖
-- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar), 并将其放入 `lib/` 目录。
+- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.27.jar), 并将其放入 `lib/` 目录。
 - 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
 
 ### 启动
-启动脚本 `./bin/store-start.sh`
 ```Shell
-sh ./bin/store-start.sh
+bash +x ./bin/store-start.sh
 ```
 
 Audit Proxy 默认监听端口为 `10081`。
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
index aef9219..c3d5727 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
@@ -37,13 +37,13 @@ telnet 127.0.0.1 46801
 
 安装完 DataProxy 后，需要将 DataProxy 服务的 IP 添加到 InLong-Manager 中。
 
-- 修改下面的配置信息：
-  ```html
+- 修改下面的配置信息然后执行命令：
+  ```bash
   curl --header "Content-Type: application/json" --request POST http://your_manager_host:8083/api/inlong/manager/openapi/cluster/save --data '
   {
      "name": "default_dataproxy",
      "type": "DATA_PROXY",
-     "ip": "127.0.0.1:46800,127.0.0.2",
+     "ip": "your_dataproxy_ip",
      "port": 46801,
      "mqSetName": "default_set_name",
      "inCharges": "admin",
@@ -51,10 +51,9 @@ telnet 127.0.0.1 46801
   }
   '
   ```
+  ```
   > **【说明】**
   > 
   > 请将 `ip` 字段修改为 DataProxy 服务的真实 IP（或 hostname），格式为 `node1:port1,node2:port2`，多个时用 `,` 分隔。
   > 
-  > 如果 `ip` 字段中所有 node 的端口号都相同，可以使用 `node1,node2`，并将 `port` 字段修改为这些 node 的默认端口号。
-
-- 打开你的命令行工具，复制上面修改后的信息，然后敲击 [回车] 发起请求，上面的信息就会保存到 InLong-Manager 中。
+  > 如果 `ip` 字段中所有 node 的端口号都相同，可以使用 `node1,node2`，并将 `port` 字段修改为这些 node 的默认端口号。
\ No newline at end of file
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 8ea0497..b14d50c 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
@@ -11,7 +11,11 @@ title: 安装部署
   # 通过用户名和密码，创建DB和表：
   mysql -uDB_USER -pDB_PASSWD < sql/apache_inlong_manager.sql
   ```
-  
+
+## 依赖
+- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar), 并将其放入 `lib/` 目录。
+- 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
+
 ## 配置
 
 前往 `inlong-manager` 目录，修改 `conf/application.properties` 文件：
@@ -26,67 +30,53 @@ spring.profiles.active=dev
 
 上面指定了 dev 配置，接下来修改 `conf/application-dev.properties` 文件：
 
-1) 修改数据库 URL、用户名和密码：
-
-   ```properties
-   spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
-   spring.datasource.druid.username=root
-   spring.datasource.druid.password=inlong
-   ```
-   
-2) 配置ZooKeeper 集群信息：
-
-   ```properties
-   # ZK 集群，用来推送 Sort 的配置
-   cluster.zk.url=127.0.0.1:2181
-   cluster.zk.root=inlong_hive
-   # 应用名称，即InLong Sort 的 cluster-id 参数
-   sort.appName=inlong_app
-   ```
-
-## 依赖
-- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar), 并将其放入 `lib/` 目录。
-- 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
+```properties
+spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
+spring.datasource.druid.username=root
+spring.datasource.druid.password=inlong
+```
 
-## 配置消息队列
-消息队列服务可以使用InLong TubeMQ 或者 Apache Pulsar：
-- 若使用TubeMQ，SQL语句为：
+## 启动
+```shell
+bash +x bin/startup.sh
+```
 
-```sql
-INSERT INTO apache_inlong_manager.third_party_cluster 
-(name, type, url, ext_params, mq_set_name, in_charges, creator)
-VALUES 
-('tube_cluster', 'TUBE', 'tubemq_master_list', 'tube_config', 'default_set_name', 'admin', 'admin');
+## 注册消息队列
+- 若使用InLong TubeMQ，注册命令为：
+```bash
+curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
+{
+        "name": "tube_cluster",
+        "type": "TUBE",
+        "mqSetName": "default_set_name",
+        "extParams": "{\"cluster_tube_manager\": \"127.0.0.1:8080\", \"tube_masterUrl\": \"127.0.0.1:8715\", \"cluster_tube_clusterId\": \"1\"}",
+        "inCharges": "admin"
+}'
 ```
-其中，`tubemq_master_list`为TubeMQ集群的master地址，多个则逗号分隔，形如`127.0.0.1:8000,127.0.0.1:8010`；`tube_config`为集群配置信息，按照JSON格式设置：
 
+- `extParams`: 集群配置信息，按照JSON格式设置，比如:
 ```json
 {
   "cluster_tube_manager": "http://127.0.0.1:8081",
+  "tube_masterUrl": "127.0.0.1:8715",
   "cluster_tube_clusterId": "1"
 }
 ```
 
-- 若使用Pulsar，SQL语句为：
-
-```sql
-INSERT INTO apache_inlong_manager.third_party_cluster 
-(name, type, url, token, ext_params, mq_set_name, in_charges, creator)
-VALUES 
-('pulsar_cluster', 'PULSAR', 'puslar_service_url', 'pulsar_token', 'pulsar_config', 'default_set_name', 'admin', 'admin');
-```
-其中，`puslar_service_url`为Pulsar集群的地址，形如`pulsar://127.0.0.1:6650,127.0.0.1:6650,127.0.0.1:6650`；`pulsar_config`为集群配置信息，按照JSON格式设置：
-
-```json
+- 若使用Pulsar，注册命令为：
+```bash
+curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
 {
-  "pulsar_adminUrl": "http://127.0.0.1:8080,127.0.0.2:8080,127.0.0.3:8080"
-}
+        "name": "pulsar_cluster",
+        "type": "PULSAR",
+        "url": "pulsar://pulsar:6650",
+        "token": "null",
+        "mqSetName": "default_set_name",
+        "extParams": "{\"pulsar_adminUrl\": \"http://pulsar:8080\"}",
+        "inCharges": "admin",
+        "creator": "admin"
+}'
 ```
 
-## 启动
-
-进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf log/manager-web.log`，若出现类似下面的日志，说明服务启动成功：
-
-```shell
-Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
-```
\ No newline at end of file
+- `url`为Pulsar集群的地址，形如`pulsar://127.0.0.1:6650,127.0.0.1:6650,127.0.0.1:6650`
+- `pulsar_adminUrl`为其它集群配置信息
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md
index 4258b1e..af4365a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md
@@ -178,8 +178,10 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
 
 ![Demo 2](img/tubemq-consume-message.png)
 
+## 3 部署 Manager
+参考 [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
 
-## 3 结束
+## 4 结束
 在这里，已经完成了TubeMQ的编译，部署，系统配置，启动，生产和消费。如果需要了解更深入的内容，请查看《TubeMQ HTTP API》里的相关内容，进行相应的配置设置。
 
 ---
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md
index 570985c..57a2341 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md
@@ -4,6 +4,15 @@ title: 安装部署
 
 安装文件在inlong-tubemq-manager目录.
 
+## 环境准备
+- 安装并启动 MySQL 5.7+
+- 通过下述命令加载`sql/apache_tube_manager.sql`，完成表结构及基础数据的初始化：
+
+```shell
+# 通过用户名和密码，创建 DB 和表：
+mysql -uDB_USER -pDB_PASSWD < sql/apache_tube_manager.sql
+```
+  
 ## 配置
 - 在mysql中创建`tubemanager`数据和相应用户.
 - 在conf/application.properties中添加mysql信息：
@@ -16,7 +25,7 @@ spring.datasource.password=mysql_password
 ```
 
 ### 依赖
-- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.26.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar), 并将其放入 `lib/` 目录。
+- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar), 并将其放入 `lib/` 目录。
 - 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
 
 ## 启动