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 a7a63b0e06 [INLONG-845][Doc] Add Command Line tools guide for TubeMQ
(#844)
a7a63b0e06 is described below
commit a7a63b0e0665c77051a585b7c600065d13cd6d53
Author: Zfancy <[email protected]>
AuthorDate: Fri Sep 8 09:44:06 2023 +0800
[INLONG-845][Doc] Add Command Line tools guide for TubeMQ (#844)
---
docs/modules/tubemq/commandline_tools.md | 248 +++++++++++++++++++++
.../current/modules/tubemq/commandline_tools.md | 248 +++++++++++++++++++++
2 files changed, 496 insertions(+)
diff --git a/docs/modules/tubemq/commandline_tools.md
b/docs/modules/tubemq/commandline_tools.md
new file mode 100644
index 0000000000..f6b7b7e59d
--- /dev/null
+++ b/docs/modules/tubemq/commandline_tools.md
@@ -0,0 +1,248 @@
+---
+title: Command-line Tools
+sidebar_position: 15
+---
+
+## Overview
+TubeMQ provides command line tools to manage topics, produce and consume
messages, and manage consumer groups.
+The command line tool `tubectl` can be found in the `bin` directory of the
TubeMQ installation path.
+
+usage:
+```
+$ bin/tubectl [options] [command] [command options]
+```
+command:
+- `topic`
+- `message`
+- `group`
+> You can also use --help or -h to get help for the above commands, for
example:
+
+```shell
+$ bin/tubectl topic -h
+```
+
+## Topic
+`topic` is used to manage topics, including adding, deleting, modifying,
checking, etc.
+
+command:
+- `list`
+- `update`
+- `create`
+- `delete`
+
+### `list`
+```shell
+$ bin/tubectl topic list
+```
+options:
+
+| **parameter** | **type** | **description**
| **default** | **required** |
+|:----------------------------:|:--------:|:-----------------------------------------------------:|:-----------:|:------------:|
+| -t, --topic | String | Topic name
| | |
+| -sid, --topic-status-id | Int | Topic status ID
| 0 | |
+| -bid, --broker-id | String | Brokers' ID, separated
by commas | | |
+| -dp, --delete-policy | String | File aging
strategy | | |
+| -np, --num-partitions | Int | Number of
partitions | 3 | |
+| -nts, --num-topic-stores | Int | Number of topic
stores | 1 | |
+| -uft, --unflush-threshold | Int | Maximum allowed disk
unflushing message count | 1000 | |
+| -ufi, --unflush-interval | Int | Maximum allowed disk
unflushing interval | 10000 | |
+| -ufd, --unflush-dataHold | Int | Maximum allowed disk
unflushing data size | 0 | |
+| -mc, --memcache-msgcnt-ink | Int | Maximum allowed memory cache
unflushing message count | 10 | |
+| -ms, --memcache-msgsize-inmb | Int | Maximum allowed memory
cache size in MB | 2 | |
+| -mfi, --memcache-flush-intvl | Int | Maximum allowed disk
unflushing data size | 20000 | |
+| -c, --creator | String | Record creator
| | |
+| -m, --modifier | String | Record modifier
| | |
+
+### `update`
+```shell
+$ bin/tubectl topic update
+```
+options:
+
+| **parameter** | **type** | **description**
| **default** | **required** |
+|:----------------------------:|:--------:|:-----------------------------------------------------:|:-----------:|:------------:|
+| -t, --topic | String | Topic name
| | yes |
+| -bid, --broker-id | String | Brokers' ID, separated
by commas | | yes |
+| -m, --modifier | String | Record modifier
| | yes |
+| -at, --auth-token | String | Admin api operation
authorization cod | | yes |
+| -dp, --delete-policy | String | File aging
strategy | | |
+| -np, --num-partitions | Int | Number of
partitions | 3 | |
+| -uft, --unflush-threshold | Int | Maximum allowed disk
unflushing message count | 1000 | |
+| -ufi, --unflush-interval | Int | Maximum allowed disk
unflushing interval | 10000 | |
+| -ufd, --unflush-datahold | Int | Maximum allowed disk
unflushing data size | 0 | |
+| -nts, --num-topic-stores | Int | Number of topic
stores | 1 | |
+| -mc, --memcache-msgcnt-ink | Int | Maximum allowed memory cache
unflushing message count | 10 | |
+| -ms, --memcache-msgsize-inmb | Int | Maximum allowed memory
cache size in MB | 2 | |
+| -mfi, --memcache-flush-intvl | Int | Maximum allowed disk
unflushing data size | 20000 | |
+| -ap, --accept-publish | Boolean | Enable
publishing | true | |
+| -as, --accept-subscribe | Boolean | Enable
subscription | true | |
+| -mms, --max-msgsize-inmb | Int | Maximum allowed message
length, unit MB | 1 | |
+| -md, --modify-date | String | Record modification
date | |
+
+### `create`
+```shell
+$ bin/tubectl topic create
+```
+options:
+
+| **parameter** | **type** | **description**
| **default** | **required** |
+|:----------------------------:|:--------:|:-----------------------------------------------------:|:-----------:|:------------:|
+| -t, --topic | String | Topic name
| | yes |
+| -bid, --broker-id | String | Brokers' ID, separated
by commas | | yes |
+| -c, --creator | String | Record creator
| | yes |
+| -at, --auth-token | String | Admin api operation
authorization cod | | yes |
+| -dp, --delete-policy | String | File aging
strategy | | |
+| -np, --num-partitions | Int | Number of
partitions | -1 | |
+| -uft, --unflush-threshold | Int | Maximum allowed disk
unflushing message count | -1 | |
+| -ufi, --unflush-interval | Int | Maximum allowed disk
unflushing interval | -1 | |
+| -ufd, --unflush-datahold | Int | Maximum allowed disk
unflushing data size | 0 | |
+| -nts, --num-topic-stores | Int | Number of topic
stores | 1 | |
+| -mc, --memcache-msgcnt-ink | Int | Maximum allowed memory cache
unflushing message count | 10 | |
+| -ms, --memcache-msgsize-inmb | Int | Maximum allowed memory
cache size in MB | 2 | |
+| -mfi, --memcache-flush-intvl | Int | Maximum allowed disk
unflushing data size | 20000 | |
+| -ap, --accept-publish | Boolean | Enable
publishing | true | |
+| -as, --accept-subscribe | Boolean | Enable
subscription | true | |
+| -mms, --max-msgsize-inmb | Int | Maximum allowed message
length, unit MB | 1 | |
+| -cd, --create-date | String | Record creation
date | | |
+
+### `delete`
+```shell
+$ bin/tubectl topic delete
+```
+options:
+
+| **parameter** | **type** | **description**
| **default** | **required** |
+|:------------------:|:--------:|:------------------------------------------------------:|:-----------:|:------------:|
+| -o, --delete-opt | String | Delete option, optional values: `soft`,
`redo`,`hard` | `soft` | |
+| -t, --topic | String | Topic name
| | yes |
+| -bid, --broker-id | String | Brokers' ID, separated by commas
| | yes |
+| -m, --modifier | String | Record modifier
| | yes |
+| -at, --auth-token | String | Admin api operation authorization
code | | yes |
+| -md, --modify-date | String | Record modification date
| | |
+
+<details>
+<summary>delete option type</summary>
+
+| delete options type | description |
+|:-------------------:|:-------------------------------:|
+| `soft` | soft deletion |
+| `redo` | rollback a previous soft delete |
+| `hard` | hard deletion |
+
+</details>
+
+## Message
+`message` is used to produce and consume messages.
+
+command:
+
+- `produce`
+- `consume`
+
+### `produce`
+```shell
+$ bin/tubectl message produce
+```
+options:
+
+| **parameter** | **type** |
**description** | **default** | **required** |
+|:---------------------:|:--------:|:-------------------------------------------------------------------------------:|:-----------:|:------------:|
+| -t, --topic | String | Topic
name | | yes |
+| -ms, --master-servers | String | The master address to connect to. Format
is master1_ip:port\[,master2_ip:port\] | | yes |
+| -mt, --msg-total | Long | The total number of messages to
be produced, -1 means unlimited | -1 | |
+| -m, --mode | String | Produce mode, optional
values: `sync`, `async` | `async` | |
+
+<details>
+<summary>produce mode type</summary>
+
+| produce mode type | description |
+|:-----------------:|:-----------:|
+| `sync` | sync mode |
+| `async` | async mode |
+
+</details>
+
+### `consume`
+```shell
+$ bin/tubectl message consume
+```
+options:
+
+| **parameter** | **type** |
**description**
| **default** | **required** |
+|:-------------------------:|:--------:|:---------------------------------------------------------------------------------------------------------------------------------:|:-----------:|:------------:|
+| -t, --topic | String |
Topic name
| | yes |
+| -g, --group | String |
Consumer group
| | yes |
+| -ms, --master-servers | String | The master
address to connect to. Format is master1_ip:port\[,master2_ip:port\]
| | yes |
+| -p, --position | String |
Consume position, optional values: `first`, `latest`, `max`
| `first` | |
+| -po, --partitions-offsets | String | Assign consume partition ids
and their offsets. Format is id1:offset1\[,id2:offset2\], for example:
0:0,1:0,2:0 | | |
+| -m, --mode | String | Consume mode, optional values:
`pull`, `push`, `balance`. When the -po parameter is specified, `balance` mode
is used by default. | `pull` | |
+
+<details>
+<summary>consume position type</summary>
+
+| consume position | description
|
+|:----------------:|:----------------------------------------------------------------------------------------------:|
+| `first` | Start from 0 for the first time. Otherwise start
from last consume position. |
+| `latest` | Start from the latest position for the first time.
Otherwise start from last consume position. |
+| `max` | Always start from the max
consume position. |
+
+</details>
+
+<details>
+<summary>consume mode type</summary>
+
+| consume mode | description |
+|:------------:|:-------------------:|
+| `pull` | pull mode |
+| `push` | push mode |
+| `balance` | client balance mode |
+
+</details>
+
+## Group
+`group` is used for consumer group management. It currently supports query,
addition, and deletion.
+
+command：
+
+- `list`
+- `create`
+- `delete`
+
+### `list`
+```shell
+$ bin/tubectl group list
+```
+options:
+
+| **parameter** | **type** | **description** | **default** | **required** |
+|:-------------:|:--------:|:---------------:|:-----------:|:------------:|
+| -t, --topic | String | Topic name | | |
+| -g, --group | String | Consumer group | | |
+| -c, --creator | String | Record creator | | |
+
+### `create`
+```shell
+$ bin/tubectl group create
+```
+options:
+
+| **parameter** | **type** | **description** |
**default** | **required** |
+|:------------------:|:--------:|:--------------------------------------:|:-----------:|:------------:|
+| -t, --topic | String | Topic name |
| yes |
+| -g, --group | String | Consumer group |
| yes |
+| -at, --auth-token | String | Admin api operation authorization code |
| yes |
+| c, --creator | String | Record creator |
| yes |
+| -cd, --create-date | String | Record creation date |
| |
+
+### `delete`
+```shell
+$ bin/tubectl group delete
+```
+options:
+
+| **parameter** | **type** | **description** |
**default** | **required** |
+|:-----------------:|:--------:|:--------------------------------------:|:-----------:|:------------:|
+| -t, --topic | String | Topic name |
| yes |
+| -at, --auth-token | String | Admin api operation authorization code |
| yes |
+| -m, --modifier | String | Record modifier |
| yes |
+| -g, --group | String | Consumer group |
| |
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/commandline_tools.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/commandline_tools.md
new file mode 100644
index 0000000000..78d30ff946
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/commandline_tools.md
@@ -0,0 +1,248 @@
+---
+title: 命令行工具
+sidebar_position: 15
+---
+
+## 总览
+TubeMQ 提供命令行工具来管理主题，生产和消费消息，以及管理消费者组。
+命令行工具 `tubectl` 可以在 TubeMQ 安装路径的 `bin` 目录下找到。
+
+用法
+```
+$ bin/tubectl [options] [command] [command options]
+```
+命令：
+
+- `topic`
+- `message`
+- `group`
+
+> 同时也可以使用 `--help` 或者 `-h` 获取上述命令的帮助，例如：
+
+```shell
+$ bin/tubectl topic -h
+```
+
+## Topic
+`topic` 命令用于管理主题，包括增删改查等。
+
+命令：
+- `list`
+- `update`
+- `create`
+- `delete`
+
+### `list`
+```shell
+$ bin/tubectl topic list
+```
+选项：
+
+| **参数** | **类型** | **描述** |
**默认值** | **必需** |
+|:----------------------------:|:------:|:-------------------------------:|:-------:|:------:|
+| -t, --topic | String | topic 名称 |
| |
+| -sid, --topic-status-id | Int | topic 记录状态 |
0 | |
+| -bid, --broker-id | String | broker 的 ID，多个 broker 之间以英文逗号间隔 |
| |
+| -dp, --delete-policy | String | topic 数据删除策略，类似 "delete,168" 定义 |
| |
+| -np, --num-partitions | Int | topic 在该 broker 上的分区量 |
3 | |
+| -nts, --num-topic-stores | Int | 允许建立 topic 数据块和分区管理组的个数 |
1 | |
+| -uft, --unflush-threshold | Int | 最大允许的待刷新的记录条数 |
1000 | |
+| -ufi, --unflush-interval | Int | 最大允许的待刷新的间隔 |
10000 | |
+| -ufd, --unflush-dataHold | Int | 缺省最大允许的待刷新数据大小 |
0 | |
+| -mc, --memcache-msgcnt-ink | Int | 缺省最大内存缓存包量 |
10 | |
+| -ms, --memcache-msgsize-inmb | Int | 缺省内存缓存包总的 size 大小 |
2 | |
+| -mfi, --memcache-flush-intvl | Int | 内存缓存最大允许的待刷新间隔 |
20000 | |
+| -c, --creator | String | topic 创建者 |
| |
+| -m, --modifier | String | topic 修改者 |
| |
+
+### `update`
+```shell
+$ bin/tubectl topic update
+```
+选项：
+
+| **参数** | **类型** | **描述** |
**默认值** | **必需** |
+|:----------------------------:|:-------:|:-------------------------------:|:-------:|:------:|
+| -t, --topic | String | topic 名称 |
| 是 |
+| -bid, --broker-id | String | broker 的 ID，多个 broker 之间以英文逗号间隔 |
| 是 |
+| -m, --modifier | String | topic 修改者 |
| 是 |
+| -at, --auth-token | String | 配置修改授权 key |
| 是 |
+| -dp, --delete-policy | String | topic 数据删除策略，类似 "delete,168" 定义 |
| |
+| -np, --num-partitions | Int | topic 在该 broker 上的分区量 |
3 | |
+| -uft, --unflush-threshold | Int | 最大允许的待刷新的记录条数 |
1000 | |
+| -ufi, --unflush-interval | Int | 最大允许的待刷新的间隔 |
10000 | |
+| -ufd, --unflush-datahold | Int | 缺省最大允许的待刷新数据大小 |
0 | |
+| -nts, --num-topic-stores | Int | 允许建立 topic 数据块和分区管理组的个数 |
1 | |
+| -mc, --memcache-msgcnt-ink | Int | 缺省最大内存缓存包量 |
10 | |
+| -ms, --memcache-msgsize-inmb | Int | 缺省内存缓存包总的 size 大小 |
2 | |
+| -mfi, --memcache-flush-intvl | Int | 内存缓存最大允许的待刷新间隔 |
20000 | |
+| -ap, --accept-publish | Boolean | topic 是否接收发布请求 |
true | |
+| -as, --accept-subscribe | Boolean | topic 是否接收订阅请求 |
true | |
+| -mms, --max-msgsize-inmb | Int | 最大消息包长设置 |
1 | |
+| -md, --modify-date | String | 修改时间 |
| |
+
+### `create`
+```shell
+$ bin/tubectl create
+```
+选项：
+
+| **参数** | **类型** | **描述** |
**默认值** | **必需** |
+|:----------------------------:|:-------:|:-------------------------------:|:-------:|:------:|
+| -t, --topic | String | topic 名称 |
| 是 |
+| -bid, --broker-id | String | broker 的 ID，多个 broker 之间以英文逗号间隔 |
| 是 |
+| -c, --creator | String | topic 创建者 |
| 是 |
+| -at, --auth-token | String | 配置修改授权 key |
| 是 |
+| -dp, --delete-policy | String | topic 数据删除策略，类似 "delete,168" 定义 |
| |
+| -np, --num-partitions | Int | topic 在该 broker 上的分区量 |
-1 | |
+| -uft, --unflush-threshold | Int | 最大允许的待刷新的记录条数 |
-1 | |
+| -ufi, --unflush-interval | Int | 最大允许的待刷新的间隔 |
-1 | |
+| -ufd, --unflush-datahold | Int | 缺省最大允许的待刷新数据大小 |
0 | |
+| -nts, --num-topic-stores | Int | 允许建立 topic 数据块和分区管理组的个数 |
1 | |
+| -mc, --memcache-msgcnt-ink | Int | 缺省最大内存缓存包量 |
10 | |
+| -ms, --memcache-msgsize-inmb | Int | 缺省内存缓存包总的 size 大小 |
2 | |
+| -mfi, --memcache-flush-intvl | Int | 内存缓存最大允许的待刷新间隔 |
20000 | |
+| -ap, --accept-publish | Boolean | topic 是否接收发布请求 |
true | |
+| -as, --accept-subscribe | Boolean | topic 是否接收订阅请求 |
true | |
+| -mms, --max-msgsize-inmb | Int | 最大消息包长设置 |
1 | |
+| -cd, --create-date | String | 创建时间 |
| |
+
+### `delete`
+```shell
+$ bin/tubectl topic delete
+```
+选项：
+
+| **参数** | **类型** | **描述** | **默认值** |
**必需** |
+|:------------------:|:------:|:-------------------------------:|:-------:|:------:|
+| -o, --delete-opt | String | 删除选项，可选值：`soft`，`redo`，`hard` | `soft` |
|
+| -t, --topic | String | topic 名称 | |
是 |
+| -bid, --broker-id | String | broker 的 ID，多个 broker 之间以英文逗号间隔 | |
是 |
+| -m, --modifier | String | topic 修改者 | |
是 |
+| -at, --auth-token | String | 配置修改授权 key | |
是 |
+| -md, --modify-date | String | 修改时间 | |
|
+
+<details>
+<summary>删除选项说明</summary>
+
+| 删除选项 | 描述 |
+|:------:|:--------:|
+| `soft` | 软删除 |
+| `redo` | 回滚之前的软删除 |
+| `hard` | 硬删除 |
+
+</details>
+
+## Message
+`message` 命令用于生产和消费消息。
+
+命令：
+- `produce`
+- `consume`
+
+### `produce`
+```shell
+$ bin/tubectl message produce
+```
+选项：
+
+| **参数** | **类型** | **描述**
| **默认值** | **必需** |
+|:---------------------:|:------:|:-----------------------------------------------------:|:-------:|:------:|
+| -t, --topic | String | topic 名称
| | 是 |
+| -ms, --master-servers | String | 连接的 master 地址，格式为
master1_ip:port\[,master2_ip:port\] | | 是 |
+| -mt, --msg-total | Long | 需要生产的消息总条数，-1表示不限制
| -1 | |
+| -m, --mode | String | 生产模式，可选值：`sync`，`async`
| `async` | |
+
+<details>
+<summary>生产模式说明</summary>
+
+| 生产模式 | 描述 |
+|:-------:|:--------:|
+| `sync` | 同步模式 |
+| `async` | 异步模式 |
+
+</details>
+
+### `consume`
+```shell
+$ bin/tubectl message consume
+```
+选项：
+
+| **参数** | **类型** | **描述**
| **默认值** | **必需** |
+|:-------------------------:|:------:|:------------------------------------------------------------------:|:-------:|:------:|
+| -t, --topic | String | topic 名称
| | 是 |
+| -g, --group | String | 消费者组
| | 是 |
+| -ms, --master-servers | String | 连接的 master 地址，格式为
master1_ip:port\[,master2_ip:port\] | | 是 |
+| -p, --position | String |
消费位置，可选值：`first`，`latest`，`max` | `first` | |
+| -po, --partitions-offsets | String | 指定消费分区 ID 和 offset ，格式为
id1:offset1\[,id2:offset2\]，例如：0:0,1:0,2:0 | | |
+| -m, --mode | String | 消费模式，可选值：`pull`，`push`，`balance`；当指定了
-po 参数时，默认使用 `balance` 模式 | `pull` | |
+
+<details>
+<summary>消费位置说明</summary>
+
+| 消费位置 | 描述 |
+|:--------:|:-----------------------:|
+| `first` | 第一次消费时从0开始，否则从上次消费位置开始 |
+| `latest` | 第一次从最新的位置开始，否则从上次消费位置开始 |
+| `max` | 始终从最大消费位置开始 |
+
+</details>
+
+<details>
+<summary>消费模式说明</summary>
+
+| 消费模式 | 描述 |
+|:---------:|:---------:|
+| `pull` | pull 模式 |
+| `push` | push 模式 |
+| `balance` | 客户端分区分配模式 |
+
+</details>
+
+## Group
+`group` 命令用于消费者组管理，目前支持查询、增加和删除。
+
+命令：
+- `list`
+- `create`
+- `delete`
+
+### `list`
+```shell
+$ bin/tubectl cgroup list
+```
+选项：
+
+| **参数** | **类型** | **描述** | **默认值** | **必需** |
+|:-------------:|:------:|:--------:|:-------:|:------:|
+| -t, --topic | String | topic 名称 | | |
+| -g, --group | String | 消费者组 | | |
+| -c, --creator | String | 创建者 | | |
+
+### `create`
+```shell
+$ bin/tubectl cgroup create
+```
+选项：
+
+| **参数** | **类型** | **描述** | **默认值** | **必需** |
+|:------------------:|:------:|:----------:|:-------:|:------:|
+| -t, --topic | String | topic 名称 | | 是 |
+| -g, --group | String | 消费者组 | | 是 |
+| -at, --auth-token | String | 配置修改授权 key | | 是 |
+| c, --creator | String | 创建者 | | 是 |
+| -cd, --create-date | String | 创建时间 | | |
+
+### `delete`
+```shell
+$ bin/tubectl cgroup delete
+```
+选项：
+
+| **参数** | **类型** | **描述** | **默认值** | **必需** |
+|:-----------------:|:------:|:----------:|:-------:|:------:|
+| -t, --topic | String | topic 名称 | | 是 |
+| -at, --auth-token | String | 配置修改授权 key | | 是 |
+| -m, --modifier | String | 修改者 | | 是 |
+| -g, --group | String | 消费者组 | | |
