Skip to content

Commit

Permalink
enhancement : add some configuration item description
Browse files Browse the repository at this point in the history
Signed-off-by: zhuhyc <[email protected]>
  • Loading branch information
zhuhyc authored and zhuhongyin committed Jun 9, 2020
1 parent eeb7bca commit 2c406af
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/source/admin-api/master/cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Show cluster space information by zone.
response

.. code-block:: json
{
"DataNodeStatInfo": {
"TotalGB": 1,
Expand Down
10 changes: 10 additions & 0 deletions docs/source/user-guide/master.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ ChubaoFS use **JSON** as configuration file format.
"exporterPort", "int", "The prometheus exporter port", "No"
"consulAddr", "string", "The consul register addr for prometheus exporter", "No"
"metaNodeReservedMem","string","If the metanode memory is below this value, it will be marked as read-only. Unit: byte. 1073741824 by default.", "No"
"heartbeatPort","string","Raft heartbeat port,5901 by default","No"
"replicaPort","string","Raft replica Port,5902 by default","No"
"nodeSetCap","string","the capacity of node set,18 by default","No"
"missingDataPartitionInterval","string","how much time it has not received the heartbeat of replica,the replica is considered missing ,24 hours by default","No"
"dataPartitionTimeOutSec","string","how much time it has not received the heartbeat of replica, the replica is considered not alive ,10 minutes by default","No"
"numberOfDataPartitionsToLoad","string","the maximum number of partitions to check at a time,40 by default","No"
"secondsToFreeDataPartitionAfterLoad","string","the task that release the memory occupied by loading data partition task can be start, only after secondsToFreeDataPartitionAfterLoad seconds
,300 by default","No"
"tickInterval","string","the interval of timer which check heartbeat and election timeout,500 ms by default","No"
"electionTick","string","how many times the tick timer has reset,the election is timeout,5 by default","No"


**Example:**
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/metanode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ At lease 3 meta nodes are required in respect to high availability.
"masterAddr", "string", "Addresses of master server", "Yes"
"zoneName", "string", "Specified zone. ``default`` by default.", "No"
"totalMem","string", "Max memory metadata used. The value needs to be higher than the value of *metaNodeReservedMem* in the master configuration. Unit: byte", "Yes"

"deleteBatchCount","int64","when deleting inodes, how many are deleted at a time ,500 by default","No"



Expand Down
2 changes: 1 addition & 1 deletion master/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const (
// if the data partition has not been reported within this interval (in terms of seconds), it will be considered as missing.
missingDataPartitionInterval = "missingDataPartitionInterval"
dataPartitionTimeOutSec = "dataPartitionTimeOutSec"
NumberOfDataPartitionsToLoad = "NumberOfDataPartitionsToLoad"
NumberOfDataPartitionsToLoad = "numberOfDataPartitionsToLoad"
secondsToFreeDataPartitionAfterLoad = "secondsToFreeDataPartitionAfterLoad"
nodeSetCapacity = "nodeSetCap"
cfgMetaNodeReservedMem = "metaNodeReservedMem"
Expand Down
1 change: 0 additions & 1 deletion metanode/metanode.go
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,6 @@ func (m *MetaNode) parseConfig(cfg *config.Config) (err error) {
m.raftDir = cfg.GetString(cfgRaftDir)
m.raftHeartbeatPort = cfg.GetString(cfgRaftHeartbeatPort)
m.raftReplicatePort = cfg.GetString(cfgRaftReplicaPort)
m.raftReplicatePort = cfg.GetString(cfgRaftReplicaPort)
m.zoneName = cfg.GetString(cfgZoneName)
configTotalMem, _ = strconv.ParseUint(cfg.GetString(cfgTotalMem), 10, 64)

Expand Down

0 comments on commit 2c406af

Please sign in to comment.