Skip to content

Commit

Permalink
[INLONG-1822] Optimize the table formatting in some MD documents (apa…
Browse files Browse the repository at this point in the history
  • Loading branch information
gosonzhang committed Nov 22, 2021
1 parent 01bae78 commit 4155afc
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 92 deletions.
4 changes: 2 additions & 2 deletions docs/modules/tubemq/http_access_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ __Request__
|acceptSubscribe|no|whether the broker accept subscribe, default true| Boolean|
|modifyUser|yes|the modifier|String|
|modifyDate|yes|the modify date in format `yyyyMMddHHmmss`|String|
|confModAuthToken|yes|the authorized key for configuration update|String|
| confModAuthToken | yes | the authorized key for configuration update | String |

#### 1.2.4 `admin_query_broker_configure`

Expand Down Expand Up @@ -913,7 +913,7 @@ __Request__
|needRefresh|no|whether it needs to refresh, default false|Boolean|

More API see:
<a href="appendixfiles/http_access_api_definition_cn.xls" target="_blank">TubeMQ HTTP API</a>
<a href="appendixfiles/http_access_api_definition_cn.xls" target="_blank" download="w3logo>TubeMQ HTTP API</a>

---
<a href="#top">Back to top</a>
3 changes: 2 additions & 1 deletion docs/modules/tubemq/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ title: Quick Start
There're two components in the cluster: **Master** and **Broker**. Master and Broker
can be deployed on the same server or different servers. In this example, we setup our cluster
like this, and all services run on the same node. Zookeeper should be setup in your environment also.

| Role | TCP Port | TLS Port | Web Port | Comment |
| ---- | -------- | -------- | -------- | ------- |
| Master | 8099 | 8199 | 8080 | Meta data is stored at /stage/meta_data |
| Broker | 8123 | 8124 | 8081 | Message is stored at /stage/msg_data |
| Zookeeper | 2181 | | | Offset is stored at /tubemq |
| Zookeeper | 2181 | | | Offset is stored at /tubemq |

### 1.2 Prerequisites
- ZooKeeper Cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Master除了后端系统配置文件外,还在resources里存放了Web前端

| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
| --- | --- | --- | --- | --- |
| [master] | Master系统运行主配置单元,必填单元,值固定为&quot;[master]&quot; |
| | [master]是Master系统运行主配置单元,必填单元,值固定为&quot;[master]&quot; | | | |
| [master] | hostName || String | Master对外服务的主机地址,必填项,必须在网卡中已配置,处于启用状态,非回环且不能为127.0.0.1的IP |
| port || int | Master监听的端口,可选项,缺省值为8715 |
| webPort || int | Master Web控制台的访问端口,缺省值为8080 |
Expand All @@ -49,18 +49,14 @@ Master除了后端系统配置文件外,还在resources里存放了Web前端
| startConsumeAuthorize || boolean | 是否启用消费端消费授权认证,缺省为false |
| maxGroupBrokerConsumeRate || int | 集群Broker数与消费组里成员数的最大比值,可选项,缺省为50,50台Broker集群里允许1个消费组最少启动1个客户端消费 |
| metaDataPath || String | Metadata存储路径,可以是绝对路径、或者相对TubeMQ安装目录(&quot;$BASE_DIR&quot;)的相对路径。缺省为&quot;var/meta_data&quot; |
|
|
| [zookeeper] | Master对应的TubeMQ集群存储Offset的ZooKeeper集群相关信息,必填单元,值固定为&quot;[zookeeper]&quot; |
| | [zookeeper]是Master对应的TubeMQ集群存储Offset的ZooKeeper集群相关信息,必填单元,值固定为&quot;[zookeeper]&quot; | | | |
| [zookeeper] | zkServerAddr || String | zk服务器地址,可选配置,缺省为&quot;localhost:2181&quot; |
| zkNodeRoot || String | zk上的节点根目录路径,可选配置,缺省为&quot;/tubemq&quot; |
| zkSessionTimeoutMs || long | zk心跳超时,单位毫秒,默认30秒 |
| zkConnectionTimeoutMs || long | zk连接超时时间,单位毫秒,默认30秒 |
| zkSyncTimeMs || long | zk数据同步时间,单位毫秒,默认5秒 |
| zkCommitPeriodMs || long | Master缓存数据刷新到zk上的时间间隔,单位毫秒,默认5秒 |
|
|
| [replication] | 集群数据复制的相关配置,用于实现元数据多节点热备,必填单元,值固定为&quot;[replication]&quot; |
| | [replication]是集群数据复制的相关配置,用于实现元数据多节点热备,必填单元,值固定为&quot;[replication]&quot; | | | |
| [replication] | repGroupName || String | 集群名,所属主备Master节点值必须相同,可选字段,缺省为&quot;tubemqMasterGroup&quot; |
| repNodeName || String | 所属Master在集群中的节点名,该值各个节点必须不重复,必填字段 |
| repNodePort || int | 节点复制通讯端口,可选字段,缺省为9001 |
Expand All @@ -69,9 +65,7 @@ Master除了后端系统配置文件外,还在resources里存放了Web前端
| metaReplicaSyncPolicy || int | 数据节点同步保存方式,该字段取值范围[1,2,3],缺省为1:其中1为数据保存到磁盘,2为数据只保存到内存,3为只将数据写文件系统buffer,但不刷盘 |
| repReplicaAckPolicy || int | 节点数据同步时的应答策略,该字段取值范围为[1,2,3],缺省为1:其中1为超过1/2多数为有效,2为所有节点应答才有效;3为不需要节点应答 |
| repStatusCheckTimeoutMs || long | 节点状态检查间隔,可选字段,单位毫秒,缺省为10秒 |
|
|
| [bdbStore] | 已弃用,请在&quot;[replication]&quot;单元进行相关配置。Master所属BDB集群的相关配置,Master采用BDB进行元数据存储以及多节点热备,必填单元,值固定为&quot;[bdbStore]&quot; |
| | [bdbStore]已弃用,请在&quot;[replication]&quot;单元进行相关配置。Master所属BDB集群的相关配置,Master采用BDB进行元数据存储以及多节点热备,必填单元,值固定为&quot;[bdbStore]&quot; | | | |
| [bdbStore] | bdbRepGroupName || String | BDB集群名,所属主备Master节点值必须相同,必填字段 |
| bdbNodeName || String | 所属Master在BDB集群中的节点名,该值各个BDB节点必须不重复,必填字段 |
| bdbNodePort || int | BDB节点通讯端口,可选字段,缺省为9001 |
Expand All @@ -81,9 +75,7 @@ Master除了后端系统配置文件外,还在resources里存放了Web前端
| bdbReplicaSync || int | BDB数据节点同步保存方式,该字段取值范围[1,2,3],缺省为1:其中1为数据保存到磁盘,2为数据只保存到内存,3为只将数据写文件系统buffer,但不刷盘 |
| bdbReplicaAck || int | BDB节点数据同步时的应答策略,该字段取值范围为[1,2,3],缺省为1:其中1为超过1/2多数为有效,2为所有节点应答才有效;3为不需要节点应答 |
| bdbStatusCheckTimeoutMs || long | BDB状态检查间隔,可选字段,单位毫秒,缺省为10秒 |
|
|
| [tlsSetting] | Master采用TLS进行传输层数据加密,启用TLS时通过该配置单元提供相关的设置,可选单元,值固定为&quot;[tlsSetting]&quot; |
| | [tlsSetting]是Master采用TLS进行传输层数据加密,启用TLS时通过该配置单元提供相关的设置,可选单元,值固定为&quot;[tlsSetting]&quot; | | | |
| [tlsSetting] | tlsEnable || boolean | 是否启用TLS功能,可选配置,缺省为false |
| tlsPort || int | Master的TLS端口号,可选配置,缺省为8716 |
| tlsKeyStorePath || String | TLS的keyStore文件的绝对存储路径+keyStore文件名,在启动TLS功能时,该字段必填且不能为空 |
Expand All @@ -96,14 +88,13 @@ Master除了后端系统配置文件外,还在resources里存放了Web前端

| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
| --- | --- | --- | --- | --- |
|
| file.resource.loader.path || String | Master的Web的模板绝对路径,该部分为实际部署Master时的工程绝对路径+/resources/templates,该配置要与实际部署相吻合,配置失败会导致Master前端页面访问失败。 |
| | file.resource.loader.path || String | Master的Web的模板绝对路径,该部分为实际部署Master时的工程绝对路径+/resources/templates,该配置要与实际部署相吻合,配置失败会导致Master前端页面访问失败。 |

### 2.3 broker.ini文件中关键配置内容说明:

| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
| --- | --- | --- | --- | --- |
| [broker] | Broker系统运行主配置单元,必填单元,值固定为&quot;[broker]&quot; |
| | [broker]是Broker系统运行主配置单元,必填单元,值固定为&quot;[broker]&quot; | | | |
| [broker] | brokerId || int | 服务器唯一标志,必填字段,可设为0;设为0时系统将默认取本机IP转化为int值再取abs绝对值,避免brokerId为负数,如果使用环境的IP比较复杂存在生成的brokerId值冲突时,则需要指定brokerId值进行设置。 |
| hostName || String | Broker对外服务的主机地址,必填项,必须在网卡中已配置,处于启用状态,非回环且不能为127.0.0.1的IP |
| port || int | Broker监听的端口,可选项,缺省值为8123 |
Expand All @@ -125,20 +116,15 @@ Master除了后端系统配置文件外,还在resources里存放了Web前端
| visitName || String | 访问Master的用户名,缺省为空字符串,在visitMasterAuth为true时该值必须存在,该值必须与master.ini里的visitName字段值同 |
| visitPassword || String | 访问Master的密码,缺省为空字符串,在visitMasterAuth为true时该值必须存在,该值必须与master.ini里的visitPassword字段值同 |
| logFlushMemDurMs || long | 批量检查消息内存持久化到文件的检查周期,单位为毫秒, 缺省为10秒进行一次全量的检查及刷盘 |
|
|
|
| [zookeeper] | Broker对应的Tube MQ集群存储Offset的ZooKeeper集群相关信息,必填单元,值固定为&quot;[zookeeper]&quot; |
| | [zookeeper]是Broker对应的Tube MQ集群存储Offset的ZooKeeper集群相关信息,必填单元,值固定为&quot;[zookeeper]&quot; | | | |
| [zookeeper] | zkServerAddr || String | zk服务器地址,可选配置,缺省为&quot;localhost:2181&quot; |
| zkNodeRoot || String | zk上的节点根目录路径,可选配置,缺省为&quot;/tubemq&quot; |
| zkSessionTimeoutMs || long | zk心跳超时,单位毫秒,默认30秒 |
| zkConnectionTimeoutMs || long | zk连接超时时间,单位毫秒,默认30秒 |
| zkSyncTimeMs || long | zk数据同步时间,单位毫秒,默认5秒 |
| zkCommitPeriodMs || long | Broker缓存数据刷新到zk上的时间间隔,单位毫秒,默认5秒 |
| zkCommitFailRetries || int | Broker刷新缓存数据到Zk失败后的最大重刷次数 |
|
|
| [tlsSetting] | Master采用TLS进行传输层数据加密,启用TLS时通过该配置单元提供相关的设置,可选单元,值固定为&quot;[tlsSetting]&quot; |
| | [tlsSetting]是Master采用TLS进行传输层数据加密,启用TLS时通过该配置单元提供相关的设置,可选单元,值固定为&quot;[tlsSetting]&quot; | | | |
| [tlsSetting] | tlsEnable || boolean | 是否启用TLS功能,可选配置,缺省为false |
| tlsPort || int | Broker的TLS端口号,可选配置,缺省为8124 |
| tlsKeyStorePath || String | TLS的keyStore文件的绝对存储路径+keyStore文件名,在启动TLS功能时,该字段必填且不能为空 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,8 @@ mvn clean package -Dmaven.test.skip
| | ZooKeeper | 2181 | | | Offset储存在根目录`/tubemq` |
| 9.23.28.24 | **Master** | 8099 | 8199 | 8080 | 元数据存储在 `/stage/meta_data` |
| | Broker | 8123 | 8124 | 8081 | 消息储存在`/stage/msg_data` |
| 9.23.27.160 | Producer ||||
| | Consumer ||||
|
| 9.23.27.160 | Producer | | | | |
| | Consumer | | | | |
部署Master时需要注意:

1. 部署Master的机器,Master集群可以部署1台、2台或者3台:如果要保证高可靠建议3台(任意坏1台Master对外仍然可读写配置及接入新的生产或者消费),如果只需要保证一般情况2台(任意坏1台Master对外仍然可读配置及已接入的生产和消费不受影响),最低1台(坏1台Master对外配置不可读写及已接入的生产和消费不受影响);
Expand Down
Loading

0 comments on commit 4155afc

Please sign in to comment.