You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by gi...@apache.org on 2021/07/20 09:51:16 UTC
[incubator-inlong-website] branch asf-site updated: Automated
deployment: Tue Jul 20 09:51:06 UTC 2021
d4d8e022d7294ea1e07f6b640165dd6bc2af5f4c
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 5b42d79 Automated deployment: Tue Jul 20 09:51:06 UTC 2021 d4d8e022d7294ea1e07f6b640165dd6bc2af5f4c
5b42d79 is described below
commit 5b42d7993bf8631e8a868075818f45eef27dcc34
Author: aloyszhang <al...@users.noreply.github.com>
AuthorDate: Tue Jul 20 09:51:07 2021 +0000
Automated deployment: Tue Jul 20 09:51:06 UTC 2021 d4d8e022d7294ea1e07f6b640165dd6bc2af5f4c
---
docs/en-us/modules/agent/quick_start.md | 34 ++++------
docs/en-us/modules/dataproxy/quick_start.md | 21 ++----
docs/en-us/modules/manager/quick_start.md | 54 +++------------
docs/en-us/modules/sort/quick_start.md | 21 ++----
docs/en-us/modules/tubemq/quick_start.md | 73 ++++----------------
.../modules/tubemq/tubemq-manager/quick_start.md | 41 +++++-------
docs/en-us/modules/website/quick_start.md | 57 +++++-----------
docs/en-us/quick_start.md | 61 ++++++++++++-----
docs/zh-cn/modules/agent/quick_start.md | 34 ++++------
docs/zh-cn/modules/dataproxy/quick_start.md | 20 ++----
docs/zh-cn/modules/manager/quick_start.md | 50 ++++----------
docs/zh-cn/modules/sort/quick_start.md | 23 ++-----
docs/zh-cn/modules/tubemq/quick_start.md | 74 +++++---------------
.../modules/tubemq/tubemq-manager/quick_start.md | 38 +++++------
docs/zh-cn/modules/website/quick_start.md | 58 ++++++----------
docs/zh-cn/quick_start.md | 78 ++++++++++++++--------
en-us/docs/modules/agent/quick_start.html | 28 +++-----
en-us/docs/modules/agent/quick_start.json | 2 +-
en-us/docs/modules/agent/quick_start.md | 34 ++++------
en-us/docs/modules/dataproxy/quick_start.html | 15 ++---
en-us/docs/modules/dataproxy/quick_start.json | 2 +-
en-us/docs/modules/dataproxy/quick_start.md | 21 ++----
en-us/docs/modules/manager/quick_start.html | 58 +++-------------
en-us/docs/modules/manager/quick_start.json | 2 +-
en-us/docs/modules/manager/quick_start.md | 54 +++------------
en-us/docs/modules/sort/quick_start.html | 25 ++-----
en-us/docs/modules/sort/quick_start.json | 2 +-
en-us/docs/modules/sort/quick_start.md | 21 ++----
en-us/docs/modules/tubemq/quick_start.html | 67 ++++---------------
en-us/docs/modules/tubemq/quick_start.json | 2 +-
en-us/docs/modules/tubemq/quick_start.md | 73 ++++----------------
.../modules/tubemq/tubemq-manager/quick_start.html | 33 ++++-----
.../modules/tubemq/tubemq-manager/quick_start.json | 2 +-
.../modules/tubemq/tubemq-manager/quick_start.md | 41 +++++-------
en-us/docs/modules/website/quick_start.html | 39 +++++------
en-us/docs/modules/website/quick_start.json | 2 +-
en-us/docs/modules/website/quick_start.md | 57 +++++-----------
en-us/docs/quick_start.html | 60 ++++++++++++-----
en-us/docs/quick_start.json | 2 +-
en-us/docs/quick_start.md | 61 ++++++++++++-----
zh-cn/docs/modules/agent/quick_start.html | 28 +++-----
zh-cn/docs/modules/agent/quick_start.json | 2 +-
zh-cn/docs/modules/agent/quick_start.md | 34 ++++------
zh-cn/docs/modules/dataproxy/quick_start.html | 15 ++---
zh-cn/docs/modules/dataproxy/quick_start.json | 2 +-
zh-cn/docs/modules/dataproxy/quick_start.md | 20 ++----
zh-cn/docs/modules/manager/quick_start.html | 52 +++------------
zh-cn/docs/modules/manager/quick_start.json | 2 +-
zh-cn/docs/modules/manager/quick_start.md | 50 ++++----------
zh-cn/docs/modules/sort/quick_start.html | 25 ++-----
zh-cn/docs/modules/sort/quick_start.json | 2 +-
zh-cn/docs/modules/sort/quick_start.md | 23 ++-----
zh-cn/docs/modules/tubemq/quick_start.html | 66 ++++--------------
zh-cn/docs/modules/tubemq/quick_start.json | 2 +-
zh-cn/docs/modules/tubemq/quick_start.md | 74 +++++---------------
.../modules/tubemq/tubemq-manager/quick_start.html | 31 ++++-----
.../modules/tubemq/tubemq-manager/quick_start.json | 2 +-
.../modules/tubemq/tubemq-manager/quick_start.md | 38 +++++------
zh-cn/docs/modules/website/quick_start.html | 40 +++++------
zh-cn/docs/modules/website/quick_start.json | 2 +-
zh-cn/docs/modules/website/quick_start.md | 58 ++++++----------
zh-cn/docs/quick_start.html | 62 ++++++++++++-----
zh-cn/docs/quick_start.json | 2 +-
zh-cn/docs/quick_start.md | 78 ++++++++++++++--------
64 files changed, 778 insertions(+), 1372 deletions(-)
diff --git a/docs/en-us/modules/agent/quick_start.md b/docs/en-us/modules/agent/quick_start.md
index a39bf63..baba6a9 100644
--- a/docs/en-us/modules/agent/quick_start.md
+++ b/docs/en-us/modules/agent/quick_start.md
@@ -1,22 +1,12 @@
+## 1、Configuration
+```
+cd inlong-agent
+```
-## 1、install
-
- env requirements：
- java JDK 1.8
- Maven 3.6 +
-
-
- mvn clean package -DskipTests
-
- The tgz installation package can be found in the target under the agent-release
-
-
-
-## 2、Configuration
The agent supports two modes of operation: local operation and online operation
-### 2.1 Agent configuration
+### 1.1 Agent configuration
Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as follows:
```ini
@@ -26,7 +16,7 @@ agent.manager.vip.http.host=manager open api host
agent.manager.vip.http.port=manager open api port
```
-### 2.2 Proxy configuration
+### 1.2 Proxy configuration
Create a new folder named .inlong in the agent directory, and create a new bid+.local file inside. For example, if the sending bid is set to a, then create a new file a.local
write:
@@ -35,7 +25,7 @@ write:
Among them, cluster_id, isInterVisit, and switch are reserved fields, please fill in the default values
```
-### 2.3 local job configuration
+### 1.3 local job configuration
If you do not use the online mode, you can use the local file to create a new read task
Create a new directory jobs in conf,
vim job1.json：
@@ -82,9 +72,9 @@ The meaning of each parameter is ：
- proxy.bid: The bid type used when writing proxy
- proxy.tid: The tid type used when writing proxy
-### 2.4 Add job configuration in real time
+### 1.4 Add job configuration in real time
-#### 2.4.1 agent.propertities Modify the following two places
+#### 1.4.1 agent.propertities Modify the following two places
```ini
# whether enable http service
agent.http.enable=true
@@ -92,7 +82,7 @@ agent.http.enable=true
agent.http.port=Available ports
```
-#### 2.4.2 Execute the following command
+#### 1.4.2 Execute the following command
```bash
curl --location --request POST 'http://localhost:8129/config/job' \
--header 'Content-Type: application/json' \
@@ -123,14 +113,14 @@ agent.http.port=Available ports
}'
```
-## 3、run
+## 2、run
After decompression, run the following command
```bash
sh agent.sh start
```
-## 4、eg for directory config
+## 3、eg for directory config
E.g:
/data/inlong-agent/test.log //Represents reading the new file test.log in the inlong-agent folder
diff --git a/docs/en-us/modules/dataproxy/quick_start.md b/docs/en-us/modules/dataproxy/quick_start.md
index da17b2c..9ecf2a0 100644
--- a/docs/en-us/modules/dataproxy/quick_start.md
+++ b/docs/en-us/modules/dataproxy/quick_start.md
@@ -1,17 +1,6 @@
-## 1、install
+## configuration
- mvn clean package -DskipTests
-
-The tgz installation package apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target
-
-un tar it
-
- tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
-
-## 2、configuration
-
- cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin
+ cd inlong-dataproxy
### config tube
@@ -24,8 +13,6 @@ sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner data
-
-
### Environmental preparation
cd bin
sh prepare_env.sh
@@ -37,9 +24,9 @@ notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner da
cluster_id=1 // cluter id is for future use please write 1
manager_hosts=ip:port // manager open api
-## 3、run
+## run
sh bin/start.sh
-## 4、check
+## check
telnet 127.0.0.1 46801
diff --git a/docs/en-us/modules/manager/quick_start.md b/docs/en-us/modules/manager/quick_start.md
index 9510c06..5871978 100644
--- a/docs/en-us/modules/manager/quick_start.md
+++ b/docs/en-us/modules/manager/quick_start.md
@@ -3,15 +3,6 @@ Quick start-Apache inlong-manager
---
# 1. Environmental preparation
-
-Before starting the installation, please download and install the following software yourself:
-
-- Install and configure JDK (1.8+), Maven (3.3+);
-
-- 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:
@@ -34,32 +25,14 @@ Before starting the installation, please download and install the following soft
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
+# 2. 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.1 Prepare installation files
+All installation files at `inlong-manager-api` directory.
-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
+## 2.2 Modify configuration
Go to the decompressed `manager-api` directory and modify the `conf/application.yml` file:
@@ -101,7 +74,7 @@ The dev configuration is specified above, then modify the `conf/application-dev.
sort.appName: inlong_app # The app name for Sort, default is 'inlong_app'
```
-## 3.3 Start the service
+## 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:
@@ -110,20 +83,15 @@ log `tailf log/manager-api.log`. If a log similar to the following appears, the
Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-# 4. Deploy and start manager-openapi
+# 3. 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
+## 3.1 Prepare installation files
+All installation files at `inlong-manager-openapi` directory.
-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
+## 3.2 Modify configuration
Go to the decompressed `manager-openapi` directory and modify the `conf/application.yml` file:
@@ -165,7 +133,7 @@ The dev configuration is specified above, then modify the `conf/application-dev.
sort.appName: inlong_app # The app name for Sort, default is 'inlong_app'
```
-## 4.3 Start the service
+## 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:
@@ -174,7 +142,7 @@ log `tailf log/manager-openapi.log`. If a log similar to the following appears,
Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
```
-# 5. Service access verification
+# 4. Service access verification
1) Verify the manager-api service:
diff --git a/docs/en-us/modules/sort/quick_start.md b/docs/en-us/modules/sort/quick_start.md
index 9765adc..6205390 100644
--- a/docs/en-us/modules/sort/quick_start.md
+++ b/docs/en-us/modules/sort/quick_start.md
@@ -2,13 +2,7 @@
Quick Start - Apache InLong-sort
---
-# Requirements
-- Java JDK 1.8
-- Maven 3.6+
-- Flink 1.9.3
-- Zookeeper
-
-## 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.
@@ -18,13 +12,10 @@ Currently, inlong-sort relys on flink-1.9.3. Chose `flink-1.9.3-bin-scala_2.11.t
Once your flink environment is set up, you can visit web ui of flink, whose address is stored in `/${your_flink_path}/conf/masters`.
-#Compile inlong-sort
-- `cd /your_path/Inlong/inlong-sort`
-- `mvn clean package`
-
-After running this, you will get `inlong-sort-core-{version}.jar` in `/your_path/Inlong/inlong-sort/core/target`
+## Prepare installation files
+All installation files at `inlong-sort` directory.
-#Starting an inlong-sort application
+## 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>
@@ -39,7 +30,7 @@ Notice：
- `inlong-sort-core-1.0-SNAPSHOT.jar` 为编译阶段产出的jar包
-#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
@@ -54,7 +45,7 @@ Configurations above are necessary, you can see full configurations in
`--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181 --zookeeper.path.root /zk_root --source.type tubemq --sink.type hive`
-#All configurations
+## All configurations
| name | necessary | default value |description |
| ------------ | ------------ | ------------ | ------------ |
|cluster-id | Y | NA | used to represent a specified inlong-sort application |
diff --git a/docs/en-us/modules/tubemq/quick_start.md b/docs/en-us/modules/tubemq/quick_start.md
index 3821050..a6b9f5c 100644
--- a/docs/en-us/modules/tubemq/quick_start.md
+++ b/docs/en-us/modules/tubemq/quick_start.md
@@ -1,53 +1,9 @@
---
title: Quick Start - Apache InLong's TubeMQ module
---
+## 1 Deploy and Start
-## 1 Build TubeMQ
-
-### 1.1 Prerequisites
-- Java JDK 1.8
-- Maven 3.3+
-
-### 1.2 Build Distribution Tarball
-- Compile and Package
-```bash
-mvn clean package -DskipTests
-```
-
-- Run Unit Tests：
-```bash
-mvn test
-```
-
-- Build Individual Module：
-```bash
-mvn clean install
-cd module-name (e.g. tubemq-client)
-mvn test
-```
-
-After the build, please go to `tubemq-server/target`. You can find the
-**apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz** file. It is the TubeMQ deployment package, which includes
-scripts, configuration files, dependency jars and web GUI code.
-
-### 1.3 Setting Up Your IDE
-If you want to build and debug source code in IDE, go to the project root, and run
-```bash
-mvn compile
-```
-This command will generate the Java source files from the `protoc` files, the generated files located in `target/generated-sources`.
-
-(Optional) If you want to use local `protoc` executable, you can change the configuration of `protobuf-maven-plugin` in `tubemq-core/pom.xml` as below
-```xml
-<configuration>
- <outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
- <protocExecutable>/usr/local/bin/protoc</protocExecutable>
-</configuration>
-```
-
-## 2 Deploy and Start
-
-### 2.1 Configuration Example
+### 1.1 Configuration Example
There're two components in the cluster: **Master** and **Broker**. Master and Broker
can be deployed on the same server or different servers. In this example, we setup our cluster
like this, and all services run on the same node. Zookeeper should be setup in your environment also.
@@ -57,13 +13,12 @@ like this, and all services run on the same node. Zookeeper should be setup in y
| Broker | 8123 | 8124 | 8081 | Message is stored at /stage/msg_data |
| Zookeeper | 2181 | | | Offset is stored at /tubemq |
-### 2.2 Prerequisites
+### 1.2 Prerequisites
- ZooKeeper Cluster
-- [apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz](download/download.md) package file
After you extract the package file, here's the folder structure.
```
-/INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin/
+/INSTALL_PATH/inlong-tubemq-server/
├── bin
├── conf
├── lib
@@ -71,7 +26,7 @@ After you extract the package file, here's the folder structure.
└── resources
```
-### 2.3 Configure Master
+### 1.3 Configure Master
You can change configurations in `conf/master.ini` according to cluster information.
- Master IP and Port
```ini
@@ -116,7 +71,7 @@ the introduction of availability level.
**Tips**：Please notice that the master servers should be clock synchronized.
-### 2.4 Configure Broker
+### 1.4 Configure Broker
You can change configurations in `conf/broker.ini` according to cluster information.
- Broker IP and Port
```ini
@@ -143,7 +98,7 @@ zkNodeRoot=/tubemq
zkServerAddr=localhost:2181 // multi zookeeper addresses can separate with ","
```
-### 2.5 Start Master
+### 1.5 Start Master
Please go to the `bin` folder and run this command to start
the master service.
```bash
@@ -155,7 +110,7 @@ web GUI now.
-#### 2.5.1 Configure Broker Metadata
+#### 1.5.1 Configure Broker Metadata
Before we start a broker service, we need to configure it on master web GUI first. Go to the `Broker List` page, click `Add Single Broker`, and input the new broker information.
@@ -169,7 +124,7 @@ Click the online link to activate the new added broker.
-### 2.6 Start Broker
+### 1.6 Start Broker
Please go to the `bin` folder and run this command to start the broker service
```bash
./tubemq.sh broker start
@@ -181,7 +136,7 @@ After the sub-state of the broker changed to `idle`, we can add topics to that b
-## 3 Quick Start
+## 2 Quick Start
### 3.1 Add Topic
We can add or manage the cluster topics on the web GUI. To add a new topic, go to the
topic list page and click the add new topic button
@@ -208,10 +163,10 @@ that the topic publish/subscribe state is active now.
Now we can use the topic to send messages.
-### 3.2 Run Example
+### 2.2 Run Example
Now we can use `demo` topic which created before to test our cluster.
-#### 3.2.1 Produce Messages
+#### 2.2.1 Produce Messages
Please don't forget replace `YOUR_MASTER_IP:port` with your server ip and port, and start producer.
@@ -223,7 +178,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
From the log, we can see the message is sent out.
-#### 3.2.2 Consume Messages
+#### 2.2.2 Consume Messages
Please don't forget replace YOUR_MASTER_IP:port with your server ip and port, and start consumer.
```bash
@@ -234,7 +189,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
From the log, we can see the message received by the consumer.
-## 4 The End
+## 3 The End
Here, the compilation, deployment, system configuration, startup, production and consumption of TubeMQ have been completed. If you need to understand more in-depth content, please check the relevant content in "TubeMQ HTTP API" and make the corresponding configuration settings.
---
diff --git a/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md b/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
index f965707..1a276e2 100644
--- a/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,34 +1,27 @@
-## compile
-
- mvn clean package
-
## deploy
+All deploying files at `inlong-tubemq-manager` directory.
-environment requirements：
-
- mysql
- java(1.8+)
-
-
-In the InLong/inlong-tubemq/tubemq-manager/dist/ directory, you can find the file apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
- tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
+### configuration
Add mysql information in conf/application.properties:
- spring.jpa.hibernate.ddl-auto=update
- # configuration for manager
- spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
- spring.datasource.username=[replace_by_usename]
- spring.datasource.password=[replace_by_password]
- # server port
- server.port=8089
-
+```ini
+spring.jpa.hibernate.ddl-auto=update
+# configuration for manager
+spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
+spring.datasource.username=[replace_by_usename]
+spring.datasource.password=[replace_by_password]
+# server port
+server.port=8089
+```
+
+### start service
Add the database tubemanager and start:
- bin/start-admin.sh
+``` bash
+$ bin/start-admin.sh
+```
-## use
+## usage
### create cluster
diff --git a/docs/en-us/modules/website/quick_start.md b/docs/en-us/modules/website/quick_start.md
index fd75f06..24fe410 100644
--- a/docs/en-us/modules/website/quick_start.md
+++ b/docs/en-us/modules/website/quick_start.md
@@ -1,41 +1,20 @@
## Environment
-You should check that `nodejs >= 12.0` is installed.
-
-## Dev
-
-In the project, you can run some built-in commands:
-
-If `node_modules` is not installed, you should first run `npm install` or `yarn install`.
-
-Use `npm run dev` or `yarn dev` to run the application in development mode.
-
-If the server runs successfully, the browser will open [http://localhost:8080](http://localhost:8080) to view in the browser.
-
-If you edit, the page will reload.
-You will also see any lint errors in the console.
-
-The start of the web server depends on the back-end server `manger api` interface.
-
-You should start the backend server first, and then set the variable `target` in `/inlong-website/src/setupProxy.js` to the address of the api service.
-
-## Test
-
-Run `npm test` or `yarn test`
-
-Start the test runner in interactive observation mode.
-For more information, see the section on [Running Tests](https://create-react-app.dev/docs/running-tests/).
-
-## Build and deploy
-
-First, make sure that the project has run `npm install` or `yarn install` to install `node_modules`.
-
-Run `npm run build` or `yarn build`.
-
-Build the application for production into the build folder.
-Better page performance can be obtained in the constructed production mode.
-
-After the build, the code is compressed, and the file name includes the hash value.
-Your application is ready to be deployed!
-
-For details, see the section on [deployment](https://create-react-app.dev/docs/deployment/).
\ No newline at end of file
+- nginx
+
+## configuration
+
+```
+server {
+ listen 80;
+ listen [::]:80;
+ server_name _;
+ # replaced by the directory of inlong-website
+ root /inlong_root_path/inlong-website;
+
+ # replaced manager_api_ip
+ location /api {
+ proxy_pass http://manager_api_ip:8083;
+ }
+}
+```
\ No newline at end of file
diff --git a/docs/en-us/quick_start.md b/docs/en-us/quick_start.md
index 7533719..f9f83cc 100644
--- a/docs/en-us/quick_start.md
+++ b/docs/en-us/quick_start.md
@@ -4,7 +4,7 @@ title: Getting Started - Apache InLong
This section contains a quick start guide to help you get started with Apache InLong.
-# Overall architecture
+## Overall architecture
<img src="../../img/inlong_architecture.png" align="center" alt="Apache InLong"/>
[Apache InLong](https://inlong.apache.org)(incubating) overall architecture is as above. This component is a one-stop data streaming platform that provides automated, secure, distributed, and efficient data publishing and subscription capabilities to help You can easily build stream-based data applications.
@@ -12,29 +12,56 @@ This section contains a quick start guide to help you get started with Apache In
InLong (Yinglong) was originally built in Tencent and has served online business for more than 8 years. It supports massive data (over 40 trillion pieces of data per day) report services under big data scenarios. The entire platform integrates 5 modules including data collection, aggregation, caching, sorting and management modules. Through this system, the business only needs to provide data sources, data service quality, data landing clusters and data landing formats, that is, data can [...]
-# How to use
-Through the overall architecture diagram of InLong above, we can see that InLong contains complete data reporting components, and we need to compile and deploy modules one by one.
+## Compile
+- Java [JDK 8](https://adoptopenjdk.net/?variant=openjdk8)
+- Maven 3.6.1+
-## Compile and deploy Manager
-[How to compile and deploy Manager](modules/manager/quick_start.md)
+```
+$ mvn clean install -DskipTests
+```
+(Optional) Compile using docker image:
+```
+$ docker pull maven:3.6-openjdk-8
+$ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8 mvn clean install -DskipTests
+```
+after compile successfully, you could find distribution file at `inlong-distribution/target` with `tar.gz` format, it includes following files:
+```
+inlong-agent
+inlong-dataproxy
+inlong-manager-api
+inlong-manager-openapi
+inlong-sort
+inlong-tubemq-manager
+inlong-tubemq-server
+inlong-website
+```
-## Compile and deploy InLong Web
-[How to compile and deploy InLong Web](modules/website/quick_start.md)
+## Environment Requirements
+- ZooKeeper 3.5+
+- Hadoop 2.10.x 和 Hive 2.3.x
+- MySQL 5.7+
+- Flink 1.9.x
-## Compile and deploy TubeMQ
-[How to compile and deploy TubeMQ](modules/tubemq/quick_start.md)
+## deploy InLong TubeMQ Server
+[deploy InLong TubeMQ Server](modules/tubemq/quick_start.md)
-## Compile and deploy TubeMQ Manager
-[How to compile and deploy TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
+## deploy InLong TubeMQ Manager
+[deploy InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
-## Compile and deploy Sort
-[How to compile and deploy Sort](modules/sort/quick_start.md)
+## deploy InLong Manager
+[deploy InLong Manager](modules/manager/quick_start.md)
-## Compile and deploy DataProxy
-[How to compile and deploy DataProxy](modules/dataproxy/quick_start.md)
+## deploy InLong Web
+[deploy InLong Web](modules/website/quick_start.md)
-## Compile and deploy the Agent
-[How to compile and deploy Agent](modules/agent/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](modules/manager/user_manual.md)
diff --git a/docs/zh-cn/modules/agent/quick_start.md b/docs/zh-cn/modules/agent/quick_start.md
index ab2658e..20dde9a 100644
--- a/docs/zh-cn/modules/agent/quick_start.md
+++ b/docs/zh-cn/modules/agent/quick_start.md
@@ -1,21 +1,11 @@
-## 一、安装
-
- 环境要求：
- java JDK 1.8
- Maven 3.6 +
-
- inlong目录下执行命令
- mvn clean package -DskipTests
-
- 在项目下的agent-release/target里面可以找到tgz安装包
-
-
-
-## 二、配置
+## 1、配置
+```
+cd inlong-agent
+```
agent 支持两种运行模式：本地运行以及线上运行
-### 2.1 Agent 线上运行相关设置
+### 1.1 Agent 线上运行相关设置
线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：
```ini
@@ -25,7 +15,7 @@ agent.manager.vip.http.host=manager open api host
agent.manager.vip.http.port=manager open api port
```
-### 2.2 DataProxy 相关设置
+### 1.2 DataProxy 相关设置
在agent目录下新建.inlong文件夹，内部新建bid+.local文件，例如设置的发送bid为a, 则新建a.local文件
内部将写入：
@@ -34,7 +24,7 @@ agent.manager.vip.http.port=manager open api port
其中cluster_id, isInterVisit，switch为预留字段，请填写默认值
```
-### 2.3 agent本地运行job配置
+### 1.3 agent本地运行job配置
如果不使用线上模式，可以使用本地文件新建读取任务
在conf中新建目录jobs，jobs内部vim job1.json：
@@ -83,9 +73,9 @@ agent.manager.vip.http.port=manager open api port
- proxy.bid: 写入proxy时使用的bid类型
- proxy.tid: 写入proxy时使用的tid类型
-### 2.4 实时添加job配置
+### 1.4 实时添加job配置
-#### 2.4.1 agent.propertities 修改下面两处
+#### 1.4.1 agent.propertities 修改下面两处
```ini
# whether enable http service
agent.http.enable=true
@@ -93,7 +83,7 @@ agent.http.enable=true
agent.http.port=可用端口
```
-#### 2.4.2 执行如下命令：
+#### 1.4.2 执行如下命令：
```bash
curl --location --request POST 'http://localhost:8018/config/job' \
--header 'Content-Type: application/json' \
@@ -128,14 +118,14 @@ curl --location --request POST 'http://localhost:8018/config/job' \
proxy.bid: 代表发送到dataproxy使用的bid
proxy.tid: 代表发送到dataproxy使用的tid
-## 三、运行
+## 2、运行
解压后如下命令运行
```bash
sh agent.sh start
```
-## 四、可支持的路径配置方案
+## 3、可支持的路径配置方案
例如：
/data/inlong-agent/test.log //代表读取inlong-agent文件夹下的的新增文件test.log
diff --git a/docs/zh-cn/modules/dataproxy/quick_start.md b/docs/zh-cn/modules/dataproxy/quick_start.md
index c4d031c..35ff916 100644
--- a/docs/zh-cn/modules/dataproxy/quick_start.md
+++ b/docs/zh-cn/modules/dataproxy/quick_start.md
@@ -1,18 +1,6 @@
-## 一、安装
+## 配置
- mvn clean package -DskipTests
-
-在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
-
-解压
-
- tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
-
-## 二、配置
-
- cd apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin
+ cd inlong-dataproxy
### 配置tube地址和端口号
@@ -37,10 +25,10 @@ sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
cluster_id=1 // 预留字段，请填写默认值1
manager_hosts=ip:port // 这里写入的是manager open api地址
-## 三、启动
+## 启动
sh bin/start.sh
-## 四、检查启动情况
+## 检查启动情况
telnet 127.0.0.1 46801
diff --git a/docs/zh-cn/modules/manager/quick_start.md b/docs/zh-cn/modules/manager/quick_start.md
index 56caf8d..67bba33 100644
--- a/docs/zh-cn/modules/manager/quick_start.md
+++ b/docs/zh-cn/modules/manager/quick_start.md
@@ -3,15 +3,6 @@
---
# 1. 环境准备
-
-开始安装前，请自行下载并安装下述软件：
-
-- 安装并配置 JDK（1.8+）、Maven（3.3+）；
-
-- 安装并启动 ZooKeeper 3.5+；
-
-- 安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；
-
- 安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 `doc/sql/apache_inlong_manager.sql` 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 `/data/`
目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：
@@ -30,29 +21,15 @@
- 参照 [编译部署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
+
+# 2. 部署、启动 manager-api
**manager-api 是与前端页面交互的后台服务。**
-## 3.1 上传、解压安装包
-
-1) 将第2步的 `inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz` 拷贝到要部署的服务器；
+## 2.1 准备安装文件
+安装文件在`inlong-manager-api`目录.
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-api-*.tar.gz`，得到 `manager-api` 文件夹。
-
-## 3.2 修改配置
+## 2.2 修改配置
前往解压后的 `manager-api` 目录，修改 `conf/application.yml` 文件：
@@ -93,7 +70,7 @@ spring:
sort.appName: inlong_app # Sort 应用名称，即设置 Sort 的 cluster-id 参数，默认值为"inlong_app"
```
-## 3.3 启动服务
+## 2.3 启动服务
进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf log/manager-api.log`，若出现类似下面的日志，说明服务启动成功：
@@ -101,17 +78,14 @@ spring:
Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-# 4. 部署、启动 manager-openapi
+# 3. 部署、启动 manager-openapi
**manager-openapi 是为其他组件（如 Agent、DataProxy）提供交互接口的服务。**
-## 4.1 上传、解压安装包
-
-1) 将第2步的 `inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz` 拷贝到要部署的服务器；
-
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`，得到 `manager-openapi` 文件夹。
+## 3.1 准备安装文件
+安装文件在`inlong-manager-openapi`目录.
-## 4.2 修改配置
+## 3.2 修改配置
前往解压后的 `manager-openapi` 目录，修改 `conf/application.yml` 文件：
@@ -152,7 +126,7 @@ spring:
sort.appName: inlong_app # Sort 应用名称，即设置 Sort 的 cluster-id 参数，默认值为"inlong_app"
```
-## 4.3 启动服务
+## 3.3 启动服务
进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
@@ -160,7 +134,7 @@ spring:
Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
```
-# 5. 服务访问验证
+# 4. 服务访问验证
1) 验证 manager-api 服务：
diff --git a/docs/zh-cn/modules/sort/quick_start.md b/docs/zh-cn/modules/sort/quick_start.md
index fcf3cb5..bbf267a 100644
--- a/docs/zh-cn/modules/sort/quick_start.md
+++ b/docs/zh-cn/modules/sort/quick_start.md
@@ -2,13 +2,7 @@
快速开始 - Apache InLong-sort
---
-# 环境要求
-- Java JDK 1.8
-- Maven 3.6+
-- Flink 1.9.3
-- Zookeeper
-
-## 配置flink运行环境
+## 配置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")
@@ -17,15 +11,10 @@
flink环境配置完成后，可以通过浏览器访问flink的web ui，对应的地址是`/{flink部署路径}/conf/masters`文件中的地址
-# 编译
-- 步骤一：进入inlong-sort的目录
-`cd /your_path/Inlong/inlong-sort`
-- 步骤二：编译
-`mvn clean package`
-
-通过以上两个步骤在目录`/your_path/Inlong/inlong-sort/core/target`中，就会产出jar包`inlong-sort-core-{version}.jar`
+## 准备安装文件
+安装文件在`inlong-sort`目录。
-# 启动inlong-sort应用
+## 启动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作业")
@@ -40,7 +29,7 @@ flink环境配置完成后，可以通过浏览器访问flink的web ui，对应
- `inlong-sort-core-1.0-SNAPSHOT.jar` 为编译阶段产出的jar包
-# 必要的配置
+## 必要的配置
- `--cluster-id ` 用来唯一标识一个inlong-sort作业
- `--zookeeper.quorum` zk quorum
- `--zookeeper.path.root` zk根目录
@@ -51,7 +40,7 @@ flink环境配置完成后，可以通过浏览器访问flink的web ui，对应
`--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181 --zookeeper.path.root /zk_root --source.type tubemq --sink.type hive`
-# 所有支持的配置
+## 所有支持的配置
| 配置名 | 是否必须 | 默认值 |描述 |
| ------------ | ------------ | ------------ | ------------ |
|cluster-id | Y | NA | 用来唯一标识一个inlong-sort作业 |
diff --git a/docs/zh-cn/modules/tubemq/quick_start.md b/docs/zh-cn/modules/tubemq/quick_start.md
index 40eb4d3..404e9ec 100644
--- a/docs/zh-cn/modules/tubemq/quick_start.md
+++ b/docs/zh-cn/modules/tubemq/quick_start.md
@@ -1,52 +1,9 @@
---
快速开始 - Apache InLong TubeMQ模块
---
+## 部署运行
-## 1 编译和构建
-
-### 1.1 准备工作
-- Java JDK 1.8
-- Maven 3.3+
-
-### 1.2 从源码包构建
-- 编译和打包：
-```bash
-mvn clean package -DskipTests
-```
-
-- 单元测试：
-```bash
-mvn test
-```
-
-- 单独对每个 module 进行构建：
-```bash
-mvn clean install
-cd module-name (比如: tubemq-client)
-mvn test
-```
-
-构建完成之后，在 `tubemq-server/target` 目录下会有 **apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz** 文件。
-这是 TubeMQ 的部署包，包含了脚本、配置文件、依赖以及 web GUI相关的内容。
-
-### 1.3 配置IDE开发环境
-在IDE中构建和调试源码，需要先运行以下命令：
-```bash
-mvn compile
-```
-执行之后，会生成 `protoc` 文件对应的 java source file，位于 `target/generated-sources` 目录。
-
-（可选）如果你打算使用本地的 `protoc` 可执行文件，你可以修改 `tubemq-core/pom.xml` 下的 `protobuf-maven-plugin` 的配置，如下所示。
-```xml
-<configuration>
- <outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
- <protocExecutable>/usr/local/bin/protoc</protocExecutable>
-</configuration>
-```
-
-## 2 部署运行
-
-### 2.1 配置示例
+### 1.1 配置示例
TubeMQ 集群包含有两个组件: **Master** 和 **Broker**. Master 和 Broker 可以部署在相同或者不同的节点上，依照业务对机器的规划进行处理。我们通过如下3台机器搭建有2台Master的生产、消费的集群进行配置示例：
| 所属角色 | TCP端口 | TLS端口 | WEB端口 | 备注 |
| --- | --- | --- | --- | --- |
@@ -54,13 +11,12 @@ TubeMQ 集群包含有两个组件: **Master** 和 **Broker**. Master 和 Broker
| Broker | 8123 | 8124 | 8081 | 消息储存在`/stage/msg_data` |
| ZooKeeper | 2181 | | | Offset储存在根目录`/tubemq` |
-### 2.2 准备工作
+### 1.2 准备工作
- ZooKeeper集群
-- [apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz](download/download.md)安装包
选择安装路径后，安装包解压后的目录结构如下：
```
-/INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin/
+/INSTALL_PATH/inlong-tubemq-server/
├── bin
├── conf
├── lib
@@ -68,7 +24,7 @@ TubeMQ 集群包含有两个组件: **Master** 和 **Broker**. Master 和 Broker
└── resources
```
-### 2.3 配置Master
+### 1.3 配置Master
编辑`conf/master.ini`，根据集群信息变更以下配置项
- Master IP和端口
@@ -111,7 +67,7 @@ repHelperHost=FIRST_MASTER_NODE_IP:9001 // helperHost用于创建master集群
**注意**：需保证Master所有节点之间的时钟同步
-### 2.4 配置Broker
+### 1.4 配置Broker
编辑`conf/broker.ini`，根据集群信息变更以下配置项
- Broker IP和端口
```ini
@@ -139,7 +95,7 @@ zkNodeRoot=/tubemq
zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址逗号分开
```
-### 2.5 启动Master
+### 1.5 启动Master
进入Master节点的 `bin` 目录下，启动服务:
```bash
./tubemq.sh master start
@@ -148,19 +104,19 @@ zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址
-#### 2.5.1 配置Broker元数据
+#### 1.5.1 配置Broker元数据
Broker启动前，首先要在Master上配置Broker元数据，增加Broker相关的管理信息。在`Broker List` 页面, `Add Single Broker`，然后填写相关信息:
需要填写的内容包括：
1. broker IP: broker server ip
-2. authToken: `conf/master.ini` 文件中 `confModAuthToken` 字段配置的 token
+1. authToken: `conf/master.ini` 文件中 `confModAuthToken` 字段配置的 token
然后上线Broker：
-
+
-### 2.6 启动Broker
+### 1.6 启动Broker
进入broker节点的 `bin` 目录下，执行以下命令启动Broker服务：
```bash
@@ -192,10 +148,10 @@ Broker启动前，首先要在Master上配置Broker元数据，增加Broker相
-### 3.2 运行Example
+### 2.2 运行Example
可以通过上面创建的`demo` topic来测试集群。
-#### 3.2.1 生产消息
+#### 2.2.1 生产消息
将 `YOUR_MASTER_IP:port` 替换为实际的IP和端口，然后运行producer:
```bash
cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
@@ -205,7 +161,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
如果能观察下如下日志，则表示数据发送成功：
-#### 3.2.2 消费消息
+#### 2.2.2 消费消息
将 `YOUR_MASTER_IP:port` 替换为实际的IP和端口，然后运行Consumer:
```bash
cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
@@ -217,7 +173,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
-## 4 结束
+## 3 结束
在这里，已经完成了TubeMQ的编译，部署，系统配置，启动，生产和消费。如果需要了解更深入的内容，请查看《TubeMQ HTTP API》里的相关内容，进行相应的配置设置。
---
diff --git a/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md b/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
index c83473e..b610cb7 100644
--- a/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,31 +1,25 @@
-## 编译
-
- mvn clean package
-
## 部署
+安装文件在inlong-tubemq-manager目录.
-环境要求：
-
- mysql
- java(1.8+)
-
-在InLong/inlong-tubemq/tubemq-manager/dist/目录当中，能够找到文件为apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
- tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
+### 配置
在conf/application.properties中添加mysql信息：
- spring.jpa.hibernate.ddl-auto=update
- # configuration for manager
- spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
- spring.datasource.username=[replace_by_usename]
- spring.datasource.password=[replace_by_password]
- # server port
- server.port=8089
-
+```ini
+spring.jpa.hibernate.ddl-auto=update
+# configuration for manager
+spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
+spring.datasource.username=[replace_by_usename]
+spring.datasource.password=[replace_by_password]
+# server port
+server.port=8089
+```
+
+### 启动服务
添加数据库tubemanager，并启动：
- bin/start-admin.sh
+``` bash
+$ bin/start-admin.sh
+```
## 使用
diff --git a/docs/zh-cn/modules/website/quick_start.md b/docs/zh-cn/modules/website/quick_start.md
index d170a64..93353ac 100644
--- a/docs/zh-cn/modules/website/quick_start.md
+++ b/docs/zh-cn/modules/website/quick_start.md
@@ -1,41 +1,21 @@
## 环境准备
-应该检查 `nodejs >= 12.0` 已经安装。
-
-## 开发
-
-在新创建的项目中，您可以运行一些内置命令：
-
-如果没有安装 `node_modules`，你应该首先运行 `npm install` 或 `yarn install`。
-
-使用 `npm run dev` 或 `yarn dev` 在开发模式下运行应用程序。
-
-如果服务器运行成功，浏览器将打开 [http://localhost:8080](http://localhost:8080) 在浏览器中查看。
-
-如果您进行编辑，页面将重新加载。
-您还将在控制台中看到任何 lint 错误。
-
-web服务器的启动依赖于后端服务 `manger api` 接口。
-
-您应该先启动后端服务器，然后将 `/inlong-website/src/setupProxy.js` 中的变量`target` 设置为api服务的地址。
-
-## 测试
-
-运行 `npm test` 或 `yarn test`
-
-在交互式观察模式下启动测试运行器。
-有关更多信息，请参阅有关 [运行测试](https://create-react-app.dev/docs/running-tests/) 的部分。
-
-## 构建和部署
-
-首先保证项目已运行过 `npm install` 或 `yarn install` 安装了 `node_modules`。
-
-运行 `npm run build` 或 `yarn build`。
-
-将用于生产的应用程序构建到构建文件夹。
-在构建后的生产模式下可以获得较好的页面性能。
-
-构建后代码被压缩，文件名包括哈希值。
-您的应用程序已准备好部署！
-
-有关详细信息，请参阅有关 [deployment](https://create-react-app.dev/docs/deployment/) 的部分。
\ No newline at end of file
+- nginx
+
+## 配置
+增加`inlong-website`
+
+```
+server {
+ listen 80;
+ listen [::]:80;
+ server_name _;
+ # replaced by the directory of inlong-website
+ root /inlong_root_path/inlong-website;
+
+ # replaced manager_api_ip
+ location /api {
+ proxy_pass http://manager_api_ip:8083;
+ }
+}
+```
\ No newline at end of file
diff --git a/docs/zh-cn/quick_start.md b/docs/zh-cn/quick_start.md
index 010a9b0..247ccdb 100644
--- a/docs/zh-cn/quick_start.md
+++ b/docs/zh-cn/quick_start.md
@@ -4,40 +4,66 @@ title: 入门 - Apache InLong
本节包含快速入门指南，可帮助您开始使用 Apache InLong。
-# 整体架构
+## 整体架构
<img src="../../img/inlong_architecture.png" align="center" alt="Apache InLong"/>
[Apache InLong](https://inlong.apache.org)(incubating) 整体架构如上，该组件是一站式数据流媒体平台，提供自动化、安全、分布式、高效的数据发布和订阅能力，帮助您轻松构建基于流的数据应用程序。
InLong(应龙)最初建于腾讯，服务线上业务8年多，支持大数据场景下的海量数据（每天40万亿条数据规模以上）报表服务。整个平台集成了数据采集、汇聚、缓存、分拣和管理模块等共5个模块，通过这个系统，业务只需要提供数据源、数据服务质量、数据落地集群和数据落地格式，即数据可以源源不断地将数据从源集群推送到目标集群，极大满足了业务大数据场景下的数据上报服务需求。
-
-# 如何使用
-通过上图的InLong整体架构图，我们可以看到InLong包含了完整的数据上报组件，我们需要逐个模块的编译部署
-
-## 编译部署Manager
-[如何编译部署Manager](modules/manager/quick_start.md)
-
-## 编译部署InLong Web
-[如何编译部署InLong Web](modules/website/quick_start.md)
-
-## 编译部署TubeMQ
-[如何编译部署TubeMQ](modules/tubemq/quick_start.md)
-
-## 编译部署TubeMQ Manager
-[如何编译部署TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
-
-## 编译部署Sort
-[如何编译部署Sort](modules/sort/quick_start.md)
-
-## 编译部署DataProxy
-[如何编译部署DataProxy](modules/dataproxy/quick_start.md)
-
-## 编译部署Agent
-[如何编译部署Agent](modules/agent/quick_start.md)
+## 编译
+- Java [JDK 8](https://adoptopenjdk.net/?variant=openjdk8)
+- Maven 3.6.1+
+
+```
+$ mvn clean install -DskipTests
+```
+(可选) 使用docker编译:
+```
+$ docker pull maven:3.6-openjdk-8
+$ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8 mvn clean install -DskipTests
+```
+若编译成功，在`inlong-distribution/target`下会找到`tar.gz`格式的安装包，解压安装目录，包括各个模块安装文件：
+```
+inlong-agent
+inlong-dataproxy
+inlong-manager-api
+inlong-manager-openapi
+inlong-sort
+inlong-tubemq-manager
+inlong-tubemq-server
+inlong-website
+```
+
+## 环境要求
+- ZooKeeper 3.5+
+- Hadoop 2.10.x 和 Hive 2.3.x
+- MySQL 5.7+
+- Flink 1.9.x
+
+## 部署InLong TubeMQ Server
+[部署InLong TubeMQ Server](modules/tubemq/quick_start.md)
+
+## 部署InLong TubeMQ Manager
+[部署InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
+
+## 部署部署InLong Manager
+[部署InLong Manager](modules/manager/quick_start.md)
+
+## 部署InLong WebSite
+[部署InLong Web](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)
## 业务配置
-[如何配置新业务](modules/manager/user_manual.md)
+[配置新业务](modules/manager/user_manual.md)
## 数据上报验证
到这里，您就可以通过文件Agent采集数据并在指定的Hive表中验证接收到的数据是否与发送的数据一致。
diff --git a/en-us/docs/modules/agent/quick_start.html b/en-us/docs/modules/agent/quick_start.html
index 617dc0e..8808877 100644
--- a/en-us/docs/modules/agent/quick_start.html
+++ b/en-us/docs/modules/agent/quick_start.html
@@ -12,32 +12,24 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<pre><code>env requirements：
-java JDK 1.8
-Maven 3.6 +
-
-
-mvn clean package -DskipTests
-
-The tgz installation package can be found in the target under the agent-release
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<pre><code>cd inlong-agent
</code></pre>
-<h2>2、Configuration</h2>
<p>The agent supports two modes of operation: local operation and online operation</p>
-<h3>2.1 Agent configuration</h3>
+<h3>1.1 Agent configuration</h3>
<p>Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as follows:</p>
<pre><code class="language-ini"><span class="hljs-attr">agent.fetcher.classname</span>=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (the class name for fetch tasks, default ManagerFetcher）
<span class="hljs-attr">agent.local.ip</span>=Write local ip
<span class="hljs-attr">agent.manager.vip.http.host</span>=manager open api host
<span class="hljs-attr">agent.manager.vip.http.port</span>=manager open api port
</code></pre>
-<h3>2.2 Proxy configuration</h3>
+<h3>1.2 Proxy configuration</h3>
<p>Create a new folder named .inlong in the agent directory, and create a new bid+.local file inside. For example, if the sending bid is set to a, then create a new file a.local</p>
<p>write:</p>
<pre><code class="language-ini">{"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":write proxy port,"host":"write proxy ip"}], "switch":0}
Among them, cluster_id, isInterVisit, and switch are reserved fields, please fill in the default values
</code></pre>
-<h3>2.3 local job configuration</h3>
+<h3>1.3 local job configuration</h3>
<p>If you do not use the online mode, you can use the local file to create a new read task
Create a new directory jobs in conf,
vim job1.json：</p>
@@ -82,14 +74,14 @@ vim job1.json：</p>
<li>proxy.bid: The bid type used when writing proxy</li>
<li>proxy.tid: The tid type used when writing proxy</li>
</ul>
-<h3>2.4 Add job configuration in real time</h3>
-<h4>2.4.1 agent.propertities Modify the following two places</h4>
+<h3>1.4 Add job configuration in real time</h3>
+<h4>1.4.1 agent.propertities Modify the following two places</h4>
<pre><code class="language-ini"><span class="hljs-comment"># whether enable http service</span>
<span class="hljs-attr">agent.http.enable</span>=<span class="hljs-literal">true</span>
<span class="hljs-comment"># http default port</span>
<span class="hljs-attr">agent.http.port</span>=Available ports
</code></pre>
-<h4>2.4.2 Execute the following command</h4>
+<h4>1.4.2 Execute the following command</h4>
<pre><code class="language-bash"> curl --location --request POST <span class="hljs-string">'http://localhost:8129/config/job'</span> \
--header <span class="hljs-string">'Content-Type: application/json'</span> \
--data <span class="hljs-string">'{
@@ -118,11 +110,11 @@ vim job1.json：</p>
"op": "add"
}'</span>
</code></pre>
-<h2>3、run</h2>
+<h2>2、run</h2>
<p>After decompression, run the following command</p>
<pre><code class="language-bash">sh agent.sh start
</code></pre>
-<h2>4、eg for directory config</h2>
+<h2>3、eg for directory config</h2>
<pre><code>E.g:
/data/inlong-agent/test.log //Represents reading the new file test.log in the inlong-agent folder
/data/inlong-agent/test[0-9]{1} // means to read the new file test in the inlong-agent folder followed by a number at the end
diff --git a/en-us/docs/modules/agent/quick_start.json b/en-us/docs/modules/agent/quick_start.json
index 8bdb04c..fd05735 100644
--- a/en-us/docs/modules/agent/quick_start.json
+++ b/en-us/docs/modules/agent/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>1、install</h2>\n<pre><code>env requirements：\njava JDK 1.8\nMaven 3.6 +\n\n\nmvn clean package -DskipTests\n\nThe tgz installation package can be found in the target under the agent-release\n</code></pre>\n<h2>2、Configuration</h2>\n<p>The agent supports two modes of operation: local operation and online operation</p>\n<h3>2.1 Agent configuration</h3>\n<p>Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as fo [...]
+ "__html": "<h2>1、Configuration</h2>\n<pre><code>cd inlong-agent\n</code></pre>\n<p>The agent supports two modes of operation: local operation and online operation</p>\n<h3>1.1 Agent configuration</h3>\n<p>Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as follows:</p>\n<pre><code class=\"language-ini\"><span class=\"hljs-attr\">agent.fetcher.classname</span>=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (the class [...]
"link": "/en-us/docs/modules/agent/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/en-us/docs/modules/agent/quick_start.md b/en-us/docs/modules/agent/quick_start.md
index a39bf63..baba6a9 100644
--- a/en-us/docs/modules/agent/quick_start.md
+++ b/en-us/docs/modules/agent/quick_start.md
@@ -1,22 +1,12 @@
+## 1、Configuration
+```
+cd inlong-agent
+```
-## 1、install
-
- env requirements：
- java JDK 1.8
- Maven 3.6 +
-
-
- mvn clean package -DskipTests
-
- The tgz installation package can be found in the target under the agent-release
-
-
-
-## 2、Configuration
The agent supports two modes of operation: local operation and online operation
-### 2.1 Agent configuration
+### 1.1 Agent configuration
Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as follows:
```ini
@@ -26,7 +16,7 @@ agent.manager.vip.http.host=manager open api host
agent.manager.vip.http.port=manager open api port
```
-### 2.2 Proxy configuration
+### 1.2 Proxy configuration
Create a new folder named .inlong in the agent directory, and create a new bid+.local file inside. For example, if the sending bid is set to a, then create a new file a.local
write:
@@ -35,7 +25,7 @@ write:
Among them, cluster_id, isInterVisit, and switch are reserved fields, please fill in the default values
```
-### 2.3 local job configuration
+### 1.3 local job configuration
If you do not use the online mode, you can use the local file to create a new read task
Create a new directory jobs in conf,
vim job1.json：
@@ -82,9 +72,9 @@ The meaning of each parameter is ：
- proxy.bid: The bid type used when writing proxy
- proxy.tid: The tid type used when writing proxy
-### 2.4 Add job configuration in real time
+### 1.4 Add job configuration in real time
-#### 2.4.1 agent.propertities Modify the following two places
+#### 1.4.1 agent.propertities Modify the following two places
```ini
# whether enable http service
agent.http.enable=true
@@ -92,7 +82,7 @@ agent.http.enable=true
agent.http.port=Available ports
```
-#### 2.4.2 Execute the following command
+#### 1.4.2 Execute the following command
```bash
curl --location --request POST 'http://localhost:8129/config/job' \
--header 'Content-Type: application/json' \
@@ -123,14 +113,14 @@ agent.http.port=Available ports
}'
```
-## 3、run
+## 2、run
After decompression, run the following command
```bash
sh agent.sh start
```
-## 4、eg for directory config
+## 3、eg for directory config
E.g:
/data/inlong-agent/test.log //Represents reading the new file test.log in the inlong-agent folder
diff --git a/en-us/docs/modules/dataproxy/quick_start.html b/en-us/docs/modules/dataproxy/quick_start.html
index 98357e7..132aeae 100644
--- a/en-us/docs/modules/dataproxy/quick_start.html
+++ b/en-us/docs/modules/dataproxy/quick_start.html
@@ -12,15 +12,8 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<pre><code>mvn clean package -DskipTests
-</code></pre>
-<p>The tgz installation package apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target</p>
-<p>un tar it</p>
-<pre><code>tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-</code></pre>
-<h2>2、configuration</h2>
-<pre><code>cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<pre><code>cd inlong-dataproxy
</code></pre>
<h3>config tube</h3>
<pre><code>ip:port are tube address
@@ -41,10 +34,10 @@ write：
cluster_id=1 // cluter id is for future use please write 1
manager_hosts=ip:port // manager open api
</code></pre>
-<h2>3、run</h2>
+<h2>run</h2>
<pre><code>sh bin/start.sh
</code></pre>
-<h2>4、check</h2>
+<h2>check</h2>
<pre><code>telnet 127.0.0.1 46801
</code></pre>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with [...]
diff --git a/en-us/docs/modules/dataproxy/quick_start.json b/en-us/docs/modules/dataproxy/quick_start.json
index 06c3674..4b59808 100644
--- a/en-us/docs/modules/dataproxy/quick_start.json
+++ b/en-us/docs/modules/dataproxy/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>1、install</h2>\n<pre><code>mvn clean package -DskipTests\n</code></pre>\n<p>The tgz installation package apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target</p>\n<p>un tar it</p>\n<pre><code>tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz\n</code></pre>\n<h2>2、configuration</h2>\n<pre><code>cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin\n</code></pre>\n<h3>config tube</h3> [...]
+ "__html": "<h2>configuration</h2>\n<pre><code>cd inlong-dataproxy\n</code></pre>\n<h3>config tube</h3>\n<pre><code>ip:port are tube address\n</code></pre>\n<p>sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf</p>\n<pre><code>change proxy port\nagent1.sources.tcp-source.port = 46801\n</code></pre>\n<p>notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner data</p>\n<h3>Environmental preparation</h3>\n<pre><code>cd bin\nsh prepare_env.sh\ncd ..\n</code></pre [...]
"link": "/en-us/docs/modules/dataproxy/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/en-us/docs/modules/dataproxy/quick_start.md b/en-us/docs/modules/dataproxy/quick_start.md
index da17b2c..9ecf2a0 100644
--- a/en-us/docs/modules/dataproxy/quick_start.md
+++ b/en-us/docs/modules/dataproxy/quick_start.md
@@ -1,17 +1,6 @@
-## 1、install
+## configuration
- mvn clean package -DskipTests
-
-The tgz installation package apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target
-
-un tar it
-
- tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
-
-## 2、configuration
-
- cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin
+ cd inlong-dataproxy
### config tube
@@ -24,8 +13,6 @@ sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner data
-
-
### Environmental preparation
cd bin
sh prepare_env.sh
@@ -37,9 +24,9 @@ notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner da
cluster_id=1 // cluter id is for future use please write 1
manager_hosts=ip:port // manager open api
-## 3、run
+## run
sh bin/start.sh
-## 4、check
+## check
telnet 127.0.0.1 46801
diff --git a/en-us/docs/modules/manager/quick_start.html b/en-us/docs/modules/manager/quick_start.html
index b9be631..8b932f5 100644
--- a/en-us/docs/modules/manager/quick_start.html
+++ b/en-us/docs/modules/manager/quick_start.html
@@ -13,18 +13,8 @@
</head>
<body>
<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<p>Before starting the installation, please download and install the following software yourself:</p>
<ul>
<li>
-<p>Install and configure JDK (1.8+), Maven (3.3+);</p>
-</li>
-<li>
-<p>Install and start ZooKeeper 3.5+;</p>
-</li>
-<li>
-<p>Install and start Hadoop 2.10.x and Hive 2.3.x;</p>
-</li>
-<li>
<p>Install and start MySQL 5.7+, copy the <code>doc/sql/apache_inlong_manager.sql</code> file in the inlong-manager module to the
server where the MySQL database is located (for example, copy to <code>/data/</code> directory), load this file through the
following command to complete the initialization of the table structure and basic data:</p>
@@ -48,28 +38,11 @@ to <a href="https://inlong.apache.org/zh-cn/docs/modules/tubemq/tubemq-manager/q
, install and start TubeManager.</p>
</li>
</ul>
-<h1>2. Compile and package</h1>
-<p>Enter the project root directory through the macOS terminal (or Windows command prompt window) and execute the following
-compilation commands:</p>
-<pre><code>mvn clean install -DskipTests
-</code></pre>
-<p>After the compilation is successful, go to the <code>inlong-manager/manager-api</code> and <code>inlong-manager/manager-openapi</code> modules
-of the project, and set them in the respective <code>target</code>
-The installation package is generated under the directory, and the names are <code>apache-inlong-manager-api*.tar.gz</code>
-and <code>apache-inlong-manager-openapi*.tar.gz</code>.</p>
-<h1>3. Deploy and start manager-api</h1>
+<h1>2. Deploy and start manager-api</h1>
<p><strong>manager-api is a background service that interacts with the front-end page.</strong></p>
-<h2>3.1 Upload and decompress the installation package</h2>
-<ol>
-<li>
-<p>Copy <code>inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz</code> from step 2 to the server to be deployed;</p>
-</li>
-<li>
-<p>Go to the deployment server and unzip the installation package: <code>tar -zxvf apache-inlong-manager-api-*.tar.gz</code> to get
-the <code>manager-api</code> folder.</p>
-</li>
-</ol>
-<h2>3.2 Modify configuration</h2>
+<h2>2.1 Prepare installation files</h2>
+<p>All installation files at <code>inlong-manager-api</code> directory.</p>
+<h2>2.2 Modify configuration</h2>
<p>Go to the decompressed <code>manager-api</code> directory and modify the <code>conf/application.yml</code> file:</p>
<pre><code class="language-yaml"><span class="hljs-comment"># manager-api service port number</span>
<span class="hljs-attr">server:</span>
@@ -106,26 +79,17 @@ the default value:</p>
</code></pre>
</li>
</ol>
-<h2>3.3 Start the service</h2>
+<h2>2.3 Start the service</h2>
<p>Enter the decompressed directory, execute <code>sh bin/startup.sh</code> to start the service, and check the
log <code>tailf log/manager-api.log</code>. If a log similar to the following appears, the service has started successfully:</p>
<pre><code class="language-shell">Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
</code></pre>
-<h1>4. Deploy and start manager-openapi</h1>
+<h1>3. Deploy and start manager-openapi</h1>
<p><strong>manager-openapi is a service that provides interactive interfaces for other components (such as Agent and DataProxy)
.</strong></p>
-<h2>4.1 Upload and decompress the installation package</h2>
-<ol>
-<li>
-<p>Copy <code>inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz</code> from step 2 to the server to be
-deployed;</p>
-</li>
-<li>
-<p>Go to the deployment server and unzip the installation package: <code>tar -zxvf apache-inlong-manager-openapi-*.tar.gz</code> to
-get the <code>manager-openapi</code> folder.</p>
-</li>
-</ol>
-<h2>4.2 Modify configuration</h2>
+<h2>3.1 Prepare installation files</h2>
+<p>All installation files at <code>inlong-manager-openapi</code> directory.</p>
+<h2>3.2 Modify configuration</h2>
<p>Go to the decompressed <code>manager-openapi</code> directory and modify the <code>conf/application.yml</code> file:</p>
<pre><code class="language-yaml"><span class="hljs-comment"># manager-openapi service port number</span>
<span class="hljs-attr">server:</span>
@@ -162,12 +126,12 @@ the default value:</p>
</code></pre>
</li>
</ol>
-<h2>4.3 Start the service</h2>
+<h2>3.3 Start the service</h2>
<p>Enter the decompressed directory, execute <code>sh bin/startup.sh</code> to start the service, and check the
log <code>tailf log/manager-openapi.log</code>. If a log similar to the following appears, the service has started successfully:</p>
<pre><code class="language-shell">Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
</code></pre>
-<h1>5. Service access verification</h1>
+<h1>4. Service access verification</h1>
<ol>
<li>
<p>Verify the manager-api service:</p>
diff --git a/en-us/docs/modules/manager/quick_start.json b/en-us/docs/modules/manager/quick_start.json
index 97af96d..65a5f64 100644
--- a/en-us/docs/modules/manager/quick_start.json
+++ b/en-us/docs/modules/manager/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h1>1. Environmental preparation</h1>\n<p>Before starting the installation, please download and install the following software yourself:</p>\n<ul>\n<li>\n<p>Install and configure JDK (1.8+), Maven (3.3+);</p>\n</li>\n<li>\n<p>Install and start ZooKeeper 3.5+;</p>\n</li>\n<li>\n<p>Install and start Hadoop 2.10.x and Hive 2.3.x;</p>\n</li>\n<li>\n<p>Install and start MySQL 5.7+, copy the <code>doc/sql/apache_inlong_manager.sql</code> file in the inlong-manager module to the\ns [...]
+ "__html": "<h1>1. Environmental preparation</h1>\n<ul>\n<li>\n<p>Install and start MySQL 5.7+, copy the <code>doc/sql/apache_inlong_manager.sql</code> file in the inlong-manager module to the\nserver where the MySQL database is located (for example, copy to <code>/data/</code> directory), load this file through the\nfollowing command to complete the initialization of the table structure and basic data:</p>\n<pre><code class=\"language-shell\"><span class=\"hljs-meta\">#</span><span cla [...]
"link": "/en-us/docs/modules/manager/quick_start.html",
"meta": {
"Quick start-Apache inlong-manager": ""
diff --git a/en-us/docs/modules/manager/quick_start.md b/en-us/docs/modules/manager/quick_start.md
index 9510c06..5871978 100644
--- a/en-us/docs/modules/manager/quick_start.md
+++ b/en-us/docs/modules/manager/quick_start.md
@@ -3,15 +3,6 @@ Quick start-Apache inlong-manager
---
# 1. Environmental preparation
-
-Before starting the installation, please download and install the following software yourself:
-
-- Install and configure JDK (1.8+), Maven (3.3+);
-
-- 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:
@@ -34,32 +25,14 @@ Before starting the installation, please download and install the following soft
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
+# 2. 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.1 Prepare installation files
+All installation files at `inlong-manager-api` directory.
-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
+## 2.2 Modify configuration
Go to the decompressed `manager-api` directory and modify the `conf/application.yml` file:
@@ -101,7 +74,7 @@ The dev configuration is specified above, then modify the `conf/application-dev.
sort.appName: inlong_app # The app name for Sort, default is 'inlong_app'
```
-## 3.3 Start the service
+## 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:
@@ -110,20 +83,15 @@ log `tailf log/manager-api.log`. If a log similar to the following appears, the
Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-# 4. Deploy and start manager-openapi
+# 3. 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
+## 3.1 Prepare installation files
+All installation files at `inlong-manager-openapi` directory.
-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
+## 3.2 Modify configuration
Go to the decompressed `manager-openapi` directory and modify the `conf/application.yml` file:
@@ -165,7 +133,7 @@ The dev configuration is specified above, then modify the `conf/application-dev.
sort.appName: inlong_app # The app name for Sort, default is 'inlong_app'
```
-## 4.3 Start the service
+## 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:
@@ -174,7 +142,7 @@ log `tailf log/manager-openapi.log`. If a log similar to the following appears,
Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
```
-# 5. Service access verification
+# 4. Service access verification
1) Verify the manager-api service:
diff --git a/en-us/docs/modules/sort/quick_start.html b/en-us/docs/modules/sort/quick_start.html
index f34b2f1..f831e71 100644
--- a/en-us/docs/modules/sort/quick_start.html
+++ b/en-us/docs/modules/sort/quick_start.html
@@ -12,27 +12,16 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<ul>
-<li>Java JDK 1.8</li>
-<li>Maven 3.6+</li>
-<li>Flink 1.9.3</li>
-<li>Zookeeper</li>
-</ul>
-<h2>Set up flink environment</h2>
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
<p>Currently inlong-sort is based on flink, before you run an inlong-sort application,
you need to set up flink environment.</p>
<p><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></p>
<p>Currently, inlong-sort relys on flink-1.9.3. Chose <code>flink-1.9.3-bin-scala_2.11.tgz</code> when downloading package.</p>
<p>Once your flink environment is set up, you can visit web ui of flink, whose address is stored in <code>/${your_flink_path}/conf/masters</code>.</p>
-<p>#Compile inlong-sort</p>
-<ul>
-<li><code>cd /your_path/Inlong/inlong-sort</code></li>
-<li><code>mvn clean package</code></li>
-</ul>
-<p>After running this, you will get <code>inlong-sort-core-{version}.jar</code> in <code>/your_path/Inlong/inlong-sort/core/target</code></p>
-<p>#Starting an inlong-sort application
-Now you can submit job to flink with the jar compiled.</p>
+<h2>Prepare installation files</h2>
+<p>All installation files at <code>inlong-sort</code> directory.</p>
+<h2>Starting an inlong-sort application</h2>
+<p>Now you can submit job to flink with the jar compiled.</p>
<p><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></p>
<p>Example：</p>
<ul>
@@ -47,7 +36,7 @@ Now you can submit job to flink with the jar compiled.</p>
<p><code>inlong-sort-core-1.0-SNAPSHOT.jar</code> 为编译阶段产出的jar包</p>
</li>
</ul>
-<p>#Necessary configurations</p>
+<h2>Necessary configurations</h2>
<ul>
<li><code>--cluster-id</code> which is used to represent a specified inlong-sort application</li>
<li><code>--zookeeper.quorum</code> zk quorum</li>
@@ -59,7 +48,7 @@ Now you can submit job to flink with the jar compiled.</p>
<p><code>~/Inlong/inlong-sort/common/src/main/java/org/apache/inlong/sort/configuration/Constants.java</code></p>
<p><strong>Example</strong></p>
<p><code>--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181 --zookeeper.path.root /zk_root --source.type tubemq --sink.type hive</code></p>
-<p>#All configurations</p>
+<h2>All configurations</h2>
<table>
<thead>
<tr>
diff --git a/en-us/docs/modules/sort/quick_start.json b/en-us/docs/modules/sort/quick_start.json
index 939e0da..fcabd3e 100644
--- a/en-us/docs/modules/sort/quick_start.json
+++ b/en-us/docs/modules/sort/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h1>Requirements</h1>\n<ul>\n<li>Java JDK 1.8</li>\n<li>Maven 3.6+</li>\n<li>Flink 1.9.3</li>\n<li>Zookeeper</li>\n</ul>\n<h2>Set up flink environment</h2>\n<p>Currently inlong-sort is based on flink, before you run an inlong-sort application,\nyou need to set up flink environment.</p>\n<p><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></p>\n<p>Currently, inlong-so [...]
+ "__html": "<h2>Set up flink environment</h2>\n<p>Currently inlong-sort is based on flink, before you run an inlong-sort application,\nyou need to set up flink environment.</p>\n<p><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></p>\n<p>Currently, inlong-sort relys on flink-1.9.3. Chose <code>flink-1.9.3-bin-scala_2.11.tgz</code> when downloading package.</p>\n<p>Once your fli [...]
"link": "/en-us/docs/modules/sort/quick_start.html",
"meta": {
"Quick Start - Apache InLong-sort": ""
diff --git a/en-us/docs/modules/sort/quick_start.md b/en-us/docs/modules/sort/quick_start.md
index 9765adc..6205390 100644
--- a/en-us/docs/modules/sort/quick_start.md
+++ b/en-us/docs/modules/sort/quick_start.md
@@ -2,13 +2,7 @@
Quick Start - Apache InLong-sort
---
-# Requirements
-- Java JDK 1.8
-- Maven 3.6+
-- Flink 1.9.3
-- Zookeeper
-
-## 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.
@@ -18,13 +12,10 @@ Currently, inlong-sort relys on flink-1.9.3. Chose `flink-1.9.3-bin-scala_2.11.t
Once your flink environment is set up, you can visit web ui of flink, whose address is stored in `/${your_flink_path}/conf/masters`.
-#Compile inlong-sort
-- `cd /your_path/Inlong/inlong-sort`
-- `mvn clean package`
-
-After running this, you will get `inlong-sort-core-{version}.jar` in `/your_path/Inlong/inlong-sort/core/target`
+## Prepare installation files
+All installation files at `inlong-sort` directory.
-#Starting an inlong-sort application
+## 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>
@@ -39,7 +30,7 @@ Notice：
- `inlong-sort-core-1.0-SNAPSHOT.jar` 为编译阶段产出的jar包
-#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
@@ -54,7 +45,7 @@ Configurations above are necessary, you can see full configurations in
`--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181 --zookeeper.path.root /zk_root --source.type tubemq --sink.type hive`
-#All configurations
+## All configurations
| name | necessary | default value |description |
| ------------ | ------------ | ------------ | ------------ |
|cluster-id | Y | NA | used to represent a specified inlong-sort application |
diff --git a/en-us/docs/modules/tubemq/quick_start.html b/en-us/docs/modules/tubemq/quick_start.html
index a63b01d..bf621c6 100644
--- a/en-us/docs/modules/tubemq/quick_start.html
+++ b/en-us/docs/modules/tubemq/quick_start.html
@@ -12,46 +12,8 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<h3>1.1 Prerequisites</h3>
-<ul>
-<li>Java JDK 1.8</li>
-<li>Maven 3.3+</li>
-</ul>
-<h3>1.2 Build Distribution Tarball</h3>
-<ul>
-<li>Compile and Package</li>
-</ul>
-<pre><code class="language-bash">mvn clean package -DskipTests
-</code></pre>
-<ul>
-<li>Run Unit Tests：</li>
-</ul>
-<pre><code class="language-bash">mvn <span class="hljs-built_in">test</span>
-</code></pre>
-<ul>
-<li>Build Individual Module：</li>
-</ul>
-<pre><code class="language-bash">mvn clean install
-<span class="hljs-built_in">cd</span> module-name (e.g. tubemq-client)
-mvn <span class="hljs-built_in">test</span>
-</code></pre>
-<p>After the build, please go to <code>tubemq-server/target</code>. You can find the
-<strong>apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz</strong> file. It is the TubeMQ deployment package, which includes
-scripts, configuration files, dependency jars and web GUI code.</p>
-<h3>1.3 Setting Up Your IDE</h3>
-<p>If you want to build and debug source code in IDE, go to the project root, and run</p>
-<pre><code class="language-bash">mvn compile
-</code></pre>
-<p>This command will generate the Java source files from the <code>protoc</code> files, the generated files located in <code>target/generated-sources</code>.</p>
-<p>(Optional) If you want to use local <code>protoc</code> executable, you can change the configuration of <code>protobuf-maven-plugin</code> in <code>tubemq-core/pom.xml</code> as below</p>
-<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">configuration</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">outputDirectory</span>></span>${project.build.directory}/generated-sources/java<span class="hljs-tag"></<span class="hljs-name">outputDirectory</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">protocExecutable</span>></span>/usr/local/bin/protoc<span class="hljs-tag"></<span class="hljs-name">protocExecutable</span>></span>
-<span class="hljs-tag"></<span class="hljs-name">configuration</span>></span>
-</code></pre>
-<h2>2 Deploy and Start</h2>
-<h3>2.1 Configuration Example</h3>
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<h3>1.1 Configuration Example</h3>
<p>There're two components in the cluster: <strong>Master</strong> and <strong>Broker</strong>. Master and Broker
can be deployed on the same server or different servers. In this example, we setup our cluster
like this, and all services run on the same node. Zookeeper should be setup in your environment also.</p>
@@ -89,20 +51,19 @@ like this, and all services run on the same node. Zookeeper should be setup in y
</tr>
</tbody>
</table>
-<h3>2.2 Prerequisites</h3>
+<h3>1.2 Prerequisites</h3>
<ul>
<li>ZooKeeper Cluster</li>
-<li><a href="download/download.md">apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz</a> package file</li>
</ul>
<p>After you extract the package file, here's the folder structure.</p>
-<pre><code>/INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin/
+<pre><code>/INSTALL_PATH/inlong-tubemq-server/
├── bin
├── conf
├── lib
├── logs
└── resources
</code></pre>
-<h3>2.3 Configure Master</h3>
+<h3>1.3 Configure Master</h3>
<p>You can change configurations in <code>conf/master.ini</code> according to cluster information.</p>
<ul>
<li>Master IP and Port</li>
@@ -166,7 +127,7 @@ the introduction of availability level.</li>
</tbody>
</table>
<p><strong>Tips</strong>：Please notice that the master servers should be clock synchronized.</p>
-<h3>2.4 Configure Broker</h3>
+<h3>1.4 Configure Broker</h3>
<p>You can change configurations in <code>conf/broker.ini</code> according to cluster information.</p>
<ul>
<li>Broker IP and Port</li>
@@ -194,7 +155,7 @@ the introduction of availability level.</li>
zkNodeRoot=/tubemq
zkServerAddr=localhost:2181 // multi zookeeper addresses can separate with ","
</code></pre>
-<h3>2.5 Start Master</h3>
+<h3>1.5 Start Master</h3>
<p>Please go to the <code>bin</code> folder and run this command to start
the master service.</p>
<pre><code class="language-bash">./tubemq.sh master start
@@ -202,7 +163,7 @@ the master service.</p>
<p>You should be able to access <code>http://your-master-ip:8080</code> to see the
web GUI now.</p>
<p><img src="img/tubemq-console-gui.png" alt="TubeMQ Console GUI"></p>
-<h4>2.5.1 Configure Broker Metadata</h4>
+<h4>1.5.1 Configure Broker Metadata</h4>
<p>Before we start a broker service, we need to configure it on master web GUI first. Go to the <code>Broker List</code> page, click <code>Add Single Broker</code>, and input the new broker information.</p>
<p><img src="img/tubemq-add-broker-1.png" alt="Add Broker 1"></p>
<p>In this example, we only need to input broker IP and authToken:</p>
@@ -213,14 +174,14 @@ web GUI now.</p>
</ol>
<p>Click the online link to activate the new added broker.</p>
<p><img src="img/tubemq-add-broker-2.png" alt="Add Broker 2"></p>
-<h3>2.6 Start Broker</h3>
+<h3>1.6 Start Broker</h3>
<p>Please go to the <code>bin</code> folder and run this command to start the broker service</p>
<pre><code class="language-bash">./tubemq.sh broker start
</code></pre>
<p>Refresh the GUI broker list page, you can see that the broker now is registered.</p>
<p>After the sub-state of the broker changed to <code>idle</code>, we can add topics to that broker.</p>
<p><img src="img/tubemq-add-broker-3.png" alt="Add Broker 3"></p>
-<h2>3 Quick Start</h2>
+<h2>2 Quick Start</h2>
<h3>3.1 Add Topic</h3>
<p>We can add or manage the cluster topics on the web GUI. To add a new topic, go to the
topic list page and click the add new topic button</p>
@@ -236,23 +197,23 @@ that the topic publish/subscribe state is active now.</p>
<p><img src="img/tubemq-add-topic-3.png" alt="Add Topic 3"></p>
<p><img src="img/tubemq-add-topic-4.png" alt="Add Topic 4"></p>
<p>Now we can use the topic to send messages.</p>
-<h3>3.2 Run Example</h3>
+<h3>2.2 Run Example</h3>
<p>Now we can use <code>demo</code> topic which created before to test our cluster.</p>
-<h4>3.2.1 Produce Messages</h4>
+<h4>2.2.1 Produce Messages</h4>
<p>Please don't forget replace <code>YOUR_MASTER_IP:port</code> with your server ip and port, and start producer.</p>
<pre><code class="language-bash"><span class="hljs-built_in">cd</span> /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
./bin/tubemq-producer-test.sh --master-servers YOUR_MASTER_IP1:port,YOUR_MASTER_IP2:port --topicName demo
</code></pre>
<p>From the log, we can see the message is sent out.
<img src="img/tubemq-send-message.png" alt="Demo 1"></p>
-<h4>3.2.2 Consume Messages</h4>
+<h4>2.2.2 Consume Messages</h4>
<p>Please don't forget replace YOUR_MASTER_IP:port with your server ip and port, and start consumer.</p>
<pre><code class="language-bash"><span class="hljs-built_in">cd</span> /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
./bin/tubemq-consumer-test.sh --master-servers YOUR_MASTER_IP1:port,YOUR_MASTER_IP2:port --topicName demo --groupName test_consume
</code></pre>
<p>From the log, we can see the message received by the consumer.
<img src="img/tubemq-consume-message.png" alt="Demo 2"></p>
-<h2>4 The End</h2>
+<h2>3 The End</h2>
<p>Here, the compilation, deployment, system configuration, startup, production and consumption of TubeMQ have been completed. If you need to understand more in-depth content, please check the relevant content in "TubeMQ HTTP API" and make the corresponding configuration settings.</p>
<hr>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with [...]
diff --git a/en-us/docs/modules/tubemq/quick_start.json b/en-us/docs/modules/tubemq/quick_start.json
index 1ea60da..d754db4 100644
--- a/en-us/docs/modules/tubemq/quick_start.json
+++ b/en-us/docs/modules/tubemq/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>1 Build TubeMQ</h2>\n<h3>1.1 Prerequisites</h3>\n<ul>\n<li>Java JDK 1.8</li>\n<li>Maven 3.3+</li>\n</ul>\n<h3>1.2 Build Distribution Tarball</h3>\n<ul>\n<li>Compile and Package</li>\n</ul>\n<pre><code class=\"language-bash\">mvn clean package -DskipTests\n</code></pre>\n<ul>\n<li>Run Unit Tests：</li>\n</ul>\n<pre><code class=\"language-bash\">mvn <span class=\"hljs-built_in\">test</span>\n</code></pre>\n<ul>\n<li>Build Individual Module：</li>\n</ul>\n<pre><code class=\"l [...]
+ "__html": "<h2>1 Deploy and Start</h2>\n<h3>1.1 Configuration Example</h3>\n<p>There're two components in the cluster: <strong>Master</strong> and <strong>Broker</strong>. Master and Broker\ncan be deployed on the same server or different servers. In this example, we setup our cluster\nlike this, and all services run on the same node. Zookeeper should be setup in your environment also.</p>\n<table>\n<thead>\n<tr>\n<th>Role</th>\n<th>TCP Port</th>\n<th>TLS Port</th>\n<th>Web Port</th>\n [...]
"link": "/en-us/docs/modules/tubemq/quick_start.html",
"meta": {
"title": "Quick Start - Apache InLong's TubeMQ module"
diff --git a/en-us/docs/modules/tubemq/quick_start.md b/en-us/docs/modules/tubemq/quick_start.md
index 3821050..a6b9f5c 100644
--- a/en-us/docs/modules/tubemq/quick_start.md
+++ b/en-us/docs/modules/tubemq/quick_start.md
@@ -1,53 +1,9 @@
---
title: Quick Start - Apache InLong's TubeMQ module
---
+## 1 Deploy and Start
-## 1 Build TubeMQ
-
-### 1.1 Prerequisites
-- Java JDK 1.8
-- Maven 3.3+
-
-### 1.2 Build Distribution Tarball
-- Compile and Package
-```bash
-mvn clean package -DskipTests
-```
-
-- Run Unit Tests：
-```bash
-mvn test
-```
-
-- Build Individual Module：
-```bash
-mvn clean install
-cd module-name (e.g. tubemq-client)
-mvn test
-```
-
-After the build, please go to `tubemq-server/target`. You can find the
-**apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz** file. It is the TubeMQ deployment package, which includes
-scripts, configuration files, dependency jars and web GUI code.
-
-### 1.3 Setting Up Your IDE
-If you want to build and debug source code in IDE, go to the project root, and run
-```bash
-mvn compile
-```
-This command will generate the Java source files from the `protoc` files, the generated files located in `target/generated-sources`.
-
-(Optional) If you want to use local `protoc` executable, you can change the configuration of `protobuf-maven-plugin` in `tubemq-core/pom.xml` as below
-```xml
-<configuration>
- <outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
- <protocExecutable>/usr/local/bin/protoc</protocExecutable>
-</configuration>
-```
-
-## 2 Deploy and Start
-
-### 2.1 Configuration Example
+### 1.1 Configuration Example
There're two components in the cluster: **Master** and **Broker**. Master and Broker
can be deployed on the same server or different servers. In this example, we setup our cluster
like this, and all services run on the same node. Zookeeper should be setup in your environment also.
@@ -57,13 +13,12 @@ like this, and all services run on the same node. Zookeeper should be setup in y
| Broker | 8123 | 8124 | 8081 | Message is stored at /stage/msg_data |
| Zookeeper | 2181 | | | Offset is stored at /tubemq |
-### 2.2 Prerequisites
+### 1.2 Prerequisites
- ZooKeeper Cluster
-- [apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz](download/download.md) package file
After you extract the package file, here's the folder structure.
```
-/INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin/
+/INSTALL_PATH/inlong-tubemq-server/
├── bin
├── conf
├── lib
@@ -71,7 +26,7 @@ After you extract the package file, here's the folder structure.
└── resources
```
-### 2.3 Configure Master
+### 1.3 Configure Master
You can change configurations in `conf/master.ini` according to cluster information.
- Master IP and Port
```ini
@@ -116,7 +71,7 @@ the introduction of availability level.
**Tips**：Please notice that the master servers should be clock synchronized.
-### 2.4 Configure Broker
+### 1.4 Configure Broker
You can change configurations in `conf/broker.ini` according to cluster information.
- Broker IP and Port
```ini
@@ -143,7 +98,7 @@ zkNodeRoot=/tubemq
zkServerAddr=localhost:2181 // multi zookeeper addresses can separate with ","
```
-### 2.5 Start Master
+### 1.5 Start Master
Please go to the `bin` folder and run this command to start
the master service.
```bash
@@ -155,7 +110,7 @@ web GUI now.
-#### 2.5.1 Configure Broker Metadata
+#### 1.5.1 Configure Broker Metadata
Before we start a broker service, we need to configure it on master web GUI first. Go to the `Broker List` page, click `Add Single Broker`, and input the new broker information.
@@ -169,7 +124,7 @@ Click the online link to activate the new added broker.
-### 2.6 Start Broker
+### 1.6 Start Broker
Please go to the `bin` folder and run this command to start the broker service
```bash
./tubemq.sh broker start
@@ -181,7 +136,7 @@ After the sub-state of the broker changed to `idle`, we can add topics to that b
-## 3 Quick Start
+## 2 Quick Start
### 3.1 Add Topic
We can add or manage the cluster topics on the web GUI. To add a new topic, go to the
topic list page and click the add new topic button
@@ -208,10 +163,10 @@ that the topic publish/subscribe state is active now.
Now we can use the topic to send messages.
-### 3.2 Run Example
+### 2.2 Run Example
Now we can use `demo` topic which created before to test our cluster.
-#### 3.2.1 Produce Messages
+#### 2.2.1 Produce Messages
Please don't forget replace `YOUR_MASTER_IP:port` with your server ip and port, and start producer.
@@ -223,7 +178,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
From the log, we can see the message is sent out.
-#### 3.2.2 Consume Messages
+#### 2.2.2 Consume Messages
Please don't forget replace YOUR_MASTER_IP:port with your server ip and port, and start consumer.
```bash
@@ -234,7 +189,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
From the log, we can see the message received by the consumer.
-## 4 The End
+## 3 The End
Here, the compilation, deployment, system configuration, startup, production and consumption of TubeMQ have been completed. If you need to understand more in-depth content, please check the relevant content in "TubeMQ HTTP API" and make the corresponding configuration settings.
---
diff --git a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html
index 054d3e2..8c0e1e3 100644
--- a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html
+++ b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html
@@ -12,30 +12,23 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<pre><code>mvn clean package
-</code></pre>
-<h2>deploy</h2>
-<p>environment requirements：</p>
-<pre><code>mysql
-java(1.8+)
-</code></pre>
-<p>In the InLong/inlong-tubemq/tubemq-manager/dist/ directory, you can find the file apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>
-<pre><code>tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-</code></pre>
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<p>All deploying files at <code>inlong-tubemq-manager</code> directory.</p>
+<h3>configuration</h3>
<p>Add mysql information in conf/application.properties:</p>
-<pre><code>spring.jpa.hibernate.ddl-auto=update
-# configuration for manager
-spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
-spring.datasource.username=[replace_by_usename]
-spring.datasource.password=[replace_by_password]
-# server port
-server.port=8089
+<pre><code class="language-ini"><span class="hljs-attr">spring.jpa.hibernate.ddl-auto</span>=update
+<span class="hljs-comment"># configuration for manager</span>
+<span class="hljs-attr">spring.datasource.url</span>=jdbc:mysql://[replace_by_mysql_address]:<span class="hljs-number">3306</span>/tubemanager
+<span class="hljs-attr">spring.datasource.username</span>=[replace_by_usename]
+<span class="hljs-attr">spring.datasource.password</span>=[replace_by_password]
+<span class="hljs-comment"># server port </span>
+<span class="hljs-attr">server.port</span>=<span class="hljs-number">8089</span>
</code></pre>
+<h3>start service</h3>
<p>Add the database tubemanager and start:</p>
-<pre><code>bin/start-admin.sh
+<pre><code class="language-bash">$ bin/start-admin.sh
</code></pre>
-<h2>use</h2>
+<h2>usage</h2>
<h3>create cluster</h3>
<p>Before using tubeAdmin to operate the cluster, you first need to register the cluster information, and use the following interface to add a cluster:
/v1/cluster?method=add</p>
diff --git a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.json b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.json
index daf4e29..bc53a60 100644
--- a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.json
+++ b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>compile</h2>\n<pre><code>mvn clean package \n</code></pre>\n<h2>deploy</h2>\n<p>environment requirements：</p>\n<pre><code>mysql\njava(1.8+)\n</code></pre>\n<p>In the InLong/inlong-tubemq/tubemq-manager/dist/ directory, you can find the file apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>\n<pre><code>tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz\n</code></pre>\n<p>Add mysql information in conf/application.properties:</p>\n<pre [...]
+ "__html": "<h2>deploy</h2>\n<p>All deploying files at <code>inlong-tubemq-manager</code> directory.</p>\n<h3>configuration</h3>\n<p>Add mysql information in conf/application.properties:</p>\n<pre><code class=\"language-ini\"><span class=\"hljs-attr\">spring.jpa.hibernate.ddl-auto</span>=update\n<span class=\"hljs-comment\"># configuration for manager</span>\n<span class=\"hljs-attr\">spring.datasource.url</span>=jdbc:mysql://[replace_by_mysql_address]:<span class=\"hljs-number\">3306</ [...]
"link": "/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md
index f965707..1a276e2 100644
--- a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,34 +1,27 @@
-## compile
-
- mvn clean package
-
## deploy
+All deploying files at `inlong-tubemq-manager` directory.
-environment requirements：
-
- mysql
- java(1.8+)
-
-
-In the InLong/inlong-tubemq/tubemq-manager/dist/ directory, you can find the file apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
- tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
+### configuration
Add mysql information in conf/application.properties:
- spring.jpa.hibernate.ddl-auto=update
- # configuration for manager
- spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
- spring.datasource.username=[replace_by_usename]
- spring.datasource.password=[replace_by_password]
- # server port
- server.port=8089
-
+```ini
+spring.jpa.hibernate.ddl-auto=update
+# configuration for manager
+spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
+spring.datasource.username=[replace_by_usename]
+spring.datasource.password=[replace_by_password]
+# server port
+server.port=8089
+```
+
+### start service
Add the database tubemanager and start:
- bin/start-admin.sh
+``` bash
+$ bin/start-admin.sh
+```
-## use
+## usage
### create cluster
diff --git a/en-us/docs/modules/website/quick_start.html b/en-us/docs/modules/website/quick_start.html
index b4a2645..7ff174c 100644
--- a/en-us/docs/modules/website/quick_start.html
+++ b/en-us/docs/modules/website/quick_start.html
@@ -13,28 +13,23 @@
</head>
<body>
<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<p>You should check that <code>nodejs >= 12.0</code> is installed.</p>
-<h2>Dev</h2>
-<p>In the project, you can run some built-in commands:</p>
-<p>If <code>node_modules</code> is not installed, you should first run <code>npm install</code> or <code>yarn install</code>.</p>
-<p>Use <code>npm run dev</code> or <code>yarn dev</code> to run the application in development mode.</p>
-<p>If the server runs successfully, the browser will open <a href="http://localhost:8080">http://localhost:8080</a> to view in the browser.</p>
-<p>If you edit, the page will reload.
-You will also see any lint errors in the console.</p>
-<p>The start of the web server depends on the back-end server <code>manger api</code> interface.</p>
-<p>You should start the backend server first, and then set the variable <code>target</code> in <code>/inlong-website/src/setupProxy.js</code> to the address of the api service.</p>
-<h2>Test</h2>
-<p>Run <code>npm test</code> or <code>yarn test</code></p>
-<p>Start the test runner in interactive observation mode.
-For more information, see the section on <a href="https://create-react-app.dev/docs/running-tests/">Running Tests</a>.</p>
-<h2>Build and deploy</h2>
-<p>First, make sure that the project has run <code>npm install</code> or <code>yarn install</code> to install <code>node_modules</code>.</p>
-<p>Run <code>npm run build</code> or <code>yarn build</code>.</p>
-<p>Build the application for production into the build folder.
-Better page performance can be obtained in the constructed production mode.</p>
-<p>After the build, the code is compressed, and the file name includes the hash value.
-Your application is ready to be deployed!</p>
-<p>For details, see the section on <a href="https://create-react-app.dev/docs/deployment/">deployment</a>.</p>
+<ul>
+<li>nginx</li>
+</ul>
+<h2>configuration</h2>
+<pre><code>server {
+ listen 80;
+ listen [::]:80;
+ server_name _;
+ # replaced by the directory of inlong-website
+ root /inlong_root_path/inlong-website;
+
+ # replaced manager_api_ip
+ location /api {
+ proxy_pass http://manager_api_ip:8083;
+ }
+}
+</code></pre>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with [...]
<script src="https://f.alicdn.com/react/15.4.1/react-with-addons.min.js"></script>
<script src="https://f.alicdn.com/react/15.4.1/react-dom.min.js"></script>
diff --git a/en-us/docs/modules/website/quick_start.json b/en-us/docs/modules/website/quick_start.json
index 455248e..c66b8ed 100644
--- a/en-us/docs/modules/website/quick_start.json
+++ b/en-us/docs/modules/website/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>Environment</h2>\n<p>You should check that <code>nodejs >= 12.0</code> is installed.</p>\n<h2>Dev</h2>\n<p>In the project, you can run some built-in commands:</p>\n<p>If <code>node_modules</code> is not installed, you should first run <code>npm install</code> or <code>yarn install</code>.</p>\n<p>Use <code>npm run dev</code> or <code>yarn dev</code> to run the application in development mode.</p>\n<p>If the server runs successfully, the browser will open <a href=\"htt [...]
+ "__html": "<h2>Environment</h2>\n<ul>\n<li>nginx</li>\n</ul>\n<h2>configuration</h2>\n<pre><code>server {\n listen 80;\n listen [::]:80;\n server_name _;\n # replaced by the directory of inlong-website\n root /inlong_root_path/inlong-website;\n\n # replaced manager_api_ip\n location /api {\n proxy_pass http://manager_api_ip:8083;\n }\n}\n</code></pre>\n",
"link": "/en-us/docs/modules/website/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/en-us/docs/modules/website/quick_start.md b/en-us/docs/modules/website/quick_start.md
index fd75f06..24fe410 100644
--- a/en-us/docs/modules/website/quick_start.md
+++ b/en-us/docs/modules/website/quick_start.md
@@ -1,41 +1,20 @@
## Environment
-You should check that `nodejs >= 12.0` is installed.
-
-## Dev
-
-In the project, you can run some built-in commands:
-
-If `node_modules` is not installed, you should first run `npm install` or `yarn install`.
-
-Use `npm run dev` or `yarn dev` to run the application in development mode.
-
-If the server runs successfully, the browser will open [http://localhost:8080](http://localhost:8080) to view in the browser.
-
-If you edit, the page will reload.
-You will also see any lint errors in the console.
-
-The start of the web server depends on the back-end server `manger api` interface.
-
-You should start the backend server first, and then set the variable `target` in `/inlong-website/src/setupProxy.js` to the address of the api service.
-
-## Test
-
-Run `npm test` or `yarn test`
-
-Start the test runner in interactive observation mode.
-For more information, see the section on [Running Tests](https://create-react-app.dev/docs/running-tests/).
-
-## Build and deploy
-
-First, make sure that the project has run `npm install` or `yarn install` to install `node_modules`.
-
-Run `npm run build` or `yarn build`.
-
-Build the application for production into the build folder.
-Better page performance can be obtained in the constructed production mode.
-
-After the build, the code is compressed, and the file name includes the hash value.
-Your application is ready to be deployed!
-
-For details, see the section on [deployment](https://create-react-app.dev/docs/deployment/).
\ No newline at end of file
+- nginx
+
+## configuration
+
+```
+server {
+ listen 80;
+ listen [::]:80;
+ server_name _;
+ # replaced by the directory of inlong-website
+ root /inlong_root_path/inlong-website;
+
+ # replaced manager_api_ip
+ location /api {
+ proxy_pass http://manager_api_ip:8083;
+ }
+}
+```
\ No newline at end of file
diff --git a/en-us/docs/quick_start.html b/en-us/docs/quick_start.html
index 02c9f30..6fe3185 100644
--- a/en-us/docs/quick_start.html
+++ b/en-us/docs/quick_start.html
@@ -13,26 +13,52 @@
</head>
<body>
<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/en-us/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<h1>Overall architecture</h1>
+<h2>Overall architecture</h2>
<img src="../../img/inlong_architecture.png" align="center" alt="Apache InLong"/>
<p><a href="https://inlong.apache.org">Apache InLong</a>(incubating) overall architecture is as above. This component is a one-stop data streaming platform that provides automated, secure, distributed, and efficient data publishing and subscription capabilities to help You can easily build stream-based data applications.</p>
<p>InLong (Yinglong) was originally built in Tencent and has served online business for more than 8 years. It supports massive data (over 40 trillion pieces of data per day) report services under big data scenarios. The entire platform integrates 5 modules including data collection, aggregation, caching, sorting and management modules. Through this system, the business only needs to provide data sources, data service quality, data landing clusters and data landing formats, that is, data [...]
-<h1>How to use</h1>
-<p>Through the overall architecture diagram of InLong above, we can see that InLong contains complete data reporting components, and we need to compile and deploy modules one by one.</p>
-<h2>Compile and deploy Manager</h2>
-<p><a href="modules/manager/quick_start.md">How to compile and deploy Manager</a></p>
-<h2>Compile and deploy InLong Web</h2>
-<p><a href="modules/website/quick_start.md">How to compile and deploy InLong Web</a></p>
-<h2>Compile and deploy TubeMQ</h2>
-<p><a href="modules/tubemq/quick_start.md">How to compile and deploy TubeMQ</a></p>
-<h2>Compile and deploy TubeMQ Manager</h2>
-<p><a href="modules/tubemq/tubemq-manager/quick_start.md">How to compile and deploy TubeMQ Manager</a></p>
-<h2>Compile and deploy Sort</h2>
-<p><a href="modules/sort/quick_start.md">How to compile and deploy Sort</a></p>
-<h2>Compile and deploy DataProxy</h2>
-<p><a href="modules/dataproxy/quick_start.md">How to compile and deploy DataProxy</a></p>
-<h2>Compile and deploy the Agent</h2>
-<p><a href="modules/agent/quick_start.md">How to compile and deploy Agent</a></p>
+<h2>Compile</h2>
+<ul>
+<li>Java <a href="https://adoptopenjdk.net/?variant=openjdk8">JDK 8</a></li>
+<li>Maven 3.6.1+</li>
+</ul>
+<pre><code>$ mvn clean install -DskipTests
+</code></pre>
+<p>(Optional) Compile using docker image:</p>
+<pre><code>$ docker pull maven:3.6-openjdk-8
+$ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8 mvn clean install -DskipTests
+</code></pre>
+<p>after compile successfully, you could find distribution file at <code>inlong-distribution/target</code> with <code>tar.gz</code> format, it includes following files:</p>
+<pre><code>inlong-agent
+inlong-dataproxy
+inlong-manager-api
+inlong-manager-openapi
+inlong-sort
+inlong-tubemq-manager
+inlong-tubemq-server
+inlong-website
+</code></pre>
+<h2>Environment Requirements</h2>
+<ul>
+<li>ZooKeeper 3.5+</li>
+<li>Hadoop 2.10.x 和 Hive 2.3.x</li>
+<li>MySQL 5.7+</li>
+<li>Flink 1.9.x</li>
+</ul>
+<h2>deploy InLong TubeMQ Server</h2>
+<p><a href="modules/tubemq/quick_start.md">deploy InLong TubeMQ Server</a></p>
+<h2>deploy InLong TubeMQ Manager</h2>
+<p><a href="modules/tubemq/tubemq-manager/quick_start.md">deploy InLong TubeMQ Manager</a></p>
+<h2>deploy InLong Manager</h2>
+<p><a href="modules/manager/quick_start.md">deploy InLong Manager</a></p>
+<h2>deploy InLong Web</h2>
+<p><a href="modules/website/quick_start.md">deploy InLong Web</a></p>
+<h2>deploy InLong Sort</h2>
+<p><a href="modules/sort/quick_start.md">deploy InLong Sort</a></p>
+<h2>deploy InLong DataProxy</h2>
+<p><a href="modules/dataproxy/quick_start.md">deploy InLong DataProxy</a></p>
+<h2>deploy InLong Agent</h2>
+<p><a href="modules/agent/quick_start.md">deploy InLong Agent</a></p>
<h2>Business configuration</h2>
<p><a href="modules/manager/user_manual.md">How to configure a new business</a></p>
<h2>Data report verification</h2>
diff --git a/en-us/docs/quick_start.json b/en-us/docs/quick_start.json
index 57adb96..d57a145 100644
--- a/en-us/docs/quick_start.json
+++ b/en-us/docs/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<p>This section contains a quick start guide to help you get started with Apache InLong.</p>\n<h1>Overall architecture</h1>\n<img src=\"../../img/inlong_architecture.png\" align=\"center\" alt=\"Apache InLong\"/>\n<p><a href=\"https://inlong.apache.org\">Apache InLong</a>(incubating) overall architecture is as above. This component is a one-stop data streaming platform that provides automated, secure, distributed, and efficient data publishing and subscription capabilities t [...]
+ "__html": "<p>This section contains a quick start guide to help you get started with Apache InLong.</p>\n<h2>Overall architecture</h2>\n<img src=\"../../img/inlong_architecture.png\" align=\"center\" alt=\"Apache InLong\"/>\n<p><a href=\"https://inlong.apache.org\">Apache InLong</a>(incubating) overall architecture is as above. This component is a one-stop data streaming platform that provides automated, secure, distributed, and efficient data publishing and subscription capabilities t [...]
"link": "/en-us/docs/quick_start.html",
"meta": {
"title": "Getting Started - Apache InLong"
diff --git a/en-us/docs/quick_start.md b/en-us/docs/quick_start.md
index 7533719..f9f83cc 100644
--- a/en-us/docs/quick_start.md
+++ b/en-us/docs/quick_start.md
@@ -4,7 +4,7 @@ title: Getting Started - Apache InLong
This section contains a quick start guide to help you get started with Apache InLong.
-# Overall architecture
+## Overall architecture
<img src="../../img/inlong_architecture.png" align="center" alt="Apache InLong"/>
[Apache InLong](https://inlong.apache.org)(incubating) overall architecture is as above. This component is a one-stop data streaming platform that provides automated, secure, distributed, and efficient data publishing and subscription capabilities to help You can easily build stream-based data applications.
@@ -12,29 +12,56 @@ This section contains a quick start guide to help you get started with Apache In
InLong (Yinglong) was originally built in Tencent and has served online business for more than 8 years. It supports massive data (over 40 trillion pieces of data per day) report services under big data scenarios. The entire platform integrates 5 modules including data collection, aggregation, caching, sorting and management modules. Through this system, the business only needs to provide data sources, data service quality, data landing clusters and data landing formats, that is, data can [...]
-# How to use
-Through the overall architecture diagram of InLong above, we can see that InLong contains complete data reporting components, and we need to compile and deploy modules one by one.
+## Compile
+- Java [JDK 8](https://adoptopenjdk.net/?variant=openjdk8)
+- Maven 3.6.1+
-## Compile and deploy Manager
-[How to compile and deploy Manager](modules/manager/quick_start.md)
+```
+$ mvn clean install -DskipTests
+```
+(Optional) Compile using docker image:
+```
+$ docker pull maven:3.6-openjdk-8
+$ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8 mvn clean install -DskipTests
+```
+after compile successfully, you could find distribution file at `inlong-distribution/target` with `tar.gz` format, it includes following files:
+```
+inlong-agent
+inlong-dataproxy
+inlong-manager-api
+inlong-manager-openapi
+inlong-sort
+inlong-tubemq-manager
+inlong-tubemq-server
+inlong-website
+```
-## Compile and deploy InLong Web
-[How to compile and deploy InLong Web](modules/website/quick_start.md)
+## Environment Requirements
+- ZooKeeper 3.5+
+- Hadoop 2.10.x 和 Hive 2.3.x
+- MySQL 5.7+
+- Flink 1.9.x
-## Compile and deploy TubeMQ
-[How to compile and deploy TubeMQ](modules/tubemq/quick_start.md)
+## deploy InLong TubeMQ Server
+[deploy InLong TubeMQ Server](modules/tubemq/quick_start.md)
-## Compile and deploy TubeMQ Manager
-[How to compile and deploy TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
+## deploy InLong TubeMQ Manager
+[deploy InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
-## Compile and deploy Sort
-[How to compile and deploy Sort](modules/sort/quick_start.md)
+## deploy InLong Manager
+[deploy InLong Manager](modules/manager/quick_start.md)
-## Compile and deploy DataProxy
-[How to compile and deploy DataProxy](modules/dataproxy/quick_start.md)
+## deploy InLong Web
+[deploy InLong Web](modules/website/quick_start.md)
-## Compile and deploy the Agent
-[How to compile and deploy Agent](modules/agent/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](modules/manager/user_manual.md)
diff --git a/zh-cn/docs/modules/agent/quick_start.html b/zh-cn/docs/modules/agent/quick_start.html
index 929dbed..7276897 100644
--- a/zh-cn/docs/modules/agent/quick_start.html
+++ b/zh-cn/docs/modules/agent/quick_start.html
@@ -12,32 +12,24 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<pre><code>环境要求：
-java JDK 1.8
-Maven 3.6 +
-
-inlong目录下执行命令
-mvn clean package -DskipTests
-
-在项目下的agent-release/target里面可以找到tgz安装包
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<pre><code>cd inlong-agent
</code></pre>
-<h2>二、配置</h2>
<p>agent 支持两种运行模式：本地运行以及线上运行</p>
-<h3>2.1 Agent 线上运行相关设置</h3>
+<h3>1.1 Agent 线上运行相关设置</h3>
<p>线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：</p>
<pre><code class="language-ini"><span class="hljs-attr">agent.fetcher.classname</span>=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (设置任务获取的类名，默认为ManagerFetcher）
<span class="hljs-attr">agent.local.ip</span>=写入本机ip
<span class="hljs-attr">agent.manager.vip.http.host</span>=manager open api host
<span class="hljs-attr">agent.manager.vip.http.port</span>=manager open api port
</code></pre>
-<h3>2.2 DataProxy 相关设置</h3>
+<h3>1.2 DataProxy 相关设置</h3>
<p>在agent目录下新建.inlong文件夹，内部新建bid+.local文件，例如设置的发送bid为a, 则新建a.local文件</p>
<p>内部将写入：</p>
<pre><code class="language-ini">{"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
其中cluster_id, isInterVisit，switch为预留字段，请填写默认值
</code></pre>
-<h3>2.3 agent本地运行job配置</h3>
+<h3>1.3 agent本地运行job配置</h3>
<p>如果不使用线上模式，可以使用本地文件新建读取任务
在conf中新建目录jobs，jobs内部vim job1.json：</p>
<p>写入</p>
@@ -83,14 +75,14 @@ mvn clean package -DskipTests
<li>proxy.bid: 写入proxy时使用的bid类型</li>
<li>proxy.tid: 写入proxy时使用的tid类型</li>
</ul>
-<h3>2.4 实时添加job配置</h3>
-<h4>2.4.1 agent.propertities 修改下面两处</h4>
+<h3>1.4 实时添加job配置</h3>
+<h4>1.4.1 agent.propertities 修改下面两处</h4>
<pre><code class="language-ini"><span class="hljs-comment"># whether enable http service</span>
<span class="hljs-attr">agent.http.enable</span>=<span class="hljs-literal">true</span>
<span class="hljs-comment"># http default port</span>
<span class="hljs-attr">agent.http.port</span>=可用端口
</code></pre>
-<h4>2.4.2 执行如下命令：</h4>
+<h4>1.4.2 执行如下命令：</h4>
<pre><code class="language-bash">curl --location --request POST <span class="hljs-string">'http://localhost:8018/config/job'</span> \
--header <span class="hljs-string">'Content-Type: application/json'</span> \
--data <span class="hljs-string">'{
@@ -123,11 +115,11 @@ pattern: 代表读取/data/inlong-agent/test.log文件，需要新建任务后
proxy.bid: 代表发送到dataproxy使用的bid
proxy.tid: 代表发送到dataproxy使用的tid
</code></pre>
-<h2>三、运行</h2>
+<h2>2、运行</h2>
<p>解压后如下命令运行</p>
<pre><code class="language-bash">sh agent.sh start
</code></pre>
-<h2>四、可支持的路径配置方案</h2>
+<h2>3、可支持的路径配置方案</h2>
<pre><code>例如：
/data/inlong-agent/test.log //代表读取inlong-agent文件夹下的的新增文件test.log
/data/inlong-agent/test[0-9]{1} //代表读取inlong-agent文件夹下的新增文件test后接一个数字结尾
diff --git a/zh-cn/docs/modules/agent/quick_start.json b/zh-cn/docs/modules/agent/quick_start.json
index c46c722..656ae89 100644
--- a/zh-cn/docs/modules/agent/quick_start.json
+++ b/zh-cn/docs/modules/agent/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>一、安装</h2>\n<pre><code>环境要求：\njava JDK 1.8\nMaven 3.6 +\n\ninlong目录下执行命令\nmvn clean package -DskipTests\n\n在项目下的agent-release/target里面可以找到tgz安装包\n</code></pre>\n<h2>二、配置</h2>\n<p>agent 支持两种运行模式：本地运行以及线上运行</p>\n<h3>2.1 Agent 线上运行相关设置</h3>\n<p>线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：</p>\n<pre><code class=\"language-ini\"><span class=\"hljs-attr\">agent.fetcher.classname</span>=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (设置任务获取的类名，默认为ManagerFetcher）\n [...]
+ "__html": "<h2>1、配置</h2>\n<pre><code>cd inlong-agent\n</code></pre>\n<p>agent 支持两种运行模式：本地运行以及线上运行</p>\n<h3>1.1 Agent 线上运行相关设置</h3>\n<p>线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：</p>\n<pre><code class=\"language-ini\"><span class=\"hljs-attr\">agent.fetcher.classname</span>=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (设置任务获取的类名，默认为ManagerFetcher）\n<span class=\"hljs-attr\">agent.local.ip</span>=写入本机ip\n<span class=\"hljs-attr\">agent.manager.vip.http.host</span>=mana [...]
"link": "/zh-cn/docs/modules/agent/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/modules/agent/quick_start.md b/zh-cn/docs/modules/agent/quick_start.md
index ab2658e..20dde9a 100644
--- a/zh-cn/docs/modules/agent/quick_start.md
+++ b/zh-cn/docs/modules/agent/quick_start.md
@@ -1,21 +1,11 @@
-## 一、安装
-
- 环境要求：
- java JDK 1.8
- Maven 3.6 +
-
- inlong目录下执行命令
- mvn clean package -DskipTests
-
- 在项目下的agent-release/target里面可以找到tgz安装包
-
-
-
-## 二、配置
+## 1、配置
+```
+cd inlong-agent
+```
agent 支持两种运行模式：本地运行以及线上运行
-### 2.1 Agent 线上运行相关设置
+### 1.1 Agent 线上运行相关设置
线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：
```ini
@@ -25,7 +15,7 @@ agent.manager.vip.http.host=manager open api host
agent.manager.vip.http.port=manager open api port
```
-### 2.2 DataProxy 相关设置
+### 1.2 DataProxy 相关设置
在agent目录下新建.inlong文件夹，内部新建bid+.local文件，例如设置的发送bid为a, 则新建a.local文件
内部将写入：
@@ -34,7 +24,7 @@ agent.manager.vip.http.port=manager open api port
其中cluster_id, isInterVisit，switch为预留字段，请填写默认值
```
-### 2.3 agent本地运行job配置
+### 1.3 agent本地运行job配置
如果不使用线上模式，可以使用本地文件新建读取任务
在conf中新建目录jobs，jobs内部vim job1.json：
@@ -83,9 +73,9 @@ agent.manager.vip.http.port=manager open api port
- proxy.bid: 写入proxy时使用的bid类型
- proxy.tid: 写入proxy时使用的tid类型
-### 2.4 实时添加job配置
+### 1.4 实时添加job配置
-#### 2.4.1 agent.propertities 修改下面两处
+#### 1.4.1 agent.propertities 修改下面两处
```ini
# whether enable http service
agent.http.enable=true
@@ -93,7 +83,7 @@ agent.http.enable=true
agent.http.port=可用端口
```
-#### 2.4.2 执行如下命令：
+#### 1.4.2 执行如下命令：
```bash
curl --location --request POST 'http://localhost:8018/config/job' \
--header 'Content-Type: application/json' \
@@ -128,14 +118,14 @@ curl --location --request POST 'http://localhost:8018/config/job' \
proxy.bid: 代表发送到dataproxy使用的bid
proxy.tid: 代表发送到dataproxy使用的tid
-## 三、运行
+## 2、运行
解压后如下命令运行
```bash
sh agent.sh start
```
-## 四、可支持的路径配置方案
+## 3、可支持的路径配置方案
例如：
/data/inlong-agent/test.log //代表读取inlong-agent文件夹下的的新增文件test.log
diff --git a/zh-cn/docs/modules/dataproxy/quick_start.html b/zh-cn/docs/modules/dataproxy/quick_start.html
index 2276f2e..52cc143 100644
--- a/zh-cn/docs/modules/dataproxy/quick_start.html
+++ b/zh-cn/docs/modules/dataproxy/quick_start.html
@@ -12,15 +12,8 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<pre><code>mvn clean package -DskipTests
-</code></pre>
-<p>在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>
-<p>解压</p>
-<pre><code>tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-</code></pre>
-<h2>二、配置</h2>
-<pre><code>cd apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<pre><code>cd inlong-dataproxy
</code></pre>
<h3>配置tube地址和端口号</h3>
<pre><code>执行以下替换命令,其中ip:port为tube地址
@@ -42,10 +35,10 @@ cd ..
cluster_id=1 // 预留字段，请填写默认值1
manager_hosts=ip:port // 这里写入的是manager open api地址
</code></pre>
-<h2>三、启动</h2>
+<h2>启动</h2>
<pre><code>sh bin/start.sh
</code></pre>
-<h2>四、检查启动情况</h2>
+<h2>检查启动情况</h2>
<pre><code>telnet 127.0.0.1 46801
</code></pre>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with [...]
diff --git a/zh-cn/docs/modules/dataproxy/quick_start.json b/zh-cn/docs/modules/dataproxy/quick_start.json
index a902792..fe1c7d0 100644
--- a/zh-cn/docs/modules/dataproxy/quick_start.json
+++ b/zh-cn/docs/modules/dataproxy/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>一、安装</h2>\n<pre><code>mvn clean package -DskipTests\n</code></pre>\n<p>在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>\n<p>解压</p>\n<pre><code>tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz\n</code></pre>\n<h2>二、配置</h2>\n<pre><code>cd apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin\n</code></pre>\n<h3>配置tube地址和端口号</h3>\n<pre><code>执行以下替换命令,其中ip:port为tube地址\n</code></pre>\n<p [...]
+ "__html": "<h2>配置</h2>\n<pre><code>cd inlong-dataproxy\n</code></pre>\n<h3>配置tube地址和端口号</h3>\n<pre><code>执行以下替换命令,其中ip:port为tube地址\n</code></pre>\n<p>sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf</p>\n<pre><code>修改以下内容为proxy端口号\nagent1.sources.tcp-source.port = 46801\n</code></pre>\n<p>注意conf/flume.conf中FLUME_HOME为proxy的中间数据文件存放地址</p>\n<h3>环境准备</h3>\n<pre><code>cd bin\nsh prepare_env.sh\ncd ..\n</code></pre>\n<h3>配置manager地址</h3>\n<pre><code>vim conf/common.properties\n\n写入以 [...]
"link": "/zh-cn/docs/modules/dataproxy/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/modules/dataproxy/quick_start.md b/zh-cn/docs/modules/dataproxy/quick_start.md
index c4d031c..35ff916 100644
--- a/zh-cn/docs/modules/dataproxy/quick_start.md
+++ b/zh-cn/docs/modules/dataproxy/quick_start.md
@@ -1,18 +1,6 @@
-## 一、安装
+## 配置
- mvn clean package -DskipTests
-
-在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
-
-解压
-
- tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
-
-## 二、配置
-
- cd apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin
+ cd inlong-dataproxy
### 配置tube地址和端口号
@@ -37,10 +25,10 @@ sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
cluster_id=1 // 预留字段，请填写默认值1
manager_hosts=ip:port // 这里写入的是manager open api地址
-## 三、启动
+## 启动
sh bin/start.sh
-## 四、检查启动情况
+## 检查启动情况
telnet 127.0.0.1 46801
diff --git a/zh-cn/docs/modules/manager/quick_start.html b/zh-cn/docs/modules/manager/quick_start.html
index e06c3b1..e60a791 100644
--- a/zh-cn/docs/modules/manager/quick_start.html
+++ b/zh-cn/docs/modules/manager/quick_start.html
@@ -13,18 +13,8 @@
</head>
<body>
<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<p>开始安装前，请自行下载并安装下述软件：</p>
<ul>
<li>
-<p>安装并配置 JDK（1.8+）、Maven（3.3+）；</p>
-</li>
-<li>
-<p>安装并启动 ZooKeeper 3.5+；</p>
-</li>
-<li>
-<p>安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；</p>
-</li>
-<li>
<p>安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 <code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 <code>/data/</code>
目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>
<pre><code class="language-shell"><span class="hljs-meta">#</span><span class="bash"> 通过用户名和密码，登录 MySQL 服务器：</span>
@@ -45,24 +35,11 @@ USE apache_inlong_manager;
TubeManager。</p>
</li>
</ul>
-<h1>2. 编译打包</h1>
-<p>通过 macOS 的终端（或 Windows 的命令提示符窗口）进入项目根目录，执行以下编译命令：</p>
-<pre><code>mvn clean install -DskipTests
-</code></pre>
-<p>编译成功后，前往项目的 <code>inlong-manager/manager-api</code> 和 <code>inlong-manager/manager-openapi</code> 模块，在各自的 <code>target</code>
-目录下生成了安装包，名称分别为 <code>apache-inlong-manager-api*.tar.gz</code> 和 <code>apache-inlong-manager-openapi*.tar.gz</code>。</p>
-<h1>3. 部署、启动 manager-api</h1>
+<h1>2. 部署、启动 manager-api</h1>
<p><strong>manager-api 是与前端页面交互的后台服务。</strong></p>
-<h2>3.1 上传、解压安装包</h2>
-<ol>
-<li>
-<p>将第2步的 <code>inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz</code> 拷贝到要部署的服务器；</p>
-</li>
-<li>
-<p>前往部署服务器，解压安装包：<code>tar -zxvf apache-inlong-manager-api-*.tar.gz</code>，得到 <code>manager-api</code> 文件夹。</p>
-</li>
-</ol>
-<h2>3.2 修改配置</h2>
+<h2>2.1 准备安装文件</h2>
+<p>安装文件在<code>inlong-manager-api</code>目录.</p>
+<h2>2.2 修改配置</h2>
<p>前往解压后的 <code>manager-api</code> 目录，修改 <code>conf/application.yml</code> 文件：</p>
<pre><code class="language-yaml"><span class="hljs-comment"># manager-api 服务的端口号</span>
<span class="hljs-attr">server:</span>
@@ -98,22 +75,15 @@ TubeManager。</p>
</code></pre>
</li>
</ol>
-<h2>3.3 启动服务</h2>
+<h2>2.3 启动服务</h2>
<p>进入解压后的目录，执行 <code>sh bin/startup.sh</code> 启动服务，查看日志 <code>tailf log/manager-api.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
<pre><code class="language-shell">Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
</code></pre>
-<h1>4. 部署、启动 manager-openapi</h1>
+<h1>3. 部署、启动 manager-openapi</h1>
<p><strong>manager-openapi 是为其他组件（如 Agent、DataProxy）提供交互接口的服务。</strong></p>
-<h2>4.1 上传、解压安装包</h2>
-<ol>
-<li>
-<p>将第2步的 <code>inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz</code> 拷贝到要部署的服务器；</p>
-</li>
-<li>
-<p>前往部署服务器，解压安装包：<code>tar -zxvf apache-inlong-manager-openapi-*.tar.gz</code>，得到 <code>manager-openapi</code> 文件夹。</p>
-</li>
-</ol>
-<h2>4.2 修改配置</h2>
+<h2>3.1 准备安装文件</h2>
+<p>安装文件在<code>inlong-manager-openapi</code>目录.</p>
+<h2>3.2 修改配置</h2>
<p>前往解压后的 <code>manager-openapi</code> 目录，修改 <code>conf/application.yml</code> 文件：</p>
<pre><code class="language-yaml"><span class="hljs-comment"># manager-openapi 服务的端口号</span>
<span class="hljs-attr">server:</span>
@@ -149,11 +119,11 @@ TubeManager。</p>
</code></pre>
</li>
</ol>
-<h2>4.3 启动服务</h2>
+<h2>3.3 启动服务</h2>
<p>进入解压后的目录，执行 <code>sh bin/startup.sh</code> 启动服务，查看日志 <code>tailf log/manager-openapi.log</code>，若出现类似下面的日志，说明服务启动成功：</p>
<pre><code class="language-shell">Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
</code></pre>
-<h1>5. 服务访问验证</h1>
+<h1>4. 服务访问验证</h1>
<ol>
<li>
<p>验证 manager-api 服务：</p>
diff --git a/zh-cn/docs/modules/manager/quick_start.json b/zh-cn/docs/modules/manager/quick_start.json
index 94815f0..9d3a8cd 100644
--- a/zh-cn/docs/modules/manager/quick_start.json
+++ b/zh-cn/docs/modules/manager/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h1>1. 环境准备</h1>\n<p>开始安装前，请自行下载并安装下述软件：</p>\n<ul>\n<li>\n<p>安装并配置 JDK（1.8+）、Maven（3.3+）；</p>\n</li>\n<li>\n<p>安装并启动 ZooKeeper 3.5+；</p>\n</li>\n<li>\n<p>安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；</p>\n</li>\n<li>\n<p>安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 <code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 <code>/data/</code>\n目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>\n<pre><code class=\"language-shell\"><span class=\"hljs-meta\">#</span><span class=\"bash\"> 通过用户名 [...]
+ "__html": "<h1>1. 环境准备</h1>\n<ul>\n<li>\n<p>安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 <code>doc/sql/apache_inlong_manager.sql</code> 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 <code>/data/</code>\n目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：</p>\n<pre><code class=\"language-shell\"><span class=\"hljs-meta\">#</span><span class=\"bash\"> 通过用户名和密码，登录 MySQL 服务器：</span>\nmysql -u xxx -p xxx\n...\n<span class=\"hljs-meta\">#</span><span class=\"bash\"> 创建数据库</span>\nCREATE DATABASE IF NOT EXISTS apache_inlong_manager;\n [...]
"link": "/zh-cn/docs/modules/manager/quick_start.html",
"meta": {
"快速开始 - Apache inlong-manager": ""
diff --git a/zh-cn/docs/modules/manager/quick_start.md b/zh-cn/docs/modules/manager/quick_start.md
index 56caf8d..67bba33 100644
--- a/zh-cn/docs/modules/manager/quick_start.md
+++ b/zh-cn/docs/modules/manager/quick_start.md
@@ -3,15 +3,6 @@
---
# 1. 环境准备
-
-开始安装前，请自行下载并安装下述软件：
-
-- 安装并配置 JDK（1.8+）、Maven（3.3+）；
-
-- 安装并启动 ZooKeeper 3.5+；
-
-- 安装并启动 Hadoop 2.10.x 和 Hive 2.3.x；
-
- 安装并启动 MySQL 5.7+，把 inlong-manager 模块中的 `doc/sql/apache_inlong_manager.sql` 文件拷贝到 MySQL 数据库所在的服务器（比如拷贝到 `/data/`
目录下），通过下述命令加载此文件，完成表结构及基础数据的初始化：
@@ -30,29 +21,15 @@
- 参照 [编译部署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
+
+# 2. 部署、启动 manager-api
**manager-api 是与前端页面交互的后台服务。**
-## 3.1 上传、解压安装包
-
-1) 将第2步的 `inlong-manager/manager-api/target/apache-inlong-manager-api-*.tar.gz` 拷贝到要部署的服务器；
+## 2.1 准备安装文件
+安装文件在`inlong-manager-api`目录.
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-api-*.tar.gz`，得到 `manager-api` 文件夹。
-
-## 3.2 修改配置
+## 2.2 修改配置
前往解压后的 `manager-api` 目录，修改 `conf/application.yml` 文件：
@@ -93,7 +70,7 @@ spring:
sort.appName: inlong_app # Sort 应用名称，即设置 Sort 的 cluster-id 参数，默认值为"inlong_app"
```
-## 3.3 启动服务
+## 2.3 启动服务
进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf log/manager-api.log`，若出现类似下面的日志，说明服务启动成功：
@@ -101,17 +78,14 @@ spring:
Started InLongApiApplication in 6.795 seconds (JVM running for 7.565)
```
-# 4. 部署、启动 manager-openapi
+# 3. 部署、启动 manager-openapi
**manager-openapi 是为其他组件（如 Agent、DataProxy）提供交互接口的服务。**
-## 4.1 上传、解压安装包
-
-1) 将第2步的 `inlong-manager/manager-openapi/target/apache-inlong-manager-openapi-*.tar.gz` 拷贝到要部署的服务器；
-
-2) 前往部署服务器，解压安装包：`tar -zxvf apache-inlong-manager-openapi-*.tar.gz`，得到 `manager-openapi` 文件夹。
+## 3.1 准备安装文件
+安装文件在`inlong-manager-openapi`目录.
-## 4.2 修改配置
+## 3.2 修改配置
前往解压后的 `manager-openapi` 目录，修改 `conf/application.yml` 文件：
@@ -152,7 +126,7 @@ spring:
sort.appName: inlong_app # Sort 应用名称，即设置 Sort 的 cluster-id 参数，默认值为"inlong_app"
```
-## 4.3 启动服务
+## 3.3 启动服务
进入解压后的目录，执行 `sh bin/startup.sh` 启动服务，查看日志 `tailf log/manager-openapi.log`，若出现类似下面的日志，说明服务启动成功：
@@ -160,7 +134,7 @@ spring:
Started InLongOpenApiApplication in 5.341 seconds (JVM running for 6.002)
```
-# 5. 服务访问验证
+# 4. 服务访问验证
1) 验证 manager-api 服务：
diff --git a/zh-cn/docs/modules/sort/quick_start.html b/zh-cn/docs/modules/sort/quick_start.html
index 8492112..e8e9509 100644
--- a/zh-cn/docs/modules/sort/quick_start.html
+++ b/zh-cn/docs/modules/sort/quick_start.html
@@ -12,27 +12,14 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<ul>
-<li>Java JDK 1.8</li>
-<li>Maven 3.6+</li>
-<li>Flink 1.9.3</li>
-<li>Zookeeper</li>
-</ul>
-<h2>配置flink运行环境</h2>
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
<p>当前inlong-sort是基于flink的一个应用，因此运行inlong-sort应用前，需要准备好flink环境。</p>
<p><a href="https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/cluster_setup.html" title="how to set up flink environment">如何配置flink环境</a></p>
<p>由于当前inlong-sort依赖的是flink1.9.3版本，因此在下载部署包时，请选择<code>flink-1.9.3-bin-scala_2.11.tgz</code></p>
<p>flink环境配置完成后，可以通过浏览器访问flink的web ui，对应的地址是<code>/{flink部署路径}/conf/masters</code>文件中的地址</p>
-<h1>编译</h1>
-<ul>
-<li>步骤一：进入inlong-sort的目录
-<code>cd /your_path/Inlong/inlong-sort</code></li>
-<li>步骤二：编译
-<code>mvn clean package</code></li>
-</ul>
-<p>通过以上两个步骤在目录<code>/your_path/Inlong/inlong-sort/core/target</code>中，就会产出jar包<code>inlong-sort-core-{version}.jar</code></p>
-<h1>启动inlong-sort应用</h1>
+<h2>准备安装文件</h2>
+<p>安装文件在<code>inlong-sort</code>目录。</p>
+<h2>启动inlong-sort应用</h2>
<p>有了上述编译阶段产出的jar包后，就可以启动inlong-sort的应用了。</p>
<p><a href="https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/yarn_setup.html#submit-job-to-flink" title="如何提交flink作业">如何提交flink作业</a></p>
<p>示例：</p>
@@ -48,7 +35,7 @@
<p><code>inlong-sort-core-1.0-SNAPSHOT.jar</code> 为编译阶段产出的jar包</p>
</li>
</ul>
-<h1>必要的配置</h1>
+<h2>必要的配置</h2>
<ul>
<li><code>--cluster-id</code> 用来唯一标识一个inlong-sort作业</li>
<li><code>--zookeeper.quorum</code> zk quorum</li>
@@ -58,7 +45,7 @@
</ul>
<p><strong>配置示例</strong></p>
<p><code>--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181 --zookeeper.path.root /zk_root --source.type tubemq --sink.type hive</code></p>
-<h1>所有支持的配置</h1>
+<h2>所有支持的配置</h2>
<table>
<thead>
<tr>
diff --git a/zh-cn/docs/modules/sort/quick_start.json b/zh-cn/docs/modules/sort/quick_start.json
index 2724042..6e35128 100644
--- a/zh-cn/docs/modules/sort/quick_start.json
+++ b/zh-cn/docs/modules/sort/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h1>环境要求</h1>\n<ul>\n<li>Java JDK 1.8</li>\n<li>Maven 3.6+</li>\n<li>Flink 1.9.3</li>\n<li>Zookeeper</li>\n</ul>\n<h2>配置flink运行环境</h2>\n<p>当前inlong-sort是基于flink的一个应用，因此运行inlong-sort应用前，需要准备好flink环境。</p>\n<p><a href=\"https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/cluster_setup.html\" title=\"how to set up flink environment\">如何配置flink环境</a></p>\n<p>由于当前inlong-sort依赖的是flink1.9.3版本，因此在下载部署包时，请选择<code>flink-1.9.3-bin-scala_2.11.tgz</code></p>\n<p>fli [...]
+ "__html": "<h2>配置flink运行环境</h2>\n<p>当前inlong-sort是基于flink的一个应用，因此运行inlong-sort应用前，需要准备好flink环境。</p>\n<p><a href=\"https://ci.apache.org/projects/flink/flink-docs-release-1.9/ops/deployment/cluster_setup.html\" title=\"how to set up flink environment\">如何配置flink环境</a></p>\n<p>由于当前inlong-sort依赖的是flink1.9.3版本，因此在下载部署包时，请选择<code>flink-1.9.3-bin-scala_2.11.tgz</code></p>\n<p>flink环境配置完成后，可以通过浏览器访问flink的web ui，对应的地址是<code>/{flink部署路径}/conf/masters</code>文件中的地址</p>\n<h2>准备安装文件</h2>\n<p>安装文件在< [...]
"link": "/zh-cn/docs/modules/sort/quick_start.html",
"meta": {
"快速开始 - Apache InLong-sort": ""
diff --git a/zh-cn/docs/modules/sort/quick_start.md b/zh-cn/docs/modules/sort/quick_start.md
index fcf3cb5..bbf267a 100644
--- a/zh-cn/docs/modules/sort/quick_start.md
+++ b/zh-cn/docs/modules/sort/quick_start.md
@@ -2,13 +2,7 @@
快速开始 - Apache InLong-sort
---
-# 环境要求
-- Java JDK 1.8
-- Maven 3.6+
-- Flink 1.9.3
-- Zookeeper
-
-## 配置flink运行环境
+## 配置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")
@@ -17,15 +11,10 @@
flink环境配置完成后，可以通过浏览器访问flink的web ui，对应的地址是`/{flink部署路径}/conf/masters`文件中的地址
-# 编译
-- 步骤一：进入inlong-sort的目录
-`cd /your_path/Inlong/inlong-sort`
-- 步骤二：编译
-`mvn clean package`
-
-通过以上两个步骤在目录`/your_path/Inlong/inlong-sort/core/target`中，就会产出jar包`inlong-sort-core-{version}.jar`
+## 准备安装文件
+安装文件在`inlong-sort`目录。
-# 启动inlong-sort应用
+## 启动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作业")
@@ -40,7 +29,7 @@ flink环境配置完成后，可以通过浏览器访问flink的web ui，对应
- `inlong-sort-core-1.0-SNAPSHOT.jar` 为编译阶段产出的jar包
-# 必要的配置
+## 必要的配置
- `--cluster-id ` 用来唯一标识一个inlong-sort作业
- `--zookeeper.quorum` zk quorum
- `--zookeeper.path.root` zk根目录
@@ -51,7 +40,7 @@ flink环境配置完成后，可以通过浏览器访问flink的web ui，对应
`--cluster-id my_application --zookeeper.quorum 192.127.0.1:2181 --zookeeper.path.root /zk_root --source.type tubemq --sink.type hive`
-# 所有支持的配置
+## 所有支持的配置
| 配置名 | 是否必须 | 默认值 |描述 |
| ------------ | ------------ | ------------ | ------------ |
|cluster-id | Y | NA | 用来唯一标识一个inlong-sort作业 |
diff --git a/zh-cn/docs/modules/tubemq/quick_start.html b/zh-cn/docs/modules/tubemq/quick_start.html
index ae36a22..41c2112 100644
--- a/zh-cn/docs/modules/tubemq/quick_start.html
+++ b/zh-cn/docs/modules/tubemq/quick_start.html
@@ -12,45 +12,8 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<h3>1.1 准备工作</h3>
-<ul>
-<li>Java JDK 1.8</li>
-<li>Maven 3.3+</li>
-</ul>
-<h3>1.2 从源码包构建</h3>
-<ul>
-<li>编译和打包：</li>
-</ul>
-<pre><code class="language-bash">mvn clean package -DskipTests
-</code></pre>
-<ul>
-<li>单元测试：</li>
-</ul>
-<pre><code class="language-bash">mvn <span class="hljs-built_in">test</span>
-</code></pre>
-<ul>
-<li>单独对每个 module 进行构建：</li>
-</ul>
-<pre><code class="language-bash">mvn clean install
-<span class="hljs-built_in">cd</span> module-name (比如: tubemq-client)
-mvn <span class="hljs-built_in">test</span>
-</code></pre>
-<p>构建完成之后，在 <code>tubemq-server/target</code> 目录下会有 <strong>apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz</strong> 文件。
-这是 TubeMQ 的部署包，包含了脚本、配置文件、依赖以及 web GUI相关的内容。</p>
-<h3>1.3 配置IDE开发环境</h3>
-<p>在IDE中构建和调试源码，需要先运行以下命令：</p>
-<pre><code class="language-bash">mvn compile
-</code></pre>
-<p>执行之后，会生成 <code>protoc</code> 文件对应的 java source file，位于 <code>target/generated-sources</code> 目录。</p>
-<p>（可选）如果你打算使用本地的 <code>protoc</code> 可执行文件，你可以修改 <code>tubemq-core/pom.xml</code> 下的 <code>protobuf-maven-plugin</code> 的配置，如下所示。</p>
-<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">configuration</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">outputDirectory</span>></span>${project.build.directory}/generated-sources/java<span class="hljs-tag"></<span class="hljs-name">outputDirectory</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">protocExecutable</span>></span>/usr/local/bin/protoc<span class="hljs-tag"></<span class="hljs-name">protocExecutable</span>></span>
-<span class="hljs-tag"></<span class="hljs-name">configuration</span>></span>
-</code></pre>
-<h2>2 部署运行</h2>
-<h3>2.1 配置示例</h3>
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<h3>1.1 配置示例</h3>
<p>TubeMQ 集群包含有两个组件: <strong>Master</strong> 和 <strong>Broker</strong>. Master 和 Broker 可以部署在相同或者不同的节点上，依照业务对机器的规划进行处理。我们通过如下3台机器搭建有2台Master的生产、消费的集群进行配置示例：</p>
<table>
<thead>
@@ -86,20 +49,19 @@ mvn <span class="hljs-built_in">test</span>
</tr>
</tbody>
</table>
-<h3>2.2 准备工作</h3>
+<h3>1.2 准备工作</h3>
<ul>
<li>ZooKeeper集群</li>
-<li><a href="download/download.md">apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz</a>安装包</li>
</ul>
<p>选择安装路径后，安装包解压后的目录结构如下：</p>
-<pre><code>/INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin/
+<pre><code>/INSTALL_PATH/inlong-tubemq-server/
├── bin
├── conf
├── lib
├── logs
└── resources
</code></pre>
-<h3>2.3 配置Master</h3>
+<h3>1.3 配置Master</h3>
<p>编辑<code>conf/master.ini</code>，根据集群信息变更以下配置项</p>
<ul>
<li>Master IP和端口</li>
@@ -160,7 +122,7 @@ zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址
</tbody>
</table>
<p><strong>注意</strong>：需保证Master所有节点之间的时钟同步</p>
-<h3>2.4 配置Broker</h3>
+<h3>1.4 配置Broker</h3>
<p>编辑<code>conf/broker.ini</code>，根据集群信息变更以下配置项</p>
<ul>
<li>Broker IP和端口</li>
@@ -188,13 +150,13 @@ zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址
zkNodeRoot=/tubemq
zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址逗号分开
</code></pre>
-<h3>2.5 启动Master</h3>
+<h3>1.5 启动Master</h3>
<p>进入Master节点的 <code>bin</code> 目录下，启动服务:</p>
<pre><code class="language-bash">./tubemq.sh master start
</code></pre>
<p>访问Master的管控台 <code>http://YOUR_MASTER_IP:8080</code> ，页面可查则表示master已成功启动:
<img src="img/tubemq-console-gui.png" alt="TubeMQ Console GUI"></p>
-<h4>2.5.1 配置Broker元数据</h4>
+<h4>1.5.1 配置Broker元数据</h4>
<p>Broker启动前，首先要在Master上配置Broker元数据，增加Broker相关的管理信息。在<code>Broker List</code> 页面, <code>Add Single Broker</code>，然后填写相关信息:</p>
<p><img src="img/tubemq-add-broker-1.png" alt="Add Broker 1"></p>
<p>需要填写的内容包括：</p>
@@ -203,8 +165,8 @@ zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址
<li>authToken: <code>conf/master.ini</code> 文件中 <code>confModAuthToken</code> 字段配置的 token</li>
</ol>
<p>然后上线Broker：
-<img src="img/tubemq-add-broker-2.png" alt="Add Broker 2"></p>
-<h3>2.6 启动Broker</h3>
+<img src="img/tubemq-add-broker-1.png" alt="Add Broker 2"></p>
+<h3>1.6 启动Broker</h3>
<p>进入broker节点的 <code>bin</code> 目录下，执行以下命令启动Broker服务：</p>
<pre><code class="language-bash">./tubemq.sh broker start
</code></pre>
@@ -223,23 +185,23 @@ zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址
<p><img src="img/tubemq-add-topic-3.png" alt="Add Topic 3"></p>
<p>之后就可以在页面查看Topic信息。</p>
<p><img src="img/tubemq-add-topic-4.png" alt="Add Topic 4"></p>
-<h3>3.2 运行Example</h3>
+<h3>2.2 运行Example</h3>
<p>可以通过上面创建的<code>demo</code> topic来测试集群。</p>
-<h4>3.2.1 生产消息</h4>
+<h4>2.2.1 生产消息</h4>
<p>将 <code>YOUR_MASTER_IP:port</code> 替换为实际的IP和端口，然后运行producer:</p>
<pre><code class="language-bash"><span class="hljs-built_in">cd</span> /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
./bin/tubemq-producer-test.sh --master-servers YOUR_MASTER_IP1:port,YOUR_MASTER_IP2:port --topicName demo
</code></pre>
<p>如果能观察下如下日志，则表示数据发送成功：
<img src="img/tubemq-send-message.png" alt="Demo 1"></p>
-<h4>3.2.2 消费消息</h4>
+<h4>2.2.2 消费消息</h4>
<p>将 <code>YOUR_MASTER_IP:port</code> 替换为实际的IP和端口，然后运行Consumer:</p>
<pre><code class="language-bash"><span class="hljs-built_in">cd</span> /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
./bin/tubemq-consumer-test.sh --master-servers YOUR_MASTER_IP1:port,YOUR_MASTER_IP2:port --topicName demo --groupName test_consume
</code></pre>
<p>如果能观察下如下日志，则表示数据被消费者消费到：</p>
<p><img src="img/tubemq-consume-message.png" alt="Demo 2"></p>
-<h2>4 结束</h2>
+<h2>3 结束</h2>
<p>在这里，已经完成了TubeMQ的编译，部署，系统配置，启动，生产和消费。如果需要了解更深入的内容，请查看《TubeMQ HTTP API》里的相关内容，进行相应的配置设置。</p>
<hr>
<p><a href="#top">Back to top</a></p>
diff --git a/zh-cn/docs/modules/tubemq/quick_start.json b/zh-cn/docs/modules/tubemq/quick_start.json
index ca3d404..9204701 100644
--- a/zh-cn/docs/modules/tubemq/quick_start.json
+++ b/zh-cn/docs/modules/tubemq/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>1 编译和构建</h2>\n<h3>1.1 准备工作</h3>\n<ul>\n<li>Java JDK 1.8</li>\n<li>Maven 3.3+</li>\n</ul>\n<h3>1.2 从源码包构建</h3>\n<ul>\n<li>编译和打包：</li>\n</ul>\n<pre><code class=\"language-bash\">mvn clean package -DskipTests\n</code></pre>\n<ul>\n<li>单元测试：</li>\n</ul>\n<pre><code class=\"language-bash\">mvn <span class=\"hljs-built_in\">test</span>\n</code></pre>\n<ul>\n<li>单独对每个 module 进行构建：</li>\n</ul>\n<pre><code class=\"language-bash\">mvn clean install\n<span class=\"hljs-built_in\">c [...]
+ "__html": "<h2>部署运行</h2>\n<h3>1.1 配置示例</h3>\n<p>TubeMQ 集群包含有两个组件: <strong>Master</strong> 和 <strong>Broker</strong>. Master 和 Broker 可以部署在相同或者不同的节点上，依照业务对机器的规划进行处理。我们通过如下3台机器搭建有2台Master的生产、消费的集群进行配置示例：</p>\n<table>\n<thead>\n<tr>\n<th>所属角色</th>\n<th>TCP端口</th>\n<th>TLS端口</th>\n<th>WEB端口</th>\n<th>备注</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Master</td>\n<td>8099</td>\n<td>8199</td>\n<td>8080</td>\n<td>元数据存储在<code>/stage/meta_data</code></td>\n</tr>\n<tr>\n<td>Broker</td>\n<td>8123</td> [...]
"link": "/zh-cn/docs/modules/tubemq/quick_start.html",
"meta": {
"快速开始 - Apache InLong TubeMQ模块": ""
diff --git a/zh-cn/docs/modules/tubemq/quick_start.md b/zh-cn/docs/modules/tubemq/quick_start.md
index 40eb4d3..404e9ec 100644
--- a/zh-cn/docs/modules/tubemq/quick_start.md
+++ b/zh-cn/docs/modules/tubemq/quick_start.md
@@ -1,52 +1,9 @@
---
快速开始 - Apache InLong TubeMQ模块
---
+## 部署运行
-## 1 编译和构建
-
-### 1.1 准备工作
-- Java JDK 1.8
-- Maven 3.3+
-
-### 1.2 从源码包构建
-- 编译和打包：
-```bash
-mvn clean package -DskipTests
-```
-
-- 单元测试：
-```bash
-mvn test
-```
-
-- 单独对每个 module 进行构建：
-```bash
-mvn clean install
-cd module-name (比如: tubemq-client)
-mvn test
-```
-
-构建完成之后，在 `tubemq-server/target` 目录下会有 **apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz** 文件。
-这是 TubeMQ 的部署包，包含了脚本、配置文件、依赖以及 web GUI相关的内容。
-
-### 1.3 配置IDE开发环境
-在IDE中构建和调试源码，需要先运行以下命令：
-```bash
-mvn compile
-```
-执行之后，会生成 `protoc` 文件对应的 java source file，位于 `target/generated-sources` 目录。
-
-（可选）如果你打算使用本地的 `protoc` 可执行文件，你可以修改 `tubemq-core/pom.xml` 下的 `protobuf-maven-plugin` 的配置，如下所示。
-```xml
-<configuration>
- <outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
- <protocExecutable>/usr/local/bin/protoc</protocExecutable>
-</configuration>
-```
-
-## 2 部署运行
-
-### 2.1 配置示例
+### 1.1 配置示例
TubeMQ 集群包含有两个组件: **Master** 和 **Broker**. Master 和 Broker 可以部署在相同或者不同的节点上，依照业务对机器的规划进行处理。我们通过如下3台机器搭建有2台Master的生产、消费的集群进行配置示例：
| 所属角色 | TCP端口 | TLS端口 | WEB端口 | 备注 |
| --- | --- | --- | --- | --- |
@@ -54,13 +11,12 @@ TubeMQ 集群包含有两个组件: **Master** 和 **Broker**. Master 和 Broker
| Broker | 8123 | 8124 | 8081 | 消息储存在`/stage/msg_data` |
| ZooKeeper | 2181 | | | Offset储存在根目录`/tubemq` |
-### 2.2 准备工作
+### 1.2 准备工作
- ZooKeeper集群
-- [apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz](download/download.md)安装包
选择安装路径后，安装包解压后的目录结构如下：
```
-/INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin/
+/INSTALL_PATH/inlong-tubemq-server/
├── bin
├── conf
├── lib
@@ -68,7 +24,7 @@ TubeMQ 集群包含有两个组件: **Master** 和 **Broker**. Master 和 Broker
└── resources
```
-### 2.3 配置Master
+### 1.3 配置Master
编辑`conf/master.ini`，根据集群信息变更以下配置项
- Master IP和端口
@@ -111,7 +67,7 @@ repHelperHost=FIRST_MASTER_NODE_IP:9001 // helperHost用于创建master集群
**注意**：需保证Master所有节点之间的时钟同步
-### 2.4 配置Broker
+### 1.4 配置Broker
编辑`conf/broker.ini`，根据集群信息变更以下配置项
- Broker IP和端口
```ini
@@ -139,7 +95,7 @@ zkNodeRoot=/tubemq
zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址逗号分开
```
-### 2.5 启动Master
+### 1.5 启动Master
进入Master节点的 `bin` 目录下，启动服务:
```bash
./tubemq.sh master start
@@ -148,19 +104,19 @@ zkServerAddr=localhost:2181 // 指向zookeeper集群，多个地址
-#### 2.5.1 配置Broker元数据
+#### 1.5.1 配置Broker元数据
Broker启动前，首先要在Master上配置Broker元数据，增加Broker相关的管理信息。在`Broker List` 页面, `Add Single Broker`，然后填写相关信息:
需要填写的内容包括：
1. broker IP: broker server ip
-2. authToken: `conf/master.ini` 文件中 `confModAuthToken` 字段配置的 token
+1. authToken: `conf/master.ini` 文件中 `confModAuthToken` 字段配置的 token
然后上线Broker：
-
+
-### 2.6 启动Broker
+### 1.6 启动Broker
进入broker节点的 `bin` 目录下，执行以下命令启动Broker服务：
```bash
@@ -192,10 +148,10 @@ Broker启动前，首先要在Master上配置Broker元数据，增加Broker相
-### 3.2 运行Example
+### 2.2 运行Example
可以通过上面创建的`demo` topic来测试集群。
-#### 3.2.1 生产消息
+#### 2.2.1 生产消息
将 `YOUR_MASTER_IP:port` 替换为实际的IP和端口，然后运行producer:
```bash
cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
@@ -205,7 +161,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
如果能观察下如下日志，则表示数据发送成功：
-#### 3.2.2 消费消息
+#### 2.2.2 消费消息
将 `YOUR_MASTER_IP:port` 替换为实际的IP和端口，然后运行Consumer:
```bash
cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
@@ -217,7 +173,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
-## 4 结束
+## 3 结束
在这里，已经完成了TubeMQ的编译，部署，系统配置，启动，生产和消费。如果需要了解更深入的内容，请查看《TubeMQ HTTP API》里的相关内容，进行相应的配置设置。
---
diff --git a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html
index e7ffb5b..f6da53f 100644
--- a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html
+++ b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html
@@ -12,28 +12,21 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<pre><code>mvn clean package
-</code></pre>
-<h2>部署</h2>
-<p>环境要求：</p>
-<pre><code>mysql
-java(1.8+)
-</code></pre>
-<p>在InLong/inlong-tubemq/tubemq-manager/dist/目录当中，能够找到文件为apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>
-<pre><code>tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-</code></pre>
+ <div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
+<p>安装文件在inlong-tubemq-manager目录.</p>
+<h3>配置</h3>
<p>在conf/application.properties中添加mysql信息：</p>
-<pre><code>spring.jpa.hibernate.ddl-auto=update
-# configuration for manager
-spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
-spring.datasource.username=[replace_by_usename]
-spring.datasource.password=[replace_by_password]
-# server port
-server.port=8089
+<pre><code class="language-ini"><span class="hljs-attr">spring.jpa.hibernate.ddl-auto</span>=update
+<span class="hljs-comment"># configuration for manager</span>
+<span class="hljs-attr">spring.datasource.url</span>=jdbc:mysql://[replace_by_mysql_address]:<span class="hljs-number">3306</span>/tubemanager
+<span class="hljs-attr">spring.datasource.username</span>=[replace_by_usename]
+<span class="hljs-attr">spring.datasource.password</span>=[replace_by_password]
+<span class="hljs-comment"># server port </span>
+<span class="hljs-attr">server.port</span>=<span class="hljs-number">8089</span>
</code></pre>
+<h3>启动服务</h3>
<p>添加数据库tubemanager，并启动：</p>
-<pre><code>bin/start-admin.sh
+<pre><code class="language-bash">$ bin/start-admin.sh
</code></pre>
<h2>使用</h2>
<h3>新建集群</h3>
diff --git a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.json b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.json
index 9e95b19..515e15c 100644
--- a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.json
+++ b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>编译</h2>\n<pre><code>mvn clean package \n</code></pre>\n<h2>部署</h2>\n<p>环境要求：</p>\n<pre><code>mysql\njava(1.8+)\n</code></pre>\n<p>在InLong/inlong-tubemq/tubemq-manager/dist/目录当中，能够找到文件为apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>\n<pre><code>tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz\n</code></pre>\n<p>在conf/application.properties中添加mysql信息：</p>\n<pre><code>spring.jpa.hibernate.ddl-auto=update\n# configuration for manage [...]
+ "__html": "<h2>部署</h2>\n<p>安装文件在inlong-tubemq-manager目录.</p>\n<h3>配置</h3>\n<p>在conf/application.properties中添加mysql信息：</p>\n<pre><code class=\"language-ini\"><span class=\"hljs-attr\">spring.jpa.hibernate.ddl-auto</span>=update\n<span class=\"hljs-comment\"># configuration for manager</span>\n<span class=\"hljs-attr\">spring.datasource.url</span>=jdbc:mysql://[replace_by_mysql_address]:<span class=\"hljs-number\">3306</span>/tubemanager\n<span class=\"hljs-attr\">spring.datasource.usern [...]
"link": "/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md
index c83473e..b610cb7 100644
--- a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,31 +1,25 @@
-## 编译
-
- mvn clean package
-
## 部署
+安装文件在inlong-tubemq-manager目录.
-环境要求：
-
- mysql
- java(1.8+)
-
-在InLong/inlong-tubemq/tubemq-manager/dist/目录当中，能够找到文件为apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
- tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
-
+### 配置
在conf/application.properties中添加mysql信息：
- spring.jpa.hibernate.ddl-auto=update
- # configuration for manager
- spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
- spring.datasource.username=[replace_by_usename]
- spring.datasource.password=[replace_by_password]
- # server port
- server.port=8089
-
+```ini
+spring.jpa.hibernate.ddl-auto=update
+# configuration for manager
+spring.datasource.url=jdbc:mysql://[replace_by_mysql_address]:3306/tubemanager
+spring.datasource.username=[replace_by_usename]
+spring.datasource.password=[replace_by_password]
+# server port
+server.port=8089
+```
+
+### 启动服务
添加数据库tubemanager，并启动：
- bin/start-admin.sh
+``` bash
+$ bin/start-admin.sh
+```
## 使用
diff --git a/zh-cn/docs/modules/website/quick_start.html b/zh-cn/docs/modules/website/quick_start.html
index af981f9..36e2e50 100644
--- a/zh-cn/docs/modules/website/quick_start.html
+++ b/zh-cn/docs/modules/website/quick_start.html
@@ -13,28 +13,24 @@
</head>
<body>
<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<p>应该检查 <code>nodejs >= 12.0</code> 已经安装。</p>
-<h2>开发</h2>
-<p>在新创建的项目中，您可以运行一些内置命令：</p>
-<p>如果没有安装 <code>node_modules</code>，你应该首先运行 <code>npm install</code> 或 <code>yarn install</code>。</p>
-<p>使用 <code>npm run dev</code> 或 <code>yarn dev</code> 在开发模式下运行应用程序。</p>
-<p>如果服务器运行成功，浏览器将打开 <a href="http://localhost:8080">http://localhost:8080</a> 在浏览器中查看。</p>
-<p>如果您进行编辑，页面将重新加载。
-您还将在控制台中看到任何 lint 错误。</p>
-<p>web服务器的启动依赖于后端服务 <code>manger api</code> 接口。</p>
-<p>您应该先启动后端服务器，然后将 <code>/inlong-website/src/setupProxy.js</code> 中的变量<code>target</code> 设置为api服务的地址。</p>
-<h2>测试</h2>
-<p>运行 <code>npm test</code> 或 <code>yarn test</code></p>
-<p>在交互式观察模式下启动测试运行器。
-有关更多信息，请参阅有关 <a href="https://create-react-app.dev/docs/running-tests/">运行测试</a> 的部分。</p>
-<h2>构建和部署</h2>
-<p>首先保证项目已运行过 <code>npm install</code> 或 <code>yarn install</code> 安装了 <code>node_modules</code>。</p>
-<p>运行 <code>npm run build</code> 或 <code>yarn build</code>。</p>
-<p>将用于生产的应用程序构建到构建文件夹。
-在构建后的生产模式下可以获得较好的页面性能。</p>
-<p>构建后代码被压缩，文件名包括哈希值。
-您的应用程序已准备好部署！</p>
-<p>有关详细信息，请参阅有关 <a href="https://create-react-app.dev/docs/deployment/">deployment</a> 的部分。</p>
+<ul>
+<li>nginx</li>
+</ul>
+<h2>配置</h2>
+<p>增加<code>inlong-website</code></p>
+<pre><code>server {
+ listen 80;
+ listen [::]:80;
+ server_name _;
+ # replaced by the directory of inlong-website
+ root /inlong_root_path/inlong-website;
+
+ # replaced manager_api_ip
+ location /api {
+ proxy_pass http://manager_api_ip:8083;
+ }
+}
+</code></pre>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with [...]
<script src="https://f.alicdn.com/react/15.4.1/react-with-addons.min.js"></script>
<script src="https://f.alicdn.com/react/15.4.1/react-dom.min.js"></script>
diff --git a/zh-cn/docs/modules/website/quick_start.json b/zh-cn/docs/modules/website/quick_start.json
index 7bb99a3..c72a4de 100644
--- a/zh-cn/docs/modules/website/quick_start.json
+++ b/zh-cn/docs/modules/website/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<h2>环境准备</h2>\n<p>应该检查 <code>nodejs >= 12.0</code> 已经安装。</p>\n<h2>开发</h2>\n<p>在新创建的项目中，您可以运行一些内置命令：</p>\n<p>如果没有安装 <code>node_modules</code>，你应该首先运行 <code>npm install</code> 或 <code>yarn install</code>。</p>\n<p>使用 <code>npm run dev</code> 或 <code>yarn dev</code> 在开发模式下运行应用程序。</p>\n<p>如果服务器运行成功，浏览器将打开 <a href=\"http://localhost:8080\">http://localhost:8080</a> 在浏览器中查看。</p>\n<p>如果您进行编辑，页面将重新加载。\n您还将在控制台中看到任何 lint 错误。</p>\n<p>web服务器的启动依赖于后端服务 <code>manger api</code> 接口。</p>\ [...]
+ "__html": "<h2>环境准备</h2>\n<ul>\n<li>nginx</li>\n</ul>\n<h2>配置</h2>\n<p>增加<code>inlong-website</code></p>\n<pre><code>server {\n listen 80;\n listen [::]:80;\n server_name _;\n # replaced by the directory of inlong-website\n root /inlong_root_path/inlong-website;\n\n # replaced manager_api_ip\n location /api {\n proxy_pass http://manager_api_ip:8083;\n }\n}\n</code></pre>\n",
"link": "/zh-cn/docs/modules/website/quick_start.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/modules/website/quick_start.md b/zh-cn/docs/modules/website/quick_start.md
index d170a64..93353ac 100644
--- a/zh-cn/docs/modules/website/quick_start.md
+++ b/zh-cn/docs/modules/website/quick_start.md
@@ -1,41 +1,21 @@
## 环境准备
-应该检查 `nodejs >= 12.0` 已经安装。
-
-## 开发
-
-在新创建的项目中，您可以运行一些内置命令：
-
-如果没有安装 `node_modules`，你应该首先运行 `npm install` 或 `yarn install`。
-
-使用 `npm run dev` 或 `yarn dev` 在开发模式下运行应用程序。
-
-如果服务器运行成功，浏览器将打开 [http://localhost:8080](http://localhost:8080) 在浏览器中查看。
-
-如果您进行编辑，页面将重新加载。
-您还将在控制台中看到任何 lint 错误。
-
-web服务器的启动依赖于后端服务 `manger api` 接口。
-
-您应该先启动后端服务器，然后将 `/inlong-website/src/setupProxy.js` 中的变量`target` 设置为api服务的地址。
-
-## 测试
-
-运行 `npm test` 或 `yarn test`
-
-在交互式观察模式下启动测试运行器。
-有关更多信息，请参阅有关 [运行测试](https://create-react-app.dev/docs/running-tests/) 的部分。
-
-## 构建和部署
-
-首先保证项目已运行过 `npm install` 或 `yarn install` 安装了 `node_modules`。
-
-运行 `npm run build` 或 `yarn build`。
-
-将用于生产的应用程序构建到构建文件夹。
-在构建后的生产模式下可以获得较好的页面性能。
-
-构建后代码被压缩，文件名包括哈希值。
-您的应用程序已准备好部署！
-
-有关详细信息，请参阅有关 [deployment](https://create-react-app.dev/docs/deployment/) 的部分。
\ No newline at end of file
+- nginx
+
+## 配置
+增加`inlong-website`
+
+```
+server {
+ listen 80;
+ listen [::]:80;
+ server_name _;
+ # replaced by the directory of inlong-website
+ root /inlong_root_path/inlong-website;
+
+ # replaced manager_api_ip
+ location /api {
+ proxy_pass http://manager_api_ip:8083;
+ }
+}
+```
\ No newline at end of file
diff --git a/zh-cn/docs/quick_start.html b/zh-cn/docs/quick_start.html
index 8dbba95..1ea33f2 100644
--- a/zh-cn/docs/quick_start.html
+++ b/zh-cn/docs/quick_start.html
@@ -13,28 +13,54 @@
</head>
<body>
<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><a href="//www.apache.org"><img class="logo apache" style="width:120px" src="/img/asf_logo.svg"/></a><div class="logo-split"></div><img class="logo tube" style="width:120px;top:12px;position:absolute" src="/img/Tube logo.svg"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class= [...]
-<h1>整体架构</h1>
+<h2>整体架构</h2>
<img src="../../img/inlong_architecture.png" align="center" alt="Apache InLong"/>
<p><a href="https://inlong.apache.org">Apache InLong</a>(incubating) 整体架构如上，该组件是一站式数据流媒体平台，提供自动化、安全、分布式、高效的数据发布和订阅能力，帮助您轻松构建基于流的数据应用程序。</p>
<p>InLong(应龙)最初建于腾讯，服务线上业务8年多，支持大数据场景下的海量数据（每天40万亿条数据规模以上）报表服务。整个平台集成了数据采集、汇聚、缓存、分拣和管理模块等共5个模块，通过这个系统，业务只需要提供数据源、数据服务质量、数据落地集群和数据落地格式，即数据可以源源不断地将数据从源集群推送到目标集群，极大满足了业务大数据场景下的数据上报服务需求。</p>
-<h1>如何使用</h1>
-<p>通过上图的InLong整体架构图，我们可以看到InLong包含了完整的数据上报组件，我们需要逐个模块的编译部署</p>
-<h2>编译部署Manager</h2>
-<p><a href="modules/manager/quick_start.md">如何编译部署Manager</a></p>
-<h2>编译部署InLong Web</h2>
-<p><a href="modules/website/quick_start.md">如何编译部署InLong Web</a></p>
-<h2>编译部署TubeMQ</h2>
-<p><a href="modules/tubemq/quick_start.md">如何编译部署TubeMQ</a></p>
-<h2>编译部署TubeMQ Manager</h2>
-<p><a href="modules/tubemq/tubemq-manager/quick_start.md">如何编译部署TubeMQ Manager</a></p>
-<h2>编译部署Sort</h2>
-<p><a href="modules/sort/quick_start.md">如何编译部署Sort</a></p>
-<h2>编译部署DataProxy</h2>
-<p><a href="modules/dataproxy/quick_start.md">如何编译部署DataProxy</a></p>
-<h2>编译部署Agent</h2>
-<p><a href="modules/agent/quick_start.md">如何编译部署Agent</a></p>
+<h2>编译</h2>
+<ul>
+<li>Java <a href="https://adoptopenjdk.net/?variant=openjdk8">JDK 8</a></li>
+<li>Maven 3.6.1+</li>
+</ul>
+<pre><code>$ mvn clean install -DskipTests
+</code></pre>
+<p>(可选) 使用docker编译:</p>
+<pre><code>$ docker pull maven:3.6-openjdk-8
+$ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8 mvn clean install -DskipTests
+</code></pre>
+<p>若编译成功，在<code>inlong-distribution/target</code>下会找到<code>tar.gz</code>格式的安装包，解压安装目录，包括各个模块安装文件：</p>
+<pre><code>inlong-agent
+inlong-dataproxy
+inlong-manager-api
+inlong-manager-openapi
+inlong-sort
+inlong-tubemq-manager
+inlong-tubemq-server
+inlong-website
+</code></pre>
+<h2>环境要求</h2>
+<ul>
+<li>ZooKeeper 3.5+</li>
+<li>Hadoop 2.10.x 和 Hive 2.3.x</li>
+<li>MySQL 5.7+</li>
+<li>Flink 1.9.x</li>
+</ul>
+<h2>部署InLong TubeMQ Server</h2>
+<p><a href="modules/tubemq/quick_start.md">部署InLong TubeMQ Server</a></p>
+<h2>部署InLong TubeMQ Manager</h2>
+<p><a href="modules/tubemq/tubemq-manager/quick_start.md">部署InLong TubeMQ Manager</a></p>
+<h2>部署部署InLong Manager</h2>
+<p><a href="modules/manager/quick_start.md">部署InLong Manager</a></p>
+<h2>部署InLong WebSite</h2>
+<p><a href="modules/website/quick_start.md">部署InLong Web</a></p>
+<h2>部署部署InLong Sort</h2>
+<p><a href="modules/sort/quick_start.md">部署InLong Sort</a></p>
+<h2>部署部署InLong DataProxy</h2>
+<p><a href="modules/dataproxy/quick_start.md">部署InLong DataProxy</a></p>
+<h2>部署部署InLong Agent</h2>
+<p><a href="modules/agent/quick_start.md">部署InLong Agent</a></p>
<h2>业务配置</h2>
-<p><a href="modules/manager/user_manual.md">如何配置新业务</a></p>
+<p><a href="modules/manager/user_manual.md">配置新业务</a></p>
<h2>数据上报验证</h2>
<p>到这里，您就可以通过文件Agent采集数据并在指定的Hive表中验证接收到的数据是否与发送的数据一致。</p>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/img/incubator-logo.svg"/><div class="cols-container"><div class="col col-24"><p>Apache InLong (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with [...]
diff --git a/zh-cn/docs/quick_start.json b/zh-cn/docs/quick_start.json
index dfb5c97..ccf9126 100644
--- a/zh-cn/docs/quick_start.json
+++ b/zh-cn/docs/quick_start.json
@@ -1,6 +1,6 @@
{
"filename": "quick_start.md",
- "__html": "<p>本节包含快速入门指南，可帮助您开始使用 Apache InLong。</p>\n<h1>整体架构</h1>\n<img src=\"../../img/inlong_architecture.png\" align=\"center\" alt=\"Apache InLong\"/>\n<p><a href=\"https://inlong.apache.org\">Apache InLong</a>(incubating) 整体架构如上，该组件是一站式数据流媒体平台，提供自动化、安全、分布式、高效的数据发布和订阅能力，帮助您轻松构建基于流的数据应用程序。</p>\n<p>InLong(应龙)最初建于腾讯，服务线上业务8年多，支持大数据场景下的海量数据（每天40万亿条数据规模以上）报表服务。整个平台集成了数据采集、汇聚、缓存、分拣和管理模块等共5个模块，通过这个系统，业务只需要提供数据源、数据服务质量、数据落地集群和数据落地格式，即数据可以源源不断地将数据从源集群推送到目标集群，极大满足了业务大数据场景下的数据上报服务需求�
��</p>\n< [...]
+ "__html": "<p>本节包含快速入门指南，可帮助您开始使用 Apache InLong。</p>\n<h2>整体架构</h2>\n<img src=\"../../img/inlong_architecture.png\" align=\"center\" alt=\"Apache InLong\"/>\n<p><a href=\"https://inlong.apache.org\">Apache InLong</a>(incubating) 整体架构如上，该组件是一站式数据流媒体平台，提供自动化、安全、分布式、高效的数据发布和订阅能力，帮助您轻松构建基于流的数据应用程序。</p>\n<p>InLong(应龙)最初建于腾讯，服务线上业务8年多，支持大数据场景下的海量数据（每天40万亿条数据规模以上）报表服务。整个平台集成了数据采集、汇聚、缓存、分拣和管理模块等共5个模块，通过这个系统，业务只需要提供数据源、数据服务质量、数据落地集群和数据落地格式，即数据可以源源不断地将数据从源集群推送到目标集群，极大满足了业务大数据场景下的数据上报服务需求�
��</p>\n< [...]
"link": "/zh-cn/docs/quick_start.html",
"meta": {
"title": "入门 - Apache InLong"
diff --git a/zh-cn/docs/quick_start.md b/zh-cn/docs/quick_start.md
index 010a9b0..247ccdb 100644
--- a/zh-cn/docs/quick_start.md
+++ b/zh-cn/docs/quick_start.md
@@ -4,40 +4,66 @@ title: 入门 - Apache InLong
本节包含快速入门指南，可帮助您开始使用 Apache InLong。
-# 整体架构
+## 整体架构
<img src="../../img/inlong_architecture.png" align="center" alt="Apache InLong"/>
[Apache InLong](https://inlong.apache.org)(incubating) 整体架构如上，该组件是一站式数据流媒体平台，提供自动化、安全、分布式、高效的数据发布和订阅能力，帮助您轻松构建基于流的数据应用程序。
InLong(应龙)最初建于腾讯，服务线上业务8年多，支持大数据场景下的海量数据（每天40万亿条数据规模以上）报表服务。整个平台集成了数据采集、汇聚、缓存、分拣和管理模块等共5个模块，通过这个系统，业务只需要提供数据源、数据服务质量、数据落地集群和数据落地格式，即数据可以源源不断地将数据从源集群推送到目标集群，极大满足了业务大数据场景下的数据上报服务需求。
-
-# 如何使用
-通过上图的InLong整体架构图，我们可以看到InLong包含了完整的数据上报组件，我们需要逐个模块的编译部署
-
-## 编译部署Manager
-[如何编译部署Manager](modules/manager/quick_start.md)
-
-## 编译部署InLong Web
-[如何编译部署InLong Web](modules/website/quick_start.md)
-
-## 编译部署TubeMQ
-[如何编译部署TubeMQ](modules/tubemq/quick_start.md)
-
-## 编译部署TubeMQ Manager
-[如何编译部署TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
-
-## 编译部署Sort
-[如何编译部署Sort](modules/sort/quick_start.md)
-
-## 编译部署DataProxy
-[如何编译部署DataProxy](modules/dataproxy/quick_start.md)
-
-## 编译部署Agent
-[如何编译部署Agent](modules/agent/quick_start.md)
+## 编译
+- Java [JDK 8](https://adoptopenjdk.net/?variant=openjdk8)
+- Maven 3.6.1+
+
+```
+$ mvn clean install -DskipTests
+```
+(可选) 使用docker编译:
+```
+$ docker pull maven:3.6-openjdk-8
+$ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8 mvn clean install -DskipTests
+```
+若编译成功，在`inlong-distribution/target`下会找到`tar.gz`格式的安装包，解压安装目录，包括各个模块安装文件：
+```
+inlong-agent
+inlong-dataproxy
+inlong-manager-api
+inlong-manager-openapi
+inlong-sort
+inlong-tubemq-manager
+inlong-tubemq-server
+inlong-website
+```
+
+## 环境要求
+- ZooKeeper 3.5+
+- Hadoop 2.10.x 和 Hive 2.3.x
+- MySQL 5.7+
+- Flink 1.9.x
+
+## 部署InLong TubeMQ Server
+[部署InLong TubeMQ Server](modules/tubemq/quick_start.md)
+
+## 部署InLong TubeMQ Manager
+[部署InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
+
+## 部署部署InLong Manager
+[部署InLong Manager](modules/manager/quick_start.md)
+
+## 部署InLong WebSite
+[部署InLong Web](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)
## 业务配置
-[如何配置新业务](modules/manager/user_manual.md)
+[配置新业务](modules/manager/user_manual.md)
## 数据上报验证
到这里，您就可以通过文件Agent采集数据并在指定的Hive表中验证接收到的数据是否与发送的数据一致。