From 204f2d38aff6e1e129dffed6433dd7d199d85457 Mon Sep 17 00:00:00 2001
From: Yicheng Qin <qycqycqycqycqyc@gmail.com>
Date: Fri, 18 Apr 2014 18:24:19 -0700
Subject: [PATCH] docs(api): add Cluster Config API

---
 Documentation/api.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/Documentation/api.md b/Documentation/api.md
index ed25b74fb..cdba9f47d 100644
--- a/Documentation/api.md
+++ b/Documentation/api.md
@@ -1197,3 +1197,39 @@ curl -L http://127.0.0.1:4001/v2/stats/store
     "watchers": 0
 }
 ```
+
+## Cluster Config
+
+Cluster config manages cluster properties to ensure both fault tolerance and high performance.
+
+### Set Cluster Config
+
+```sh
+curl -L http://127.0.0.1:7001/v2/admin/config -XPUT -d '{"activeSize":3, "promoteDelay":1800}'
+```
+
+```json
+{
+    "activeSize": 3,
+    "promoteDelay": 1800
+}
+```
+
+`activeSize` indicates expected active peer-mode instances in the cluster.
+
+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.
+
+`promoteDelay` indicates the minimum length of delay that has been observed before promotion or demotion.
+
+### Get Cluster Config
+
+```sh
+curl -L http://127.0.0.1:7001/v2/admin/config
+```
+
+```json
+{
+    "activeSize": 3,
+    "promoteDelay": 1800
+}
+```