You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2022/08/25 02:53:01 UTC
[inlong-website] branch master updated: [INLONG-520][Manager] Supplement command line tools information for inlong manager (#519)
This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 96563d9cd [INLONG-520][Manager] Supplement command line tools information for inlong manager (#519)
96563d9cd is described below
commit 96563d9cd61424b920792232489a790b94107053
Author: Yizhou Yang <32...@users.noreply.github.com>
AuthorDate: Thu Aug 25 10:52:57 2022 +0800
[INLONG-520][Manager] Supplement command line tools information for inlong manager (#519)
---
docs/user_guide/command_line_tools.md | 75 ++++++++++++++++++--
.../current/user_guide/command_line_tools.md | 81 ++++++++++++++++++++--
2 files changed, 146 insertions(+), 10 deletions(-)
diff --git a/docs/user_guide/command_line_tools.md b/docs/user_guide/command_line_tools.md
index 4088978b2..5a016a97a 100644
--- a/docs/user_guide/command_line_tools.md
+++ b/docs/user_guide/command_line_tools.md
@@ -21,7 +21,7 @@ Usage: managerctl [options] [command] [command options]
Usage: list [options]
```
-The current command line tool supports three commands of `list` , `describe` , and `create`.
+The current command line tool supports six commands of `list` , `describe` , `update` , `delete` , `log` , and `create`.
## Configuration
@@ -121,7 +121,7 @@ Usage: managerctl describe [command] [command options]
sink type
```
-The `describe` command is used to show the details of the Inlong Group / Stream / Sink / Source
+The `describe` command is used to show the details of the Inlong Group / Stream / Sink / Source
and output in JSON format.
## Create
@@ -277,8 +277,8 @@ Json files have five parts: `groupConf` 、`streamConf` 、`streamSource` 、`st
> ```
> "mqBaseConf": {
> "type": "KAFKA",
-> "bootstrapServers": "pulsar://100.76.43.216:6650",
-> "topicName": "http://100.76.43.216:8080",
+> "bootstrapServers": "127.0.0.1:9092",
+> "topicName": "test_topic",
> "dataFormat": "JSON",
> "boolean": false,
> }
@@ -305,4 +305,69 @@ Json files have five parts: `groupConf` 、`streamConf` 、`streamSource` 、`st
> "retryTimes": 3,
> "needCreated": false
> }
-> ```
\ No newline at end of file
+>
+> ```
+
+## Delete
+
+```
+Usage: managerctl delete [command]
+ Commands:
+ group The id of the inlong group that is to be deleted
+ Usage: group
+```
+
+The `delete` command deletes the inlong group corresponding to the given id.
+
+## Update
+
+```
+Usage: managerctl update [command] [command options]
+ Commands:
+ group The id of the inlong group that is to be updated
+ Usage: group [options]
+ Options:
+ *-c --config
+ the config file as json
+```
+
+The `update` command updates the inlong group corresponding to the given id, using the config file provided.
+- Sortconf json example
+> ```
+> "FlinkSortConf": {
+> "sortType": "flink",
+> "authentication": "NONE",
+> "serviceUrl": "127.0.0.1:8080",
+> "region": "beijing",
+> "properties": {}
+> }
+>
+> ```
+
+
+
+## Log
+
+```
+Usage: managerctl log [command] [command options]
+ Commands:
+ group Get group details
+ Usage: group [options]
+ Options:
+ *-q --query [parameter:value]
+ select the list of groups accourding to one selected query.
+ Supported filters:
+ inlongGroupId
+ name (Inlong group name)
+ mqType
+ mqResource
+ inlongClusterTag
+ inCharges
+ status
+ creator
+ modifier
+ createTime
+ modifyTime
+```
+
+The `log` command is used to filter out inlong groups according to its properties from a small list of inlong groups.
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md
index f171e3a1f..c1a1400b2 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md
@@ -1,5 +1,5 @@
---
-title: 命令行工具
+title: 命令行工具
sidebar_position: 2
---
@@ -19,9 +19,18 @@ Usage: managerctl [options] [command] [command options]
list Displays main information for one or more resources
Usage: list [options]
+
+ delete Deletes the inlong group corresponding to the given id
+ Usage: managerctl delete [command]
+
+ update Updates the inlong group corresponding to the given id
+ Usage: managerctl update [command] [command options]
+
+ log Filters out inlong groups according to its properties
+ Usage: managerctl log [command] [command options]
```
-目前命令行工具支持 `list`、`describe` 以及 `create` 三个命令。
+目前命令行工具支持 `list`、`describe`、`create`、`log`、`update`、`delete` 六个命令。
## 配置
@@ -276,8 +285,8 @@ Json 文件主要有五个部分： `groupConf` 、`streamConf` 、`streamSource
> ```
> "mqBaseConf": {
> "type": "KAFKA",
-> "bootstrapServers": "pulsar://127.0.0.1:6650",
-> "topicName": "http://100.76.43.216:8080",
+> "bootstrapServers": "127.0.0.1:9092",
+> "topicName": "test_topic",
> "dataFormat": "JSON",
> "boolean": false,
> }
@@ -304,4 +313,66 @@ Json 文件主要有五个部分： `groupConf` 、`streamConf` 、`streamSource
> "retryTimes": 3,
> "needCreated": false
> }
-> ```
\ No newline at end of file
+> ```
+>
+>
+## Delete
+
+```
+Usage: managerctl delete [command]
+ Commands:
+ group The id of the inlong group that is to be deleted
+ Usage: group
+```
+
+`delete` 删除对应任务id的任务实例
+
+## Update
+
+```
+Usage: managerctl update [command] [command options]
+ Commands:
+ group The id of the inlong group that is to be updated
+ Usage: group [options]
+ Options:
+ *-c --config
+ the config file as json
+```
+
+`update` 命令指定一个任务实例，并使用--config中指定的sortconf json文件对其进行更新
+- Sortconf json 示例
+> ```
+> "FlinkSortConf": {
+> "sortType": "flink",
+> "authentication": "NONE",
+> "serviceUrl": "127.0.0.1:8123",
+> "region": "beijing",
+> "properties": {}
+> }
+> ```
+
+## Log
+
+```
+Usage: managerctl log [command] [command options]
+ Commands:
+ group Get group details
+ Usage: group [options]
+ Options:
+ *-q --query [parameter:value]
+ select the list of groups accourding to one selected query.
+ Supported filters:
+ inlongGroupId
+ name (Inlong group name)
+ mqType
+ mqResource
+ inlongClusterTag
+ inCharges
+ status
+ creator
+ modifier
+ createTime
+ modifyTime
+```
+
+`log` 命令行使用时需选择过滤参数，当存在的任务数不多时，该命令将打印出所有满足参数的任务实例