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 2bd33eb [INLONG-668] adjust quick_start.md content of inlong-manager
(#89)
2bd33eb is described below
commit 2bd33eba25111dde7cb05a8a2d3dda9719815817
Author: 瘦风 <[email protected]>
AuthorDate: Thu Jul 8 12:05:20 2021 +0800
[INLONG-668] adjust quick_start.md content of inlong-manager (#89)
Co-authored-by: healzhou <[email protected]>
---
docs/en-us/modules/manager/quick_start.md | 263 +++++++++++++++++++-----------
docs/zh-cn/modules/manager/quick_start.md | 131 ++++++++++-----
2 files changed, 259 insertions(+), 135 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>
