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/22 06:10:34 UTC
[incubator-inlong-website] branch asf-site updated: Automated
deployment: Thu Jul 22 06:10:26 UTC 2021
b6bf7426618b7190ad36a2865304fdad8ce120a3
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 6a1b06c Automated deployment: Thu Jul 22 06:10:26 UTC 2021 b6bf7426618b7190ad36a2865304fdad8ce120a3
6a1b06c is described below
commit 6a1b06cc80e38c5625ba03bc288a38fa1643f610
Author: gosonzhang <go...@users.noreply.github.com>
AuthorDate: Thu Jul 22 06:10:26 2021 +0000
Automated deployment: Thu Jul 22 06:10:26 UTC 2021 b6bf7426618b7190ad36a2865304fdad8ce120a3
---
.../modules/tubemq/tubemq-manager/quick_start.md | 74 ++++++---------------
.../modules/tubemq/tubemq-manager/quick_start.md | 76 ++++++----------------
.../modules/tubemq/tubemq-manager/quick_start.html | 65 ++++++------------
.../modules/tubemq/tubemq-manager/quick_start.json | 2 +-
.../modules/tubemq/tubemq-manager/quick_start.md | 74 ++++++---------------
.../modules/tubemq/tubemq-manager/quick_start.html | 70 ++++++--------------
.../modules/tubemq/tubemq-manager/quick_start.json | 2 +-
.../modules/tubemq/tubemq-manager/quick_start.md | 76 ++++++----------------
8 files changed, 127 insertions(+), 312 deletions(-)
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 1a276e2..d8d4e6e 100644
--- a/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/en-us/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,54 +1,39 @@
-## deploy
+## Deploy TubeMQ Manager
All deploying files at `inlong-tubemq-manager` directory.
### configuration
-Add mysql information in conf/application.properties:
+- create `tubemanager` and account in MySQL.
+- Add mysql information in conf/application.properties:
```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
+# mysql configuration for manager
+spring.datasource.url=jdbc:mysql://mysql_ip:mysql_port/tubemanager
+spring.datasource.username=mysql_username
+spring.datasource.password=mysql_password
```
### start service
-Add the database tubemanager and start:
``` bash
-$ bin/start-admin.sh
+$ bin/start-manager.sh
```
-## usage
-
-### 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
-
- POST
-
-parameter:
-
- {
- "masterIp": "127.0.0.1", (tubemq master ip)
- "clusterName": "test",
- "masterPort": "8000", (tubemq master port)
- "masterWebPort": "8080", (tubemq master web port)
- "createUser": "test",
- "token": "abc" (tubemq token)
- }
+### register TubeMQ cluster
+replace `master_ip` and other parameters of TubeMQ Clusters, .
+```
+curl --header "Content-Type: application/json" --request POST --data \
+'{"masterIp":"master_ip","clusterName":"inlong","masterPort":"8715","masterWebPort":"8080","createUser":"manager","token":"abc"}' \
+http://127.0.0.1:8089/v1/cluster?method=add
+```
-### Operation interface
+### Appendix: Other Operation interface
#### cluster
Query full data of clusterId and clusterName (get)
Example
-GET
-/v1/cluster
+
+【GET】 /v1/cluster
return value
@@ -81,8 +66,7 @@ AddTopicTasks is a list of the following objects, which can carry multiple creat
Example
-POST
-/v1/task?method=addTopicTask
+【POST】 /v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -110,7 +94,7 @@ If result is false, the writing task failed
example
-POST
+【POST】 /v1/topic?method=queryCanWrite
{
"clusterId": "1",
@@ -124,20 +108,4 @@ return json
{ "result":false, "errCode": 100, "errMsg":"topic test is not writable"}
{ "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
+result is false as not writable
\ No newline at end of file
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 b610cb7..d40cce6 100644
--- a/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
+++ b/docs/zh-cn/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,55 +1,39 @@
-## 部署
+## 部署TubeMQ Manager
安装文件在inlong-tubemq-manager目录.
### 配置
-在conf/application.properties中添加mysql信息：
+- 在mysql中创建`tubemanager`数据和相应用户.
+- 在conf/application.properties中添加mysql信息：
```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
+# mysql configuration for manager
+spring.datasource.url=jdbc:mysql://mysql_ip:mysql_port/tubemanager
+spring.datasource.username=mysql_username
+spring.datasource.password=mysql_password
```
### 启动服务
-添加数据库tubemanager，并启动：
``` bash
-$ bin/start-admin.sh
+$ bin/start-manager.sh
```
-## 使用
-
-### 新建集群
-
-在使用tubeAdmin操作集群之前，首先需要注册集群信息，使用如下接口添加一个集群：
-
- /v1/cluster?method=add
-
- POST
-
-参数：
-
- {
- "masterIp": "127.0.0.1", (tubemq master ip)
- "clusterName": "test",
- "masterPort": "8000", (tubemq master port)
- "masterWebPort": "8080", (tubemq master web port)
- "createUser": "test",
- "token": "abc" (tubemq token)
- }
+### 注册TubeMQ集群
+替换`master_ip`等TubeMQ集群参数，然后执行以下命令：
+```
+curl --header "Content-Type: application/json" --request POST --data \
+'{"masterIp":"master_ip","clusterName":"inlong","masterPort":"8715","masterWebPort":"8080","createUser":"manager","token":"abc"}' \
+http://127.0.0.1:8089/v1/cluster?method=add
+```
-### 操作接口
+### 附录：其它操作接口
#### cluster
查询clusterId以及clusterName全量数据 （get)
示例
-GET
-/v1/cluster
+
+【GET】 /v1/cluster
返回值
@@ -80,8 +64,7 @@ AddTopicTasks 为以下对象的List，可携带多个创建topic请求
示例
-POST
-/v1/task?method=addTopicTask
+【POST】 /v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -110,9 +93,7 @@ result为false为写入task失败
示例
-POST
-
- /v1/topic?method=queryCanWrite
+【POST】 /v1/topic?method=queryCanWrite
{
"clusterId": "1",
@@ -127,19 +108,4 @@ POST
{ "result":false, "errCode": 100, "errMsg":"topic test is not writable"}
{ "result":false, "errCode": 101, "errMsg":"no such topic in master"}
-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
+result为false为不可写
\ No newline at end of file
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 8c0e1e3..9b3776c 100644
--- a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html
+++ b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.html
@@ -12,44 +12,32 @@
<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= [...]
+ <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 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>
+<ul>
+<li>create <code>tubemanager</code> and account in MySQL.</li>
+<li>Add mysql information in conf/application.properties:</li>
+</ul>
+<pre><code class="language-ini"><span class="hljs-comment"># mysql configuration for manager</span>
+<span class="hljs-attr">spring.datasource.url</span>=jdbc:mysql://mysql_ip:mysql_port/tubemanager
+<span class="hljs-attr">spring.datasource.username</span>=mysql_username
+<span class="hljs-attr">spring.datasource.password</span>=mysql_password
</code></pre>
<h3>start service</h3>
-<p>Add the database tubemanager and start:</p>
-<pre><code class="language-bash">$ bin/start-admin.sh
+<pre><code class="language-bash">$ bin/start-manager.sh
</code></pre>
-<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>
-<pre><code>POST
-</code></pre>
-<p>parameter:</p>
-<pre><code>{
-"masterIp": "127.0.0.1", (tubemq master ip)
-"clusterName": "test",
-"masterPort": "8000", (tubemq master port)
-"masterWebPort": "8080", (tubemq master web port)
-"createUser": "test",
-"token": "abc" (tubemq token)
-}
+<h3>register TubeMQ cluster</h3>
+<p>replace <code>master_ip</code> and other parameters of TubeMQ Clusters, .</p>
+<pre><code>curl --header "Content-Type: application/json" --request POST --data \
+'{"masterIp":"master_ip","clusterName":"inlong","masterPort":"8715","masterWebPort":"8080","createUser":"manager","token":"abc"}' \
+http://127.0.0.1:8089/v1/cluster?method=add
</code></pre>
-<h3>Operation interface</h3>
+<h3>Appendix: Other Operation interface</h3>
<h4>cluster</h4>
<p>Query full data of clusterId and clusterName (get)</p>
-<p>Example
-GET
-/v1/cluster</p>
+<p>Example</p>
+<p>【GET】 /v1/cluster</p>
<p>return value</p>
<pre><code>{
"errMsg": "",
@@ -73,8 +61,7 @@ Currently an addTopicTask will create topics in all brokers in the cluster</p>
<pre><code>topicName (required) topic name
</code></pre>
<p>Example</p>
-<p>POST
-/v1/task?method=addTopicTask</p>
+<p>【POST】 /v1/task?method=addTopicTask</p>
<pre><code>{
"clusterId": "1",
"addTopicTasks": [{"topicName": "1"}],
@@ -96,7 +83,7 @@ topicName (Required) Query topic name
user (Required) After the access authorization verification needs to verify the user, it is reserved here
</code></pre>
<p>example</p>
-<p>POST</p>
+<p>【POST】 /v1/topic?method=queryCanWrite</p>
<pre><code>{
"clusterId": "1",
"topicName": "1",
@@ -109,18 +96,6 @@ user (Required) After the access authorization verification needs to verify the
{ "result":false, "errCode": 101, "errMsg":"no such topic in master"}
</code></pre>
<p>result is false as not writable</p>
-<h3>curls for operations</h3>
-<pre><code>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</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/tubemq/tubemq-manager/quick_start.json b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.json
index bc53a60..b3fc1f1 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>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</ [...]
+ "__html": "<h2>Deploy TubeMQ Manager</h2>\n<p>All deploying files at <code>inlong-tubemq-manager</code> directory.</p>\n<h3>configuration</h3>\n<ul>\n<li>create <code>tubemanager</code> and account in MySQL.</li>\n<li>Add mysql information in conf/application.properties:</li>\n</ul>\n<pre><code class=\"language-ini\"><span class=\"hljs-comment\"># mysql configuration for manager</span>\n<span class=\"hljs-attr\">spring.datasource.url</span>=jdbc:mysql://mysql_ip:mysql_port/tubemanager\ [...]
"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 1a276e2..d8d4e6e 100644
--- a/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/en-us/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,54 +1,39 @@
-## deploy
+## Deploy TubeMQ Manager
All deploying files at `inlong-tubemq-manager` directory.
### configuration
-Add mysql information in conf/application.properties:
+- create `tubemanager` and account in MySQL.
+- Add mysql information in conf/application.properties:
```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
+# mysql configuration for manager
+spring.datasource.url=jdbc:mysql://mysql_ip:mysql_port/tubemanager
+spring.datasource.username=mysql_username
+spring.datasource.password=mysql_password
```
### start service
-Add the database tubemanager and start:
``` bash
-$ bin/start-admin.sh
+$ bin/start-manager.sh
```
-## usage
-
-### 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
-
- POST
-
-parameter:
-
- {
- "masterIp": "127.0.0.1", (tubemq master ip)
- "clusterName": "test",
- "masterPort": "8000", (tubemq master port)
- "masterWebPort": "8080", (tubemq master web port)
- "createUser": "test",
- "token": "abc" (tubemq token)
- }
+### register TubeMQ cluster
+replace `master_ip` and other parameters of TubeMQ Clusters, .
+```
+curl --header "Content-Type: application/json" --request POST --data \
+'{"masterIp":"master_ip","clusterName":"inlong","masterPort":"8715","masterWebPort":"8080","createUser":"manager","token":"abc"}' \
+http://127.0.0.1:8089/v1/cluster?method=add
+```
-### Operation interface
+### Appendix: Other Operation interface
#### cluster
Query full data of clusterId and clusterName (get)
Example
-GET
-/v1/cluster
+
+【GET】 /v1/cluster
return value
@@ -81,8 +66,7 @@ AddTopicTasks is a list of the following objects, which can carry multiple creat
Example
-POST
-/v1/task?method=addTopicTask
+【POST】 /v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -110,7 +94,7 @@ If result is false, the writing task failed
example
-POST
+【POST】 /v1/topic?method=queryCanWrite
{
"clusterId": "1",
@@ -124,20 +108,4 @@ return json
{ "result":false, "errCode": 100, "errMsg":"topic test is not writable"}
{ "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
+result is false as not writable
\ No newline at end of file
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 f6da53f..55b9b48 100644
--- a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html
+++ b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.html
@@ -12,45 +12,32 @@
<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= [...]
<p>安装文件在inlong-tubemq-manager目录.</p>
<h3>配置</h3>
-<p>在conf/application.properties中添加mysql信息：</p>
-<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>
+<ul>
+<li>在mysql中创建<code>tubemanager</code>数据和相应用户.</li>
+<li>在conf/application.properties中添加mysql信息：</li>
+</ul>
+<pre><code class="language-ini"><span class="hljs-comment"># mysql configuration for manager</span>
+<span class="hljs-attr">spring.datasource.url</span>=jdbc:mysql://mysql_ip:mysql_port/tubemanager
+<span class="hljs-attr">spring.datasource.username</span>=mysql_username
+<span class="hljs-attr">spring.datasource.password</span>=mysql_password
</code></pre>
<h3>启动服务</h3>
-<p>添加数据库tubemanager，并启动：</p>
-<pre><code class="language-bash">$ bin/start-admin.sh
+<pre><code class="language-bash">$ bin/start-manager.sh
</code></pre>
-<h2>使用</h2>
-<h3>新建集群</h3>
-<p>在使用tubeAdmin操作集群之前，首先需要注册集群信息，使用如下接口添加一个集群：</p>
-<pre><code>/v1/cluster?method=add
-
-POST
-</code></pre>
-<p>参数：</p>
-<pre><code>{
-"masterIp": "127.0.0.1", (tubemq master ip)
-"clusterName": "test",
-"masterPort": "8000", (tubemq master port)
-"masterWebPort": "8080", (tubemq master web port)
-"createUser": "test",
-"token": "abc" (tubemq token)
-}
+<h3>注册TubeMQ集群</h3>
+<p>替换<code>master_ip</code>等TubeMQ集群参数，然后执行以下命令：</p>
+<pre><code>curl --header "Content-Type: application/json" --request POST --data \
+'{"masterIp":"master_ip","clusterName":"inlong","masterPort":"8715","masterWebPort":"8080","createUser":"manager","token":"abc"}' \
+http://127.0.0.1:8089/v1/cluster?method=add
</code></pre>
-<h3>操作接口</h3>
+<h3>附录：其它操作接口</h3>
<h4>cluster</h4>
<p>查询clusterId以及clusterName全量数据 （get)</p>
-<p>示例
-GET
-/v1/cluster</p>
+<p>示例</p>
+<p>【GET】 /v1/cluster</p>
<p>返回值</p>
<pre><code>{
"errMsg": "",
@@ -73,8 +60,7 @@ user (必填) 之后接入权限验证需要验证用户，这里预留出来
<pre><code>topicName (必填) topic名称
</code></pre>
<p>示例</p>
-<p>POST
-/v1/task?method=addTopicTask</p>
+<p>【POST】 /v1/task?method=addTopicTask</p>
<pre><code>{
"clusterId": "1",
"addTopicTasks": [{"topicName": "1"}],
@@ -96,10 +82,8 @@ topicName (必填) 查询topic名称
user (必填) 之后接入权限验证需要验证用户，这里预留出来
</code></pre>
<p>示例</p>
-<p>POST</p>
-<pre><code>/v1/topic?method=queryCanWrite
-
-{
+<p>【POST】 /v1/topic?method=queryCanWrite</p>
+<pre><code>{
"clusterId": "1",
"topicName": "1",
"user": "test"
@@ -111,18 +95,6 @@ user (必填) 之后接入权限验证需要验证用户，这里预留出来
{ "result":false, "errCode": 101, "errMsg":"no such topic in master"}
</code></pre>
<p>result为false为不可写</p>
-<h3>附录：以上操作的curl</h3>
-<pre><code>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</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/tubemq/tubemq-manager/quick_start.json b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.json
index 515e15c..b481e3a 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<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 [...]
+ "__html": "<h2>部署TubeMQ Manager</h2>\n<p>安装文件在inlong-tubemq-manager目录.</p>\n<h3>配置</h3>\n<ul>\n<li>在mysql中创建<code>tubemanager</code>数据和相应用户.</li>\n<li>在conf/application.properties中添加mysql信息：</li>\n</ul>\n<pre><code class=\"language-ini\"><span class=\"hljs-comment\"># mysql configuration for manager</span>\n<span class=\"hljs-attr\">spring.datasource.url</span>=jdbc:mysql://mysql_ip:mysql_port/tubemanager\n<span class=\"hljs-attr\">spring.datasource.username</span>=mysql_username\n<spa [...]
"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 b610cb7..d40cce6 100644
--- a/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md
+++ b/zh-cn/docs/modules/tubemq/tubemq-manager/quick_start.md
@@ -1,55 +1,39 @@
-## 部署
+## 部署TubeMQ Manager
安装文件在inlong-tubemq-manager目录.
### 配置
-在conf/application.properties中添加mysql信息：
+- 在mysql中创建`tubemanager`数据和相应用户.
+- 在conf/application.properties中添加mysql信息：
```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
+# mysql configuration for manager
+spring.datasource.url=jdbc:mysql://mysql_ip:mysql_port/tubemanager
+spring.datasource.username=mysql_username
+spring.datasource.password=mysql_password
```
### 启动服务
-添加数据库tubemanager，并启动：
``` bash
-$ bin/start-admin.sh
+$ bin/start-manager.sh
```
-## 使用
-
-### 新建集群
-
-在使用tubeAdmin操作集群之前，首先需要注册集群信息，使用如下接口添加一个集群：
-
- /v1/cluster?method=add
-
- POST
-
-参数：
-
- {
- "masterIp": "127.0.0.1", (tubemq master ip)
- "clusterName": "test",
- "masterPort": "8000", (tubemq master port)
- "masterWebPort": "8080", (tubemq master web port)
- "createUser": "test",
- "token": "abc" (tubemq token)
- }
+### 注册TubeMQ集群
+替换`master_ip`等TubeMQ集群参数，然后执行以下命令：
+```
+curl --header "Content-Type: application/json" --request POST --data \
+'{"masterIp":"master_ip","clusterName":"inlong","masterPort":"8715","masterWebPort":"8080","createUser":"manager","token":"abc"}' \
+http://127.0.0.1:8089/v1/cluster?method=add
+```
-### 操作接口
+### 附录：其它操作接口
#### cluster
查询clusterId以及clusterName全量数据 （get)
示例
-GET
-/v1/cluster
+
+【GET】 /v1/cluster
返回值
@@ -80,8 +64,7 @@ AddTopicTasks 为以下对象的List，可携带多个创建topic请求
示例
-POST
-/v1/task?method=addTopicTask
+【POST】 /v1/task?method=addTopicTask
{
"clusterId": "1",
@@ -110,9 +93,7 @@ result为false为写入task失败
示例
-POST
-
- /v1/topic?method=queryCanWrite
+【POST】 /v1/topic?method=queryCanWrite
{
"clusterId": "1",
@@ -127,19 +108,4 @@ POST
{ "result":false, "errCode": 100, "errMsg":"topic test is not writable"}
{ "result":false, "errCode": 101, "errMsg":"no such topic in master"}
-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
+result为false为不可写
\ No newline at end of file