You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by he...@apache.org on 2022/06/17 03:09:38 UTC
[incubator-inlong-website] branch master updated: [INLONG-419][Manager] Update cluster register operation document (#420)
This is an automated email from the ASF dual-hosted git repository.
healchow 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 a028727d0 [INLONG-419][Manager] Update cluster register operation document (#420)
a028727d0 is described below
commit a028727d07b450e62a941ea1faa6f5d1be266419
Author: healzhou <he...@gmail.com>
AuthorDate: Fri Jun 17 11:09:31 2022 +0800
[INLONG-419][Manager] Update cluster register operation document (#420)
---
docs/deployment/docker.md | 61 ++++++++-------
docs/deployment/img/dp_cluster.png | Bin 0 -> 50574 bytes
docs/deployment/img/dp_cluster_node.png | Bin 0 -> 48235 bytes
docs/deployment/img/dp_cluster_node_save.png | Bin 0 -> 41826 bytes
docs/deployment/img/pulsar_cluster_save.png | Bin 0 -> 35208 bytes
docs/modules/dataproxy/img/dp_cluster.png | Bin 0 -> 50574 bytes
docs/modules/dataproxy/img/dp_cluster_node.png | Bin 0 -> 48235 bytes
.../modules/dataproxy/img/dp_cluster_node_save.png | Bin 0 -> 41826 bytes
docs/modules/dataproxy/quick_start.md | 39 +++++-----
docs/modules/manager/img/pulsar_cluster.png | Bin 0 -> 49524 bytes
docs/modules/manager/img/pulsar_cluster_save.png | Bin 0 -> 35208 bytes
docs/modules/manager/img/tube_cluster_save.png | Bin 0 -> 24969 bytes
docs/modules/manager/overview.md | 28 ++++---
docs/modules/manager/quick_start.md | 85 ++++++++++-----------
.../current/deployment/docker.md | 69 +++++++++--------
.../current/deployment/img/dp_cluster_cn.png | Bin 0 -> 42230 bytes
.../current/deployment/img/dp_cluster_node_cn.png | Bin 0 -> 50501 bytes
.../deployment/img/dp_cluster_node_save_cn.png | Bin 0 -> 45334 bytes
.../current/deployment/img/pulsar_cluster_cn.png | Bin 0 -> 41978 bytes
.../deployment/img/pulsar_cluster_save_cn.png | Bin 0 -> 36738 bytes
.../modules/dataproxy/img/dp_cluster_cn.png | Bin 0 -> 42230 bytes
.../modules/dataproxy/img/dp_cluster_node_cn.png | Bin 0 -> 50501 bytes
.../dataproxy/img/dp_cluster_node_save_cn.png | Bin 0 -> 45334 bytes
.../current/modules/dataproxy/quick_start.md | 48 ++++++------
.../modules/manager/img/pulsar_cluster_cn.png | Bin 0 -> 41978 bytes
.../modules/manager/img/pulsar_cluster_save_cn.png | Bin 0 -> 36738 bytes
.../modules/manager/img/tube_cluster_save_cn.png | Bin 0 -> 25719 bytes
.../current/modules/manager/overview.md | 21 ++---
.../current/modules/manager/quick_start.md | 82 +++++++++-----------
.../version-1.1.0/modules/dataproxy/quick_start.md | 6 +-
.../version-1.1.0/modules/dataproxy/quick_start.md | 6 +-
31 files changed, 222 insertions(+), 223 deletions(-)
diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md
index 921980f75..42640f07a 100644
--- a/docs/deployment/docker.md
+++ b/docs/deployment/docker.md
@@ -5,7 +5,7 @@ sidebar_position: 2
Deploy all InLong module by Docker Compose, it's only available for development.
-*Notice: The default message queue services is Apache Pulsar for Docker.*
+*Notice: The default message queue is Apache Pulsar for Docker.*
Requirements:
@@ -13,9 +13,11 @@ Requirements:
- Docker Compose 1.29.2+
## Build
-you can refer to [How to Build](quick_start/how_to_build.md).
+
+You can refer to [How to Build](quick_start/how_to_build.md).
## Deploy
+
Start all components.
```shell
@@ -23,36 +25,33 @@ cd docker/docker-compose
docker-compose up -d
```
-## Register Component
-- DataProxy
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "default_dataproxy",
- "type": "DATA_PROXY",
- "ip": "dataproxy",
- "port": 46801,
- "mqSetName": "default_set_name",
- "inCharges": "admin",
- "creator": "admin"
-}
-'
-```
+## Register Cluster
-- Pulsar
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "pulsar_cluster",
- "type": "PULSAR",
- "url": "pulsar://pulsar:6650",
- "token": "null",
- "mqSetName": "default_set_name",
- "extParams": "{\"pulsar_adminUrl\": \"http://pulsar:8080\"}",
- "inCharges": "admin",
- "creator": "admin"
-}'
-```
+### DataProxy Cluster
+
+Open the Inlong-Dashboard page (the default is <http://127.0.0.1>), and select to add a DataProxy cluster on the [Clusters] tab:
+
+
+
+Click the [Create] button, and fill in the cluster name, cluster label, and responsible person in the pop-up box to save.
+
+> Note: [Cluster Tag] is a logical concept. Tags with the same name will be regarded as the same cluster.
+>
+> For example, the DataProxy cluster and the Pulsar cluster with the same cluster tag belong to the same cluster.
+
+Then add nodes to this DataProxy cluster - a DataProxy cluster can support adding multiple nodes:
+
+
+
+Just fill in the IP and port of the DataProxy node.
+
+
+
+### Pulsar Cluster
+
+Similar to the above entry for adding a DataProxy cluster, the filling example is as follows:
+
+
## Usage
diff --git a/docs/deployment/img/dp_cluster.png b/docs/deployment/img/dp_cluster.png
new file mode 100644
index 000000000..fc0fdf2e8
Binary files /dev/null and b/docs/deployment/img/dp_cluster.png differ
diff --git a/docs/deployment/img/dp_cluster_node.png b/docs/deployment/img/dp_cluster_node.png
new file mode 100644
index 000000000..cd15287d6
Binary files /dev/null and b/docs/deployment/img/dp_cluster_node.png differ
diff --git a/docs/deployment/img/dp_cluster_node_save.png b/docs/deployment/img/dp_cluster_node_save.png
new file mode 100644
index 000000000..5cb973e6d
Binary files /dev/null and b/docs/deployment/img/dp_cluster_node_save.png differ
diff --git a/docs/deployment/img/pulsar_cluster_save.png b/docs/deployment/img/pulsar_cluster_save.png
new file mode 100644
index 000000000..d27583767
Binary files /dev/null and b/docs/deployment/img/pulsar_cluster_save.png differ
diff --git a/docs/modules/dataproxy/img/dp_cluster.png b/docs/modules/dataproxy/img/dp_cluster.png
new file mode 100644
index 000000000..fc0fdf2e8
Binary files /dev/null and b/docs/modules/dataproxy/img/dp_cluster.png differ
diff --git a/docs/modules/dataproxy/img/dp_cluster_node.png b/docs/modules/dataproxy/img/dp_cluster_node.png
new file mode 100644
index 000000000..cd15287d6
Binary files /dev/null and b/docs/modules/dataproxy/img/dp_cluster_node.png differ
diff --git a/docs/modules/dataproxy/img/dp_cluster_node_save.png b/docs/modules/dataproxy/img/dp_cluster_node_save.png
new file mode 100644
index 000000000..5cb973e6d
Binary files /dev/null and b/docs/modules/dataproxy/img/dp_cluster_node_save.png differ
diff --git a/docs/modules/dataproxy/quick_start.md b/docs/modules/dataproxy/quick_start.md
index 625d1ecbf..5c96281ac 100644
--- a/docs/modules/dataproxy/quick_start.md
+++ b/docs/modules/dataproxy/quick_start.md
@@ -18,11 +18,11 @@ audit.proxys=127.0.0.1:10081
## run
```
-#By default, pulsar is used as the message middleware, and the dataproxy-pulsar.conf configuration file is loaded.
+# Default using Pulsar to cache data, and the dataproxy-pulsar.conf configuration file is loaded.
bash +x bin/dataproxy-start.sh
-or
+# or
bash +x bin/dataproxy-start.sh pulsar
-# If using Inlong TubeMQ
+# If using Inlong TubeMQ to cache data
# bash +x bin/dataproxy-start.sh tube
```
@@ -35,20 +35,21 @@ telnet 127.0.0.1 46801
## Add DataProxy configuration to InLong-Manager
After installing the DataProxy, you need to add the IP of the DataProxy service into the InLong-Manager.
-Modify the following information and execute command:
-```bash
-curl --header "Content-Type: application/json" --request POST http://your_manager_host:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "default_dataproxy",
- "type": "DATA_PROXY",
- "ip": "your_dataproxy_ip",
- "port": 46801,
- "mqSetName": "default_set_name",
- "inCharges": "admin",
- "creator": "admin"
-}
-'
-```
-- Please modify the `ip` field to the real IP (or hostname) of the DataProxy, the format is `node1:port1,node2:port2`, and separate them with `,`.
-- If all nodes in the `ip` field have the same port, you can use `node1,node2` and modify the `port` field to the default port for those nodes.
\ No newline at end of file
+Open the Inlong-Dashboard page (the default is <http://127.0.0.1>), and select to add a DataProxy cluster on the [Clusters] tab:
+
+
+
+Click the [Create] button, and fill in the cluster name, cluster label, and responsible person in the pop-up box to save.
+
+> Note: [Cluster Tag] is a logical concept. Tags with the same name will be regarded as the same cluster.
+>
+> For example, the DataProxy cluster and the Pulsar cluster with the same cluster tag belong to the same cluster.
+
+Then add nodes to this DataProxy cluster - a DataProxy cluster can support adding multiple nodes:
+
+
+
+Just fill in the IP and port of the DataProxy node.
+
+
diff --git a/docs/modules/manager/img/pulsar_cluster.png b/docs/modules/manager/img/pulsar_cluster.png
new file mode 100644
index 000000000..57a682eeb
Binary files /dev/null and b/docs/modules/manager/img/pulsar_cluster.png differ
diff --git a/docs/modules/manager/img/pulsar_cluster_save.png b/docs/modules/manager/img/pulsar_cluster_save.png
new file mode 100644
index 000000000..d27583767
Binary files /dev/null and b/docs/modules/manager/img/pulsar_cluster_save.png differ
diff --git a/docs/modules/manager/img/tube_cluster_save.png b/docs/modules/manager/img/tube_cluster_save.png
new file mode 100644
index 000000000..ceeaabb1c
Binary files /dev/null and b/docs/modules/manager/img/tube_cluster_save.png differ
diff --git a/docs/modules/manager/overview.md b/docs/modules/manager/overview.md
index c6c243ed0..519c408f7 100644
--- a/docs/modules/manager/overview.md
+++ b/docs/modules/manager/overview.md
@@ -4,11 +4,12 @@ title: Overview
## 1 Introduction to Apache InLong Manager
-+ Target positioning: Apache inlong is positioned as a one-stop integration framework for massive data, providing complete coverage of big data access scenarios from data collection, transmission, sorting, and technical capabilities.
+- Target positioning: Apache InLong is positioned as a one-stop mass data integration framework, providing technical capabilities for big data from collection -> transmission -> sorting -> landing.
-+ Platform value: Users can complete task configuration, management, and indicator monitoring through the platform's built-in management and configuration platform. At the same time, the platform provides SPI extension points in the main links of the process to implement custom logic as needed. Ensure stable and efficient functions while lowering the threshold for platform use.
+- Platform value: Users can complete task configuration, management and indicator monitoring through the management and configuration platform in the platform, and at the same time, through the plug-in expansion capability provided by the platform, they can realize customized expansion on demand.
+
+- InLong Manager is a unified management platform for the Apache InLong project. The platform provides maintenance portals for various basic configurations (such as data flow configuration, consumption configuration, cluster management, etc.). Users can create data collection tasks and view indicator data.
-+ Apache InLong Manager is the user-oriented unified UI of the entire data access platform. After the user logs in, it will provide different function permissions and data permissions according to the corresponding role. The page provides maintenance portals for the platform's basic clusters (such as mq, sorting), and you can view basic maintenance information and capacity planning adjustments at any time. At the same time, business users can complete the creation, modification and maint [...]
## 2 Architecture
@@ -16,17 +17,20 @@ title: Overview
## 3 Module division of labor
-| Module | Responsibilities |
-| :----| :---- |
-| 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 |
+| Modules | Responsibilities |
+| :---------| :--------------- |
+| manager-common | Module common code, such as exception definition, tool class, enumeration, etc. |
+| manager-dao | database operations |
+| manager-service | business logic layer |
+| manager-workflow | Workflow Services |
+| manager-plugins | Sort plugin service |
+| manager-web | Front-end interactive interface layer |
+| manager-client | Client Services |
+| manager-client-examples | Client usage examples |
+| manager-client-tools | Client command line tools |
## 4 use process
-
## 5 data model
-
\ No newline at end of file
+
diff --git a/docs/modules/manager/quick_start.md b/docs/modules/manager/quick_start.md
index 4b69772d8..2cdaf0fd6 100644
--- a/docs/modules/manager/quick_start.md
+++ b/docs/modules/manager/quick_start.md
@@ -3,6 +3,7 @@ title: Deployment
---
## Environment Requirements
+
- Install and start MySQL 5.7+
- initialize database
there is `sql/apache_inlong_manager.sql` in `inlong-manager` directory, load this file through the
@@ -13,11 +14,12 @@ title: Deployment
mysql -uDB_USER -pDB_PASSWD < sql/apache_inlong_manager.sql
```
-## Dependencies
-- If the backend database is MySQL, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar) and put it into `lib/` directory.
-- If the backend database is PostgreSQL, there's no need for additional dependencies.
+## Add Dependencies
+
+- If using MySQL database, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector- java-8.0.27.jar) and put it in the `lib/` directory.
+- If you use PostgreSQL database, you don't need to download additional dependencies.
-## Configuration
+## Update Configuration
Go to the decompressed `inlong-manager` directory and modify the `conf/application.properties` file:
@@ -30,67 +32,60 @@ spring.profiles.active=dev
```
The dev configuration is specified above, then modify the `conf/application-dev.properties` file:
+> If test or prod is specified, modify the corresponding application-xxx.properties file.
+
```properties
spring.datasource.druid.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.druid.username=root
spring.datasource.druid.password=inlong
```
-## Flink Plugin
-InLong support to start a Sort task by Manager, you need to configure a Flink environment in the `plugins/flink-sort-plugin.properties`.
+## Configure the Flink Plugin
+
+The InLong Manager can start the Sort task, you need to configure the Flink environment first. The configuration file is `plugins/flink-sort-plugin.properties`.
+
```properties
# Flink host split by coma if more than one host, such as 'host1,host2'
flink.rest.address=127.0.0.1
# Flink port
flink.rest.port=8081
-# Flink jobmanager port
+# Flink job manager port
flink.jobmanager.port=6123
# InLong Audit Proxy Address
metrics.audit.proxy.hosts=127.0.0.1:10081
```
-## Start
+## Start Application
+
```shell
bash +x bin/startup.sh
```
-## Register Message Queue
-- If using InLong TubeMQ, the register command is:
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "tube_cluster",
- "type": "TUBE",
- "mqSetName": "default_set_name",
- "extParams": "{\"tube.manager.url\": \"127.0.0.1:8080\", \"tube.master.url\": \"127.0.0.1:8715\", \"tube.cluster.id\": \"1\"}",
- "inCharges": "admin",
- "creator": "admin"
-}'
-```
+## Register MQ Cluster
-- `extParams`: the other info of your cluster. It is described in JSON format, for example:
-```json
-{
- "tube.manager.url": "http://127.0.0.1:8080",
- "tube.master.url": "127.0.0.1:8715",
- "tube.cluster.id": "1"
-}
-```
+### Pulsar Cluster
-- If using Pulsar, the register command is:
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "pulsar_cluster",
- "type": "PULSAR",
- "url": "pulsar://pulsar:6650",
- "token": "null",
- "mqSetName": "default_set_name",
- "extParams": "{\"pulsar_adminUrl\": \"http://pulsar:8080\"}",
- "inCharges": "admin",
- "creator": "admin"
-}'
-```
+If you use Pulsar as the message queue for data cache, you need to add its configuration to InLong-Manager:
+
+Open the Inlong-Dashboard page (the default is <http://127.0.0.1>), and select to add a Pulsar cluster on the [Clusters] tab:
+
+
+
+Click the [Create] button, and fill in the required information such as cluster name, cluster tag, responsible person, AdminUrl, ServiceUrl and default tenant in the pop-up box to save.
+
+> Note: [Cluster Tag] is a logical concept. Tags with the same name will be regarded as the same cluster.
+>
+> For example, the DataProxy cluster and the Pulsar cluster with the same cluster tag belong to the same cluster.
+
+Fill in the example:
+
+
+
+### TubeMQ Cluster
+
+If you use InLong TubeMQ as the message queue for data cache, you need to add its configuration to InLong-Manager:
+
+Similar to the above entry for adding a Pulsar cluster, the filling example is as follows:
+
+
-- `url`: the address of your Pulsar cluster, such as `pulsar://127.0.0.1:6650,127.0.0.1:6650,127.0.0.1:6650`
-- `pulsar_adminUrl`: the other info of your cluster
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md
index 0aea2155d..c7f6df626 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md
@@ -3,63 +3,66 @@ title: Docker 部署
sidebar_position: 2
---
-通过Docker Compose部署InLong, 这种部署方式只适用于开发调试，不适用于生产环境.
+通过 Docker Compose 部署 InLong，这种部署方式只适用于开发与调试，不适用于生产环境。
-*注意：Docker 部署默认消息队列服务使用的是 Apache Pulsar*
+*注意：Docker 部署默认使用 Apache Pulsar 作为消息队列服务。*
准备条件:
- [Docker](https://docs.docker.com/engine/install/) 19.03.1+
- Docker Compose 1.29.2+
## 编译
+
可以参考[如何编译](quick_start/how_to_build.md).
## 部署
+
启动所有组件：
```
cd docker/docker-compose
docker-compose up -d
```
-## 注册组件
-- DataProxy
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "default_dataproxy",
- "type": "DATA_PROXY",
- "ip": "dataproxy",
- "port": 46801,
- "mqSetName": "default_set_name",
- "inCharges": "admin",
- "creator": "admin"
-}
-'
-```
+## 注册集群
-- Pulsar
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "pulsar_cluster",
- "type": "PULSAR",
- "url": "pulsar://pulsar:6650",
- "token": "null",
- "mqSetName": "default_set_name",
- "extParams": "{\"pulsar_adminUrl\": \"http://pulsar:8080\"}",
- "inCharges": "admin",
- "creator": "admin"
-}'
-```
+### DataProxy 集群
+
+打开 Inlong-Dashboard 页面（默认是 <http://127.0.0.1>），在 [集群管理] 页签中选择添加 DataProxy 集群：
+
+
+
+点击 [新建集群] 按钮，在弹出的框中填写 集群名称、集群标签、责任人 即可保存。
+
+> 说明：[集群标签] 是一个逻辑概念，同名的标签将被视为同一套集群，比如相同集群标签的 DataProxy 集群和 Pulsar 集群，属于同一套集群。
+
+然后为此 DataProxy 集群添加节点 —— 一个 DataProxy 集群可以支持添加多个节点：
+
+
+
+填写 DataProxy 节点的 IP 和端口即可。
+
+
+
+### Pulsar 集群
+
+与上述 DataProxy 集群的添加入口相似，填写示例如下：
+
+
+
+填写示例：
+
+
## 使用
-当所有容器都成功启动后，可以访问`http://localhost`，并使用以下默认账号登录:
+
+当所有容器都成功启动后，可以访问 `http://localhost`，并使用以下默认账号登录:
```
User: admin
Password: inlong
```
## 销毁
+
```
docker-compose down
-```
\ No newline at end of file
+```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_cn.png
new file mode 100644
index 000000000..e52e990f7
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_cn.png
new file mode 100644
index 000000000..a69134a4b
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_save_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_save_cn.png
new file mode 100644
index 000000000..44c854498
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_save_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_cn.png
new file mode 100644
index 000000000..b883c47e1
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_save_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_save_cn.png
new file mode 100644
index 000000000..c692b6b76
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_save_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_cn.png
new file mode 100644
index 000000000..e52e990f7
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_node_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_node_cn.png
new file mode 100644
index 000000000..a69134a4b
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_node_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_node_save_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_node_save_cn.png
new file mode 100644
index 000000000..44c854498
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/img/dp_cluster_node_save_cn.png differ
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 47bbb5f83..82e88aafc 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
@@ -6,9 +6,10 @@ title: 安装部署
## 配置
-### 配置InLong-Manager 地址
+### 配置 InLong-Manager 地址
+
+配置文件：`conf/common.properties`：
-配置文件：`conf/common.properties`:
```
# manager 地址
manager.hosts=127.0.0.1:8083
@@ -19,11 +20,11 @@ audit.proxys=127.0.0.1:10081
## 启动
```
-#默认使用 pulsar 作为消息中间件，加载 dataproxy-pulsar.conf 配置文件
+# 默认使用 Pulsar 来缓存数据，加载 dataproxy-pulsar.conf 配置文件
bash +x bin/dataproxy-start.sh
-或者
+# 或者
bash +x bin/dataproxy-start.sh pulsar
-# 如果使用 Inlong TubeMQ
+# 如果使用 Inlong TubeMQ 来缓存数据
# bash +x bin/dataproxy-start.sh tube
```
@@ -33,21 +34,22 @@ bash +x bin/dataproxy-start.sh pulsar
telnet 127.0.0.1 46801
```
-## 将 DataProxy 配置添加到 InLong-Manager
-
-安装完 DataProxy 后，需要将 DataProxy 服务的 IP 添加到 InLong-Manager 中，修改下面的配置信息然后执行命令：
-```bash
-curl --header "Content-Type: application/json" --request POST http://your_manager_host:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "default_dataproxy",
- "type": "DATA_PROXY",
- "ip": "your_dataproxy_ip",
- "port": 46801,
- "mqSetName": "default_set_name",
- "inCharges": "admin",
- "creator": "admin"
-}
-'
-```
-- 请将 `ip` 字段修改为 DataProxy 服务的真实 IP（或 hostname），格式为 `node1:port1,node2:port2`，多个时用 `,` 分隔。
-- 如果 `ip` 字段中所有 node 的端口号都相同，可以使用 `node1,node2`，并将 `port` 字段修改为这些 node 的默认端口号。
\ No newline at end of file
+## 将 DataProxy 注册到 InLong-Manager
+
+安装完 DataProxy 后，需要将 DataProxy 服务的 IP 添加到 InLong-Manager 中。
+
+打开 Inlong-Dashboard 页面（默认是 <http://127.0.0.1>），在 [集群管理] 页签中选择添加 DataProxy 集群：
+
+
+
+点击 [新建集群] 按钮，在弹出的框中填写 集群名称、集群标签、责任人 即可保存。
+
+> 说明：[集群标签] 是一个逻辑概念，同名的标签将被视为同一套集群，比如相同集群标签的 DataProxy 集群和 Pulsar 集群，属于同一套集群。
+
+然后为此 DataProxy 集群添加节点 —— 一个 DataProxy 集群可以支持添加多个节点：
+
+
+
+填写 DataProxy 节点的 IP 和端口即可。
+
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_cn.png
new file mode 100644
index 000000000..b883c47e1
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_save_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_save_cn.png
new file mode 100644
index 000000000..c692b6b76
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_save_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/tube_cluster_save_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/tube_cluster_save_cn.png
new file mode 100644
index 000000000..32007f0d6
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/tube_cluster_save_cn.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/overview.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/overview.md
index cfb43a2a3..34c8d3f0e 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/overview.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/overview.md
@@ -2,32 +2,35 @@
title: 总览
---
-## 1 Apache InLong Manager介绍
+## 1 InLong Manager 介绍
-+ 目标定位：Apache inlong 定位为一站式海量数据集成框架，提供完整覆盖大数据接入场景从数据采集、传输、分拣、落地的技术能力。
+- 目标定位：Apache InLong 定位为一站式海量数据集成框架，提供大数据从采集 -> 传输 -> 分拣 -> 落地的技术能力。
-+ 平台价值：用户可以通过平台中自带的管理、配置平台完成任务的配置、管理、指标监控，同时通过平台在流程中各主要环节提供SPI扩展点按需要实现自定义逻辑。保证功能稳定高效的同时降低平台使用门槛。
+- 平台价值：用户可以通过平台中的管理、配置平台完成任务的配置、管理以及指标的监控，同时通过平台提供的插件化扩展能力，按需实现自定义的扩展。
-+ Apache InLong Manager作为整个数据集成平台面向用户的统一管理入口，用户登录后会根据对应角色提供不同的功能权限以及数据权限。页面提供平台各基础集群（如mq、分拣）维护入口，可随时查看维护基本信息、容量规划调整。同时业务用户可完成数据接入任务的创建、修改维护、指标查看、接入对账等功能。其对应的后台服务在用户创建并启动任务的同时会与底层各模块进行数据交互，将各模块需要执行的任务通过合理的方式下发。起到协调串联后台业务执行流程的作用。
+- InLong Manager 是 Apache InLong 项目的统一管理平台，平台提供各基础配置（如数据流配置、消费配置、集群管理等）的维护入口，用户可创建数据采集任务、查看指标数据等。
## 2 Architecture
-
## 3 模块分工
| 模块 | 职责 |
| :-----| :---- |
-| manager-common | 模块公共代码，入异常定义，工具类，枚举等 |
+| manager-common | 模块公共代码，如异常定义、工具类、枚举等 |
| manager-dao | 数据库操作 |
| manager-service | 业务逻辑层 |
-| manager-web | 前端交互对应接口 |
-| manager-workflow-engine | 工作流引擎|
+| manager-workflow | 工作流服务 |
+| manager-plugins | Sort 插件服务 |
+| manager-web | 前端交互接口层 |
+| manager-client | 客户端服务 |
+| manager-client-examples | 客户端使用示例 |
+| manager-client-tools | 客户端命令行工具 |
## 4 系统使用流程
-
+
## 5 数据模型
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
index 822583613..9a5369b15 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
@@ -3,6 +3,7 @@ title: 安装部署
---
## 环境准备
+
- 安装并启动 MySQL 5.7+
- 初始化数据库
`inlong-manager` 目录下有 `sql/apache_inlong_manager.sql`文件，通过下述命令加载此文件，完成表结构及基础数据的初始化：
@@ -12,11 +13,13 @@ title: 安装部署
mysql -uDB_USER -pDB_PASSWD < sql/apache_inlong_manager.sql
```
-## 依赖
-- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar), 并将其放入 `lib/` 目录。
-- 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
+## 添加依赖（可选）
+
+- 如果使用 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar)，将其放入 `lib/` 目录。
+- 如果使用 PostgreSQL 数据库，则无需额外下载依赖包。
+
+## 修改配置
-## 配置
前往 `inlong-manager` 目录，修改 `conf/application.properties` 文件：
```properties
@@ -28,6 +31,7 @@ spring.profiles.active=dev
```
上面指定了 dev 配置，接下来修改 `conf/application-dev.properties` 文件：
+> 如果指定了 test 或 prod，则修改对应的 application-xxx.properties 文件。
```properties
spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
@@ -35,61 +39,49 @@ spring.datasource.druid.username=root
spring.datasource.druid.password=inlong
```
-## Flink 插件
-InLong 支持 Manager 发起 Sort 任务进行数据分拣，需要先配置 Flink 环境信息。配置文件为`plugins/flink-sort-plugin.properties`.
+## 配置 Flink 插件
+
+InLong Manager 可启动 Sort 任务进行数据的消费和落地，需要先配置 Flink 环境信息。配置文件为 `plugins/flink-sort-plugin.properties`。
+
```properties
# Flink host split by coma if more than one host, such as 'host1,host2'
flink.rest.address=127.0.0.1
# Flink port
flink.rest.port=8081
-# Flink jobmanager port
+# Flink job manager port
flink.jobmanager.port=6123
# InLong Audit Proxy Address
metrics.audit.proxy.hosts=127.0.0.1:10081
```
-## 启动
+## 启动服务
+
```shell
bash +x bin/startup.sh
```
-## 注册消息队列
-- 若使用InLong TubeMQ，注册命令为：
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "tube_cluster",
- "type": "TUBE",
- "mqSetName": "default_set_name",
- "extParams": "{\"tube.manager.url\": \"127.0.0.1:8080\", \"tube.master.url\": \"127.0.0.1:8715\", \"tube.cluster.id\": \"1\"}",
- "inCharges": "admin",
- "creator": "admin"
-}'
-```
+## 注册 MQ 集群
-- `extParams`: 集群配置信息，按照JSON格式设置，比如:
-```json
-{
- "tube.manager.url": "http://127.0.0.1:8080",
- "tube.master.url": "127.0.0.1:8715",
- "tube.cluster.id": "1"
-}
-```
+### Pulsar 集群
-- 若使用Pulsar，注册命令为：
-```bash
-curl --header "Content-Type: application/json" --request POST http://localhost:8083/api/inlong/manager/openapi/cluster/save --data '
-{
- "name": "pulsar_cluster",
- "type": "PULSAR",
- "url": "pulsar://pulsar:6650",
- "token": "null",
- "mqSetName": "default_set_name",
- "extParams": "{\"pulsar_adminUrl\": \"http://pulsar:8080\"}",
- "inCharges": "admin",
- "creator": "admin"
-}'
-```
+若使用 Pulsar 作为数据缓存的消息队列，则需要添加其配置到 InLong-Manager 中：
+
+打开 Inlong-Dashboard 页面（默认是 <http://127.0.0.1>），在 [集群管理] 页签中选择添加 Pulsar 集群：
+
+
+
+点击 [新建集群] 按钮，在弹出的框中填写 集群名称、集群标签、责任人、AdminUrl、ServiceUrl 及默认租户等必填信息即可保存。
+
+> 说明：[集群标签] 是一个逻辑概念，同名的标签将被视为同一套集群，比如相同集群标签的 DataProxy 集群和 Pulsar 集群，属于同一套集群。
+
+填写示例：
+
+
+
+### TubeMQ 集群
+
+若使用 InLong TubeMQ 作为数据缓存的消息队列，则需要添加其配置到 InLong-Manager 中：
+
+与上述 Pulsar 集群的添加入口相似，填写示例如下：
-- `url`为Pulsar集群的地址，形如`pulsar://127.0.0.1:6650,127.0.0.1:6650,127.0.0.1:6650`
-- `pulsar_adminUrl`为其它集群配置信息
\ No newline at end of file
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/modules/dataproxy/quick_start.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/modules/dataproxy/quick_start.md
index 47bbb5f83..e19435b3e 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/modules/dataproxy/quick_start.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/modules/dataproxy/quick_start.md
@@ -19,11 +19,11 @@ audit.proxys=127.0.0.1:10081
## 启动
```
-#默认使用 pulsar 作为消息中间件，加载 dataproxy-pulsar.conf 配置文件
+# 默认使用 Pulsar 来缓存数据，加载 dataproxy-pulsar.conf 配置文件
bash +x bin/dataproxy-start.sh
-或者
+# 或者
bash +x bin/dataproxy-start.sh pulsar
-# 如果使用 Inlong TubeMQ
+# 如果使用 Inlong TubeMQ 来缓存数据
# bash +x bin/dataproxy-start.sh tube
```
diff --git a/versioned_docs/version-1.1.0/modules/dataproxy/quick_start.md b/versioned_docs/version-1.1.0/modules/dataproxy/quick_start.md
index 625d1ecbf..f62f20d4f 100644
--- a/versioned_docs/version-1.1.0/modules/dataproxy/quick_start.md
+++ b/versioned_docs/version-1.1.0/modules/dataproxy/quick_start.md
@@ -18,11 +18,11 @@ audit.proxys=127.0.0.1:10081
## run
```
-#By default, pulsar is used as the message middleware, and the dataproxy-pulsar.conf configuration file is loaded.
+# Default using Pulsar to cache data, and the dataproxy-pulsar.conf configuration file is loaded.
bash +x bin/dataproxy-start.sh
-or
+# or
bash +x bin/dataproxy-start.sh pulsar
-# If using Inlong TubeMQ
+# If using Inlong TubeMQ to cache data
# bash +x bin/dataproxy-start.sh tube
```