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 2021/12/20 12:08:33 UTC
[incubator-inlong-website] branch master updated: [INLONG-2040] make the deployment guide more readable (#232)

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 8c4f187  [INLONG-2040] make the deployment guide more readable (#232)
8c4f187 is described below

commit 8c4f187f8d113146c1eb4aa9e974f45c0aa86e54
Author: dockerzhang <do...@apache.org>
AuthorDate: Mon Dec 20 20:08:26 2021 +0800

    [INLONG-2040] make the deployment guide more readable (#232)
---
 docs/deployment/bare_metal.md                      | 43 +++++++--------------
 docs/design_and_concept/basic_concept.md           |  2 +-
 docs/quick_start/pulsar_example.md                 | 12 +++---
 .../current/deployment/bare_metal.md               | 45 +++++++---------------
 4 files changed, 34 insertions(+), 68 deletions(-)

diff --git a/docs/deployment/bare_metal.md b/docs/deployment/bare_metal.md
index 9dac34c..89e48f3 100644
--- a/docs/deployment/bare_metal.md
+++ b/docs/deployment/bare_metal.md
@@ -9,33 +9,16 @@ sidebar_position: 4
 - Flink 1.9.x
 - Apache Pulsar 2.6+ (Optional)
 
-## Deploy InLong TubeMQ Server (Optional)
-If you use Apache Pulsar, you don’t need to install this component.
-
-[deploy InLong TubeMQ Server](modules/tubemq/quick_start.md)
-
-## Deploy InLong TubeMQ Manager (Optional)
-If you use Apache Pulsar, you don’t need to install this component.
-
-[deploy InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
-
-## Deploy InLong Manager
-[deploy InLong Manager](modules/manager/quick_start.md)
-
-## Deploy InLong WebSite
-[deploy InLong WebSite](modules/website/quick_start.md)
-
-## Deploy InLong Sort
-[deploy InLong Sort](modules/sort/quick_start.md)
-
-## Deploy InLong DataProxy
-[deploy InLong DataProxy](modules/dataproxy/quick_start.md)
-
-## Deploy InLong Agent
-[deploy InLong Agent](modules/agent/quick_start.md)
-
-## Business configuration
-[How to configure a new business](user_guide/user_manual.md)
-
-## Data report verification
-At this stage, you can collect data through the file agent and verify whether the received data is consistent with the sent data in the specified Hive table.
\ No newline at end of file
+## Deploy InLong
+| order |  component | dependencies | deploy guide | description |
+|  ----  | ----  | ----  | ----  | ---- |
+| 1 | inlong-tubemq-server | ZooKeeper | [InLong TubeMQ Server](modules/tubemq/quick_start.md) | If you use Apache Pulsar, you don’t need to install this component. |
+| 2 | inlong-tubemq-manager | MySQL | [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md) | If you use Apache Pulsar, you don’t need to install this component. |
+| 3 | inlong-manager | MySQL, ZooKeeper  | [InLong Manager](modules/manager/quick_start.md) |  |
+| 4 | inlong-website | Nginx or Docker | [InLong WebSite](modules/website/quick_start.md) | |
+| 5 | inlong-dataproxy |  | [InLong DataProxy](modules/dataproxy/quick_start.md) |  |
+| 6 | inlong-sort | ZooKeeper, Flink | [InLong Sort](modules/sort/quick_start.md) |  |
+| 7 | inlong-agent |  | [InLong Agent](modules/agent/quick_start.md) |  |
+
+## Create Data Stream
+After the InLong cluster deployed successfully, you can create a data stream refer to the [user manual](user_guide/user_manual.md) to start using.
\ No newline at end of file
diff --git a/docs/design_and_concept/basic_concept.md b/docs/design_and_concept/basic_concept.md
index 871c9c1..888ea0e 100644
--- a/docs/design_and_concept/basic_concept.md
+++ b/docs/design_and_concept/basic_concept.md
@@ -5,7 +5,7 @@ sidebar_position: 1
 
 | Name |  Description | Other |
 |  ----  | ----  | ----  |
-| Group | Data Streams Group, it contains multiple data streams, and one Group represents one data access. |  Group has attributes such as ID and Name.  |
+| Group | Data Streams Group, it contains multiple data streams, and one Group represents one data ingestion. |  Group has attributes such as ID and Name.  |
 | Stream | Data Stream, a stream has a specific flow direction. | Stream has attributes such as ID, Name, and data fields.  |
 | Agent | Represents various collection capabilities. | It contains File Agent, SQL Agent, Binlog Agent, etc. |
 | DataProxy | Forward received data to different message queues. |  Supports data transmission blocking, placing retransmission. |
diff --git a/docs/quick_start/pulsar_example.md b/docs/quick_start/pulsar_example.md
index 864c9c8..3ecd263 100644
--- a/docs/quick_start/pulsar_example.md
+++ b/docs/quick_start/pulsar_example.md
@@ -3,7 +3,7 @@ title: Pulsar Example
 sidebar_position: 2
 ---
 
-Apache InLong has increased the ability to access data through Apache Pulsar, taking full advantage of Pulsar's technical advantages that are different from other MQ, and providing complete solutions for data access scenarios with higher data quality requirements such as finance and billing.
+Apache InLong has increased the ability to access data through Apache Pulsar, taking full advantage of Pulsar's technical advantages that are different from other MQ, and providing complete solutions for data ingestion scenarios with higher data quality requirements such as finance and billing.
 In the following content, we will use a complete example to introduce Apache Pulsar to access data through Apache InLong.
 
 ![Create Group](img/pulsar-arch.png)
@@ -32,10 +32,10 @@ pulsar.serviceUrl=pulsar://127.0.0.1:6650,127.0.0.1:6650,127.0.0.1:6650
 pulsar.defaultTenant=public
 ```
 
-## Create a data access
+## Create a data ingestion
 ### Configure data streams group information
 ![](img/pulsar-group.png)
-When creating data access, the message middleware that the data stream group can use is Pulsar, 
+When creating data ingestion, the message middleware that the data stream group can use is Pulsar, 
 and other configuration items related to Pulsar include:
 - Queue module: Parallel or Serial, when selecting parallel, you can set the number of topic partitions
 - Write quorum: Number of copies to store for each message
@@ -55,14 +55,14 @@ When configuring the message source, the file path in the file data source can b
 Save Hive cluster information, click "Ok" to submit.
 ![](img/pulsar-hive.png)
 
-## Data access Approval
-Enter **Approval** page, click **My Approval**, abd approve the data access application. After the approval is over, 
+## Data ingestion Approval
+Enter **Approval** page, click **My Approval**, abd approve the data ingestion application. After the approval is over, 
 the topics and subscriptions required for the data stream will be created in the Pulsar cluster synchronously.
 We can use the command-line tool in the Pulsar cluster to check whether the topic is created successfully:
 ![](img/pulsar-topic.png)
 
 ## Configure File Agent
-When configuring the file agent, you must create the file in the directory specified when creating the data access:
+When configuring the file agent, you must create the file in the directory specified when creating the data ingestion:
 ```
 touch /data/test_file.txt;
 ```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
index 2ea7c74..557dc30 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
@@ -3,40 +3,23 @@ title: Bare Metal 部署
 sidebar_position: 4
 ---
 
-## 3 环境要求
+## 环境要求
 - ZooKeeper 3.5+
 - MySQL 5.7+
 - Flink 1.9.x
 - Apache Pulsar 2.6+ (可选)
 
-## 部署InLong TubeMQ Server (可选)
-如果使用Apache Pulsar，可不安装该组件。
-
-[部署InLong TubeMQ Server](modules/tubemq/quick_start.md)
-
-## 部署InLong TubeMQ Manager (可选)
-如果使用Apache Pulsar，可不安装该组件。
-
-[部署InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
-
-## 部署InLong Manager
-[部署InLong Manager](modules/manager/quick_start.md)
-
-## 部署InLong WebSite
-[部署InLong WebSite](modules/website/quick_start.md)
-
-## 部署InLong Sort
-[部署InLong Sort](modules/sort/quick_start.md)
-
-## 部署InLong DataProxy
-[部署InLong DataProxy](modules/dataproxy/quick_start.md)
-
-## 部署InLong Agent
-[部署InLong Agent](modules/agent/quick_start.md)
-
-## 业务配置
-[配置新业务](user_guide/user_manual.md)
-
-## 数据上报验证
-到这里，您就可以通过文件Agent采集数据并在指定的Hive表中验证接收到的数据是否与发送的数据一致。
+## 安装InLong
+| 顺序 |  组件 | 第三方依赖 | 部署指引 | 说明 |
+|  ----  | ----  | ----  | ----  | ---- |
+| 1 | inlong-tubemq-server | ZooKeeper | [InLong TubeMQ Server](modules/tubemq/quick_start.md) | 若使用Apache Pulsar，可不安装该组件 |
+| 2 | inlong-tubemq-manager | MySQL | [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md) | 若使用Apache Pulsar，可不安装该组件 |
+| 3 | inlong-manager | MySQL, ZooKeeper  | [InLong Manager](modules/manager/quick_start.md) |  |
+| 4 | inlong-website | Nginx 或者 Docker | [InLong WebSite](modules/website/quick_start.md) | |
+| 5 | inlong-dataproxy | 无 | [InLong DataProxy](modules/dataproxy/quick_start.md) |  |
+| 6 | inlong-sort | ZooKeeper, Flink | [InLong Sort](modules/sort/quick_start.md) |  |
+| 7 | inlong-agent | 无 | [InLong Agent](modules/agent/quick_start.md) |  |
+
+## 创建数据流
+InLong 集群部署成功后，你可以参考[用户手册](user_guide/user_manual.md)创建一个数据流开始使用。