You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by go...@apache.org on 2021/07/08 06:53:09 UTC
[incubator-inlong-website] branch master updated: [INLONG-684]
change doc in agent and tubemanager and proxy (#92)
This is an automated email from the ASF dual-hosted git repository.
gosonzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new bb3c465 [INLONG-684] change doc in agent and tubemanager and proxy (#92)
bb3c465 is described below
commit bb3c465785f990142c2a5d0ae9329e37eae744a3
Author: ziruipeng <zp...@connect.ust.hk>
AuthorDate: Thu Jul 8 14:53:03 2021 +0800
[INLONG-684] change doc in agent and tubemanager and proxy (#92)
Co-authored-by: stingpeng <st...@tencent.com>
---
docs/en-us/modules/agent/quick_start.md | 7 +++----
docs/en-us/modules/tubemq/tubemq-manager/quick_start.md | 16 ++++++++++++++++
docs/zh-cn/modules/agent/quick_start.md | 12 ++++++------
docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md | 17 ++++++++++++++++-
4 files changed, 41 insertions(+), 11 deletions(-)
diff --git a/docs/en-us/modules/agent/quick_start.md b/docs/en-us/modules/agent/quick_start.md
index 294e052..b3cc37c 100644
--- a/docs/en-us/modules/agent/quick_start.md
+++ b/docs/en-us/modules/agent/quick_start.md
@@ -27,7 +27,7 @@ agent.manager.vip.http.port=manager port
```
### 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
+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:
```ini
@@ -114,10 +114,9 @@ agent.http.port=Available ports
"channel": "org.apache.inlong.agent.plugin.channel.MemoryChannel"
},
"bus": {
- "bid": "thirtybid10",
+ "bid": "bid10",
"tdmanager": {
- "port": "8099",
- "host": "http://tl-tdbank-tdmanger.tencent-distribute.com"
+ "port": "8099"
}
},
"op": "add"
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 a2f8d3d..3b4ea81 100644
--- a/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
@@ -130,3 +130,19 @@ return json
{ "result":false, "errCode": 101, "errMsg":"no such topic in master"}
result is false as not writable
+
+
+
+### curls for operations
+
+ curl --header "Content-Type: application/json" --request POST --data \
+ '{"masterIp":"masterip","clusterName":"test","masterPort":"8099","masterWebPort":"8080","createUser":"test","token":"abc"}' \
+ http://tubemanagerip:tubemanagerport/v1/cluster?method=add
+
+ curl --header "Content-Type: application/json" --request POST --data \
+ '{"clusterId":"1","addTopicTasks":[{"topicName": "testfordocker"}],"user":"test"}' \
+ http://tubemanagerip:tubemanagerport/v1/task?method=addTopicTask
+
+ curl --header "Content-Type: application/json" --request POST --data \
+ '{"clusterId":"1","topicName":"testfordocker","user":"test"}' \
+ http://tubemanagerip:tubemanagerport/v1/topic?method=queryCanWrite
\ No newline at end of file
diff --git a/docs/zh-cn/modules/agent/quick_start.md b/docs/zh-cn/modules/agent/quick_start.md
index 3711af6..ff3444e 100644
--- a/docs/zh-cn/modules/agent/quick_start.md
+++ b/docs/zh-cn/modules/agent/quick_start.md
@@ -26,7 +26,7 @@ agent.manager.vip.http.port=manager port
```
### 2.2 Proxy 相关设置
-在agent目录下新建.inlong\.managerIps文件夹，内部新建bid+.local文件，例如设置的发送bid为a, 则新建a.local文件
+在agent目录下新建.inlong文件夹，内部新建bid+.local文件，例如设置的发送bid为a, 则新建a.local文件
内部将写入：
```ini
@@ -76,7 +76,7 @@ vim job1.json：
其中各个参数含义为：
- job.dir.pattern: 配置读取的文件路径，可包含正则表达式
-- job.trigger: 触发器名称，默认为DirectoryTrigger，功能为监听文件夹下的文件产生事件
+- job.trigger: 触发器名称，默认为DirectoryTrigger，功能为监听文件夹下的文件产生事件，任务运行时已有的文件不会读取
- job.source: 使用的数据源类型，默认为TextFileSource，读取文本文件
- job.sink：使用的写入器类型，默认为ProxySink，发送消息到proxy中
- proxy.bid: 写入proxy时使用的bid类型
@@ -114,15 +114,15 @@ curl --location --request POST 'http://localhost:8129/config/job' \
"channel": "org.apache.inlong.agent.plugin.channel.MemoryChannel"
},
"proxy": {
-"bid": "thirtybid10"
+"bid": "bid10"
},
"op": "add"
}'
```
-其中参数分别为：
-- pattern: 代表读取/data/inlong-agent/test.log文件
-- proxy.bid: 代表发送到proxy使用的bid
+ 其中参数分别为：
+ pattern: 代表读取/data/inlong-agent/test.log文件，需要新建任务后再创建文件
+ proxy.bid: 代表发送到proxy使用的bid
## 三、运行
解压后如下命令运行
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 f060931..560c75a 100644
--- a/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
@@ -132,4 +132,19 @@ POST
{ "result":false, "errCode": 100, "errMsg":"topic thirty5is not writable"}
{ "result":false, "errCode": 101, "errMsg":"no such topic in master"}
-result为false为不可写
\ No newline at end of file
+result为false为不可写
+
+
+### 附录：以上操作的curl
+
+ curl --header "Content-Type: application/json" --request POST --data \
+ '{"masterIp":"masterip","clusterName":"test","masterPort":"8099","masterWebPort":"8080","createUser":"test","token":"abc"}' \
+ http://tubemanagerip:tubemanagerport/v1/cluster?method=add
+
+ curl --header "Content-Type: application/json" --request POST --data \
+ '{"clusterId":"1","addTopicTasks":[{"topicName": "testfordocker"}],"user":"test"}' \
+ http://tubemanagerip:tubemanagerport/v1/task?method=addTopicTask
+
+ curl --header "Content-Type: application/json" --request POST --data \
+ '{"clusterId":"1","topicName":"testfordocker","user":"test"}' \
+ http://tubemanagerip:tubemanagerport/v1/topic?method=queryCanWrite
\ No newline at end of file