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/07 14:52:06 UTC
[incubator-inlong-website] branch asf-site updated: Automated
deployment: Wed Jul 7 14:51:31 UTC 2021
533d37afa3830521f2a05f6d0109a0c1fb936823
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 0f08903 Automated deployment: Wed Jul 7 14:51:31 UTC 2021 533d37afa3830521f2a05f6d0109a0c1fb936823
0f08903 is described below
commit 0f0890382cc750cb5093c62d51a98f2b08e867bc
Author: gosonzhang <go...@users.noreply.github.com>
AuthorDate: Wed Jul 7 14:51:31 2021 +0000
Automated deployment: Wed Jul 7 14:51:31 UTC 2021 533d37afa3830521f2a05f6d0109a0c1fb936823
---
docs/en-us/modules/agent/quick_start.md | 3 +-
docs/en-us/modules/dataproxy/quick_start.md | 25 ++++++++++-----
.../modules/tubemq/tubemq-manager/quick_start.md | 33 +++++++++----------
docs/zh-cn/modules/agent/quick_start.md | 7 ++--
docs/zh-cn/modules/dataproxy/quick_start.md | 30 ++++++++++++------
.../modules/tubemq/tubemq-manager/quick_start.md | 37 +++++++++++-----------
en-us/docs/modules/agent/quick_start.html | 5 ++-
en-us/docs/modules/agent/quick_start.json | 2 +-
en-us/docs/modules/agent/quick_start.md | 3 +-
en-us/docs/modules/dataproxy/quick_start.html | 19 ++++++-----
en-us/docs/modules/dataproxy/quick_start.json | 2 +-
en-us/docs/modules/dataproxy/quick_start.md | 25 ++++++++++-----
.../modules/tubemq/tubemq-manager/quick_start.html | 29 +++++++++--------
.../modules/tubemq/tubemq-manager/quick_start.json | 2 +-
.../modules/tubemq/tubemq-manager/quick_start.md | 33 +++++++++----------
zh-cn/docs/modules/agent/quick_start.html | 6 ++--
zh-cn/docs/modules/agent/quick_start.json | 2 +-
zh-cn/docs/modules/agent/quick_start.md | 7 ++--
zh-cn/docs/modules/dataproxy/quick_start.html | 24 ++++++++------
zh-cn/docs/modules/dataproxy/quick_start.json | 2 +-
zh-cn/docs/modules/dataproxy/quick_start.md | 30 ++++++++++++------
.../modules/tubemq/tubemq-manager/quick_start.html | 30 ++++++++++--------
.../modules/tubemq/tubemq-manager/quick_start.json | 2 +-
.../modules/tubemq/tubemq-manager/quick_start.md | 37 +++++++++++-----------
24 files changed, 221 insertions(+), 174 deletions(-)
diff --git a/docs/en-us/modules/agent/quick_start.md b/docs/en-us/modules/agent/quick_start.md
index 985c249..f2a2840 100644
--- a/docs/en-us/modules/agent/quick_start.md
+++ b/docs/en-us/modules/agent/quick_start.md
@@ -29,7 +29,7 @@ Create a new folder named .inlong\.managerIps in the agent directory, and create
write:
- {"cluster_id":45,"isInterVisit":1,"size":1,"address": [{"port":write proxy port,"host":"write proxy ip"}], "switch":0}
+ {"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":write proxy port,"host":"write proxy ip"}], "switch":0}
###2.3 local job configuration
If you do not use the online mode, you can use the local file to create a new read task
@@ -37,7 +37,6 @@ Create a new directory jobs in conf,
vim job1.json：
put
-{
"job": {
diff --git a/docs/en-us/modules/dataproxy/quick_start.md b/docs/en-us/modules/dataproxy/quick_start.md
index f98748f..d556fbf 100644
--- a/docs/en-us/modules/dataproxy/quick_start.md
+++ b/docs/en-us/modules/dataproxy/quick_start.md
@@ -2,10 +2,11 @@
mvn clean package -DskipTests
-The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target project
+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-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+un tar it
+
+ tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
## 2、configuration
@@ -13,9 +14,17 @@ The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.t
cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin
### config tube
- vim conf/flume.conf
- In vim command line mode, execute the following replacement commands, where ip:port is the tube address
- :%s/TUBE_LIST/ip:port,ip:port
+
+ ip:port are tube address
+
+sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
+
+ change proxy port
+ agent1.sources.tcp-source.port = 46801
+
+notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner data
+
+
### Environmental preparation
cd bin
@@ -23,10 +32,10 @@ The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.t
cd ..
### config manager
- vim conf/commmon.properties
+ vim conf/common.properties
write：
cluster_id=1
- manager_hosts=xx.xx.xx.xx:port
+ manager_hosts=ip:port
## 3、run
sh bin/start.sh
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 e893718..a2f8d3d 100644
--- a/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
@@ -8,40 +8,42 @@ environment requirements：
mysql
java(1.8+)
-In the dist directory, you can find the file tubemq-manager-bin.zip
+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
- unzip tubemq-manager-bin.zip
+ tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
Add mysql information in conf/application.properties:
spring.jpa.hibernate.ddl-auto=update
# configuration for manager
- spring.datasource.url=jdbc:mysql://x.x.x.x:3306/tubemanager
- spring.datasource.username=xx
- spring.datasource.password=xxx
+ 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
Add the database tubemanager and start:
- bin/start-manager.sh
+ bin/start-admin.sh
## use
### create cluster
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
+/v1/cluster?method=add
POST
parameter:
{
- "masterIp": "9.23.28.86", (tube master ip)
+ "masterIp": "127.0.0.1", (tubemq master ip)
"clusterName": "test",
- "masterPort": "8000", (tube master port)
- "masterWebPort": "8080", (tube master web port)
+ "masterPort": "8000", (tubemq master port)
+ "masterWebPort": "8080", (tubemq master web port)
"createUser": "test",
- "token": "abc" (tube token)
+ "token": "abc" (tubemq token)
}
### Operation interface
@@ -82,10 +84,10 @@ AddTopicTasks is a list of the following objects, which can carry multiple creat
topicName (required) topic name
-Example
+Example
POST
- /v1/task?method=addTopicTask
+/v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -115,10 +117,9 @@ example
POST
- /v1/topic?method=queryCanWrite
{
- "clusterId": "2",
- "topicName": "pzrTestss1123123",
+ "clusterId": "1",
+ "topicName": "1",
"user": "test"
}
diff --git a/docs/zh-cn/modules/agent/quick_start.md b/docs/zh-cn/modules/agent/quick_start.md
index c387c0f..2bfe2ce 100644
--- a/docs/zh-cn/modules/agent/quick_start.md
+++ b/docs/zh-cn/modules/agent/quick_start.md
@@ -1,4 +1,4 @@
-##一、安装
+## ~~~~一、安装
环境要求：
java JDK 1.8
@@ -11,7 +11,6 @@
-
## 二、配置
agent 支持两种运行模式：本地运行以及线上运行
@@ -29,7 +28,7 @@ agent.manager.vip.http.port=manager port
内部写入：
- {"cluster_id":45,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
+ {"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
###2.3 agent本地运行job配置
如果不使用线上模式，可以使用本地文件新建读取任务
@@ -44,7 +43,7 @@ vim job1.json：
"dir": {
- "pattern": "需要读取的文件路径，可包含正则表达式"
+ "pattern": "需要读取的文件路径，可包含正则表达式，例如test/inlong_[0-9]{1}，监听test下创建的新文件"
},
diff --git a/docs/zh-cn/modules/dataproxy/quick_start.md b/docs/zh-cn/modules/dataproxy/quick_start.md
index 337ab40..07b0882 100644
--- a/docs/zh-cn/modules/dataproxy/quick_start.md
+++ b/docs/zh-cn/modules/dataproxy/quick_start.md
@@ -2,20 +2,29 @@
mvn clean package -DskipTests
-在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
- 解压
- tar -zxvf apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+
+解压
+
+ tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
## 二、配置
- cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin
+ cd apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin
+
+### 配置tube地址和端口号
+
+ 执行以下替换命令,其中ip:port为tube地址
-### 配置tube地址
- vim conf/flume.conf
- vim命令行模式，执行以下替换命令,其中ip:port为tube master地址，可配置多个
- :%s/TUBE_LIST/ip1:port,ip2:port
+sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
+
+
+ 修改以下内容为proxy端口号
+ agent1.sources.tcp-source.port = 46801
+
+注意conf/flume.conf中FLUME_HOME为proxy的中间数据文件存放地址
### 环境准备
cd bin
@@ -23,10 +32,11 @@
cd ..
### 配置manager地址
- vim conf/commmon.properties
+ vim conf/common.properties
+
写入以下配置：
cluster_id=1
- manager_hosts=xx.xx.xx.xx:port
+ manager_hosts=ip:port // 这里写入的是manager_api地址
## 三、启动
sh bin/start.sh
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 9a8f3e5..f060931 100644
--- a/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
@@ -8,21 +8,23 @@
mysql
java(1.8+)
-在dist目录当中，能够找到文件为tubemq-manager-bin.zip
+在InLong/inlong-tubemq/tubemq-manager/dist/目录当中，能够找到文件为apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
- unzip tubemq-manager-bin.zip
+ 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://x.x.x.x:3306/tubemanager
- spring.datasource.username=xx
- spring.datasource.password=xxx
+ 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-manager.sh
+ bin/start-admin.sh
## 使用
@@ -37,12 +39,12 @@ java(1.8+)
参数：
{
- "masterIp": "9.23.28.86", (tube master ip)
+ "masterIp": "127.0.0.1", (tubemq master ip)
"clusterName": "test",
- "masterPort": "8000", (tube master port)
- "masterWebPort": "8080", (tube master web port)
+ "masterPort": "8000", (tubemq master port)
+ "masterWebPort": "8080", (tubemq master web port)
"createUser": "test",
- "token": "abc" (tube token)
+ "token": "abc" (tubemq token)
}
### 操作接口
@@ -51,8 +53,8 @@ java(1.8+)
查询clusterId以及clusterName全量数据 （get)
示例
- GET
- /v1/cluster
+GET
+/v1/cluster
返回值
@@ -65,7 +67,7 @@ java(1.8+)
#### topic
-#####添加topicTask
+#### 添加topicTask
type (必填) 请求类型，字段填写：op_query
clusterId (必填) 请求集群id
@@ -84,7 +86,7 @@ AddTopicTasks 为以下对象的List，可携带多个创建topic请求
示例
POST
- /v1/task?method=addTopicTask
+/v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -104,8 +106,7 @@ POST
result为false为写入task失败
-
-#####查询某一个topic是否创建成功（业务可以写入）
+#### 查询某一个topic是否创建成功（业务可以写入）
clusterId (必填) 请求集群id
topicName (必填) 查询topic名称
@@ -119,8 +120,8 @@ POST
/v1/topic?method=queryCanWrite
{
- "clusterId": "2",
- "topicName": "pzrTestss1123123",
+ "clusterId": "1",
+ "topicName": "1",
"user": "test"
}
diff --git a/en-us/docs/modules/agent/quick_start.html b/en-us/docs/modules/agent/quick_start.html
index 0afaac4..11f1f5c 100644
--- a/en-us/docs/modules/agent/quick_start.html
+++ b/en-us/docs/modules/agent/quick_start.html
@@ -33,14 +33,13 @@ agent.manager.vip.http.port=manager port</p>
<p>###2.2 Proxy configuration
Create a new folder named .inlong.managerIps 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>{"cluster_id":45,"isInterVisit":1,"size":1,"address": [{"port":write proxy port,"host":"write proxy ip"}], "switch":0}
+<pre><code>{"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":write proxy port,"host":"write proxy ip"}], "switch":0}
</code></pre>
<p>###2.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：</p>
-<p>put
-{</p>
+<p>put</p>
<pre><code>"job": {
"dir": {
diff --git a/en-us/docs/modules/agent/quick_start.json b/en-us/docs/modules/agent/quick_start.json
index fa24221..6ab2fb3 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<p>###2.1 Agent configuration</p>\n<p>Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as f [...]
+ "__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<p>###2.1 Agent configuration</p>\n<p>Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as f [...]
"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 985c249..f2a2840 100644
--- a/en-us/docs/modules/agent/quick_start.md
+++ b/en-us/docs/modules/agent/quick_start.md
@@ -29,7 +29,7 @@ Create a new folder named .inlong\.managerIps in the agent directory, and create
write:
- {"cluster_id":45,"isInterVisit":1,"size":1,"address": [{"port":write proxy port,"host":"write proxy ip"}], "switch":0}
+ {"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":write proxy port,"host":"write proxy ip"}], "switch":0}
###2.3 local job configuration
If you do not use the online mode, you can use the local file to create a new read task
@@ -37,7 +37,6 @@ Create a new directory jobs in conf,
vim job1.json：
put
-{
"job": {
diff --git a/en-us/docs/modules/dataproxy/quick_start.html b/en-us/docs/modules/dataproxy/quick_start.html
index bcf196b..dce5d67 100644
--- a/en-us/docs/modules/dataproxy/quick_start.html
+++ b/en-us/docs/modules/dataproxy/quick_start.html
@@ -15,28 +15,31 @@
<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-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target project</p>
-<pre><code>un tar it
-tar -zxvf apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+<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
</code></pre>
<h3>config tube</h3>
-<pre><code>vim conf/flume.conf
-In vim command line mode, execute the following replacement commands, where ip:port is the tube address
-:%s/TUBE_LIST/ip:port,ip:port
+<pre><code>ip:port are tube address
</code></pre>
+<p>sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf</p>
+<pre><code>change proxy port
+agent1.sources.tcp-source.port = 46801
+</code></pre>
+<p>notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner data</p>
<h3>Environmental preparation</h3>
<pre><code>cd bin
sh prepare_env.sh
cd ..
</code></pre>
<h3>config manager</h3>
-<pre><code>vim conf/commmon.properties
+<pre><code>vim conf/common.properties
write：
cluster_id=1
-manager_hosts=xx.xx.xx.xx:port
+manager_hosts=ip:port
</code></pre>
<h2>3、run</h2>
<pre><code>sh bin/start.sh
diff --git a/en-us/docs/modules/dataproxy/quick_start.json b/en-us/docs/modules/dataproxy/quick_start.json
index 4a0c33d..26f523f 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-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target project</p>\n<pre><code>un tar it\ntar -zxvf apache-inlong-proxy-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>\n<pre> [...]
+ "__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> [...]
"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 f98748f..d556fbf 100644
--- a/en-us/docs/modules/dataproxy/quick_start.md
+++ b/en-us/docs/modules/dataproxy/quick_start.md
@@ -2,10 +2,11 @@
mvn clean package -DskipTests
-The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz can be found under the inlong-dataproxy/dataproxy-dist/target project
+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-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+un tar it
+
+ tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
## 2、configuration
@@ -13,9 +14,17 @@ The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.t
cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin
### config tube
- vim conf/flume.conf
- In vim command line mode, execute the following replacement commands, where ip:port is the tube address
- :%s/TUBE_LIST/ip:port,ip:port
+
+ ip:port are tube address
+
+sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
+
+ change proxy port
+ agent1.sources.tcp-source.port = 46801
+
+notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner data
+
+
### Environmental preparation
cd bin
@@ -23,10 +32,10 @@ The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.t
cd ..
### config manager
- vim conf/commmon.properties
+ vim conf/common.properties
write：
cluster_id=1
- manager_hosts=xx.xx.xx.xx:port
+ manager_hosts=ip:port
## 3、run
sh bin/start.sh
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 39e6d65..bc889ba 100644
--- a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html
+++ b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html
@@ -19,18 +19,20 @@
<p>environment requirements：</p>
<p>mysql
java(1.8+)
-In the dist directory, you can find the file tubemq-manager-bin.zip</p>
-<pre><code>unzip tubemq-manager-bin.zip
+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>
<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://x.x.x.x:3306/tubemanager
-spring.datasource.username=xx
-spring.datasource.password=xxx
+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
</code></pre>
<p>Add the database tubemanager and start:</p>
-<pre><code>bin/start-manager.sh
+<pre><code>bin/start-admin.sh
</code></pre>
<h2>use</h2>
<h3>create cluster</h3>
@@ -40,12 +42,12 @@ spring.datasource.password=xxx
</code></pre>
<p>parameter:</p>
<pre><code>{
-"masterIp": "9.23.28.86", (tube master ip)
+"masterIp": "127.0.0.1", (tubemq master ip)
"clusterName": "test",
-"masterPort": "8000", (tube master port)
-"masterWebPort": "8080", (tube master web port)
+"masterPort": "8000", (tubemq master port)
+"masterWebPort": "8080", (tubemq master web port)
"createUser": "test",
-"token": "abc" (tube token)
+"token": "abc" (tubemq token)
}
</code></pre>
<h3>Operation interface</h3>
@@ -101,10 +103,9 @@ user (Required) After the access authorization verification needs to verify the
</code></pre>
<p>example</p>
<p>POST</p>
-<pre><code>/v1/topic?method=queryCanWrite
-{
-"clusterId": "2",
-"topicName": "pzrTestss1123123",
+<pre><code>{
+"clusterId": "1",
+"topicName": "1",
"user": "test"
}
</code></pre>
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 d8df09b..6215645 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<p>mysql\njava(1.8+)\nIn the dist directory, you can find the file tubemq-manager-bin.zip</p>\n<pre><code>unzip tubemq-manager-bin.zip\n</code></pre>\n<p>Add mysql information in conf/application.properties:</p>\n<pre><code>spring.jpa.hibernate.ddl-auto=update\n# configuration for manager\nspring.datasource.url=jdbc:mysql://x.x.x.x:3306/tubemanager\nspring.datas [...]
+ "__html": "<h2>compile</h2>\n<pre><code>mvn clean package \n</code></pre>\n<h2>deploy</h2>\n<p>environment requirements：</p>\n<p>mysql\njava(1.8+)\nIn 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><code>spring.jpa.hibernat [...]
"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 e893718..a2f8d3d 100644
--- a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -8,40 +8,42 @@ environment requirements：
mysql
java(1.8+)
-In the dist directory, you can find the file tubemq-manager-bin.zip
+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
- unzip tubemq-manager-bin.zip
+ tar -zxvf apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
Add mysql information in conf/application.properties:
spring.jpa.hibernate.ddl-auto=update
# configuration for manager
- spring.datasource.url=jdbc:mysql://x.x.x.x:3306/tubemanager
- spring.datasource.username=xx
- spring.datasource.password=xxx
+ 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
Add the database tubemanager and start:
- bin/start-manager.sh
+ bin/start-admin.sh
## use
### create cluster
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
+/v1/cluster?method=add
POST
parameter:
{
- "masterIp": "9.23.28.86", (tube master ip)
+ "masterIp": "127.0.0.1", (tubemq master ip)
"clusterName": "test",
- "masterPort": "8000", (tube master port)
- "masterWebPort": "8080", (tube master web port)
+ "masterPort": "8000", (tubemq master port)
+ "masterWebPort": "8080", (tubemq master web port)
"createUser": "test",
- "token": "abc" (tube token)
+ "token": "abc" (tubemq token)
}
### Operation interface
@@ -82,10 +84,10 @@ AddTopicTasks is a list of the following objects, which can carry multiple creat
topicName (required) topic name
-Example
+Example
POST
- /v1/task?method=addTopicTask
+/v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -115,10 +117,9 @@ example
POST
- /v1/topic?method=queryCanWrite
{
- "clusterId": "2",
- "topicName": "pzrTestss1123123",
+ "clusterId": "1",
+ "topicName": "1",
"user": "test"
}
diff --git a/zh-cn/docs/modules/agent/quick_start.html b/zh-cn/docs/modules/agent/quick_start.html
index 06a10a6..19acace 100644
--- a/zh-cn/docs/modules/agent/quick_start.html
+++ b/zh-cn/docs/modules/agent/quick_start.html
@@ -12,7 +12,7 @@
<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= [...]
+ <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 +
@@ -33,7 +33,7 @@ agent.manager.vip.http.port=manager port</p>
<p>###2.2 Proxy 相关设置
在agent目录下新建.inlong.managerIps文件夹，内部新建bid+.local文件，例如设置的发送bid为a, 则新建a.local文件</p>
<p>内部写入：</p>
-<pre><code>{"cluster_id":45,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
+<pre><code>{"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
</code></pre>
<p>###2.3 agent本地运行job配置
如果不使用线上模式，可以使用本地文件新建读取任务
@@ -46,7 +46,7 @@ vim job1.json：</p>
"dir": {
-"pattern": "需要读取的文件路径，可包含正则表达式"
+"pattern": "需要读取的文件路径，可包含正则表达式，例如test/inlong_[0-9]{1}，监听test下创建的新文件"
},
diff --git a/zh-cn/docs/modules/agent/quick_start.json b/zh-cn/docs/modules/agent/quick_start.json
index 4048cdd..cd0a434 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": "<p>##一、安装</p>\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<p>###2.1 Agent 线上运行相关设置</p>\n<p>线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：\nagent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (设置任务获取的类名，默认为ManagerFetcher）\nagent.local.ip=写入本机ip\nagent.manager.vip.http.host=manager host\nagent [...]
+ "__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<p>###2.1 Agent 线上运行相关设置</p>\n<p>线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：\nagent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (设置任务获取的类名，默认为ManagerFetcher）\nagent.local.ip=写入本机ip\nagent.manager.vip.http.host=manager host\na [...]
"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 c387c0f..2bfe2ce 100644
--- a/zh-cn/docs/modules/agent/quick_start.md
+++ b/zh-cn/docs/modules/agent/quick_start.md
@@ -1,4 +1,4 @@
-##一、安装
+## ~~~~一、安装
环境要求：
java JDK 1.8
@@ -11,7 +11,6 @@
-
## 二、配置
agent 支持两种运行模式：本地运行以及线上运行
@@ -29,7 +28,7 @@ agent.manager.vip.http.port=manager port
内部写入：
- {"cluster_id":45,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
+ {"cluster_id":1,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
###2.3 agent本地运行job配置
如果不使用线上模式，可以使用本地文件新建读取任务
@@ -44,7 +43,7 @@ vim job1.json：
"dir": {
- "pattern": "需要读取的文件路径，可包含正则表达式"
+ "pattern": "需要读取的文件路径，可包含正则表达式，例如test/inlong_[0-9]{1}，监听test下创建的新文件"
},
diff --git a/zh-cn/docs/modules/dataproxy/quick_start.html b/zh-cn/docs/modules/dataproxy/quick_start.html
index 1646c62..a49642a 100644
--- a/zh-cn/docs/modules/dataproxy/quick_start.html
+++ b/zh-cn/docs/modules/dataproxy/quick_start.html
@@ -15,28 +15,32 @@
<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-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>
-<pre><code>解压
-tar -zxvf apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+<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-proxy-0.9.0-incubating-SNAPSHOT-bin
+<pre><code>cd apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin
</code></pre>
-<h3>配置tube地址</h3>
-<pre><code>vim conf/flume.conf
-vim命令行模式，执行以下替换命令,其中ip:port为tube master地址，可配置多个
-:%s/TUBE_LIST/ip1:port,ip2:port
+<h3>配置tube地址和端口号</h3>
+<pre><code>执行以下替换命令,其中ip:port为tube地址
</code></pre>
+<p>sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf</p>
+<pre><code>修改以下内容为proxy端口号
+agent1.sources.tcp-source.port = 46801
+</code></pre>
+<p>注意conf/flume.conf中FLUME_HOME为proxy的中间数据文件存放地址</p>
<h3>环境准备</h3>
<pre><code>cd bin
sh prepare_env.sh
cd ..
</code></pre>
<h3>配置manager地址</h3>
-<pre><code>vim conf/commmon.properties
+<pre><code>vim conf/common.properties
+
写入以下配置：
cluster_id=1
-manager_hosts=xx.xx.xx.xx:port
+manager_hosts=ip:port // 这里写入的是manager_api地址
</code></pre>
<h2>三、启动</h2>
<pre><code>sh bin/start.sh
diff --git a/zh-cn/docs/modules/dataproxy/quick_start.json b/zh-cn/docs/modules/dataproxy/quick_start.json
index f3991c3..fe1d524 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-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz</p>\n<pre><code>解压\ntar -zxvf apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz\n</code></pre>\n<h2>二、配置</h2>\n<pre><code>cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin\n</code></pre>\n<h3>配置tube地址</h3>\n<pre><code>vim conf/flume.conf\nvim命令行模式，执行以下替换命令,其中ip:port为tube master地址，可配置多 [...]
+ "__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 [...]
"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 337ab40..07b0882 100644
--- a/zh-cn/docs/modules/dataproxy/quick_start.md
+++ b/zh-cn/docs/modules/dataproxy/quick_start.md
@@ -2,20 +2,29 @@
mvn clean package -DskipTests
-在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+在inlong-dataproxy/dataproxy-dist/target项目下可以找到tgz安装包apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
- 解压
- tar -zxvf apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
+
+解压
+
+ tar -zxvf apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin.tar.gz
## 二、配置
- cd apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin
+ cd apache-inlong-dataproxy-0.9.0-incubating-SNAPSHOT-bin
+
+### 配置tube地址和端口号
+
+ 执行以下替换命令,其中ip:port为tube地址
-### 配置tube地址
- vim conf/flume.conf
- vim命令行模式，执行以下替换命令,其中ip:port为tube master地址，可配置多个
- :%s/TUBE_LIST/ip1:port,ip2:port
+sed -i 's/TUBE_LIST/ip1:port,ip2:port/g' conf/flume.conf
+
+
+ 修改以下内容为proxy端口号
+ agent1.sources.tcp-source.port = 46801
+
+注意conf/flume.conf中FLUME_HOME为proxy的中间数据文件存放地址
### 环境准备
cd bin
@@ -23,10 +32,11 @@
cd ..
### 配置manager地址
- vim conf/commmon.properties
+ vim conf/common.properties
+
写入以下配置：
cluster_id=1
- manager_hosts=xx.xx.xx.xx:port
+ manager_hosts=ip:port // 这里写入的是manager_api地址
## 三、启动
sh bin/start.sh
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 2e336da..cfeaed1 100644
--- a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html
+++ b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html
@@ -19,18 +19,20 @@
<p>环境要求：</p>
<p>mysql
java(1.8+)
-在dist目录当中，能够找到文件为tubemq-manager-bin.zip</p>
-<pre><code>unzip tubemq-manager-bin.zip
+在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>
<p>在conf/application.properties中添加mysql信息：</p>
<pre><code>spring.jpa.hibernate.ddl-auto=update
# configuration for manager
-spring.datasource.url=jdbc:mysql://x.x.x.x:3306/tubemanager
-spring.datasource.username=xx
-spring.datasource.password=xxx
+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
</code></pre>
<p>添加数据库tubemanager，并启动：</p>
-<pre><code>bin/start-manager.sh
+<pre><code>bin/start-admin.sh
</code></pre>
<h2>使用</h2>
<h3>新建集群</h3>
@@ -41,12 +43,12 @@ POST
</code></pre>
<p>参数：</p>
<pre><code>{
-"masterIp": "9.23.28.86", (tube master ip)
+"masterIp": "127.0.0.1", (tubemq master ip)
"clusterName": "test",
-"masterPort": "8000", (tube master port)
-"masterWebPort": "8080", (tube master web port)
+"masterPort": "8000", (tubemq master port)
+"masterWebPort": "8080", (tubemq master web port)
"createUser": "test",
-"token": "abc" (tube token)
+"token": "abc" (tubemq token)
}
</code></pre>
<h3>操作接口</h3>
@@ -64,7 +66,7 @@ GET
}
</code></pre>
<h4>topic</h4>
-<p>#####添加topicTask</p>
+<h4>添加topicTask</h4>
<pre><code>type (必填) 请求类型，字段填写：op_query
clusterId (必填) 请求集群id
addTopicTasks (必填) topicTasks，创建task任务json，
@@ -94,7 +96,7 @@ user (必填) 之后接入权限验证需要验证用户，这里预留出来
}
</code></pre>
<p>result为false为写入task失败</p>
-<p>#####查询某一个topic是否创建成功（业务可以写入）</p>
+<h4>查询某一个topic是否创建成功（业务可以写入）</h4>
<pre><code>clusterId (必填) 请求集群id
topicName (必填) 查询topic名称
user (必填) 之后接入权限验证需要验证用户，这里预留出来
@@ -104,8 +106,8 @@ user (必填) 之后接入权限验证需要验证用户，这里预留出来
<pre><code>/v1/topic?method=queryCanWrite
{
-"clusterId": "2",
-"topicName": "pzrTestss1123123",
+"clusterId": "1",
+"topicName": "1",
"user": "test"
}
</code></pre>
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 996a949..306835f 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<p>mysql\njava(1.8+)\n在dist目录当中，能够找到文件为tubemq-manager-bin.zip</p>\n<pre><code>unzip tubemq-manager-bin.zip\n</code></pre>\n<p>在conf/application.properties中添加mysql信息：</p>\n<pre><code>spring.jpa.hibernate.ddl-auto=update\n# configuration for manager\nspring.datasource.url=jdbc:mysql://x.x.x.x:3306/tubemanager\nspring.datasource.username=xx\nspring.datasource.password=xxx\n</code></pre>\n<p>添加 [...]
+ "__html": "<h2>编译</h2>\n<pre><code>mvn clean package \n</code></pre>\n<h2>部署</h2>\n<p>环境要求：</p>\n<p>mysql\njava(1.8+)\n在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 manager\nspring.datasource.url=j [...]
"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 9a8f3e5..f060931 100644
--- a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -8,21 +8,23 @@
mysql
java(1.8+)
-在dist目录当中，能够找到文件为tubemq-manager-bin.zip
+在InLong/inlong-tubemq/tubemq-manager/dist/目录当中，能够找到文件为apache-inlong-tubemanager-0.9.0-incubating-SNAPSHOT-bin.tar.gz
- unzip tubemq-manager-bin.zip
+ 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://x.x.x.x:3306/tubemanager
- spring.datasource.username=xx
- spring.datasource.password=xxx
+ 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-manager.sh
+ bin/start-admin.sh
## 使用
@@ -37,12 +39,12 @@ java(1.8+)
参数：
{
- "masterIp": "9.23.28.86", (tube master ip)
+ "masterIp": "127.0.0.1", (tubemq master ip)
"clusterName": "test",
- "masterPort": "8000", (tube master port)
- "masterWebPort": "8080", (tube master web port)
+ "masterPort": "8000", (tubemq master port)
+ "masterWebPort": "8080", (tubemq master web port)
"createUser": "test",
- "token": "abc" (tube token)
+ "token": "abc" (tubemq token)
}
### 操作接口
@@ -51,8 +53,8 @@ java(1.8+)
查询clusterId以及clusterName全量数据 （get)
示例
- GET
- /v1/cluster
+GET
+/v1/cluster
返回值
@@ -65,7 +67,7 @@ java(1.8+)
#### topic
-#####添加topicTask
+#### 添加topicTask
type (必填) 请求类型，字段填写：op_query
clusterId (必填) 请求集群id
@@ -84,7 +86,7 @@ AddTopicTasks 为以下对象的List，可携带多个创建topic请求
示例
POST
- /v1/task?method=addTopicTask
+/v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -104,8 +106,7 @@ POST
result为false为写入task失败
-
-#####查询某一个topic是否创建成功（业务可以写入）
+#### 查询某一个topic是否创建成功（业务可以写入）
clusterId (必填) 请求集群id
topicName (必填) 查询topic名称
@@ -119,8 +120,8 @@ POST
/v1/topic?method=queryCanWrite
{
- "clusterId": "2",
- "topicName": "pzrTestss1123123",
+ "clusterId": "1",
+ "topicName": "1",
"user": "test"
}