docs(api): make Cluster Config API part clearer

release-0.4
Yicheng Qin 2014-05-05 18:49:21 -07:00
parent 204f2d38af
commit 8b5d9cc1fb
1 changed files with 2 additions and 2 deletions

View File

@ -1200,7 +1200,7 @@ curl -L http://127.0.0.1:4001/v2/stats/store
## Cluster Config
Cluster config manages cluster properties to ensure both fault tolerance and high performance.
The configuration endpoint manages shared cluster wide properties.
### Set Cluster Config
@ -1215,7 +1215,7 @@ curl -L http://127.0.0.1:7001/v2/admin/config -XPUT -d '{"activeSize":3, "promot
}
```
`activeSize` indicates expected active peer-mode instances in the cluster.
`activeSize` is the maximum number of peers that can join the cluster and participate in the consensus protocol.
The size of cluster is controlled to be around a certain number. If it is not, it will promote standby-mode instances or demote peer-mode instances to make it happen.