You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by gi...@apache.org on 2021/07/07 06:05:42 UTC
[incubator-inlong-website] branch asf-site updated: Automated
deployment: Wed Jul 7 06:04:57 UTC 2021
ba3f87537e8575821dfdf06ace6fe11f601b5812
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 28b35b6 Automated deployment: Wed Jul 7 06:04:57 UTC 2021 ba3f87537e8575821dfdf06ace6fe11f601b5812
28b35b6 is described below
commit 28b35b6569812bf0a7cd987c3e7f1b309fd5bc84
Author: gosonzhang <go...@users.noreply.github.com>
AuthorDate: Wed Jul 7 06:04:57 2021 +0000
Automated deployment: Wed Jul 7 06:04:57 UTC 2021 ba3f87537e8575821dfdf06ace6fe11f601b5812
---
docs/zh-cn/modules/manager/quick_start.md | 184 +++++++++++++--------------
zh-cn/docs/modules/manager/quick_start.html | 186 +++++++++++++---------------
zh-cn/docs/modules/manager/quick_start.json | 6 +-
zh-cn/docs/modules/manager/quick_start.md | 184 +++++++++++++--------------
4 files changed, 263 insertions(+), 297 deletions(-)
diff --git a/docs/zh-cn/modules/manager/quick_start.md b/docs/zh-cn/modules/manager/quick_start.md
index 3cd87c9..91cabc3 100644
--- a/docs/zh-cn/modules/manager/quick_start.md
+++ b/docs/zh-cn/modules/manager/quick_start.md
@@ -1,121 +1,109 @@
-
-
---
- 快速开始 - Apache inlong-manager
+快速开始 - Apache inlong-manager
---
-# 1. 编译
+# 1. 环境准备
-+ 环境准备：已正确安装 Java（1.8+）、Maven（3.3+） 工具。
-+ 通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录`Inlong`执行编译打包命令：
-```
-mvn clean package -DskipTests
+- 安装并配置 JDK（1.8+）、Maven（3.3+）；
+
+- 安装并启动 ZooKeeper 3.5+；
+
+- 安装并启动 Tube 集群；
+
+- 安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；
+
+- 安装并启动 MySQL 5.7+，创建数据库，如 `CREATE DATABASE IF NOT EXISTS inlong; USE inlong;`，然后把 inlong-manager
+ 模块中的 `doc/sql/apache_inlong_manager.sql` 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 `/data/` 目录下，通过下述命令加载此文件，完成表结构及基础数据的初始化：
+
+ ```shell
+ # 通过用户名和密码，登录 MySQL 服务器：
+ mysql -u xxx -p xxx
+ ...
+ # 通过 source 命令加载上述 SQL 文件：
+ mysql> source /data/apache_inlong_manager.sql;
+ ```
+
+# 2. 修改配置
+
+`inlong-manager/manager-web/src/resources/application.yml` 中默认使用开发环境的配置：
+
+```yaml
+spring:
+ profiles:
+ active: dev
```
-+ 进入Inlong-manager子项目`inlong-manager` 目录，运行以下 Maven 命令打包项目，仅编译打包manager子项目：
+
+所以需要修改 `inlong-manager/manager-web/src/resources/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
+ username: xxxxxx
+ password: xxxxxx
+ ```
+
+2) 修改 Tube 和 ZooKeeper 集群的连接信息，其中 `cluster.zk.root` 建议使用默认值：
+
+ ```yaml
+ 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
+ ```
+
+# 3. 编译打包
+
+通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录 `incubator-inlong`，然后执行以下编译命令：
+
```
-mvn clean package -DskipTests
+mvn clean install -DskipTests
```
-+ 正确打包完成后，可在各个子模块的 `target` 目录下看到打好的tar包，manager-web-xxx-incubating-SNAPSHOT.tar.gz
+编译成功后，前往项目的 `inlong-manager/manager-web` 和 `inlong-manager/manager-openapi` 模块，在各自的 `target` 目录下有打好的 tar
+包，名称为 `apache-inlong-manager-web-*.tar.gz`。
+# 4. 部署、启动服务
-# 2 依赖准备
-## 2.1 数据库初始化
-+ 基于mysql 5.7+，提前创建好数据库，如``CREATE DATABASE IF NOT EXISTS inlong; USE inlong``， 并导入inlong-manager/doc/sql/apache_inlong_manager.sql完成表结构及基础数据的初始化
-+ 修改inlong-manager/manager-web/src/resources/application-xx.yml中数据库连接地址
-+ zookeeper 3.5+ ，信息配置到inlong-manager/manager-web/src/resources/application-xx.yml文件对应位置
-+ Tube集群信息，修改inlong-manager/manager-web/src/resources/application-xx.yml中tube相关配置信息
-+ hadoop2.10.x 集群 , hive 2.3.x需提前构建并启动完成
+## 4.1 部署 manager-web
-# 3. 后台服务部署&启动
+1) 将上面打好的 tar 包 `inlong-manager/manager-web/target/apache-inlong-manager-web-*.tar.gz` 拷贝到要部署的服务器；
-## 3.1 manager-web部署
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-web-*.tar.gz`；
-+ （1）找到安装包,进入 /apache-inlong/inlong-manager/manager-web/target 找到 manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ （2）部署安装包,压到即将部署服务的服务器对应目录 tar -zxvf manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ （3） 修改配置文件，将manager-web/conf中的配置文件, 以application.yml中profile.active=dev为例，将application-dev.yml文件按真实内容修改
-+ （4）启动服务，执行bin目录下的start.sh脚本，观察日志manager-web/log/manager-web.log和后端端口是否正常监听，manager-web默认使用8083端口
+3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `log/manager-web.log`，若出现类似下面的日志，说明服务启动成功：
-## 3.2 manager-openapi部署
-+ （1） 找到安装包,进入 /apache-inlong/inlong-manager/manager-openapi/target 找到 manager-openapi-xxx-incubating-SNAPSHOT.tar.gz
-+ （2） 部署安装包,压到即将部署服务的服务器对应目录 tar -zxvf manager-web-0.9.0-incubating-SNAPSHOT.tar.gz
-+ （3）修改配置文件，将manager-openapi/conf中的配置文件, 以application.yml中profile.active=dev为例，将配置application-dev.yml文件内容改为真实内容
-+ （4）启动服务，执行bin目录下的start.sh脚本，观察日志manager-openapi/log/manager-openapi.log和后端端口是否正常监听，manager-openapi默认使用8082端口
+ ```shell
+ Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
+ ```
+## 4.2 部署 manager-openapi
-## 3.3 后端配置详解
-+ `manager-web/conf/application-xx.yml` 示例
+1) 将上面打好的 tar 包 `inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz` 拷贝到要部署的服务器；
-```yml
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`；
-logging:
- level:
- root: INFO
- org:
- apache:
- inlong:
- manager:
- dao:
- mapper: debug
- third:
- debug
+3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
-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
+ ```shell
+ Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
+ ```
-```
+## 4.3 服务访问验证
+
+1) 验证 manager-web 服务：
+
+ 访问地址：<http://x.x.x.x:8083/api/inlong/manager/doc.html#/home>
+
+ 将 `x.x.x.x` 修改为 manager-web 服务对应的 IP 地址，端口号默认是 8083。
-## 3.4 后台服务验证：
+2) 验证 manager-openapi 服务：
-<http://x.x.x.x:8083/api/inlong/manager/doc.html#/home>
+ 访问地址：<http://x.x.x.x:8082/openapi/inlong/manager/doc.html#/home>
-其中 `x.x.x.x` 修改为manager-web所部署的机器IP地址
+ 将 `x.x.x.x` 修改为 manager-openapi 服务对应的 IP 地址，端口号默认是 8082。
diff --git a/zh-cn/docs/modules/manager/quick_start.html b/zh-cn/docs/modules/manager/quick_start.html
index a2397d0..9cc767c 100644
--- a/zh-cn/docs/modules/manager/quick_start.html
+++ b/zh-cn/docs/modules/manager/quick_start.html
@@ -12,120 +12,108 @@
<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="/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= [...]
-<h2>快速开始 - Apache inlong-manager</h2>
-<h1>1. 编译</h1>
+ <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= [...]
<ul>
-<li>环境准备：已正确安装 Java（1.8+）、Maven（3.3+） 工具。</li>
-<li>通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录<code>Inlong</code>执行编译打包命令：</li>
-</ul>
-<pre><code>mvn clean package -DskipTests
+<li>
+<p>安装并配置 JDK（1.8+）、Maven（3.3+）；</p>
+</li>
+<li>
+<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+，创建数据库，如 <code>CREATE DATABASE IF NOT EXISTS inlong; USE inlong;</code>，然后把 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
+...
+<span class="hljs-meta">#</span><span class="bash"> 通过 <span class="hljs-built_in">source</span> 命令加载上述 SQL 文件：</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>进入Inlong-manager子项目<code>inlong-manager</code> 目录，运行以下 Maven 命令打包项目，仅编译打包manager子项目：</li>
+</li>
</ul>
-<pre><code>mvn clean package -DskipTests
+<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>
+ <span class="hljs-attr">profiles:</span>
+ <span class="hljs-attr">active:</span> <span class="hljs-string">dev</span>
</code></pre>
-<ul>
-<li>正确打包完成后，可在各个子模块的 <code>target</code> 目录下看到打好的tar包，manager-web-xxx-incubating-SNAPSHOT.tar.gz</li>
-</ul>
-<h1>2 依赖准备</h1>
-<h2>2.1 数据库初始化</h2>
-<ul>
-<li>基于mysql 5.7+，提前创建好数据库，如<code>CREATE DATABASE IF NOT EXISTS inlong; USE inlong</code>， 并导入inlong-manager/doc/sql/apache_inlong_manager.sql完成表结构及基础数据的初始化</li>
-<li>修改inlong-manager/manager-web/src/resources/application-xx.yml中数据库连接地址</li>
-<li>zookeeper 3.5+ ，信息配置到inlong-manager/manager-web/src/resources/application-xx.yml文件对应位置</li>
-<li>Tube集群信息，修改inlong-manager/manager-web/src/resources/application-xx.yml中tube相关配置信息</li>
-<li>hadoop2.10.x 集群 , hive 2.3.x需提前构建并启动完成</li>
-</ul>
-<h1>3. 后台服务部署&启动</h1>
-<h2>3.1 manager-web部署</h2>
-<ul>
-<li>（1）找到安装包,进入 /apache-inlong/inlong-manager/manager-web/target 找到 manager-web-xxx-incubating-SNAPSHOT.tar.gz</li>
-<li>（2）部署安装包,压到即将部署服务的服务器对应目录 tar -zxvf manager-web-xxx-incubating-SNAPSHOT.tar.gz</li>
-<li>（3） 修改配置文件，将manager-web/conf中的配置文件, 以application.yml中profile.active=dev为例，将application-dev.yml文件按真实内容修改</li>
-<li>（4）启动服务，执行bin目录下的start.sh脚本，观察日志manager-web/log/manager-web.log和后端端口是否正常监听，manager-web默认使用8083端口</li>
-</ul>
-<h2>3.2 manager-openapi部署</h2>
-<ul>
-<li>（1） 找到安装包,进入 /apache-inlong/inlong-manager/manager-openapi/target 找到 manager-openapi-xxx-incubating-SNAPSHOT.tar.gz</li>
-<li>（2） 部署安装包,压到即将部署服务的服务器对应目录 tar -zxvf manager-web-0.9.0-incubating-SNAPSHOT.tar.gz</li>
-<li>（3）修改配置文件，将manager-openapi/conf中的配置文件, 以application.yml中profile.active=dev为例，将配置application-dev.yml文件内容改为真实内容</li>
-<li>（4）启动服务，执行bin目录下的start.sh脚本，观察日志manager-openapi/log/manager-openapi.log和后端端口是否正常监听，manager-openapi默认使用8082端口</li>
-</ul>
-<h2>3.3 后端配置详解</h2>
-<ul>
-<li><code>manager-web/conf/application-xx.yml</code> 示例</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>
-
-<span class="hljs-attr">spring:</span>
+<p>所以需要修改 <code>inlong-manager/manager-web/src/resources/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">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>修改 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">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>
-<h2>3.4 后台服务验证：</h2>
-<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地址</p>
+</li>
+</ol>
+<h1>3. 编译打包</h1>
+<p>通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录 <code>incubator-inlong</code>，然后执行以下编译命令：</p>
+<pre><code>mvn clean install -DskipTests
+</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>
+<ol>
+<li>
+<p>将上面打好的 tar 包 <code>inlong-manager/manager-web/target/apache-inlong-manager-web-*.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>log/manager-web.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
+<pre><code class="language-shell">Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
+</code></pre>
+</li>
+</ol>
+<h2>4.2 部署 manager-openapi</h2>
+<ol>
+<li>
+<p>将上面打好的 tar 包 <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>
+</li>
+<li>
+<p>进入解压后的目录，执行 <code>sh bin/start.sh</code> 启动服务，查看日志 <code>log/manager-openapi.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
+<pre><code class="language-shell">Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
+</code></pre>
+</li>
+</ol>
+<h2>4.3 服务访问验证</h2>
+<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>
+</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>
+</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/zh-cn/docs/modules/manager/quick_start.json b/zh-cn/docs/modules/manager/quick_start.json
index 8b96694..cd1f48d 100644
--- a/zh-cn/docs/modules/manager/quick_start.json
+++ b/zh-cn/docs/modules/manager/quick_start.json
@@ -1,6 +1,8 @@
{
"filename": "quick_start.md",
- "__html": "<hr>\n<h2>快速开始 - Apache inlong-manager</h2>\n<h1>1. 编译</h1>\n<ul>\n<li>环境准备：已正确安装 Java（1.8+）、Maven（3.3+） 工具。</li>\n<li>通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录<code>Inlong</code>执行编译打包命令：</li>\n</ul>\n<pre><code>mvn clean package -DskipTests\n</code></pre>\n<ul>\n<li>进入Inlong-manager子项目<code>inlong-manager</code> 目录，运行以下 Maven 命令打包项目，仅编译打包manager子项目：</li>\n</ul>\n<pre><code>mvn clean package -DskipTests\n</code></pre>\n<ul>\n<li>正确打包完成后，可在各个子模块的 <code>target</code> 目录下看到打好的tar包， [...]
+ "__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+，创建数据库，如 <code>CREATE DATABASE IF NOT EXISTS inlong; USE inlong;</code>，然后把 inlong-manager\n模块中的 <code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 <code>/data/</code> 目录下，通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>\n<pre><code class= [...]
"link": "/zh-cn/docs/modules/manager/quick_start.html",
- "meta": {}
+ "meta": {
+ "快速开始 - Apache inlong-manager": ""
+ }
}
\ No newline at end of file
diff --git a/zh-cn/docs/modules/manager/quick_start.md b/zh-cn/docs/modules/manager/quick_start.md
index 3cd87c9..91cabc3 100644
--- a/zh-cn/docs/modules/manager/quick_start.md
+++ b/zh-cn/docs/modules/manager/quick_start.md
@@ -1,121 +1,109 @@
-
-
---
- 快速开始 - Apache inlong-manager
+快速开始 - Apache inlong-manager
---
-# 1. 编译
+# 1. 环境准备
-+ 环境准备：已正确安装 Java（1.8+）、Maven（3.3+） 工具。
-+ 通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录`Inlong`执行编译打包命令：
-```
-mvn clean package -DskipTests
+- 安装并配置 JDK（1.8+）、Maven（3.3+）；
+
+- 安装并启动 ZooKeeper 3.5+；
+
+- 安装并启动 Tube 集群；
+
+- 安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；
+
+- 安装并启动 MySQL 5.7+，创建数据库，如 `CREATE DATABASE IF NOT EXISTS inlong; USE inlong;`，然后把 inlong-manager
+ 模块中的 `doc/sql/apache_inlong_manager.sql` 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 `/data/` 目录下，通过下述命令加载此文件，完成表结构及基础数据的初始化：
+
+ ```shell
+ # 通过用户名和密码，登录 MySQL 服务器：
+ mysql -u xxx -p xxx
+ ...
+ # 通过 source 命令加载上述 SQL 文件：
+ mysql> source /data/apache_inlong_manager.sql;
+ ```
+
+# 2. 修改配置
+
+`inlong-manager/manager-web/src/resources/application.yml` 中默认使用开发环境的配置：
+
+```yaml
+spring:
+ profiles:
+ active: dev
```
-+ 进入Inlong-manager子项目`inlong-manager` 目录，运行以下 Maven 命令打包项目，仅编译打包manager子项目：
+
+所以需要修改 `inlong-manager/manager-web/src/resources/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
+ username: xxxxxx
+ password: xxxxxx
+ ```
+
+2) 修改 Tube 和 ZooKeeper 集群的连接信息，其中 `cluster.zk.root` 建议使用默认值：
+
+ ```yaml
+ 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
+ ```
+
+# 3. 编译打包
+
+通过 macOS 的终端（或 Windows 的 cmd）进入项目根目录 `incubator-inlong`，然后执行以下编译命令：
+
```
-mvn clean package -DskipTests
+mvn clean install -DskipTests
```
-+ 正确打包完成后，可在各个子模块的 `target` 目录下看到打好的tar包，manager-web-xxx-incubating-SNAPSHOT.tar.gz
+编译成功后，前往项目的 `inlong-manager/manager-web` 和 `inlong-manager/manager-openapi` 模块，在各自的 `target` 目录下有打好的 tar
+包，名称为 `apache-inlong-manager-web-*.tar.gz`。
+# 4. 部署、启动服务
-# 2 依赖准备
-## 2.1 数据库初始化
-+ 基于mysql 5.7+，提前创建好数据库，如``CREATE DATABASE IF NOT EXISTS inlong; USE inlong``， 并导入inlong-manager/doc/sql/apache_inlong_manager.sql完成表结构及基础数据的初始化
-+ 修改inlong-manager/manager-web/src/resources/application-xx.yml中数据库连接地址
-+ zookeeper 3.5+ ，信息配置到inlong-manager/manager-web/src/resources/application-xx.yml文件对应位置
-+ Tube集群信息，修改inlong-manager/manager-web/src/resources/application-xx.yml中tube相关配置信息
-+ hadoop2.10.x 集群 , hive 2.3.x需提前构建并启动完成
+## 4.1 部署 manager-web
-# 3. 后台服务部署&启动
+1) 将上面打好的 tar 包 `inlong-manager/manager-web/target/apache-inlong-manager-web-*.tar.gz` 拷贝到要部署的服务器；
-## 3.1 manager-web部署
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-web-*.tar.gz`；
-+ （1）找到安装包,进入 /apache-inlong/inlong-manager/manager-web/target 找到 manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ （2）部署安装包,压到即将部署服务的服务器对应目录 tar -zxvf manager-web-xxx-incubating-SNAPSHOT.tar.gz
-+ （3） 修改配置文件，将manager-web/conf中的配置文件, 以application.yml中profile.active=dev为例，将application-dev.yml文件按真实内容修改
-+ （4）启动服务，执行bin目录下的start.sh脚本，观察日志manager-web/log/manager-web.log和后端端口是否正常监听，manager-web默认使用8083端口
+3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `log/manager-web.log`，若出现类似下面的日志，说明服务启动成功：
-## 3.2 manager-openapi部署
-+ （1） 找到安装包,进入 /apache-inlong/inlong-manager/manager-openapi/target 找到 manager-openapi-xxx-incubating-SNAPSHOT.tar.gz
-+ （2） 部署安装包,压到即将部署服务的服务器对应目录 tar -zxvf manager-web-0.9.0-incubating-SNAPSHOT.tar.gz
-+ （3）修改配置文件，将manager-openapi/conf中的配置文件, 以application.yml中profile.active=dev为例，将配置application-dev.yml文件内容改为真实内容
-+ （4）启动服务，执行bin目录下的start.sh脚本，观察日志manager-openapi/log/manager-openapi.log和后端端口是否正常监听，manager-openapi默认使用8082端口
+ ```shell
+ Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
+ ```
+## 4.2 部署 manager-openapi
-## 3.3 后端配置详解
-+ `manager-web/conf/application-xx.yml` 示例
+1) 将上面打好的 tar 包 `inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz` 拷贝到要部署的服务器；
-```yml
+2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`；
-logging:
- level:
- root: INFO
- org:
- apache:
- inlong:
- manager:
- dao:
- mapper: debug
- third:
- debug
+3) 进入解压后的目录，执行 `sh bin/start.sh` 启动服务，查看日志 `log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
-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
+ ```shell
+ Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
+ ```
-```
+## 4.3 服务访问验证
+
+1) 验证 manager-web 服务：
+
+ 访问地址：<http://x.x.x.x:8083/api/inlong/manager/doc.html#/home>
+
+ 将 `x.x.x.x` 修改为 manager-web 服务对应的 IP 地址，端口号默认是 8083。
-## 3.4 后台服务验证：
+2) 验证 manager-openapi 服务：
-<http://x.x.x.x:8083/api/inlong/manager/doc.html#/home>
+ 访问地址：<http://x.x.x.x:8082/openapi/inlong/manager/doc.html#/home>
-其中 `x.x.x.x` 修改为manager-web所部署的机器IP地址
+ 将 `x.x.x.x` 修改为 manager-openapi 服务对应的 IP 地址，端口号默认是 8082。