This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 1472301 Modify the deployment document of InLong-Manager (#126)
1472301 is described below
commit 1472301aa0926760b19b5d654ecdf8379833ab4e
Author: healchow <heal.c...@gmail.com>
AuthorDate: Mon Aug 9 17:43:24 2021 +0800
Modify the deployment document of InLong-Manager (#126)
* Modify the deployment document of InLong-Manager
Co-authored-by: healzhou <healz...@tencent.com>
---
docs/en-us/modules/agent/quick_start.md | 4 +-
docs/en-us/modules/dataproxy/quick_start.md | 4 +-
docs/en-us/modules/manager/architecture.md | 13 ++-
docs/en-us/modules/manager/quick_start.md | 133 ++++++++--------------------
docs/en-us/quick_start.md | 3 +-
docs/zh-cn/modules/agent/quick_start.md | 4 +-
docs/zh-cn/modules/dataproxy/quick_start.md | 2 +-
docs/zh-cn/modules/manager/architecture.md | 4 +-
docs/zh-cn/modules/manager/quick_start.md | 132 ++++++++-------------------
docs/zh-cn/quick_start.md | 3 +-
10 files changed, 87 insertions(+), 215 deletions(-)
diff --git a/docs/en-us/modules/agent/quick_start.md
b/docs/en-us/modules/agent/quick_start.md
index d61c883..fa9d80d 100644
--- a/docs/en-us/modules/agent/quick_start.md
+++ b/docs/en-us/modules/agent/quick_start.md
@@ -12,8 +12,8 @@ Online operation needs to pull the configuration from
inlong-manager, the config
```ini
agent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher
(the class name for fetch tasks, default ManagerFetcher）
agent.local.ip=Write local ip
-agent.manager.vip.http.host=manager open api host
-agent.manager.vip.http.port=manager open api port
+agent.manager.vip.http.host=manager web host
+agent.manager.vip.http.port=manager web port
```
### 1.2 Proxy configuration
diff --git a/docs/en-us/modules/dataproxy/quick_start.md
b/docs/en-us/modules/dataproxy/quick_start.md
index 0fdd177..e1274a6 100644
--- a/docs/en-us/modules/dataproxy/quick_start.md
+++ b/docs/en-us/modules/dataproxy/quick_start.md
@@ -14,10 +14,10 @@ notice that conf/flume.conf FLUME_HOME is proxy the
directory for proxy inner da
sh prepare_env.sh
```
-### config manager openapi
+### config manager web url
配置文件`conf/common.properties`:
```
-# manager open api
+# manager web
manager_hosts=ip:port
```
diff --git a/docs/en-us/modules/manager/architecture.md
b/docs/en-us/modules/manager/architecture.md
index fc683ac..85937b1 100644
--- a/docs/en-us/modules/manager/architecture.md
+++ b/docs/en-us/modules/manager/architecture.md
@@ -16,14 +16,13 @@ title: Architecture Introduction-Apache InLong Manager
##Module division of labor
-|Module |Responsibilities |
+| Module | Responsibilities |
| :----| :---- |
-|manager-common |Module common code, entry exception definition, tool class,
enumeration, etc.|
-|manager-dao|Database Operation|
-|manager-openapi |Background open interface|
-|manager-service |Business Logic Layer |
-|manager-web |Front-end interactive response interface|
-|manager-workflow-engin|Workflow Engine|
+| manager-common | Module common code, entry exception definition, tool class,
enumeration, etc.|
+| manager-dao |Database Operation |
+| manager-service |Business Logic Layer |
+| manager-web | Front-end interactive response interface |
+| manager-workflow-engine | Workflow Engine |
## use process
diff --git a/docs/en-us/modules/manager/quick_start.md
b/docs/en-us/modules/manager/quick_start.md
index 5871978..ee9bdf2 100644
--- a/docs/en-us/modules/manager/quick_start.md
+++ b/docs/en-us/modules/manager/quick_start.md
@@ -25,129 +25,66 @@ Quick start-Apache inlong-manager
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. Deploy and start manager-api
+# 2. Deploy and start manager-web
-**manager-api is a background service that interacts with the front-end page.**
+**manager-web is a background service that interacts with the front-end page.**
## 2.1 Prepare installation files
-All installation files at `inlong-manager-api` directory.
+
+All installation files at `inlong-manager-web` directory.
## 2.2 Modify configuration
-Go to the decompressed `manager-api` directory and modify the
`conf/application.yml` file:
+Go to the decompressed `inlong-manager-web` directory and modify the
`conf/application.properties` file:
-```yaml
-# manager-api service port number
-server:
- port: 8083
+```properties
+# manager-web service port number
+server.port=8083
# The configuration file used is dev
-spring:
- profiles:
- active: dev
+spring.profiles.active=dev
```
-The dev configuration is specified above, then modify the
`conf/application-dev.yml` file:
+The dev configuration is specified above, then modify the
`conf/application-dev.properties` file:
-1) Modify the database URL, user name and password:
+1) Modify the database URL, username 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
+ ```properties
+
spring.datasource.jdbc-url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
+ spring.datasource.username=xxxxxx
+ spring.datasource.password=xxxxxx
```
-2) Modify the connection information of the Tube and ZooKeeper clusters, among
which `cluster.zk.root` suggests to use
+2) Modify the connection information of the Tube and ZooKeeper clusters, among
which `cluster.zk.root` suggests using
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
- sort.appName: inlong_app # The app name for Sort, default is 'inlong_app'
+ ```properties
+ # Manager address of Tube cluster, used to create Topic
+ cluster.tube.manager=http://127.0.0.1:8081
+ # Broker used to manage Tube
+ cluster.tube.master=127.0.0.1:8000,127.0.0.1:8010
+ # Tube cluster ID
+ cluster.tube.clusterId=1
+
+ # ZK cluster, used to push the configuration of Sort
+ cluster.zk.url=127.0.0.1:2181
+ cluster.zk.root=inlong_hive
+
+ # Sort application name, that is, set the cluster-id parameter of Sort, the
default value is "inlong_app"
+ sort.appName=inlong_app
```
## 2.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)
-```
-
-# 3. Deploy and start manager-openapi
-
-**manager-openapi is a service that provides interactive interfaces for other
components (such as Agent and DataProxy)
-.**
-
-## 3.1 Prepare installation files
-All installation files at `inlong-manager-openapi` directory.
-
-## 3.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:
- 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
- sort.appName: inlong_app # The app name for Sort, default is 'inlong_app'
- ```
-
-## 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-openapi.log`. If a log similar to the following
appears, the service has started successfully:
+log `tailf log/manager-web.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)
+Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
```
-# 4. Service access verification
-
-1) Verify the manager-api service:
-
- Visit address:
<http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home>
+# 3. Service access verification
-2) Verify the manager-openapi service:
+Verify the manager-web service:
- Visit address:
<http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home>
\ No newline at end of file
+Visit address:
<http://[manager_web_ip]:[manager_web_port]/api/inlong/manager/doc.html#/home>
diff --git a/docs/en-us/quick_start.md b/docs/en-us/quick_start.md
index 720bbad..b6eab74 100644
--- a/docs/en-us/quick_start.md
+++ b/docs/en-us/quick_start.md
@@ -29,8 +29,7 @@ after compile successfully, you could find distribution file
at `inlong-distribu
inlong-agent
inlong-dataproxy
inlong-dataproxy-sdk
-inlong-manager-api
-inlong-manager-openapi
+inlong-manager-web
inlong-sort
inlong-tubemq-manager
inlong-tubemq-server
diff --git a/docs/zh-cn/modules/agent/quick_start.md
b/docs/zh-cn/modules/agent/quick_start.md
index 6f24d43..abeed06 100644
--- a/docs/zh-cn/modules/agent/quick_start.md
+++ b/docs/zh-cn/modules/agent/quick_start.md
@@ -11,8 +11,8 @@ agent 支持本地运行以及线上运行，其中线上运行从inlong manager
```ini
agent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher
(设置任务获取的类名，默认为ManagerFetcher）
agent.local.ip=写入本机ip
-agent.manager.vip.http.host=manager open api host
-agent.manager.vip.http.port=manager open api port
+agent.manager.vip.http.host=manager web host
+agent.manager.vip.http.port=manager web port
```
### 1.2 DataProxy 相关设置
diff --git a/docs/zh-cn/modules/dataproxy/quick_start.md
b/docs/zh-cn/modules/dataproxy/quick_start.md
index 52afb3a..ccde508 100644
--- a/docs/zh-cn/modules/dataproxy/quick_start.md
+++ b/docs/zh-cn/modules/dataproxy/quick_start.md
@@ -17,7 +17,7 @@ sh prepare_env.sh
### 配置manager地址
configuration file `conf/common.properties`:
```
-# manager open api
+# manager web url
manager_hosts=ip:port
```
diff --git a/docs/zh-cn/modules/manager/architecture.md
b/docs/zh-cn/modules/manager/architecture.md
index b61cc76..97002cd 100644
--- a/docs/zh-cn/modules/manager/architecture.md
+++ b/docs/zh-cn/modules/manager/architecture.md
@@ -21,11 +21,9 @@ title: 架构介绍 - Apache InLong Manager
| :-----| :---- |
| manager-common | 模块公共代码，入异常定义，工具类，枚举等 |
| manager-dao | 数据库操作 |
-| manager-opapi | 后台开放接口|
| manager-service | 业务逻辑层 |
| manager-web | 前端交互对应接口 |
-| manager-workflow-engin | 工作流引擎|
-
+| manager-workflow-engine | 工作流引擎|
## 系统使用流程
diff --git a/docs/zh-cn/modules/manager/quick_start.md
b/docs/zh-cn/modules/manager/quick_start.md
index 67bba33..e8bccf4 100644
--- a/docs/zh-cn/modules/manager/quick_start.md
+++ b/docs/zh-cn/modules/manager/quick_start.md
@@ -3,8 +3,8 @@
---
# 1. 环境准备
-- 安装并启动 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 服务器：
@@ -22,124 +22,64 @@
- 参照 [编译部署TubeMQ
Manager](https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html)，安装并启动
TubeManager。
-# 2. 部署、启动 manager-api
+# 2. 部署、启动 manager-web
-**manager-api 是与前端页面交互的后台服务。**
+**manager-web 是与前端页面交互的后台服务。**
## 2.1 准备安装文件
-安装文件在`inlong-manager-api`目录.
+
+安装文件在 `inlong-manager-web` 目录下。
## 2.2 修改配置
-前往解压后的 `manager-api` 目录，修改 `conf/application.yml` 文件：
+前往 `inlong-manager-web` 目录，修改 `conf/application.properties` 文件：
-```yaml
-# manager-api 服务的端口号
-server:
- port: 8083
+```properties
+# manager-web 服务的端口号
+server.port=8083
-# 使用的配置文件为 dev
-spring:
- profiles:
- active: dev
+# 默认使用的配置文件为 dev
+spring.profiles.active=dev
```
-上面指定了 dev 配置，接下来修改 `conf/application-dev.yml` 文件：
+上面指定了 dev 配置，接下来修改 `conf/application-dev.properties` 文件：
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
+ ```properties
+
spring.datasource.jdbc-url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
+ spring.datasource.username=xxxxxx
+ spring.datasource.password=xxxxxx
```
2) 修改 Tube 和 ZooKeeper 集群的连接信息，其中 `cluster.zk.root` 建议使用默认值：
- ```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
- sort.appName: inlong_app # Sort 应用名称，即设置 Sort 的 cluster-id
参数，默认值为"inlong_app"
+ ```properties
+ # Tube 集群的 Manager 地址，用来创建 Topic
+ cluster.tube.manager=http://127.0.0.1:8081
+ # 用来管理 Tube 的 Broker
+ cluster.tube.master=127.0.0.1:8000,127.0.0.1:8010
+ # Tube 集群的 ID
+ cluster.tube.clusterId=1
+
+ # ZK 集群，用来推送 Sort 的配置
+ cluster.zk.url=127.0.0.1:2181
+ cluster.zk.root=inlong_hive
+
+ # Sort 应用名称，即设置 Sort 的 cluster-id 参数，默认值为"inlong_app"
+ sort.appName=inlong_app
```
## 2.3 启动服务
-进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf
log/manager-api.log`，若出现类似下面的日志，说明服务启动成功：
+进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf
log/manager-web.log`，若出现类似下面的日志，说明服务启动成功：
```shell
-Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
+Started InLongWebApplication in 6.795 seconds (JVM running for 7.565)
```
-# 3. 部署、启动 manager-openapi
-
-**manager-openapi 是为其他组件（如 Agent、DataProxy）提供交互接口的服务。**
-
-## 3.1 准备安装文件
-安装文件在`inlong-manager-openapi`目录.
-
-## 3.2 修改配置
-
-前往解压后的 `manager-openapi` 目录，修改 `conf/application.yml` 文件：
-
-```yaml
-# manager-openapi 服务的端口号
-server:
- port: 8082
-
-# 使用的配置文件为 dev
-spring:
- profiles:
- active: dev
-```
-
-上面指定了 dev 配置，接下来修改 `conf/application-dev.yml` 文件：
-
-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
- ```
-
-2) 修改 Tube 和 ZooKeeper 集群的连接信息，其中 `cluster.zk.root` 建议使用默认值：
-
- ```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
- sort.appName: inlong_app # Sort 应用名称，即设置 Sort 的 cluster-id
参数，默认值为"inlong_app"
- ```
-
-## 3.3 启动服务
-
-进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf
log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
-
-```shell
-Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
-```
-
-# 4. 服务访问验证
-
-1) 验证 manager-api 服务：
-
-
访问地址：<http://[manager_api_ip]:[manager_api_port]/api/inlong/manager/doc.html#/home>
+# 3. 服务访问验证
-2) 验证 manager-openapi 服务：
+在浏览器中访问如下地址，验证 manager-web 服务：
-
访问地址：<http://[manager_openapi_ip]:[manager_openapi_port]/openapi/inlong/manager/doc.html#/home>
+地址：<http://[manager_web_ip]:[manager_web_port]/api/inlong/manager/doc.html#/home>
diff --git a/docs/zh-cn/quick_start.md b/docs/zh-cn/quick_start.md
index 4d21a95..df5ba02 100644
--- a/docs/zh-cn/quick_start.md
+++ b/docs/zh-cn/quick_start.md
@@ -28,8 +28,7 @@ $ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8
mvn clean install
inlong-agent
inlong-dataproxy
inlong-dataproxy-sdk
-inlong-manager-api
-inlong-manager-openapi
+inlong-manager-web
inlong-sort
inlong-tubemq-manager
inlong-tubemq-server
