This is an automated email from the ASF dual-hosted git repository.
gosonzhang 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 c632607 [INLONG-2042] fix the deployment guide mistakes (#233)
c632607 is described below
commit c63260708fd9fd2687e6f077627d19ff66960fcf
Author: dockerzhang <[email protected]>
AuthorDate: Tue Dec 21 10:05:12 2021 +0800
[INLONG-2042] fix the deployment guide mistakes (#233)
Co-authored-by: dockerzhang <[email protected]>
---
docs/modules/dataproxy/quick_start.md | 14 ++++----
docs/modules/manager/quick_start.md | 2 +-
docs/modules/sort/quick_start.md | 38 +++++++++-------------
docs/modules/tubemq/tubemq-manager/quick_start.md | 7 ++--
.../current/modules/dataproxy/quick_start.md | 15 +++++----
.../current/modules/sort/quick_start.md | 34 +++++++++----------
.../modules/tubemq/tubemq-manager/quick_start.md | 7 ++--
7 files changed, 54 insertions(+), 63 deletions(-)
diff --git a/docs/modules/dataproxy/quick_start.md
b/docs/modules/dataproxy/quick_start.md
index 7e72038..297111e 100644
--- a/docs/modules/dataproxy/quick_start.md
+++ b/docs/modules/dataproxy/quick_start.md
@@ -1,11 +1,11 @@
---
title: Deployment
---
-## 1 Deploy DataProxy
All deploying files at `inlong-dataproxy` directory.
+## Configuration
-### 1.1 config TubeMQ master
+### Configure TubeMQ
`tubemq_master_list` is the rpc address of TubeMQ Master.
```
@@ -14,13 +14,13 @@ $ sed -i 's/TUBE_LIST/tubemq_master_list/g' conf/flume.conf
notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner
data
-### 1.2 Environmental preparation
+### Environment Preparation
```
sh prepare_env.sh
```
-### 1.3 config manager web url
+### Configure InLong-Manager URL
configuration file: `conf/common.properties`:
```
@@ -28,19 +28,19 @@ configuration file: `conf/common.properties`:
manager_hosts=ip:port
```
-## 2 run
+## run
```
sh bin/start.sh
```
-## 3 check
+## check
```
telnet 127.0.0.1 46801
```
-## 4 Add DataProxy configuration to InLong-Manager
+## Add DataProxy configuration to InLong-Manager
After installing the DataProxy, you need to insert the IP and port of the
DataProxy service is located into the backend database of InLong-Manager.
diff --git a/docs/modules/manager/quick_start.md
b/docs/modules/manager/quick_start.md
index 2b24fef..6249986 100644
--- a/docs/modules/manager/quick_start.md
+++ b/docs/modules/manager/quick_start.md
@@ -2,7 +2,7 @@
title: Deployment
---
-## Environmental preparation
+## Environment Requirements
- Install and start MySQL 5.7+
- initialize database
there is `sql/apache_inlong_manager.sql` in `inlong-manager-web` directory,
load this file through the
diff --git a/docs/modules/sort/quick_start.md b/docs/modules/sort/quick_start.md
index 663194c..7cb4730 100644
--- a/docs/modules/sort/quick_start.md
+++ b/docs/modules/sort/quick_start.md
@@ -3,62 +3,56 @@ title: Deployment
sidebar_position: 2
---
-## 1 Set up flink environment
+## Set up flink environment
Currently inlong-sort is based on flink, before you run an inlong-sort
application,
-you need to set up flink environment.
-
-<a
href="https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/cluster_setup.html";
target="_blank">how to set up flink environment</a>
+you need to set up [flink
environment](https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/cluster_setup.html).
Currently, inlong-sort relys on flink-1.9.3. Chose
`flink-1.9.3-bin-scala_2.11.tgz` when downloading package.
Once your flink environment is set up, you can visit web ui of flink, whose
address is stored in `/${your_flink_path}/conf/masters`.
-## 2 Prepare installation files
+## Prepare installation files
All installation files at `inlong-sort` directory.
-## 3 Starting an inlong-sort application
-Now you can submit job to flink with the jar compiled.
-
-<a
href="https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/yarn_setup.html#submit-job-to-flink";
target="_blank">how to submit job to flink</a>
+## Starting an inlong-sort application
+Now you can submit job to flink with the jar compiled, refer to [how to submit
job to
flink](https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/yarn_setup.html#submit-job-to-flink).
Example：
-
-- `./bin/flink run -c org.apache.inlong.sort.flink.Entrance
inlong-sort-core-1.0-SNAPSHOT.jar --cluster-id my_application
--zookeeper.quorum 127.0.0.1:2181 --zookeeper.path.root /inlong-sort
--source.type tubemq --sink.type hive`
+```
+$ ./bin/flink run -c org.apache.inlong.sort.flink.Entrance
inlong-sort-core-[version].jar --cluster-id my_application --zookeeper.quorum
127.0.0.1:2181 --zookeeper.path.root /inlong-sort --source.type tubemq
--sink.type hive
+```
Notice：
- `-c org.apache.inlong.sort.flink.Entrance` is the main class name
-- `inlong-sort-core-1.0-SNAPSHOT.jar` is the compiled jar
+- `inlong-sort-core-[version].jar` is the compiled jar
-## 4 Necessary configurations
+## Necessary configurations
- `--cluster-id ` which is used to represent a specified inlong-sort
application
- `--zookeeper.quorum` zk quorum
- `--zookeeper.path.root` zk root path
- `--source.type` source of the application, currently "tubemq" and "pulsar"
are supported
- `--sink.type` sink of the application, currently "clickhouse" and "hive" are
supported
-Configurations above are necessary, you can see full configurations in
-
-`~/Inlong/inlong-sort/common/src/main/java/org/apache/inlong/sort/configuration/Constants.java`
-
**Example**
+```
+--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181
--zookeeper.path.root /zk_root --source.type tubemq --sink.type hive
+```
-`--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181
--zookeeper.path.root /zk_root --source.type tubemq --sink.type hive`
-
-## 5 All configurations
+## All configurations
| name | necessary | default value |description |
| ------------ | ------------ | ------------ | ------------ |
|cluster-id | Y | NA | used to represent a specified inlong-sort
application |
|zookeeper.quorum | Y | NA | zk quorum |
-|zookeeper.path.root | Y | "/inlong-sort" | zk root path |
+|zookeeper.path.root | Y | /inlong-sort | zk root path |
|source.type | Y | NA | source of the application, currently "tubemq" and
"pulsar" are supported |
|sink.type | Y | NA | sink of the application, currently "clickhouse" and
"hive" are supported |
|source.parallelism | N | 1 | parallelism of source |
|deserialization.parallelism | N | 1 | parallelism of deserialization |
|sink.parallelism | N | 1 | parallelism of sink |
|tubemq.master.address | N | NA | tube master address used if absent in
DataFlowInfo on zk |
-|tubemq.session.key |N |"inlong-sort" | session key used when subscribing to
tubemq |
+|tubemq.session.key |N | inlong-sort | session key used when subscribing to
tubemq |
|tubemq.bootstrap.from.max | N | false | whether consume from max or not when
subscribing to tubemq |
|tubemq.message.not.found.wait.period | N | 350ms | The time of waiting period
if tube broker return message not found |
|tubemq.subscribe.retry.timeout | N | 300000 | The time of subscribing tube
timeout, in millisecond |
diff --git a/docs/modules/tubemq/tubemq-manager/quick_start.md
b/docs/modules/tubemq/tubemq-manager/quick_start.md
index 66b495a..e435473 100644
--- a/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -2,10 +2,9 @@
title: Deployment
---
-## 1 Deploy TubeMQ Manager
All deploying files at `inlong-tubemq-manager` directory.
-### 1.1 configuration
+## Configuration
- create `tubemanager` and account in MySQL.
- Add mysql information in conf/application.properties:
@@ -16,13 +15,13 @@ spring.datasource.username=mysql_username
spring.datasource.password=mysql_password
```
-### 1.2 start service
+## Start
``` bash
$ bin/start-manager.sh
```
-### 1.3 register TubeMQ cluster
+## Register TubeMQ cluster
vim bin/init-tube-cluster.sh
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
index de5b9af..2bfb4db 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
@@ -1,11 +1,12 @@
---
title: 安装部署
---
-## 1 部署 DataProxy
所有的安装文件都在 `inlong-dataproxy` 目录下。
-### 1.1 配置tube地址和端口号
+## 配置
+
+### 配置TubeMQ 地址和端口号
`tubemq_master_list`是TubeMQ master rpc地址，多个逗号分隔。
```
@@ -14,13 +15,13 @@ $ sed -i 's/TUBE_LIST/tubemq_master_list/g' conf/flume.conf
注意conf/flume.conf中FLUME_HOME为proxy的中间数据文件存放地址
-### 1.2 环境准备
+### 环境准备
```
sh prepare_env.sh
```
-### 1.3 配置manager地址
+### 配置InLong-Manager 地址
配置文件：`conf/common.properties`:
```
@@ -28,19 +29,19 @@ sh prepare_env.sh
manager_hosts=ip:port
```
-## 2 启动
+## 启动
```
sh bin/start.sh
```
-## 3 检查启动状态
+## 检查
```
telnet 127.0.0.1 46801
```
-## 4 将 DataProxy 配置添加到 InLong-Manager
+## 将 DataProxy 配置添加到 InLong-Manager
安装完 DataProxy 后，需要将 DataProxy 所在主机的 IP 插入到 InLong-Manager 的后台数据库中。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
index 46fc560..000978c 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
@@ -3,34 +3,31 @@ title: 安装部署
sidebar_position: 2
---
-## 1 配置flink运行环境
-当前inlong-sort是基于flink的一个应用，因此运行inlong-sort应用前，需要准备好flink环境。
-
-[如何配置flink环境](https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/cluster_setup.html
"how to set up flink environment")
+## 配置flink运行环境
+当前inlong-sort是基于flink的一个应用，因此运行inlong-sort应用前，需要准备好[flink
环境](https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/cluster_setup.html)。
由于当前inlong-sort依赖的是flink1.9.3版本，因此在下载部署包时，请选择`flink-1.9.3-bin-scala_2.11.tgz`
flink环境配置完成后，可以通过浏览器访问flink的web ui，对应的地址是`/{flink部署路径}/conf/masters`文件中的地址
-## 2 准备安装文件
+## 准备安装文件
安装文件在`inlong-sort`目录。
-## 3 启动inlong-sort应用
-有了上述编译阶段产出的jar包后，就可以启动inlong-sort的应用了。
-
-[如何提交flink作业](https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/yarn_setup.html#submit-job-to-flink
"如何提交flink作业")
+## 启动inlong-sort应用
+有了上述编译阶段产出的jar包后，就可以启动inlong-sort的应用了。提交方式可以参考[如何提交flink作业](https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/yarn_setup.html#submit-job-to-flink)。
示例：
-
-- `./bin/flink run -c org.apache.inlong.sort.flink.Entrance
inlong-sort-core-1.0-SNAPSHOT.jar --cluster-id my_application
--zookeeper.quorum 127.0.0.1:2181 --zookeeper.path.root /inlong-sort
--source.type tubemq --sink.type hive`
+```
+$ ./bin/flink run -c org.apache.inlong.sort.flink.Entrance
inlong-sort-core-[version].jar --cluster-id my_application --zookeeper.quorum
127.0.0.1:2181 --zookeeper.path.root /inlong-sort --source.type tubemq
--sink.type hive
+```
注意：
- `-c org.apache.inlong.sort.flink.Entrance` 表示main class name
-- `inlong-sort-core-1.0-SNAPSHOT.jar` 为编译阶段产出的jar包
+- `inlong-sort-core-[version].jar` 为编译阶段产出的jar包
-## 4 必要的配置
+## 必要的配置
- `--cluster-id ` 用来唯一标识一个inlong-sort作业
- `--zookeeper.quorum` zk quorum
- `--zookeeper.path.root` zk根目录
@@ -38,22 +35,23 @@ flink环境配置完成后，可以通过浏览器访问flink的web ui，对应
- `--sink.type` 存储系统的种类，当前支持："clickhouse"、"hive"
**配置示例**
+```
+--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181
--zookeeper.path.root /zk_root --source.type tubemq --sink.type hive
+```
-`--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181
--zookeeper.path.root /zk_root --source.type tubemq --sink.type hive`
-
-## 5 所有支持的配置
+## 所有支持的配置
| 配置名 | 是否必须 | 默认值 |描述 |
| ------------ | ------------ | ------------ | ------------ |
|cluster-id | Y | NA | 用来唯一标识一个inlong-sort作业 |
|zookeeper.quorum | Y | NA | zk quorum |
-|zookeeper.path.root | Y | "/inlong-sort" | zk根目录 |
+|zookeeper.path.root | Y | /inlong-sort | zk根目录 |
|source.type | Y | NA | 数据源的种类, 当前支持"tubemq"和"pulsar" |
|sink.type | Y | NA | 存储系统的种类，当前支持"clickhouse" 和 "hive" |
|source.parallelism | N | 1 | source的并行度 |
|deserialization.parallelism | N | 1 | deserialization的并行度 |
|sink.parallelism | N | 1 | sink的并行度 |
|tubemq.master.address | N | NA | 订阅tube的master address，优先级低于zk上的元数据 |
-|tubemq.session.key | N |"inlong-sort" | 订阅tube使用的session key前缀 |
+|tubemq.session.key | N | inlong-sort | 订阅tube使用的session key前缀 |
|tubemq.bootstrap.from.max | N | false | 是否从最大位置开始消费tube |
|tubemq.message.not.found.wait.period | N | 350ms | tube返回message not
found后的等待时间 |
|tubemq.subscribe.retry.timeout | N | 300000 | 订阅tube的重试超时时间，单位为ms |
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md
index 7eee8c8..9fc092e 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq-manager/quick_start.md
@@ -2,10 +2,9 @@
title: 安装部署
---
-## 1 部署TubeMQ Manager
安装文件在inlong-tubemq-manager目录.
-### 1.1 配置
+## 配置
- 在mysql中创建`tubemanager`数据和相应用户.
- 在conf/application.properties中添加mysql信息：
@@ -16,13 +15,13 @@ spring.datasource.username=mysql_username
spring.datasource.password=mysql_password
```
-### 1.2 启动服务
+## 启动
``` bash
$ bin/start-manager.sh
```
-### 1.3 初始化TubeMQ集群
+## 初始化TubeMQ集群
vim bin/init-tube-cluster.sh
