This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 5585fc1 Automated deployment: Thu Jul 8 04:07:50 UTC 2021
2bd33eba25111dde7cb05a8a2d3dda9719815817
5585fc1 is described below
commit 5585fc1d6390b85d85b0edee28504d2cdadffc3f
Author: dockerzhang <[email protected]>
AuthorDate: Thu Jul 8 04:07:50 2021 +0000
Automated deployment: Thu Jul 8 04:07:50 UTC 2021
2bd33eba25111dde7cb05a8a2d3dda9719815817
---
docs/en-us/modules/manager/quick_start.md | 263 +++++++++++++++++-----------
docs/zh-cn/modules/manager/quick_start.md | 131 ++++++++++----
en-us/docs/modules/manager/quick_start.html | 238 +++++++++++++++----------
en-us/docs/modules/manager/quick_start.json | 2 +-
en-us/docs/modules/manager/quick_start.md | 263 +++++++++++++++++-----------
zh-cn/docs/modules/manager/quick_start.html | 123 ++++++++-----
zh-cn/docs/modules/manager/quick_start.json | 2 +-
zh-cn/docs/modules/manager/quick_start.md | 131 ++++++++++----
8 files changed, 750 insertions(+), 403 deletions(-)
diff --git a/docs/en-us/modules/manager/quick_start.md
b/docs/en-us/modules/manager/quick_start.md
index 25b3dff..13d2217 100644
--- a/docs/en-us/modules/manager/quick_start.md
+++ b/docs/en-us/modules/manager/quick_start.md
@@ -1,116 +1,183 @@
---
- Quick start-Apache inlong-manager
+Quick start-Apache inlong-manager
---
-# 1. Compile
+# 1. Environmental preparation
-+ Environment preparation: Java (1.8+) and Maven (3.3+) tools have been
installed correctly.
+Before starting the installation, please download and install the following
software yourself:
-+ Enter the `inlong-manager` directory of the project through the terminal of
macOS (or cmd on Windows), and run the following Maven command to package the
project:
+- Install and configure JDK (1.8+), Maven (3.3+);
--Compile and Package
+- Install and start ZooKeeper 3.5+;
+
+- Install and start Hadoop 2.10.x and Hive 2.3.x;
+
+- Install and start MySQL 5.7+, copy the `doc/sql/apache_inlong_manager.sql`
file in the inlong-manager module to the
+ server where the MySQL database is located (for example, copy to `/data/`
directory), load this file through the
+ following command to complete the initialization of the table structure and
basic data:
+
+ ```shell
+ # Log in to the MySQL server by username and password:
+ mysql -u xxx -p xxx
+ ...
+ # Create database
+ CREATE DATABASE IF NOT EXISTS apache_inlong_manager;
+ USE apache_inlong_manager;
+ # Load the above SQL file through the source command:
+ mysql> source /data/apache_inlong_manager.sql;
+ ```
+
+- Refer to [Compile and deploy
TubeMQ](https://inlong.apache.org/zh-cn/docs/modules/tubemq/quick_start.html)
to install
+ and start the Tube cluster;
+
+- Refer
+ to [Compile and deploy TubeMQ
Manager](https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html)
+ , install and start TubeManager.
+
+# 2. Compile and package
+
+Enter the project root directory through the macOS terminal (or Windows
command prompt window) and execute the following
+compilation commands:
+
+```
+mvn clean install -DskipTests
+```
+
+After the compilation is successful, go to the `inlong-manager/manager-api`
and `inlong-manager/manager-openapi` modules
+of the project, and set them in the respective `target`
+The installation package is generated under the directory, and the names are
`apache-inlong-manager-api*.tar.gz`
+and `apache-inlong-manager-openapi*.tar.gz`.
+
+# 3. Deploy and start manager-api
+
+**manager-api is a background service that interacts with the front-end page.**
+
+## 3.1 Upload and decompress the installation package
+
+1) Copy `inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz`
from step 2 to the server to be deployed;
+
+2) Go to the deployment server and unzip the installation package: `tar -zxvf
apache-inlong-manager-api-*.tar.gz` to get
+ the `manager-api` folder.
+
+## 3.2 Modify configuration
+
+Go to the decompressed `manager-api` directory and modify the
`conf/application.yml` file:
+
+```yaml
+# manager-api service port number
+server:
+ port: 8083
+
+# The configuration file used is dev
+spring:
+ profiles:
+ active: dev
```
-mvn clean package -DskipTests
+
+The dev configuration is specified above, then modify the
`conf/application-dev.yml` file:
+
+1) Modify the database URL, user name and password:
+
+ ```yaml
+ spring:
+ datasource:
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ username: xxxxxx
+ password: xxxxxx
+ ```
+
+2) Modify the connection information of the Tube and ZooKeeper clusters, among
which `cluster.zk.root` suggests to use
+ the default value:
+
+ ```yaml
+ cluster:
+ tube:
+ manager: http://127.0.0.1:8081 # Manager address of Tube cluster, used
to create Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # Broker used to manage Tube
+ clusterId: 1 # Tube cluster ID
+ zk:
+ url: 127.0.0.1:2181
+ root: inlong_hive
+ ```
+
+## 3.3 Start the service
+
+Enter the decompressed directory, execute `sh bin/startup.sh` to start the
service, and check the
+log `tailf log/manager-api.log`. If a log similar to the following appears,
the service has started successfully:
+
+```shell
+Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-+ After the correct packaging is completed, you can see the tar package in the
`target` directory of each submodule, manager-web-xxx-incubating-SNAPSHOT.tar.gz
-
-
-# 2 Dependency Preparation
-## 2.1 Database initialization
-+ mysql 5.7+, create a database in advance, and import
inlong-manager/doc/sql/apache_inlong_manager.sql to complete the initialization
of the table structure and basic data, and modify the database connection in
application-xx.yml
-+ zookeeper 3.5+, configure the information to the corresponding location of
the application-xx.yml file
-+ Tube cluster information, and modify tube-related configuration information
in application-xx.yml
-+ hadoop 2.10.x cluster, hive 2.3.x needs to be built and started in advance
-
-# 3. Background service deployment & startup
-
-## 3.1 manager-web deployment
-+ 3.1.1 Find the installation package, enter
/apache-inlong/inlong-manager/manager-web/target and find
manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ 3.1.2 Deploy the installation package and press it to the corresponding
directory of the server where the service will be deployed tar -zxvf
manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ 3.1.3 Modify the configuration file, change the configuration file in
manager-web/conf, take profile.active=dev in application.yml as an example,
modify the application-dev.yml file according to the actual content
-+ 3.1.4 Start the service, execute the start.sh script in the bin directory,
and observe whether the log manager-web/log/manager-web.log and the back-end
port are listening normally
-
-## 3.2 manager-apenapi deployment
-+ 3.2.1 Find the installation package, enter
/apache-inlong/inlong-manager/manager-openapi/target and find
manager-openapi-xxx-incubating-SNAPSHOT.tar.gz
-+ 3.2.2 Deploy the installation package and press it to the corresponding
directory of the server where the service will be deployed tar -zxvf
manager-web-0.9.0-incubating-SNAPSHOT.tar.gz
-+ 3.2.3 Modify the configuration file, change the configuration file in
manager-openapi/conf, take profile.active=dev in application.yml as an example,
change the content of the configuration application-dev.yml file to the real
content
-+ 3.2.4 Start the service, execute the start.sh script in the bin directory,
and observe whether the log manager-openapi/log/manager-openapi.log and the
backend port are listening normally
-
-## 3.3 Detailed back-end configuration
-+ `manager-web/conf/application.yml` file
-
-```yml
-logging:
- level:
- root: INFO
- org:
- apache:
- inlong:
- manager:
- dao:
- mapper: debug
- third:
- debug
+# 4. Deploy and start manager-openapi
+
+**manager-openapi is a service that provides interactive interfaces for other
components (such as Agent and DataProxy)
+.**
+
+## 4.1 Upload and decompress the installation package
+
+1) Copy
`inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz`
from step 2 to the server to be
+ deployed;
+
+2) Go to the deployment server and unzip the installation package: `tar -zxvf
apache-inlong-manager-openapi-*.tar.gz` to
+ get the `manager-openapi` folder.
+## 4.2 Modify configuration
+
+Go to the decompressed `manager-openapi` directory and modify the
`conf/application.yml` file:
+
+```yaml
+# manager-openapi service port number
+server:
+ port: 8082
+
+# The configuration file used is dev
spring:
- datasource:
- jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?serverTimezone=GMT%2b8&useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
- username: xxxxxx
- password: xxxxxx
- driver-class-name: com.mysql.cj.jdbc.Driver
- type: com.alibaba.druid.pool.DruidDataSource
- druid:
- # Configure test query
- validationQuery: SELECT 'x'
- # Initialization size, minimum, maximum
- initialSize: 20
- minIdle: 20
- maxActive: 300
- # Configure the timeout period to wait for the connection to be acquired
- maxWait: 600000
- # Configure the minimum survival time of a connection in the pool, in
milliseconds
- minEvictableIdleTimeMillis: 3600000
- # Detect when applying for connection. It is recommended to configure it
to true, which does not affect performance and ensures safety
- testWhileIdle: true
- # Perform detection when obtaining a connection, it is recommended to
close it, which affects performance
- testOnBorrow: false
- # Perform detection when returning the connection, it is recommended to
close it, which affects performance
- testOnReturn: false
- # Configure filters for monitoring statistics
interception，stat:Monitoring statistics log4j:log wall:Defense against SQL
injection
- filters: stat,wall
- # Open the mergeSql function through the connectProperties property；Slow
SQL records
- connectionProperties:
druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
-
-# InLong configuration
-inlong:
- schedule:
- user:
- enable: false
- update-cron: '0 0 2 * * ?'
- common:
- machineNum: 1
- path: ~/
- modules:
- - agent
-
-# Cluster info
-cluster:
- tube:
- manager: http://127.0.0.1:8081
- master: 127.0.0.1:8000,127.0.0.1:8010
- zk:
- url: 127.0.0.1:2181
- root: inlong_hive
- hive:
- metastoreAddress: jdbc:mysql://127.0.0.1:3306/hive?useSSL=false
+ profiles:
+ active: dev
+```
+
+The dev configuration is specified above, then modify the
`conf/application-dev.yml` file:
+
+1) Modify the database URL, user name and password:
+
+ ```yaml
+ spring:
+ datasource:
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ username: xxxxxx
+ password: xxxxxx
+ ```
+
+2) Modify the connection information of the Tube and ZooKeeper clusters, among
which `cluster.zk.root` suggests to use
+ the default value:
+
+ ```yaml
+ cluster:
+ tube:
+ manager: http://127.0.0.1:8081 # Manager address of Tube cluster, used
to create Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # Broker used to manage Tube
+ clusterId: 1 # Tube cluster ID
+ zk:
+ url: 127.0.0.1:2181
+ root: inlong_hive
+ ```
+
+## 4.3 Start the service
+
+Enter the decompressed directory, execute `sh bin/startup.sh` to start the
service, and check the
+log `tailf log/manager-openapi.log`. If a log similar to the following
appears, the service has started successfully:
+```shell
+Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
```
-## 3.4 Background service verification:
+# 5. Service access verification
-<http://x.x.x.x/api/inlong/manager/doc.html#/home>
+1) Verify the manager-api service:
-Here `x.x.x.x` is modified to the IP of the server where the application is
deployed
+ Visit address:
<http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home>
+2) Verify the manager-openapi service:
+ Visit address:
<http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home>
\ No newline at end of file
diff --git a/docs/zh-cn/modules/manager/quick_start.md
b/docs/zh-cn/modules/manager/quick_start.md
index c1d1a01..036db76 100644
--- a/docs/zh-cn/modules/manager/quick_start.md
+++ b/docs/zh-cn/modules/manager/quick_start.md
@@ -4,16 +4,16 @@
# 1. 环境准备
+开始安装前，请自行下载并安装下述软件：
+
- 安装并配置 JDK（1.8+）、Maven（3.3+）；
- 安装并启动 ZooKeeper 3.5+；
-- 安装并启动 Tube 集群；
-
- 安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；
-- 安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 `doc/sql/apache_inlong_manager.sql`
文件拷贝到 MySQL
- 数据库所在的服务器（比如拷贝到 `/data/` 目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：
+- 安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 `doc/sql/apache_inlong_manager.sql`
文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 `/data/`
+ 目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：
```shell
# 通过用户名和密码，登录 MySQL 服务器：
@@ -26,24 +26,55 @@
mysql> source /data/apache_inlong_manager.sql;
```
-# 2. 修改配置
+- 参照
[编译部署TubeMQ](https://inlong.apache.org/zh-cn/docs/modules/tubemq/quick_start.html)，安装并启动
Tube 集群；
+
+- 参照 [编译部署TubeMQ
Manager](https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html)，安装并启动
+ TubeManager。
+
+# 2. 编译打包
+
+通过 macOS 的终端（或 Windows 的命令提示符窗口）进入项目根目录，执行以下编译命令：
+
+```
+mvn clean install -DskipTests
+```
+
+编译成功后，前往项目的 `inlong-manager/manager-api` 和 `inlong-manager/manager-openapi`
模块，在各自的 `target`
+目录下生成了安装包，名称分别为 `apache-inlong-manager-api*.tar.gz` 和
`apache-inlong-manager-openapi*.tar.gz`。
+
+# 3. 部署、启动 manager-api
+
+**manager-api 是与前端页面交互的后台服务。**
-`inlong-manager/manager-web/src/resources/application.yml` 中默认使用开发环境的配置：
+## 3.1 上传、解压安装包
+
+1) 将第2步的
`inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz`
拷贝到要部署的服务器；
+
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-api-*.tar.gz`，得到
`manager-api` 文件夹。
+
+## 3.2 修改配置
+
+前往解压后的 `manager-api` 目录，修改 `conf/application.yml` 文件：
```yaml
+# manager-api 服务的端口号
+server:
+ port: 8083
+
+# 使用的配置文件为 dev
spring:
profiles:
active: dev
```
-所以需要修改 `inlong-manager/manager-web/src/resources/application-dev.yml` 中的相关配置：
+上面指定了 dev 配置，接下来修改 `conf/application-dev.yml` 文件：
1) 修改数据库 URL、用户名和密码：
```yaml
spring:
datasource:
- jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?serverTimezone=GMT%2b8&useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
username: xxxxxx
password: xxxxxx
```
@@ -53,60 +84,86 @@ spring:
```yaml
cluster:
tube:
- manager: http://127.0.0.1:8081
- master: 127.0.0.1:8000,127.0.0.1:8010
+ manager: http://127.0.0.1:8081 # Tube 集群的 Manager 地址，用来创建 Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # 用来管理 Tube 的 Broker
+ clusterId: 1 # Tube 集群的 ID
zk:
url: 127.0.0.1:2181
root: inlong_hive
```
-# 3. 编译打包
+## 3.3 启动服务
-通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录 `incubator-inlong`，然后执行以下编译命令：
+进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf
log/manager-api.log`，若出现类似下面的日志，说明服务启动成功：
-```
-mvn clean install -DskipTests
+```shell
+Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-编译成功后，前往项目的 `inlong-manager/manager-web` 和 `inlong-manager/manager-openapi`
模块，在各自的 `target` 目录下有打好的 tar
-包，名称为 `apache-inlong-manager-web-*.tar.gz`。
+# 4. 部署、启动 manager-openapi
-# 4. 部署、启动服务
+**manager-openapi 是为其他组件（如 Agent、DataProxy）提供交互接口的服务。**
-## 4.1 部署 manager-web
+## 4.1 上传、解压安装包
-1) 将上面的 `inlong-manager/manager-web/target/apache-inlong-manager-web-*.tar.gz`
拷贝到要部署的服务器；
+1) 将第2步的
`inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz`
拷贝到要部署的服务器；
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-web-*.tar.gz`；
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`，得到
`manager-openapi` 文件夹。
-3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `tailf
log/manager-web.log`，若出现类似下面的日志，说明服务启动成功：
+## 4.2 修改配置
- ```shell
- Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
- ```
+前往解压后的 `manager-openapi` 目录，修改 `conf/application.yml` 文件：
-## 4.2 部署 manager-openapi
+```yaml
+# manager-openapi 服务的端口号
+server:
+ port: 8082
-1) 将上面的
`inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz`
拷贝到要部署的服务器；
+# 使用的配置文件为 dev
+spring:
+ profiles:
+ active: dev
+```
+
+上面指定了 dev 配置，接下来修改 `conf/application-dev.yml` 文件：
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`；
+1) 修改数据库 URL、用户名和密码：
+
+ ```yaml
+ spring:
+ datasource:
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ username: xxxxxx
+ password: xxxxxx
+ ```
-3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `tailf
log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
+2) 修改 Tube 和 ZooKeeper 集群的连接信息，其中 `cluster.zk.root` 建议使用默认值：
- ```shell
- Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
+ ```yaml
+ cluster:
+ tube:
+ manager: http://127.0.0.1:8081 # Tube 集群的 Manager 地址，用来创建 Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # 用来管理 Tube 的 Broker
+ clusterId: 1 # Tube 集群的 ID
+ zk:
+ url: 127.0.0.1:2181
+ root: inlong_hive
```
-## 4.3 服务访问验证
+## 4.3 启动服务
-1) 验证 manager-web 服务：
+进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf
log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
- 访问地址：<http://x.x.x.x:8083/api/inlong/manager/doc.html#/home>
+```shell
+Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
+```
- 将 `x.x.x.x` 修改为 manager-web 服务对应的 IP 地址，端口号默认是 8083。
+# 5. 服务访问验证
-2) 验证 manager-openapi 服务：
+1) 验证 manager-api 服务：
- 访问地址：<http://x.x.x.x:8082/openapi/inlong/manager/doc.html#/home>
+
访问地址：<http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home>
+
+2) 验证 manager-openapi 服务：
- 将 `x.x.x.x` 修改为 manager-openapi 服务对应的 IP 地址，端口号默认是 8082。
+
访问地址：<http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home>
diff --git a/en-us/docs/modules/manager/quick_start.html
b/en-us/docs/modules/manager/quick_start.html
index 82d4394..e54ecf6 100644
--- a/en-us/docs/modules/manager/quick_start.html
+++ b/en-us/docs/modules/manager/quick_start.html
@@ -12,116 +12,170 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img
class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div
class="logo-split"></div><img class="logo tube"
style="width:120px;top:12px;position:absolute" src="/img/Tube
logo.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class= [...]
+ <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img
class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div
class="logo-split"></div><img class="logo tube"
style="width:120px;top:12px;position:absolute" src="/img/Tube
logo.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class= [...]
+<p>Before starting the installation, please download and install the following
software yourself:</p>
<ul>
<li>
-<p>Environment preparation: Java (1.8+) and Maven (3.3+) tools have been
installed correctly.</p>
+<p>Install and configure JDK (1.8+), Maven (3.3+);</p>
</li>
<li>
-<p>Enter the <code>inlong-manager</code> directory of the project through the
terminal of macOS (or cmd on Windows), and run the following Maven command to
package the project:</p>
+<p>Install and start ZooKeeper 3.5+;</p>
</li>
-</ul>
-<p>-Compile and Package</p>
-<pre><code>mvn clean package -DskipTests
+<li>
+<p>Install and start Hadoop 2.10.x and Hive 2.3.x;</p>
+</li>
+<li>
+<p>Install and start MySQL 5.7+, copy the
<code>doc/sql/apache_inlong_manager.sql</code> file in the inlong-manager
module to the
+server where the MySQL database is located (for example, copy to
<code>/data/</code> directory), load this file through the
+following command to complete the initialization of the table structure and
basic data:</p>
+<pre><code class="language-shell"><span class="hljs-meta">#</span><span
class="bash"> Log <span class="hljs-keyword">in</span> to the MySQL server by
username and password:</span>
+mysql -u xxx -p xxx
+...
+<span class="hljs-meta">#</span><span class="bash"> Create database</span>
+CREATE DATABASE IF NOT EXISTS apache_inlong_manager;
+USE apache_inlong_manager;
+<span class="hljs-meta">#</span><span class="bash"> Load the above SQL file
through the <span class="hljs-built_in">source</span> <span
class="hljs-built_in">command</span>:</span>
+<span class="hljs-meta">mysql></span><span class="bash"> <span
class="hljs-built_in">source</span> /data/apache_inlong_manager.sql;</span>
</code></pre>
-<ul>
-<li>After the correct packaging is completed, you can see the tar package in
the <code>target</code> directory of each submodule,
manager-web-xxx-incubating-SNAPSHOT.tar.gz</li>
-</ul>
-<h1>2 Dependency Preparation</h1>
-<h2>2.1 Database initialization</h2>
-<ul>
-<li>mysql 5.7+, create a database in advance, and import
inlong-manager/doc/sql/apache_inlong_manager.sql to complete the initialization
of the table structure and basic data, and modify the database connection in
application-xx.yml</li>
-<li>zookeeper 3.5+, configure the information to the corresponding location of
the application-xx.yml file</li>
-<li>Tube cluster information, and modify tube-related configuration
information in application-xx.yml</li>
-<li>hadoop 2.10.x cluster, hive 2.3.x needs to be built and started in
advance</li>
-</ul>
-<h1>3. Background service deployment & startup</h1>
-<h2>3.1 manager-web deployment</h2>
-<ul>
-<li>3.1.1 Find the installation package, enter
/apache-inlong/inlong-manager/manager-web/target and find
manager-web-xxx-incubating-SNAPSHOT.tar.gz</li>
-<li>3.1.2 Deploy the installation package and press it to the corresponding
directory of the server where the service will be deployed tar -zxvf
manager-web-xxx-incubating-SNAPSHOT.tar.gz</li>
-<li>3.1.3 Modify the configuration file, change the configuration file in
manager-web/conf, take profile.active=dev in application.yml as an example,
modify the application-dev.yml file according to the actual content</li>
-<li>3.1.4 Start the service, execute the <a
href="http://start.sh";>start.sh</a> script in the bin directory, and observe
whether the log manager-web/log/manager-web.log and the back-end port are
listening normally</li>
-</ul>
-<h2>3.2 manager-apenapi deployment</h2>
-<ul>
-<li>3.2.1 Find the installation package, enter
/apache-inlong/inlong-manager/manager-openapi/target and find
manager-openapi-xxx-incubating-SNAPSHOT.tar.gz</li>
-<li>3.2.2 Deploy the installation package and press it to the corresponding
directory of the server where the service will be deployed tar -zxvf
manager-web-0.9.0-incubating-SNAPSHOT.tar.gz</li>
-<li>3.2.3 Modify the configuration file, change the configuration file in
manager-openapi/conf, take profile.active=dev in application.yml as an example,
change the content of the configuration application-dev.yml file to the real
content</li>
-<li>3.2.4 Start the service, execute the <a
href="http://start.sh";>start.sh</a> script in the bin directory, and observe
whether the log manager-openapi/log/manager-openapi.log and the backend port
are listening normally</li>
-</ul>
-<h2>3.3 Detailed back-end configuration</h2>
-<ul>
-<li><code>manager-web/conf/application.yml</code> file</li>
+</li>
+<li>
+<p>Refer to <a
href="https://inlong.apache.org/zh-cn/docs/modules/tubemq/quick_start.html";>Compile
and deploy TubeMQ</a> to install
+and start the Tube cluster;</p>
+</li>
+<li>
+<p>Refer
+to <a
href="https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html";>Compile
and deploy TubeMQ Manager</a>
+, install and start TubeManager.</p>
+</li>
</ul>
-<pre><code class="language-yml"><span class="hljs-attr">logging:</span>
- <span class="hljs-attr">level:</span>
- <span class="hljs-attr">root:</span> <span class="hljs-string">INFO</span>
- <span class="hljs-attr">org:</span>
- <span class="hljs-attr">apache:</span>
- <span class="hljs-attr">inlong:</span>
- <span class="hljs-attr">manager:</span>
- <span class="hljs-attr">dao:</span>
- <span class="hljs-attr">mapper:</span> <span
class="hljs-string">debug</span>
- <span class="hljs-attr">third:</span>
- <span class="hljs-string">debug</span>
+<h1>2. Compile and package</h1>
+<p>Enter the project root directory through the macOS terminal (or Windows
command prompt window) and execute the following
+compilation commands:</p>
+<pre><code>mvn clean install -DskipTests
+</code></pre>
+<p>After the compilation is successful, go to the
<code>inlong-manager/manager-api</code> and
<code>inlong-manager/manager-openapi</code> modules
+of the project, and set them in the respective <code>target</code>
+The installation package is generated under the directory, and the names are
<code>apache-inlong-manager-api*.tar.gz</code>
+and <code>apache-inlong-manager-openapi*.tar.gz</code>.</p>
+<h1>3. Deploy and start manager-api</h1>
+<p><strong>manager-api is a background service that interacts with the
front-end page.</strong></p>
+<h2>3.1 Upload and decompress the installation package</h2>
+<ol>
+<li>
+<p>Copy
<code>inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz</code>
from step 2 to the server to be deployed;</p>
+</li>
+<li>
+<p>Go to the deployment server and unzip the installation package: <code>tar
-zxvf apache-inlong-manager-api-*.tar.gz</code> to get
+the <code>manager-api</code> folder.</p>
+</li>
+</ol>
+<h2>3.2 Modify configuration</h2>
+<p>Go to the decompressed <code>manager-api</code> directory and modify the
<code>conf/application.yml</code> file:</p>
+<pre><code class="language-yaml"><span class="hljs-comment"># manager-api
service port number</span>
+<span class="hljs-attr">server:</span>
+ <span class="hljs-attr">port:</span> <span class="hljs-number">8083</span>
+<span class="hljs-comment"># The configuration file used is dev</span>
<span class="hljs-attr">spring:</span>
+ <span class="hljs-attr">profiles:</span>
+ <span class="hljs-attr">active:</span> <span class="hljs-string">dev</span>
+</code></pre>
+<p>The dev configuration is specified above, then modify the
<code>conf/application-dev.yml</code> file:</p>
+<ol>
+<li>
+<p>Modify the database URL, user name and password:</p>
+<pre><code class="language-yaml"><span class="hljs-attr">spring:</span>
<span class="hljs-attr">datasource:</span>
- <span class="hljs-attr">jdbc-url:</span> <span
class="hljs-string">jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?serverTimezone=GMT%2b8&useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true</span>
+ <span class="hljs-attr">jdbc-url:</span> <span
class="hljs-string">jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true</span>
<span class="hljs-attr">username:</span> <span
class="hljs-string">xxxxxx</span>
<span class="hljs-attr">password:</span> <span
class="hljs-string">xxxxxx</span>
- <span class="hljs-attr">driver-class-name:</span> <span
class="hljs-string">com.mysql.cj.jdbc.Driver</span>
- <span class="hljs-attr">type:</span> <span
class="hljs-string">com.alibaba.druid.pool.DruidDataSource</span>
- <span class="hljs-attr">druid:</span>
- <span class="hljs-comment"># Configure test query</span>
- <span class="hljs-attr">validationQuery:</span> <span
class="hljs-string">SELECT</span> <span class="hljs-string">'x'</span>
- <span class="hljs-comment"># Initialization size, minimum, maximum</span>
- <span class="hljs-attr">initialSize:</span> <span
class="hljs-number">20</span>
- <span class="hljs-attr">minIdle:</span> <span
class="hljs-number">20</span>
- <span class="hljs-attr">maxActive:</span> <span
class="hljs-number">300</span>
- <span class="hljs-comment"># Configure the timeout period to wait for
the connection to be acquired</span>
- <span class="hljs-attr">maxWait:</span> <span
class="hljs-number">600000</span>
- <span class="hljs-comment"># Configure the minimum survival time of a
connection in the pool, in milliseconds</span>
- <span class="hljs-attr">minEvictableIdleTimeMillis:</span> <span
class="hljs-number">3600000</span>
- <span class="hljs-comment"># Detect when applying for connection. It is
recommended to configure it to true, which does not affect performance and
ensures safety</span>
- <span class="hljs-attr">testWhileIdle:</span> <span
class="hljs-literal">true</span>
- <span class="hljs-comment"># Perform detection when obtaining a
connection, it is recommended to close it, which affects performance</span>
- <span class="hljs-attr">testOnBorrow:</span> <span
class="hljs-literal">false</span>
- <span class="hljs-comment"># Perform detection when returning the
connection, it is recommended to close it, which affects performance</span>
- <span class="hljs-attr">testOnReturn:</span> <span
class="hljs-literal">false</span>
- <span class="hljs-comment"># Configure filters for monitoring statistics
interception，stat:Monitoring statistics log4j:log wall:Defense against SQL
injection</span>
- <span class="hljs-attr">filters:</span> <span
class="hljs-string">stat,wall</span>
- <span class="hljs-comment"># Open the mergeSql function through the
connectProperties property；Slow SQL records</span>
- <span class="hljs-attr">connectionProperties:</span> <span
class="hljs-string">druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000</span>
-
-<span class="hljs-comment"># InLong configuration</span>
-<span class="hljs-attr">inlong:</span>
- <span class="hljs-attr">schedule:</span>
- <span class="hljs-attr">user:</span>
- <span class="hljs-attr">enable:</span> <span
class="hljs-literal">false</span>
- <span class="hljs-attr">update-cron:</span> <span class="hljs-string">'0
0 2 * * ?'</span>
- <span class="hljs-attr">common:</span>
- <span class="hljs-attr">machineNum:</span> <span
class="hljs-number">1</span>
- <span class="hljs-attr">path:</span> <span class="hljs-string">~/</span>
- <span class="hljs-attr">modules:</span>
- <span class="hljs-bullet">-</span> <span class="hljs-string">agent</span>
-
-<span class="hljs-comment"># Cluster info</span>
-<span class="hljs-attr">cluster:</span>
+</code></pre>
+</li>
+<li>
+<p>Modify the connection information of the Tube and ZooKeeper clusters, among
which <code>cluster.zk.root</code> suggests to use
+the default value:</p>
+<pre><code class="language-yaml"><span class="hljs-attr">cluster:</span>
<span class="hljs-attr">tube:</span>
- <span class="hljs-attr">manager:</span> <span
class="hljs-string">http://127.0.0.1:8081</span>
- <span class="hljs-attr">master:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span
class="hljs-string">:8000,127.0.0.1:8010</span>
+ <span class="hljs-attr">manager:</span> <span
class="hljs-string">http://127.0.0.1:8081</span> <span class="hljs-comment">#
Manager address of Tube cluster, used to create Topic</span>
+ <span class="hljs-attr">master:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span
class="hljs-string">:8000,127.0.0.1:8010</span> <span class="hljs-comment">#
Broker used to manage Tube</span>
+ <span class="hljs-attr">clusterId:</span> <span
class="hljs-number">1</span> <span class="hljs-comment"># Tube cluster ID</span>
<span class="hljs-attr">zk:</span>
<span class="hljs-attr">url:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span class="hljs-string">:2181</span>
<span class="hljs-attr">root:</span> <span
class="hljs-string">inlong_hive</span>
- <span class="hljs-attr">hive:</span>
- <span class="hljs-attr">metastoreAddress:</span> <span
class="hljs-string">jdbc:mysql://127.0.0.1:3306/hive?useSSL=false</span>
+</code></pre>
+</li>
+</ol>
+<h2>3.3 Start the service</h2>
+<p>Enter the decompressed directory, execute <code>sh bin/startup.sh</code> to
start the service, and check the
+log <code>tailf log/manager-api.log</code>. If a log similar to the following
appears, the service has started successfully:</p>
+<pre><code class="language-shell">Started InLongApiApplication in 6.795
seconds (JVM running for 7.565)
+</code></pre>
+<h1>4. Deploy and start manager-openapi</h1>
+<p><strong>manager-openapi is a service that provides interactive interfaces
for other components (such as Agent and DataProxy)
+.</strong></p>
+<h2>4.1 Upload and decompress the installation package</h2>
+<ol>
+<li>
+<p>Copy
<code>inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz</code>
from step 2 to the server to be
+deployed;</p>
+</li>
+<li>
+<p>Go to the deployment server and unzip the installation package: <code>tar
-zxvf apache-inlong-manager-openapi-*.tar.gz</code> to
+get the <code>manager-openapi</code> folder.</p>
+</li>
+</ol>
+<h2>4.2 Modify configuration</h2>
+<p>Go to the decompressed <code>manager-openapi</code> directory and modify
the <code>conf/application.yml</code> file:</p>
+<pre><code class="language-yaml"><span class="hljs-comment"># manager-openapi
service port number</span>
+<span class="hljs-attr">server:</span>
+ <span class="hljs-attr">port:</span> <span class="hljs-number">8082</span>
+<span class="hljs-comment"># The configuration file used is dev</span>
+<span class="hljs-attr">spring:</span>
+ <span class="hljs-attr">profiles:</span>
+ <span class="hljs-attr">active:</span> <span class="hljs-string">dev</span>
+</code></pre>
+<p>The dev configuration is specified above, then modify the
<code>conf/application-dev.yml</code> file:</p>
+<ol>
+<li>
+<p>Modify the database URL, user name and password:</p>
+<pre><code class="language-yaml"><span class="hljs-attr">spring:</span>
+ <span class="hljs-attr">datasource:</span>
+ <span class="hljs-attr">jdbc-url:</span> <span
class="hljs-string">jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true</span>
+ <span class="hljs-attr">username:</span> <span
class="hljs-string">xxxxxx</span>
+ <span class="hljs-attr">password:</span> <span
class="hljs-string">xxxxxx</span>
+</code></pre>
+</li>
+<li>
+<p>Modify the connection information of the Tube and ZooKeeper clusters, among
which <code>cluster.zk.root</code> suggests to use
+the default value:</p>
+<pre><code class="language-yaml"><span class="hljs-attr">cluster:</span>
+ <span class="hljs-attr">tube:</span>
+ <span class="hljs-attr">manager:</span> <span
class="hljs-string">http://127.0.0.1:8081</span> <span class="hljs-comment">#
Manager address of Tube cluster, used to create Topic</span>
+ <span class="hljs-attr">master:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span
class="hljs-string">:8000,127.0.0.1:8010</span> <span class="hljs-comment">#
Broker used to manage Tube</span>
+ <span class="hljs-attr">clusterId:</span> <span
class="hljs-number">1</span> <span class="hljs-comment"># Tube cluster ID</span>
+ <span class="hljs-attr">zk:</span>
+ <span class="hljs-attr">url:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span class="hljs-string">:2181</span>
+ <span class="hljs-attr">root:</span> <span
class="hljs-string">inlong_hive</span>
+</code></pre>
+</li>
+</ol>
+<h2>4.3 Start the service</h2>
+<p>Enter the decompressed directory, execute <code>sh bin/startup.sh</code> to
start the service, and check the
+log <code>tailf log/manager-openapi.log</code>. If a log similar to the
following appears, the service has started successfully:</p>
+<pre><code class="language-shell">Started InLongOpenApiApplication in 5.341
seconds (JVM running for 6.002)
</code></pre>
-<h2>3.4 Background service verification:</h2>
-<p><a
href="http://x.x.x.x/api/inlong/manager/doc.html#/home";>http://x.x.x.x/api/inlong/manager/doc.html#/home</a></p>
-<p>Here <code>x.x.x.x</code> is modified to the IP of the server where the
application is deployed</p>
+<h1>5. Service access verification</h1>
+<ol>
+<li>
+<p>Verify the manager-api service:</p>
+<p>Visit address: <a
href="http://%5Bmanager_api_ip%5D:%5Bmanager_api_port%5D/api/inlong/manager/doc.html#/home";>http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home</a></p>
+</li>
+<li>
+<p>Verify the manager-openapi service:</p>
+<p>Visit address: <a
href="http://%5Bmanager_openapi_ip%5D:%5Bmanager_openapi_port%5D/openapi/inlong/manager/doc.html#/home";>http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home</a></p>
+</li>
+</ol>
</div></section><footer class="footer-container"><div class="footer-body"><img
src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col
col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The
Apache Software Foundation (ASF), sponsored by Incubator. Incubation is
required of all newly accepted projects until a further review indicates that
the infrastructure, communications, and decision making process have stabilized
in a manner consistent with [...]
<script
src="https://f.alicdn.com/react/15.4.1/react-with-addons.min.js";></script>
<script
src="https://f.alicdn.com/react/15.4.1/react-dom.min.js";></script>
diff --git a/en-us/docs/modules/manager/quick_start.json
b/en-us/docs/modules/manager/quick_start.json
index 55a944e..1cbc29f 100644
--- a/en-us/docs/modules/manager/quick_start.json
+++ b/en-us/docs/modules/manager/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h1>1. Compile</h1>\n<ul>\n<li>\n<p>Environment preparation: Java
(1.8+) and Maven (3.3+) tools have been installed
correctly.</p>\n</li>\n<li>\n<p>Enter the <code>inlong-manager</code> directory
of the project through the terminal of macOS (or cmd on Windows), and run the
following Maven command to package the project:</p>\n</li>\n</ul>\n<p>-Compile
and Package</p>\n<pre><code>mvn clean package
-DskipTests\n</code></pre>\n<ul>\n<li>After the correct packaging is completed,
[...]
+ "__html": "<h1>1. Environmental preparation</h1>\n<p>Before starting the
installation, please download and install the following software
yourself:</p>\n<ul>\n<li>\n<p>Install and configure JDK (1.8+), Maven
(3.3+);</p>\n</li>\n<li>\n<p>Install and start ZooKeeper
3.5+;</p>\n</li>\n<li>\n<p>Install and start Hadoop 2.10.x and Hive
2.3.x;</p>\n</li>\n<li>\n<p>Install and start MySQL 5.7+, copy the
<code>doc/sql/apache_inlong_manager.sql</code> file in the inlong-manager
module to the\ns [...]
"link": "/en-us/docs/modules/manager/quick_start.html",
"meta": {
"Quick start-Apache inlong-manager": ""
diff --git a/en-us/docs/modules/manager/quick_start.md
b/en-us/docs/modules/manager/quick_start.md
index 25b3dff..13d2217 100644
--- a/en-us/docs/modules/manager/quick_start.md
+++ b/en-us/docs/modules/manager/quick_start.md
@@ -1,116 +1,183 @@
---
- Quick start-Apache inlong-manager
+Quick start-Apache inlong-manager
---
-# 1. Compile
+# 1. Environmental preparation
-+ Environment preparation: Java (1.8+) and Maven (3.3+) tools have been
installed correctly.
+Before starting the installation, please download and install the following
software yourself:
-+ Enter the `inlong-manager` directory of the project through the terminal of
macOS (or cmd on Windows), and run the following Maven command to package the
project:
+- Install and configure JDK (1.8+), Maven (3.3+);
--Compile and Package
+- Install and start ZooKeeper 3.5+;
+
+- Install and start Hadoop 2.10.x and Hive 2.3.x;
+
+- Install and start MySQL 5.7+, copy the `doc/sql/apache_inlong_manager.sql`
file in the inlong-manager module to the
+ server where the MySQL database is located (for example, copy to `/data/`
directory), load this file through the
+ following command to complete the initialization of the table structure and
basic data:
+
+ ```shell
+ # Log in to the MySQL server by username and password:
+ mysql -u xxx -p xxx
+ ...
+ # Create database
+ CREATE DATABASE IF NOT EXISTS apache_inlong_manager;
+ USE apache_inlong_manager;
+ # Load the above SQL file through the source command:
+ mysql> source /data/apache_inlong_manager.sql;
+ ```
+
+- Refer to [Compile and deploy
TubeMQ](https://inlong.apache.org/zh-cn/docs/modules/tubemq/quick_start.html)
to install
+ and start the Tube cluster;
+
+- Refer
+ to [Compile and deploy TubeMQ
Manager](https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html)
+ , install and start TubeManager.
+
+# 2. Compile and package
+
+Enter the project root directory through the macOS terminal (or Windows
command prompt window) and execute the following
+compilation commands:
+
+```
+mvn clean install -DskipTests
+```
+
+After the compilation is successful, go to the `inlong-manager/manager-api`
and `inlong-manager/manager-openapi` modules
+of the project, and set them in the respective `target`
+The installation package is generated under the directory, and the names are
`apache-inlong-manager-api*.tar.gz`
+and `apache-inlong-manager-openapi*.tar.gz`.
+
+# 3. Deploy and start manager-api
+
+**manager-api is a background service that interacts with the front-end page.**
+
+## 3.1 Upload and decompress the installation package
+
+1) Copy `inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz`
from step 2 to the server to be deployed;
+
+2) Go to the deployment server and unzip the installation package: `tar -zxvf
apache-inlong-manager-api-*.tar.gz` to get
+ the `manager-api` folder.
+
+## 3.2 Modify configuration
+
+Go to the decompressed `manager-api` directory and modify the
`conf/application.yml` file:
+
+```yaml
+# manager-api service port number
+server:
+ port: 8083
+
+# The configuration file used is dev
+spring:
+ profiles:
+ active: dev
```
-mvn clean package -DskipTests
+
+The dev configuration is specified above, then modify the
`conf/application-dev.yml` file:
+
+1) Modify the database URL, user name and password:
+
+ ```yaml
+ spring:
+ datasource:
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ username: xxxxxx
+ password: xxxxxx
+ ```
+
+2) Modify the connection information of the Tube and ZooKeeper clusters, among
which `cluster.zk.root` suggests to use
+ the default value:
+
+ ```yaml
+ cluster:
+ tube:
+ manager: http://127.0.0.1:8081 # Manager address of Tube cluster, used
to create Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # Broker used to manage Tube
+ clusterId: 1 # Tube cluster ID
+ zk:
+ url: 127.0.0.1:2181
+ root: inlong_hive
+ ```
+
+## 3.3 Start the service
+
+Enter the decompressed directory, execute `sh bin/startup.sh` to start the
service, and check the
+log `tailf log/manager-api.log`. If a log similar to the following appears,
the service has started successfully:
+
+```shell
+Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-+ After the correct packaging is completed, you can see the tar package in the
`target` directory of each submodule, manager-web-xxx-incubating-SNAPSHOT.tar.gz
-
-
-# 2 Dependency Preparation
-## 2.1 Database initialization
-+ mysql 5.7+, create a database in advance, and import
inlong-manager/doc/sql/apache_inlong_manager.sql to complete the initialization
of the table structure and basic data, and modify the database connection in
application-xx.yml
-+ zookeeper 3.5+, configure the information to the corresponding location of
the application-xx.yml file
-+ Tube cluster information, and modify tube-related configuration information
in application-xx.yml
-+ hadoop 2.10.x cluster, hive 2.3.x needs to be built and started in advance
-
-# 3. Background service deployment & startup
-
-## 3.1 manager-web deployment
-+ 3.1.1 Find the installation package, enter
/apache-inlong/inlong-manager/manager-web/target and find
manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ 3.1.2 Deploy the installation package and press it to the corresponding
directory of the server where the service will be deployed tar -zxvf
manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ 3.1.3 Modify the configuration file, change the configuration file in
manager-web/conf, take profile.active=dev in application.yml as an example,
modify the application-dev.yml file according to the actual content
-+ 3.1.4 Start the service, execute the start.sh script in the bin directory,
and observe whether the log manager-web/log/manager-web.log and the back-end
port are listening normally
-
-## 3.2 manager-apenapi deployment
-+ 3.2.1 Find the installation package, enter
/apache-inlong/inlong-manager/manager-openapi/target and find
manager-openapi-xxx-incubating-SNAPSHOT.tar.gz
-+ 3.2.2 Deploy the installation package and press it to the corresponding
directory of the server where the service will be deployed tar -zxvf
manager-web-0.9.0-incubating-SNAPSHOT.tar.gz
-+ 3.2.3 Modify the configuration file, change the configuration file in
manager-openapi/conf, take profile.active=dev in application.yml as an example,
change the content of the configuration application-dev.yml file to the real
content
-+ 3.2.4 Start the service, execute the start.sh script in the bin directory,
and observe whether the log manager-openapi/log/manager-openapi.log and the
backend port are listening normally
-
-## 3.3 Detailed back-end configuration
-+ `manager-web/conf/application.yml` file
-
-```yml
-logging:
- level:
- root: INFO
- org:
- apache:
- inlong:
- manager:
- dao:
- mapper: debug
- third:
- debug
+# 4. Deploy and start manager-openapi
+
+**manager-openapi is a service that provides interactive interfaces for other
components (such as Agent and DataProxy)
+.**
+
+## 4.1 Upload and decompress the installation package
+
+1) Copy
`inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz`
from step 2 to the server to be
+ deployed;
+
+2) Go to the deployment server and unzip the installation package: `tar -zxvf
apache-inlong-manager-openapi-*.tar.gz` to
+ get the `manager-openapi` folder.
+## 4.2 Modify configuration
+
+Go to the decompressed `manager-openapi` directory and modify the
`conf/application.yml` file:
+
+```yaml
+# manager-openapi service port number
+server:
+ port: 8082
+
+# The configuration file used is dev
spring:
- datasource:
- jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?serverTimezone=GMT%2b8&useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
- username: xxxxxx
- password: xxxxxx
- driver-class-name: com.mysql.cj.jdbc.Driver
- type: com.alibaba.druid.pool.DruidDataSource
- druid:
- # Configure test query
- validationQuery: SELECT 'x'
- # Initialization size, minimum, maximum
- initialSize: 20
- minIdle: 20
- maxActive: 300
- # Configure the timeout period to wait for the connection to be acquired
- maxWait: 600000
- # Configure the minimum survival time of a connection in the pool, in
milliseconds
- minEvictableIdleTimeMillis: 3600000
- # Detect when applying for connection. It is recommended to configure it
to true, which does not affect performance and ensures safety
- testWhileIdle: true
- # Perform detection when obtaining a connection, it is recommended to
close it, which affects performance
- testOnBorrow: false
- # Perform detection when returning the connection, it is recommended to
close it, which affects performance
- testOnReturn: false
- # Configure filters for monitoring statistics
interception，stat:Monitoring statistics log4j:log wall:Defense against SQL
injection
- filters: stat,wall
- # Open the mergeSql function through the connectProperties property；Slow
SQL records
- connectionProperties:
druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
-
-# InLong configuration
-inlong:
- schedule:
- user:
- enable: false
- update-cron: '0 0 2 * * ?'
- common:
- machineNum: 1
- path: ~/
- modules:
- - agent
-
-# Cluster info
-cluster:
- tube:
- manager: http://127.0.0.1:8081
- master: 127.0.0.1:8000,127.0.0.1:8010
- zk:
- url: 127.0.0.1:2181
- root: inlong_hive
- hive:
- metastoreAddress: jdbc:mysql://127.0.0.1:3306/hive?useSSL=false
+ profiles:
+ active: dev
+```
+
+The dev configuration is specified above, then modify the
`conf/application-dev.yml` file:
+
+1) Modify the database URL, user name and password:
+
+ ```yaml
+ spring:
+ datasource:
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ username: xxxxxx
+ password: xxxxxx
+ ```
+
+2) Modify the connection information of the Tube and ZooKeeper clusters, among
which `cluster.zk.root` suggests to use
+ the default value:
+
+ ```yaml
+ cluster:
+ tube:
+ manager: http://127.0.0.1:8081 # Manager address of Tube cluster, used
to create Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # Broker used to manage Tube
+ clusterId: 1 # Tube cluster ID
+ zk:
+ url: 127.0.0.1:2181
+ root: inlong_hive
+ ```
+
+## 4.3 Start the service
+
+Enter the decompressed directory, execute `sh bin/startup.sh` to start the
service, and check the
+log `tailf log/manager-openapi.log`. If a log similar to the following
appears, the service has started successfully:
+```shell
+Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
```
-## 3.4 Background service verification:
+# 5. Service access verification
-<http://x.x.x.x/api/inlong/manager/doc.html#/home>
+1) Verify the manager-api service:
-Here `x.x.x.x` is modified to the IP of the server where the application is
deployed
+ Visit address:
<http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home>
+2) Verify the manager-openapi service:
+ Visit address:
<http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home>
\ No newline at end of file
diff --git a/zh-cn/docs/modules/manager/quick_start.html
b/zh-cn/docs/modules/manager/quick_start.html
index 002f706..c1d3aa9 100644
--- a/zh-cn/docs/modules/manager/quick_start.html
+++ b/zh-cn/docs/modules/manager/quick_start.html
@@ -13,6 +13,7 @@
</head>
<body>
<div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img
class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div
class="logo-split"></div><img class="logo tube"
style="width:120px;top:12px;position:absolute" src="/img/Tube
logo.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class= [...]
+<p>开始安装前，请自行下载并安装下述软件：</p>
<ul>
<li>
<p>安装并配置 JDK（1.8+）、Maven（3.3+）；</p>
@@ -21,14 +22,11 @@
<p>安装并启动 ZooKeeper 3.5+；</p>
</li>
<li>
-<p>安装并启动 Tube 集群；</p>
-</li>
-<li>
<p>安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；</p>
</li>
<li>
-<p>安装并启动 MySQL 5.7+，把 inlong-manager 模块中的
<code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到 MySQL
-数据库所在的服务器（比如拷贝到 <code>/data/</code> 目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>
+<p>安装并启动 MySQL 5.7+，把 inlong-manager 模块中的
<code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到
<code>/data/</code>
+目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>
<pre><code class="language-shell"><span class="hljs-meta">#</span><span
class="bash"> 通过用户名和密码，登录 MySQL 服务器：</span>
mysql -u xxx -p xxx
...
@@ -39,20 +37,49 @@ USE apache_inlong_manager;
<span class="hljs-meta">mysql></span><span class="bash"> <span
class="hljs-built_in">source</span> /data/apache_inlong_manager.sql;</span>
</code></pre>
</li>
+<li>
+<p>参照 <a
href="https://inlong.apache.org/zh-cn/docs/modules/tubemq/quick_start.html";>编译部署TubeMQ</a>，安装并启动
Tube 集群；</p>
+</li>
+<li>
+<p>参照 <a
href="https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html";>编译部署TubeMQ
Manager</a>，安装并启动
+TubeManager。</p>
+</li>
</ul>
-<h1>2. 修改配置</h1>
-<p><code>inlong-manager/manager-web/src/resources/application.yml</code>
中默认使用开发环境的配置：</p>
-<pre><code class="language-yaml"><span class="hljs-attr">spring:</span>
+<h1>2. 编译打包</h1>
+<p>通过 macOS 的终端（或 Windows 的命令提示符窗口）进入项目根目录，执行以下编译命令：</p>
+<pre><code>mvn clean install -DskipTests
+</code></pre>
+<p>编译成功后，前往项目的 <code>inlong-manager/manager-api</code> 和
<code>inlong-manager/manager-openapi</code> 模块，在各自的 <code>target</code>
+目录下生成了安装包，名称分别为 <code>apache-inlong-manager-api*.tar.gz</code> 和
<code>apache-inlong-manager-openapi*.tar.gz</code>。</p>
+<h1>3. 部署、启动 manager-api</h1>
+<p><strong>manager-api 是与前端页面交互的后台服务。</strong></p>
+<h2>3.1 上传、解压安装包</h2>
+<ol>
+<li>
+<p>将第2步的
<code>inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz</code>
拷贝到要部署的服务器；</p>
+</li>
+<li>
+<p>前往部署服务器，解压安装包：<code>tar -zxvf apache-inlong-manager-api-*.tar.gz</code>，得到
<code>manager-api</code> 文件夹。</p>
+</li>
+</ol>
+<h2>3.2 修改配置</h2>
+<p>前往解压后的 <code>manager-api</code> 目录，修改 <code>conf/application.yml</code>
文件：</p>
+<pre><code class="language-yaml"><span class="hljs-comment"># manager-api
服务的端口号</span>
+<span class="hljs-attr">server:</span>
+ <span class="hljs-attr">port:</span> <span class="hljs-number">8083</span>
+
+<span class="hljs-comment"># 使用的配置文件为 dev</span>
+<span class="hljs-attr">spring:</span>
<span class="hljs-attr">profiles:</span>
<span class="hljs-attr">active:</span> <span class="hljs-string">dev</span>
</code></pre>
-<p>所以需要修改
<code>inlong-manager/manager-web/src/resources/application-dev.yml</code>
中的相关配置：</p>
+<p>上面指定了 dev 配置，接下来修改 <code>conf/application-dev.yml</code> 文件：</p>
<ol>
<li>
<p>修改数据库 URL、用户名和密码：</p>
<pre><code class="language-yaml"><span class="hljs-attr">spring:</span>
<span class="hljs-attr">datasource:</span>
- <span class="hljs-attr">jdbc-url:</span> <span
class="hljs-string">jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?serverTimezone=GMT%2b8&useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true</span>
+ <span class="hljs-attr">jdbc-url:</span> <span
class="hljs-string">jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true</span>
<span class="hljs-attr">username:</span> <span
class="hljs-string">xxxxxx</span>
<span class="hljs-attr">password:</span> <span
class="hljs-string">xxxxxx</span>
</code></pre>
@@ -61,60 +88,78 @@ USE apache_inlong_manager;
<p>修改 Tube 和 ZooKeeper 集群的连接信息，其中 <code>cluster.zk.root</code> 建议使用默认值：</p>
<pre><code class="language-yaml"><span class="hljs-attr">cluster:</span>
<span class="hljs-attr">tube:</span>
- <span class="hljs-attr">manager:</span> <span
class="hljs-string">http://127.0.0.1:8081</span>
- <span class="hljs-attr">master:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span
class="hljs-string">:8000,127.0.0.1:8010</span>
+ <span class="hljs-attr">manager:</span> <span
class="hljs-string">http://127.0.0.1:8081</span> <span class="hljs-comment">#
Tube 集群的 Manager 地址，用来创建 Topic</span>
+ <span class="hljs-attr">master:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span
class="hljs-string">:8000,127.0.0.1:8010</span> <span class="hljs-comment">#
用来管理 Tube 的 Broker</span>
+ <span class="hljs-attr">clusterId:</span> <span
class="hljs-number">1</span> <span class="hljs-comment"># Tube 集群的 ID</span>
<span class="hljs-attr">zk:</span>
<span class="hljs-attr">url:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span class="hljs-string">:2181</span>
<span class="hljs-attr">root:</span> <span
class="hljs-string">inlong_hive</span>
</code></pre>
</li>
</ol>
-<h1>3. 编译打包</h1>
-<p>通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录
<code>incubator-inlong</code>，然后执行以下编译命令：</p>
-<pre><code>mvn clean install -DskipTests
+<h2>3.3 启动服务</h2>
+<p>进入解压后的目录，执行 <code>sh bin/startup.sh</code> 启动服务，查看日志 <code>tailf
log/manager-api.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
+<pre><code class="language-shell">Started InLongApiApplication in 6.795
seconds (JVM running for 7.565)
</code></pre>
-<p>编译成功后，前往项目的 <code>inlong-manager/manager-web</code> 和
<code>inlong-manager/manager-openapi</code> 模块，在各自的 <code>target</code> 目录下有打好的
tar
-包，名称为 <code>apache-inlong-manager-web-*.tar.gz</code>。</p>
-<h1>4. 部署、启动服务</h1>
-<h2>4.1 部署 manager-web</h2>
+<h1>4. 部署、启动 manager-openapi</h1>
+<p><strong>manager-openapi 是为其他组件（如 Agent、DataProxy）提供交互接口的服务。</strong></p>
+<h2>4.1 上传、解压安装包</h2>
<ol>
<li>
-<p>将上面的
<code>inlong-manager/manager-web/target/apache-inlong-manager-web-*.tar.gz</code>
拷贝到要部署的服务器；</p>
+<p>将第2步的
<code>inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz</code>
拷贝到要部署的服务器；</p>
</li>
<li>
-<p>前往部署服务器，解压安装包：<code>tar -zxvf apache-inlong-manager-web-*.tar.gz</code>；</p>
-</li>
-<li>
-<p>进入解压后的目录，执行 <code>sh bin/start.sh</code> 启动服务，查看日志 <code>tailf
log/manager-web.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
-<pre><code class="language-shell">Started InLongWebApplication in 6.795
seconds (JVM running for 7.565)
-</code></pre>
+<p>前往部署服务器，解压安装包：<code>tar -zxvf
apache-inlong-manager-openapi-*.tar.gz</code>，得到 <code>manager-openapi</code>
文件夹。</p>
</li>
</ol>
-<h2>4.2 部署 manager-openapi</h2>
+<h2>4.2 修改配置</h2>
+<p>前往解压后的 <code>manager-openapi</code> 目录，修改 <code>conf/application.yml</code>
文件：</p>
+<pre><code class="language-yaml"><span class="hljs-comment"># manager-openapi
服务的端口号</span>
+<span class="hljs-attr">server:</span>
+ <span class="hljs-attr">port:</span> <span class="hljs-number">8082</span>
+
+<span class="hljs-comment"># 使用的配置文件为 dev</span>
+<span class="hljs-attr">spring:</span>
+ <span class="hljs-attr">profiles:</span>
+ <span class="hljs-attr">active:</span> <span class="hljs-string">dev</span>
+</code></pre>
+<p>上面指定了 dev 配置，接下来修改 <code>conf/application-dev.yml</code> 文件：</p>
<ol>
<li>
-<p>将上面的
<code>inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz</code>
拷贝到要部署的服务器；</p>
-</li>
-<li>
-<p>前往部署服务器，解压安装包：<code>tar -zxvf
apache-inlong-manager-openapi-*.tar.gz</code>；</p>
+<p>修改数据库 URL、用户名和密码：</p>
+<pre><code class="language-yaml"><span class="hljs-attr">spring:</span>
+ <span class="hljs-attr">datasource:</span>
+ <span class="hljs-attr">jdbc-url:</span> <span
class="hljs-string">jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true</span>
+ <span class="hljs-attr">username:</span> <span
class="hljs-string">xxxxxx</span>
+ <span class="hljs-attr">password:</span> <span
class="hljs-string">xxxxxx</span>
+</code></pre>
</li>
<li>
-<p>进入解压后的目录，执行 <code>sh bin/start.sh</code> 启动服务，查看日志 <code>tailf
log/manager-openapi.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
-<pre><code class="language-shell">Started InLongOpenApiApplication in 5.341
seconds (JVM running for 6.002)
+<p>修改 Tube 和 ZooKeeper 集群的连接信息，其中 <code>cluster.zk.root</code> 建议使用默认值：</p>
+<pre><code class="language-yaml"><span class="hljs-attr">cluster:</span>
+ <span class="hljs-attr">tube:</span>
+ <span class="hljs-attr">manager:</span> <span
class="hljs-string">http://127.0.0.1:8081</span> <span class="hljs-comment">#
Tube 集群的 Manager 地址，用来创建 Topic</span>
+ <span class="hljs-attr">master:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span
class="hljs-string">:8000,127.0.0.1:8010</span> <span class="hljs-comment">#
用来管理 Tube 的 Broker</span>
+ <span class="hljs-attr">clusterId:</span> <span
class="hljs-number">1</span> <span class="hljs-comment"># Tube 集群的 ID</span>
+ <span class="hljs-attr">zk:</span>
+ <span class="hljs-attr">url:</span> <span
class="hljs-number">127.0</span><span class="hljs-number">.0</span><span
class="hljs-number">.1</span><span class="hljs-string">:2181</span>
+ <span class="hljs-attr">root:</span> <span
class="hljs-string">inlong_hive</span>
</code></pre>
</li>
</ol>
-<h2>4.3 服务访问验证</h2>
+<h2>4.3 启动服务</h2>
+<p>进入解压后的目录，执行 <code>sh bin/startup.sh</code> 启动服务，查看日志 <code>tailf
log/manager-openapi.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
+<pre><code class="language-shell">Started InLongOpenApiApplication in 5.341
seconds (JVM running for 6.002)
+</code></pre>
+<h1>5. 服务访问验证</h1>
<ol>
<li>
-<p>验证 manager-web 服务：</p>
-<p>访问地址：<a
href="http://x.x.x.x:8083/api/inlong/manager/doc.html#/home";>http://x.x.x.x:8083/api/inlong/manager/doc.html#/home</a></p>
-<p>将 <code>x.x.x.x</code> 修改为 manager-web 服务对应的 IP 地址，端口号默认是 8083。</p>
+<p>验证 manager-api 服务：</p>
+<p>访问地址：<a
href="http://%5Bmanager_api_ip%5D:%5Bmanager_api_port%5D/api/inlong/manager/doc.html#/home";>http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home</a></p>
</li>
<li>
<p>验证 manager-openapi 服务：</p>
-<p>访问地址：<a
href="http://x.x.x.x:8082/openapi/inlong/manager/doc.html#/home";>http://x.x.x.x:8082/openapi/inlong/manager/doc.html#/home</a></p>
-<p>将 <code>x.x.x.x</code> 修改为 manager-openapi 服务对应的 IP 地址，端口号默认是 8082。</p>
+<p>访问地址：<a
href="http://%5Bmanager_openapi_ip%5D:%5Bmanager_openapi_port%5D/openapi/inlong/manager/doc.html#/home";>http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home</a></p>
</li>
</ol>
</div></section><footer class="footer-container"><div class="footer-body"><img
src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col
col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The
Apache Software Foundation (ASF), sponsored by Incubator. Incubation is
required of all newly accepted projects until a further review indicates that
the infrastructure, communications, and decision making process have stabilized
in a manner consistent with [...]
diff --git a/zh-cn/docs/modules/manager/quick_start.json
b/zh-cn/docs/modules/manager/quick_start.json
index 3fc465e..686b7a2 100644
--- a/zh-cn/docs/modules/manager/quick_start.json
+++ b/zh-cn/docs/modules/manager/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h1>1. 环境准备</h1>\n<ul>\n<li>\n<p>安装并配置
JDK（1.8+）、Maven（3.3+）；</p>\n</li>\n<li>\n<p>安装并启动 ZooKeeper
3.5+；</p>\n</li>\n<li>\n<p>安装并启动 Tube 集群；</p>\n</li>\n<li>\n<p>安装并启动 Hadoop
2.10.x 和 Hive 2.3.x；</p>\n</li>\n<li>\n<p>安装并启动 MySQL 5.7+，把 inlong-manager
模块中的 <code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到
MySQL\n数据库所在的服务器（比如拷贝到 <code>/data/</code>
目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>\n<pre><code class=\"language-shell\"><span
class=\"hljs-meta\">#</span><span class=\"bash\ [...]
+ "__html": "<h1>1.
环境准备</h1>\n<p>开始安装前，请自行下载并安装下述软件：</p>\n<ul>\n<li>\n<p>安装并配置
JDK（1.8+）、Maven（3.3+）；</p>\n</li>\n<li>\n<p>安装并启动 ZooKeeper
3.5+；</p>\n</li>\n<li>\n<p>安装并启动 Hadoop 2.10.x 和 Hive
2.3.x；</p>\n</li>\n<li>\n<p>安装并启动 MySQL 5.7+，把 inlong-manager 模块中的
<code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到
<code>/data/</code>\n目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>\n<pre><code
class=\"language-shell\"><span class=\"hljs-meta\">#</span><span
class=\"bash\"> 通过用户名 [...]
"link": "/zh-cn/docs/modules/manager/quick_start.html",
"meta": {
"快速开始 - Apache inlong-manager": ""
diff --git a/zh-cn/docs/modules/manager/quick_start.md
b/zh-cn/docs/modules/manager/quick_start.md
index c1d1a01..036db76 100644
--- a/zh-cn/docs/modules/manager/quick_start.md
+++ b/zh-cn/docs/modules/manager/quick_start.md
@@ -4,16 +4,16 @@
# 1. 环境准备
+开始安装前，请自行下载并安装下述软件：
+
- 安装并配置 JDK（1.8+）、Maven（3.3+）；
- 安装并启动 ZooKeeper 3.5+；
-- 安装并启动 Tube 集群；
-
- 安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；
-- 安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 `doc/sql/apache_inlong_manager.sql`
文件拷贝到 MySQL
- 数据库所在的服务器（比如拷贝到 `/data/` 目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：
+- 安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 `doc/sql/apache_inlong_manager.sql`
文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 `/data/`
+ 目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：
```shell
# 通过用户名和密码，登录 MySQL 服务器：
@@ -26,24 +26,55 @@
mysql> source /data/apache_inlong_manager.sql;
```
-# 2. 修改配置
+- 参照
[编译部署TubeMQ](https://inlong.apache.org/zh-cn/docs/modules/tubemq/quick_start.html)，安装并启动
Tube 集群；
+
+- 参照 [编译部署TubeMQ
Manager](https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html)，安装并启动
+ TubeManager。
+
+# 2. 编译打包
+
+通过 macOS 的终端（或 Windows 的命令提示符窗口）进入项目根目录，执行以下编译命令：
+
+```
+mvn clean install -DskipTests
+```
+
+编译成功后，前往项目的 `inlong-manager/manager-api` 和 `inlong-manager/manager-openapi`
模块，在各自的 `target`
+目录下生成了安装包，名称分别为 `apache-inlong-manager-api*.tar.gz` 和
`apache-inlong-manager-openapi*.tar.gz`。
+
+# 3. 部署、启动 manager-api
+
+**manager-api 是与前端页面交互的后台服务。**
-`inlong-manager/manager-web/src/resources/application.yml` 中默认使用开发环境的配置：
+## 3.1 上传、解压安装包
+
+1) 将第2步的
`inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz`
拷贝到要部署的服务器；
+
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-api-*.tar.gz`，得到
`manager-api` 文件夹。
+
+## 3.2 修改配置
+
+前往解压后的 `manager-api` 目录，修改 `conf/application.yml` 文件：
```yaml
+# manager-api 服务的端口号
+server:
+ port: 8083
+
+# 使用的配置文件为 dev
spring:
profiles:
active: dev
```
-所以需要修改 `inlong-manager/manager-web/src/resources/application-dev.yml` 中的相关配置：
+上面指定了 dev 配置，接下来修改 `conf/application-dev.yml` 文件：
1) 修改数据库 URL、用户名和密码：
```yaml
spring:
datasource:
- jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?serverTimezone=GMT%2b8&useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
username: xxxxxx
password: xxxxxx
```
@@ -53,60 +84,86 @@ spring:
```yaml
cluster:
tube:
- manager: http://127.0.0.1:8081
- master: 127.0.0.1:8000,127.0.0.1:8010
+ manager: http://127.0.0.1:8081 # Tube 集群的 Manager 地址，用来创建 Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # 用来管理 Tube 的 Broker
+ clusterId: 1 # Tube 集群的 ID
zk:
url: 127.0.0.1:2181
root: inlong_hive
```
-# 3. 编译打包
+## 3.3 启动服务
-通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录 `incubator-inlong`，然后执行以下编译命令：
+进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf
log/manager-api.log`，若出现类似下面的日志，说明服务启动成功：
-```
-mvn clean install -DskipTests
+```shell
+Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-编译成功后，前往项目的 `inlong-manager/manager-web` 和 `inlong-manager/manager-openapi`
模块，在各自的 `target` 目录下有打好的 tar
-包，名称为 `apache-inlong-manager-web-*.tar.gz`。
+# 4. 部署、启动 manager-openapi
-# 4. 部署、启动服务
+**manager-openapi 是为其他组件（如 Agent、DataProxy）提供交互接口的服务。**
-## 4.1 部署 manager-web
+## 4.1 上传、解压安装包
-1) 将上面的 `inlong-manager/manager-web/target/apache-inlong-manager-web-*.tar.gz`
拷贝到要部署的服务器；
+1) 将第2步的
`inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz`
拷贝到要部署的服务器；
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-web-*.tar.gz`；
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`，得到
`manager-openapi` 文件夹。
-3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `tailf
log/manager-web.log`，若出现类似下面的日志，说明服务启动成功：
+## 4.2 修改配置
- ```shell
- Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
- ```
+前往解压后的 `manager-openapi` 目录，修改 `conf/application.yml` 文件：
-## 4.2 部署 manager-openapi
+```yaml
+# manager-openapi 服务的端口号
+server:
+ port: 8082
-1) 将上面的
`inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz`
拷贝到要部署的服务器；
+# 使用的配置文件为 dev
+spring:
+ profiles:
+ active: dev
+```
+
+上面指定了 dev 配置，接下来修改 `conf/application-dev.yml` 文件：
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`；
+1) 修改数据库 URL、用户名和密码：
+
+ ```yaml
+ spring:
+ datasource:
+ jdbc-url:
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true
+ username: xxxxxx
+ password: xxxxxx
+ ```
-3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `tailf
log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
+2) 修改 Tube 和 ZooKeeper 集群的连接信息，其中 `cluster.zk.root` 建议使用默认值：
- ```shell
- Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
+ ```yaml
+ cluster:
+ tube:
+ manager: http://127.0.0.1:8081 # Tube 集群的 Manager 地址，用来创建 Topic
+ master: 127.0.0.1:8000,127.0.0.1:8010 # 用来管理 Tube 的 Broker
+ clusterId: 1 # Tube 集群的 ID
+ zk:
+ url: 127.0.0.1:2181
+ root: inlong_hive
```
-## 4.3 服务访问验证
+## 4.3 启动服务
-1) 验证 manager-web 服务：
+进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf
log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
- 访问地址：<http://x.x.x.x:8083/api/inlong/manager/doc.html#/home>
+```shell
+Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
+```
- 将 `x.x.x.x` 修改为 manager-web 服务对应的 IP 地址，端口号默认是 8083。
+# 5. 服务访问验证
-2) 验证 manager-openapi 服务：
+1) 验证 manager-api 服务：
- 访问地址：<http://x.x.x.x:8082/openapi/inlong/manager/doc.html#/home>
+
访问地址：<http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home>
+
+2) 验证 manager-openapi 服务：
- 将 `x.x.x.x` 修改为 manager-openapi 服务对应的 IP 地址，端口号默认是 8082。
+
访问地址：<http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home>
