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/03/24 12:12:54 UTC
[incubator-inlong-website] branch master updated: [INLONG-3354][TubeMQ]Update master.ini configuration guidelines document (#317)
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/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 58e2c29 [INLONG-3354][TubeMQ]Update master.ini configuration guidelines document (#317)
58e2c29 is described below
commit 58e2c299e717d19d7b61836a528110436d54c314
Author: gosonzhang <46...@qq.com>
AuthorDate: Thu Mar 24 20:12:46 2022 +0800
[INLONG-3354][TubeMQ]Update master.ini configuration guidelines document (#317)
---
docs/modules/tubemq/configure_introduction.md | 52 ++----
.../modules/tubemq/configure_introduction.md | 197 ++++++++++-----------
2 files changed, 112 insertions(+), 137 deletions(-)
diff --git a/docs/modules/tubemq/configure_introduction.md b/docs/modules/tubemq/configure_introduction.md
index 14ed716..3e4e313 100644
--- a/docs/modules/tubemq/configure_introduction.md
+++ b/docs/modules/tubemq/configure_introduction.md
@@ -6,10 +6,10 @@ title: Configuration
The TubeMQ server includes two modules for the Master and the Broker. The Master also includes a Web front-end module for external page access (this part is stored in the resources). Considering the actual deployment, two modules are often deployed in the same machine, TubeMQ. The contents of the three parts of the two modules are packaged and delivered to the operation and maintenance; the client does not include the lib package of the server part and is delivered to the user separately.
-Master and Broker use the ini configuration file format, and the relevant configuration files are placed in the master.ini and broker.ini files in the tubemq-server-3.9.0/conf/ directory:
+Master and Broker use the ini configuration file format, and the relevant configuration files are placed in the master.ini and broker.ini files in the tubemq-server-x.y.z/conf/ directory:
-Their configuration is defined by a set of configuration units. The Master configuration consists of four mandatory units: [master], [zookeeper], [bdbStore], and optional [tlsSetting]. The Broker configuration is mandatory. Broker], [zookeeper] and optional [tlsSetting] consist of a total of 3 configuration units; in actual use, you can also combine the contents of the two configuration files into one ini file.
+Their configuration is defined by a set of configuration units. The Master configuration consists of four mandatory units: [master], required but optional in [meta_zookeeper], [meta_bdb], and optional [tlsSetting]. The Broker configuration is mandatory. Broker], [zookeeper] and optional [tlsSetting] consist of a total of 3 configuration units; in actual use, you can also combine the contents of the two configuration files into one ini file.
In addition to the back-end system configuration file, the Master also stores the Web front-end page module in the resources. The root directory velocity.properties file of the resources is the Web front-end page configuration file of the Master.
@@ -47,27 +47,28 @@ In addition to the back-end system configuration file, the Master also stores th
| startConsumeAuthenticate | no | boolean | Whether to enable consumer user authentication, the default is false |
| startConsumeAuthorize | no | boolean | Whether to enable consumer consumption authorization authentication, the default is false |
| maxGroupBrokerConsumeRate | no | int | The maximum ratio of the number of clustered brokers to the number of members in the consumer group. The default is 50. In a 50-kerrow cluster, one consumer group is allowed to start at least one client. |
-| metaDataPath | no | string | Metadata storage path. Absolute, or relative to TubeMQ base directory (`$BASE_DIR`). Optional field, default is "var/meta_data". Should be the same as "[bdbStore].bdbEnvHome" if upgrade from version prior `0.5.0`. |
-[zookeeper]
->The corresponding Tom MQ cluster of the Master stores the information about the ZooKeeper cluster of the Offset. The required unit has a fixed value of "[zookeeper]".
+[meta_zookeeper]
+>Replication configuration for metadata storage replication and multi-node hot standby between Masters. The required unit has a fixed value of "[meta_zookeeper]"，this part and [meta_bdb] can choose one.
-| Name | Required | Type | Description |
-| --------------------- | -----------------------------| ----------------------------- | ------------------------------------------------------------ |
-| zkServerAddr | no | string | Zk server address, optional configuration, defaults to "localhost:2181" |
-| zkNodeRoot | no | string | The root path of the node on zk, optional configuration. The default is "/tube". |
-| zkSessionTimeoutMs | no | long | Zk heartbeat timeout, in milliseconds, default 30 seconds |
-| zkConnectionTimeoutMs | no | long | Zk connection timeout, in milliseconds, default 30 seconds |
-| zkSyncTimeMs | no | long | Zk data synchronization time, in milliseconds, default 5 seconds |
-| zkCommitPeriodMs | no | long | The interval at which the Master cache data is flushed to zk, in milliseconds, default 5 seconds. |
+| Name | Required | Type | Description |
+| --------------------- | -----------------------------| ----------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| zkServerAddr | no | string | Zk server address, optional configuration, defaults to "localhost:2181" |
+| zkNodeRoot | no | string | The root path of the node on zk, optional configuration. The default is "/tube". |
+| zkSessionTimeoutMs | no | long | Zk heartbeat timeout, in milliseconds, default 30 seconds |
+| zkConnectionTimeoutMs | no | long | Zk connection timeout, in milliseconds, default 30 seconds |
+| zkSyncTimeMs | no | long | Zk data synchronization time, in milliseconds, default 5 seconds |
+| zkCommitPeriodMs | no | long | The interval at which the Master cache data is flushed to zk, in milliseconds, default 5 seconds. |
+| zkMasterCheckPeriodMs | no | long | The time interval for the node to check whether it is the Master role, in milliseconds, the default is 5 seconds. |
-[replication]
->Replication configuration for metadata storage replication and multi-node hot standby between Masters. The required unit has a fixed value of "[replication]".
+[meta_bdb]
+>Replication configuration for metadata storage replication and multi-node hot standby between Masters. The required unit has a fixed value of "[meta_bdb]"，this part and [meta_zookeeper] can choose one.
| Name | Required | Type | Description |
| ----------------------- | ----------------------------- | ----------------------------- | ------------------------------------------------------------ |
| repGroupName | no | string | Cluster name, the primary and backup master node values must be the same. Optional field, default is "tubemqMasterGroup". |
| repNodeName | yes | string | The name of the master node in the cluster. The value of each node MUST BE DIFFERENT. Required field. |
+| metaDataPath | no | string | Metadata storage path. Absolute, or relative to TubeMQ base directory (`$BASE_DIR`). Optional field, default is "var/meta_data". |
| repNodePort | no | int | Node communication port, optional field, default is 9001. |
| repHelperHost | no | string | Primary node when the master cluster starts, optional field, default is "127.0.0.1:9001". |
| metaLocalSyncPolicy | no | int | Replication data node local storage mode, the value range of this field is [1, 2, 3]. The default is 1: 1 is data saved to disk, 2 is data only saved to memory, and 3 is only data is written to file system buffer without flush. |
@@ -76,29 +77,12 @@ In addition to the back-end system configuration file, the Master also stores th
| repStatusCheckTimeoutMs | no | long | Replication status check interval, optional field, in milliseconds, defaults to 10 seconds. |
**Notice**:
-- Based on the need of Docker containerization, the [replication] above 3 parameters in the master.ini file are all the default settings used, and the actual information of the Master node needs to be configured when used in actual networking.
+- Based on the need of Docker containerization, the [meta_bdb] above 3 parameters in the master.ini file are all the default settings used, and the actual information of the Master node needs to be configured when used in actual networking.
- The IP information of all master nodes should be mapped to the hostName in the hosts configuration file, such as "10.10.11.205 10-10-11-205"
- It is necessary to ensure the clock synchronization between all master nodes
-[bdbStore]
->Deprecated, config in "[replication]" instead.
-
->Master configuration of the BDB cluster to which the master belongs. The master uses BDB for metadata storage and multi-node hot standby. The required unit has a fixed value of "[bdbStore]".
-
-| Name | Required | Type | Description |
-| ----------------------- | ----------------------------- | ----------------------------- | ------------------------------------------------------------ |
-| bdbRepGroupName | yes | string | BDB cluster name, the primary and backup master node values must be the same, required field |
-| bdbNodeName | yes | string | The name of the node of the master in the BDB cluster. The value of each BDB node must not be repeated. Required field. |
-| bdbNodePort | no | int | BDB node communication port, optional field, default is 9001 |
-| bdbEnvHome | yes | string | BDB data storage path, required field |
-| bdbHelperHost | yes | string | Primary node when the BDB cluster starts, required field |
-| bdbLocalSync | no | int | BDB data node local storage mode, the value range of this field is [1, 2, 3]. The default is 1: 1 is data saved to disk, 2 is data only saved to memory, and 3 is only data is written to file system buffer. But not brush |
-| bdbReplicaSync | no | int | BDB data node synchronization save mode, the value range of this field is [1, 2, 3]. The default is 1: 1 is data saved to disk, 2 is data only saved to memory, and 3 is only data is written to file system buffer. But not brush |
-| bdbReplicaAck | no | int | The response policy of the BDB node data synchronization, the value range of this field is [1, 2, 3], the default is 1: 1 is more than 1/2 majority is valid, 2 is valid for all nodes, 3 is not Need node response |
-| bdbStatusCheckTimeoutMs | no | long | BDB status check interval, optional field, in milliseconds, defaults to 10 seconds |
-
-[tlsSetting]
+- [tlsSetting]
>The Master uses TLS to encrypt the transport layer data. When TLS is enabled, the configuration unit provides related settings. The optional unit has a fixed value of "[tlsSetting]".
| Name | Required | Type | Description |
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
index dc684dc..eb7b2a3 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
@@ -6,11 +6,11 @@ title: 配置参数
TubeMQ服务端包括Master和Broker共2个模块，Master又包含供外部页面访问的Web前端模块（该部分存放在resources中），考虑到实际部署时2个模块常常部署在同1台机器中，TubeMQ将2个模块3个部分的内容打包在一起交付给运维使用；客户端则不包含服务端部分的lib包单独交付给业务使用。
-Master与Broker采用ini配置文件格式，相关配置文件分别放置在tubemq-server-3.9.0/conf/目录的master.ini和broker.ini文件中：
+Master与Broker采用ini配置文件格式，相关配置文件分别放置在tubemq-server-x.y.z/conf/目录的master.ini和broker.ini文件中：
-他们的配置是按照配置单元集合来定义的，Master配置由必选的[master]、[zookeeper]、[bdbStore]和可选的[tlsSetting]一共4个配置单元组成，Broker配置由必选的[broker]、[zookeeper]和可选的[tlsSetting]一共3个配置单元组成；实际使用时，大家也可将两个配置文件内容合并放置为一个ini文件。
+他们的配置是按照配置单元集合来定义的，Master配置由必选的[master]、可选择的必选[meta_zookeeper]、[meta_bdb]和可选的[tlsSetting]一共4个配置单元组成，Broker配置由必选的[broker]、[zookeeper]和可选的[tlsSetting]一共3个配置单元组成；实际使用时，大家也可将两个配置文件内容合并放置为一个ini文件。
Master除了后端系统配置文件外，还在resources里存放了Web前端页面模块，resources的根目录velocity.properties文件为Master的Web前端页面配置文件。
@@ -21,71 +21,62 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
### 2.1 master.ini文件中关键配置内容说明：
-| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
-| --- | --- | --- | --- | --- |
-| | [master]是Master系统运行主配置单元，必填单元，值固定为"[master]" | | | |
-| [master] | hostName | 是 | String | Master对外服务的主机地址，必填项，必须在网卡中已配置，处于启用状态，非回环且不能为127.0.0.1的IP |
-| port | 否 | int | Master监听的端口，可选项，缺省值为8715 |
-| webPort | 否 | int | Master Web控制台的访问端口，缺省值为8080 |
-| webResourcePath | 是 | String | Master Web Resource部署绝对路径，必填项，该值设置不正确时Web页面将不能正常显示 |
-| confModAuthToken | 否 | String | 通过Master的Web或API做变更操作（包括增、删、改配置，以及变更Master及管理的Broker状态）时操作者需要提供的授权Token，该值可选，缺省为"ASDFGHJKL" |
-| firstBalanceDelayAfterStartMs | 否 | long | Master启动至首次开始Rebalance的时间间隔，可选项，缺省30000毫秒 |
-| consumerBalancePeriodMs | 否 | long | Master对消费组进行Rebalance的均衡周期，可选项，缺省60000毫秒，当集群规模较大时，请调大该值 |
-| consumerHeartbeatTimeoutMs | 否 | long | 消费者心跳超时周期，可选项，缺省30000毫秒，当集群规模较大时，请调大该值 |
-| producerHeartbeatTimeoutMs | 否 | long | 生产者心跳超时周期，可选项，缺省30000毫秒，当集群规模较大时，请调大该值 |
-| brokerHeartbeatTimeoutMs | 否 | long | Broker心跳超时周期，可选项，缺省30000毫秒，当集群规模较大时，请调大该值 |
-| rebalanceParallel | 否 | int | Master Rebalance处理并行度，可选项，缺省4，取值范围[1, 20], 当集群规模较大时，请调大该值 |
-| socketRecvBuffer | 否 | long | Socket接收Buffer缓冲区SO\_RCVBUF大小,单位字节, 负数为不做设置以缺省值为准 |
-| socketSendBuffer | 否 | long | Socket发送Buffer缓冲区SO\_SNDBUF大小,单位字节, 负数为不做设置以缺省值为准 |
-| maxAutoForbiddenCnt | 否 | int | Broker出现IO故障时最大允许Master自动下线Broker个数，可选项，缺省为5，建议该值不超过集群内Broker总数的10% |
-| startOffsetResetCheck | 否 | boolean | 是否启用客户端Offset重置功能的检查功能，可选项，缺省为false |
-| needBrokerVisitAuth | 否 | boolean | 是否启用Broker访问鉴权，缺省为false，如果为true，则Broker上报的消息里必须携带正确的用户名及签名信息 |
-| visitName | 否 | String | Broker访问鉴权的用户名，缺省为空字符串，在needBrokerVisitAuth为true时该值必须存在，该值必须与broker.ini里的visitName字段值同 |
-| visitPassword | 否 | String | Broker访问鉴权的密码，缺省为空字符串，在needBrokerVisitAuth为true时该值必须存在，该值必须与broker.ini里的visitPassword字段值同 |
-| startVisitTokenCheck | 否 | boolean | 是否启用客户端visitToken检查，缺省为false |
-| startProduceAuthenticate | 否 | boolean | 是否启用生产端用户认证，缺省为false |
-| startProduceAuthorize | 否 | boolean | 是否启用生产端生产授权认证，缺省为false |
-| startConsumeAuthenticate | 否 | boolean | 是否启用消费端用户认证，缺省为false |
-| startConsumeAuthorize | 否 | boolean | 是否启用消费端消费授权认证，缺省为false |
-| maxGroupBrokerConsumeRate | 否 | int | 集群Broker数与消费组里成员数的最大比值，可选项，缺省为50，50台Broker集群里允许1个消费组最少启动1个客户端消费 |
-| metaDataPath | 否 | String | Metadata存储路径，可以是绝对路径、或者相对TubeMQ安装目录（"$BASE_DIR"）的相对路径。缺省为"var/meta_data" |
-| | [zookeeper]是Master对应的TubeMQ集群存储Offset的ZooKeeper集群相关信息，必填单元，值固定为"[zookeeper]" | | | |
-| [zookeeper] | zkServerAddr | 否 | String | zk服务器地址，可选配置，缺省为"localhost:2181" |
-| zkNodeRoot | 否 | String | zk上的节点根目录路径，可选配置，缺省为"/tubemq" |
-| zkSessionTimeoutMs | 否 | long | zk心跳超时，单位毫秒，默认30秒 |
-| zkConnectionTimeoutMs | 否 | long | zk连接超时时间，单位毫秒，默认30秒 |
-| zkSyncTimeMs | 否 | long | zk数据同步时间，单位毫秒，默认5秒 |
-| zkCommitPeriodMs | 否 | long | Master缓存数据刷新到zk上的时间间隔，单位毫秒，默认5秒 |
-| | [replication]是集群数据复制的相关配置，用于实现元数据多节点热备，必填单元，值固定为"[replication]" | | | |
-| [replication] | repGroupName | 否 | String | 集群名，所属主备Master节点值必须相同，可选字段，缺省为"tubemqMasterGroup" |
-| repNodeName | 是 | String | 所属Master在集群中的节点名，该值各个节点必须不重复，必填字段 |
-| repNodePort | 否 | int | 节点复制通讯端口，可选字段，缺省为9001 |
-| repHelperHost | 否 | String | 集群启动时的主节点，可选字段，缺省为"127.0.0.1:9001" |
-| metaLocalSyncPolicy | 否 | int | 数据节点本地保存方式，该字段取值范围[1，2，3]，缺省为1：其中1为数据保存到磁盘，2为数据只保存到内存，3为只将数据写文件系统buffer，但不刷盘 |
-| 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]已弃用，请在"[replication]"单元进行相关配置。Master所属BDB集群的相关配置，Master采用BDB进行元数据存储以及多节点热备，必填单元，值固定为"[bdbStore]" | | | |
-| [bdbStore] | bdbRepGroupName | 是 | String | BDB集群名，所属主备Master节点值必须相同，必填字段 |
-| bdbNodeName | 是 | String | 所属Master在BDB集群中的节点名，该值各个BDB节点必须不重复，必填字段 |
-| bdbNodePort | 否 | int | BDB节点通讯端口，可选字段，缺省为9001 |
-| bdbEnvHome | 是 | String | BDB数据存储路径，必填字段 |
-| bdbHelperHost | 是 | String | BDB集群启动时的主节点，必填字段 |
-| bdbLocalSync | 否 | int | BDB数据节点本地保存方式，该字段取值范围[1，2，3]，缺省为1：其中1为数据保存到磁盘，2为数据只保存到内存，3为只将数据写文件系统buffer，但不刷盘 |
-| 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时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]" | | | |
-| [tlsSetting] | tlsEnable | 否 | boolean | 是否启用TLS功能，可选配置，缺省为false |
-| tlsPort | 否 | int | Master的TLS端口号，可选配置，缺省为8716 |
-| tlsKeyStorePath | 否 | String | TLS的keyStore文件的绝对存储路径+keyStore文件名，在启动TLS功能时，该字段必填且不能为空 |
-| tlsKeyStorePassword | 否 | String | TLS的keyStorePassword文件的绝对存储路径+keyStorePassword文件名，在启动TLS功能时，该字段必填且不能为空 |
-| tlsTwoWayAuthEnable | 否 | boolean | 是否启用TLS双向认证功能，可选配置，缺省为false |
-| tlsTrustStorePath | 否 | String | TLS的TrustStore文件的绝对存储路径+TrustStore文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
-| tlsTrustStorePassword | 否 | String | TLS的TrustStorePassword文件的绝对存储路径+TrustStorePassword文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
+| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
+| --- |-----| --- | --- |---------------------------------------------------------|
+| [master] | | 是 | 配置单元 | [master]是Master系统运行主配置单元，必填单元，值固定为"[master]" |
+| | hostName | 是 | String | Master对外服务的主机地址，必填项，必须在网卡中已配置，处于启用状态，非回环且不能为127.0.0.1的IP |
+| | port | 否 | int | Master监听的端口，可选项，缺省值为8715 |
+| | webPort | 否 | int | Master Web控制台的访问端口，缺省值为8080 |
+| | webResourcePath | 是 | String | Master Web Resource部署绝对路径，必填项，该值设置不正确时Web页面将不能正常显示 |
+| | confModAuthToken | 否 | String | 通过Master的Web或API做变更操作（包括增、删、改配置，以及变更Master及管理的Broker状态）时操作者需要提供的授权Token，该值可选，缺省为"ASDFGHJKL" |
+| | firstBalanceDelayAfterStartMs | 否 | long | Master启动至首次开始Rebalance的时间间隔，可选项，缺省30000毫秒 |
+| | consumerBalancePeriodMs | 否 | long | Master对消费组进行Rebalance的均衡周期，可选项，缺省60000毫秒，当集群规模较大时，请调大该值 |
+| | consumerHeartbeatTimeoutMs | 否 | long | 消费者心跳超时周期，可选项，缺省30000毫秒，当集群规模较大时，请调大该值 |
+| | producerHeartbeatTimeoutMs | 否 | long | 生产者心跳超时周期，可选项，缺省30000毫秒，当集群规模较大时，请调大该值 |
+| | brokerHeartbeatTimeoutMs | 否 | long | Broker心跳超时周期，可选项，缺省30000毫秒，当集群规模较大时，请调大该值 |
+| | rebalanceParallel | 否 | int | Master Rebalance处理并行度，可选项，缺省4，取值范围[1, 20], 当集群规模较大时，请调大该值 |
+| | socketRecvBuffer | 否 | long | Socket接收Buffer缓冲区SO\_RCVBUF大小,单位字节, 负数为不做设置以缺省值为准 |
+| | socketSendBuffer | 否 | long | Socket发送Buffer缓冲区SO\_SNDBUF大小,单位字节, 负数为不做设置以缺省值为准 |
+| | maxAutoForbiddenCnt | 否 | int | Broker出现IO故障时最大允许Master自动下线Broker个数，可选项，缺省为5，建议该值不超过集群内Broker总数的10% |
+| | startOffsetResetCheck | 否 | boolean | 是否启用客户端Offset重置功能的检查功能，可选项，缺省为false |
+| | needBrokerVisitAuth | 否 | boolean | 是否启用Broker访问鉴权，缺省为false，如果为true，则Broker上报的消息里必须携带正确的用户名及签名信息 |
+| | visitName | 否 | String | Broker访问鉴权的用户名，缺省为空字符串，在needBrokerVisitAuth为true时该值必须存在，该值必须与broker.ini里的visitName字段值同 |
+| | visitPassword | 否 | String | Broker访问鉴权的密码，缺省为空字符串，在needBrokerVisitAuth为true时该值必须存在，该值必须与broker.ini里的visitPassword字段值同 |
+| | startVisitTokenCheck | 否 | boolean | 是否启用客户端visitToken检查，缺省为false |
+| | startProduceAuthenticate | 否 | boolean | 是否启用生产端用户认证，缺省为false |
+| | startProduceAuthorize | 否 | boolean | 是否启用生产端生产授权认证，缺省为false |
+| | startConsumeAuthenticate | 否 | boolean | 是否启用消费端用户认证，缺省为false |
+| | startConsumeAuthorize | 否 | boolean | 是否启用消费端消费授权认证，缺省为false |
+| | maxGroupBrokerConsumeRate | 否 | int | 集群Broker数与消费组里成员数的最大比值，可选项，缺省为50，50台Broker集群里允许1个消费组最少启动1个客户端消费 |
+| [meta_zookeeper] | | 条件 | 配置单元 | 元数据存储到ZooKeeper时的配置单元，[meta_bdb]与[meta_zookeeper]二选一 |
+| | zkServerAddr | 否 | String | zk服务器地址，可选配置，缺省为"localhost:2181" |
+| | zkNodeRoot | 否 | String | zk上的节点根目录路径，可选配置，缺省为"/tubemq" |
+| | zkSessionTimeoutMs | 否 | long | zk心跳超时，单位毫秒，默认30秒 |
+| | zkConnectionTimeoutMs | 否 | long | zk连接超时时间，单位毫秒，默认30秒 |
+| | zkSyncTimeMs | 否 | long | zk数据同步时间，单位毫秒，默认5秒 |
+| | zkCommitPeriodMs | 否 | long | Master缓存数据刷新到zk上的时间间隔，单位毫秒，默认5秒 |
+| | zkMasterCheckPeriodMs | 否 | long | 当前节点是否为Master角色的检查周期，单位毫秒，缺省为5秒 |
+| [meta_bdb] | | 条件 | 配置单元 | 元数据存储到BDB时的配置单元，[meta_bdb]与[meta_zookeeper]二选一 |
+| | repGroupName | 否 | String | 集群名，所属主备Master节点值必须相同，可选字段，缺省为"tubemqMasterGroup" |
+| | repNodeName | 是 | String | 所属Master在集群中的节点名，该值各个节点必须不重复，必填字段 |
+| | metaDataPath | 否 | String | Metadata存储路径，可以是绝对路径、或者相对TubeMQ安装目录（"$BASE_DIR"）的相对路径。缺省为"var/meta_data" |
+| | repNodePort | 否 | int | 节点复制通讯端口，可选字段，缺省为9001 |
+| | repHelperHost | 否 | String | 集群启动时的主节点，可选字段，缺省为"127.0.0.1:9001" |
+| | metaLocalSyncPolicy | 否 | int | 数据节点本地保存方式，该字段取值范围[1，2，3]，缺省为1：其中1为数据保存到磁盘，2为数据只保存到内存，3为只将数据写文件系统buffer，但不刷盘 |
+| | metaReplicaSyncPolicy | 否 | int | 数据节点同步保存方式，该字段取值范围[1，2，3]，缺省为1：其中1为数据保存到磁盘，2为数据只保存到内存，3为只将数据写文件系统buffer，但不刷盘 |
+| | repReplicaAckPolicy | 否 | int | 节点数据同步时的应答策略，该字段取值范围为[1，2，3]，缺省为1：其中1为超过1/2多数为有效，2为所有节点应答才有效；3为不需要节点应答 |
+| | repStatusCheckTimeoutMs | 否 | long | 节点状态检查间隔，可选字段，单位毫秒，缺省为10秒 |
+| [tlsSetting] | | 否 | 配置单元 | [tlsSetting]是Master采用TLS进行传输层数据加密，启用TLS时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]" |
+| | tlsEnable | 否 | boolean | 是否启用TLS功能，可选配置，缺省为false |
+| | tlsPort | 否 | int | Master的TLS端口号，可选配置，缺省为8716 |
+| | tlsKeyStorePath | 否 | String | TLS的keyStore文件的绝对存储路径+keyStore文件名，在启动TLS功能时，该字段必填且不能为空 |
+| | tlsKeyStorePassword | 否 | String | TLS的keyStorePassword文件的绝对存储路径+keyStorePassword文件名，在启动TLS功能时，该字段必填且不能为空 |
+| | tlsTwoWayAuthEnable | 否 | boolean | 是否启用TLS双向认证功能，可选配置，缺省为false |
+| | tlsTrustStorePath | 否 | String | TLS的TrustStore文件的绝对存储路径+TrustStore文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
+| | tlsTrustStorePassword | 否 | String | TLS的TrustStorePassword文件的绝对存储路径+TrustStorePassword文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
**注意**：
-- 基于Docker容器化的需要，master.ini文件里对[replication]如上3个参数部分都是使用的缺省设置，在实际组网使用时需要以Master节点真实信息配置
+- 基于Docker容器化的需要，master.ini文件里对[meta_bdb]如上3个参数部分都是使用的缺省设置，在实际组网使用时需要以Master节点真实信息配置
- Master所有节点的IP信息要在hosts配置文件里构造IP与hostName映射关系，如类似“10.10.11.205 10-10-11-205”
- 需保证Master所有节点之间的时钟同步
@@ -100,44 +91,44 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
| --- | --- | --- | --- | --- |
-| | [broker]是Broker系统运行主配置单元，必填单元，值固定为"[broker]" | | | |
-| [broker] | brokerId | 是 | int | 服务器唯一标志，必填字段，可设为0；设为0时系统将默认取本机IP转化为int值再取abs绝对值，避免brokerId为负数，如果使用环境的IP比较复杂存在生成的brokerId值冲突时，则需要指定brokerId值进行设置。 |
-| hostName | 是 | String | Broker对外服务的主机地址，必填项，必须在网卡中已配置，处于启用状态，非回环且不能为127.0.0.1的IP |
-| port | 否 | int | Broker监听的端口，可选项，缺省值为8123 |
-| webPort | 否 | int | Broker的http管理访问端口,可选项,缺省为8081 |
-| masterAddressList | 是 | String | Broker所属集群的Master地址列表，必填字段，格式必须是ip1:port1,ip2:port2,ip3:port3 |
-| primaryPath | 是 | String | Broker存储消息的绝对路径，必选字段 |
-| maxSegmentSize | 否 | int | Broker存储消息Data内容的文件大小，可选字段，缺省512M，最大1G |
-| maxIndexSegmentSize | 否 | int | Broker存储消息Index内容的文件大小，可选字段，缺省18M，约70W条消息每文件 |
-| transferSize | 否 | int | Broker允许每次传输给客户端的最大消息内容大小，可选字段，缺省为512K |
-| consumerRegTimeoutMs | 否 | long | consumer心跳超时时间，可选项，单位毫秒，默认30秒 |
-| socketRecvBuffer | 否 | long | Socket接收Buffer缓冲区SO\_RCVBUF大小,单位字节,负数为不做设置以缺省值为准 |
-| socketSendBuffer | 否 | long | Socket发送Buffer缓冲区SO\_SNDBUF大小,单位字节,负数为不做设置以缺省值为准 |
-| tcpWriteServiceThread | 否 | int | Broker支持TCP生产服务的socket worker线程数，可选字段，缺省为所在机器的2倍CPU个数 |
-| tcpReadServiceThread | 否 | int | Broker支持TCP消费服务的socket worker线程数，可选字段，缺省为所在机器的2倍CPU个数 |
-| logClearupDurationMs | 否 | long | 消息文件的老化清理周期, 单位为毫秒, 缺省为3分钟进行一次日志清理操作,最低1分钟 |
-| logFlushDiskDurMs | 否 | long | 批量检查消息持久化到文件的检查周期,单位为毫秒, 缺省为20秒进行一次全量的检查及刷盘 |
-| visitTokenCheckInValidTimeMs | 否 | long | visitToken检查时允许Broker注册后延迟检查的时长，单位ms,缺省120000，取值范围[60000，300000] |
-| visitMasterAuth | 否 | boolean | 是否启用上报Master鉴权，缺省为false，如果为true，则会在上报Master的信令里加入用户名及签名信息 |
-| 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集群相关信息，必填单元，值固定为"[zookeeper]" | | | |
-| [zookeeper] | zkServerAddr | 否 | String | zk服务器地址，可选配置，缺省为"localhost:2181" |
-| zkNodeRoot | 否 | String | zk上的节点根目录路径，可选配置，缺省为"/tubemq" |
-| 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时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]" | | | |
-| [tlsSetting] | tlsEnable | 否 | boolean | 是否启用TLS功能，可选配置，缺省为false |
-| tlsPort | 否 | int | Broker的TLS端口号，可选配置，缺省为8124 |
-| tlsKeyStorePath | 否 | String | TLS的keyStore文件的绝对存储路径+keyStore文件名，在启动TLS功能时，该字段必填且不能为空 |
-| tlsKeyStorePassword | 否 | String | TLS的keyStorePassword文件的绝对存储路径+keyStorePassword文件名，在启动TLS功能时，该字段必填且不能为空 |
-| tlsTwoWayAuthEnable | 否 | boolean | 是否启用TLS双向认证功能，可选配置，缺省为false |
-| tlsTrustStorePath | 否 | String | TLS的TrustStore文件的绝对存储路径+TrustStore文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
-| tlsTrustStorePassword | 否 | String | TLS的TrustStorePassword文件的绝对存储路径+TrustStorePassword文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
+| [broker] | | 是 | 配置单元 | [broker]是Broker系统运行主配置单元，必填单元，值固定为"[broker]" |
+| | brokerId | 是 | int | 服务器唯一标志，必填字段，可设为0；设为0时系统将默认取本机IP转化为int值再取abs绝对值，避免brokerId为负数，如果使用环境的IP比较复杂存在生成的brokerId值冲突时，则需要指定brokerId值进行设置。 |
+| | hostName | 是 | String | Broker对外服务的主机地址，必填项，必须在网卡中已配置，处于启用状态，非回环且不能为127.0.0.1的IP |
+| | port | 否 | int | Broker监听的端口，可选项，缺省值为8123 |
+| | webPort | 否 | int | Broker的http管理访问端口,可选项,缺省为8081 |
+| | masterAddressList | 是 | String | Broker所属集群的Master地址列表，必填字段，格式必须是ip1:port1,ip2:port2,ip3:port3 |
+| | primaryPath | 是 | String | Broker存储消息的绝对路径，必选字段 |
+| | maxSegmentSize | 否 | int | Broker存储消息Data内容的文件大小，可选字段，缺省512M，最大1G |
+| | maxIndexSegmentSize | 否 | int | Broker存储消息Index内容的文件大小，可选字段，缺省18M，约70W条消息每文件 |
+| | transferSize | 否 | int | Broker允许每次传输给客户端的最大消息内容大小，可选字段，缺省为512K |
+| | consumerRegTimeoutMs | 否 | long | consumer心跳超时时间，可选项，单位毫秒，默认30秒 |
+| | socketRecvBuffer | 否 | long | Socket接收Buffer缓冲区SO\_RCVBUF大小,单位字节,负数为不做设置以缺省值为准 |
+| | socketSendBuffer | 否 | long | Socket发送Buffer缓冲区SO\_SNDBUF大小,单位字节,负数为不做设置以缺省值为准 |
+| | tcpWriteServiceThread | 否 | int | Broker支持TCP生产服务的socket worker线程数，可选字段，缺省为所在机器的2倍CPU个数 |
+| | tcpReadServiceThread | 否 | int | Broker支持TCP消费服务的socket worker线程数，可选字段，缺省为所在机器的2倍CPU个数 |
+| | logClearupDurationMs | 否 | long | 消息文件的老化清理周期, 单位为毫秒, 缺省为3分钟进行一次日志清理操作,最低1分钟 |
+| | logFlushDiskDurMs | 否 | long | 批量检查消息持久化到文件的检查周期,单位为毫秒, 缺省为20秒进行一次全量的检查及刷盘 |
+| | visitTokenCheckInValidTimeMs | 否 | long | visitToken检查时允许Broker注册后延迟检查的时长，单位ms,缺省120000，取值范围[60000，300000] |
+| | visitMasterAuth | 否 | boolean | 是否启用上报Master鉴权，缺省为false，如果为true，则会在上报Master的信令里加入用户名及签名信息 |
+| | visitName | 否 | String | 访问Master的用户名，缺省为空字符串，在visitMasterAuth为true时该值必须存在，该值必须与master.ini里的visitName字段值同 |
+| | visitPassword | 否 | String | 访问Master的密码，缺省为空字符串，在visitMasterAuth为true时该值必须存在，该值必须与master.ini里的visitPassword字段值同 |
+| | logFlushMemDurMs | 否 | long | 批量检查消息内存持久化到文件的检查周期,单位为毫秒, 缺省为10秒进行一次全量的检查及刷盘 |
+| [zookeeper] | | 否 | 配置单元 | [zookeeper]是Broker对应的Tube MQ集群存储Offset的ZooKeeper集群相关信息，必填单元，值固定为"[zookeeper]" |
+| | zkServerAddr | 否 | String | zk服务器地址，可选配置，缺省为"localhost:2181" |
+| | zkNodeRoot | 否 | String | zk上的节点根目录路径，可选配置，缺省为"/tubemq" |
+| | zkSessionTimeoutMs | 否 | long | zk心跳超时，单位毫秒，默认30秒 |
+| | zkConnectionTimeoutMs | 否 | long | zk连接超时时间，单位毫秒，默认30秒 |
+| | zkSyncTimeMs | 否 | long | zk数据同步时间，单位毫秒，默认5秒 |
+| | zkCommitPeriodMs | 否 | long | Broker缓存数据刷新到zk上的时间间隔，单位毫秒，默认5秒 |
+| | zkCommitFailRetries | 否 | int | Broker刷新缓存数据到Zk失败后的最大重刷次数 |
+| [tlsSetting] | | 否 | 配置单元 | [tlsSetting]是Master采用TLS进行传输层数据加密，启用TLS时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]" |
+| | tlsEnable | 否 | boolean | 是否启用TLS功能，可选配置，缺省为false |
+| | tlsPort | 否 | int | Broker的TLS端口号，可选配置，缺省为8124 |
+| | tlsKeyStorePath | 否 | String | TLS的keyStore文件的绝对存储路径+keyStore文件名，在启动TLS功能时，该字段必填且不能为空 |
+| | tlsKeyStorePassword | 否 | String | TLS的keyStorePassword文件的绝对存储路径+keyStorePassword文件名，在启动TLS功能时，该字段必填且不能为空 |
+| | tlsTwoWayAuthEnable | 否 | boolean | 是否启用TLS双向认证功能，可选配置，缺省为false |
+| | tlsTrustStorePath | 否 | String | TLS的TrustStore文件的绝对存储路径+TrustStore文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
+| | tlsTrustStorePassword | 否 | String | TLS的TrustStorePassword文件的绝对存储路径+TrustStorePassword文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
---
<a href="#top">Back to top</a>