From: Yuan Zhou <yuan.zhou@intel.com>
Date: Tue, 9 Jun 2015 14:00:56 +0000 (+0800)
Subject: doc: update rgw configuration doc on bucket index sharding feature
X-Git-Tag: v9.1.0~413^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=93d920e6fbc8d337d8d9f87a6f53fd76ab977df3;p=ceph.git

doc: update rgw configuration doc on bucket index sharding feature

Signed-off-by: Yuan Zhou <yuan.zhou@intel.com>
---

diff --git a/doc/radosgw/config-ref.rst b/doc/radosgw/config-ref.rst
index 0352969e89f0..b23f2b9d34f2 100644
--- a/doc/radosgw/config-ref.rst
+++ b/doc/radosgw/config-ref.rst
@@ -270,6 +270,17 @@ Ceph configuration file, the default value will be set automatically.
 :Default: ``1000``
 
 
+``rgw override bucket index max shards``
+
+:Description: Represents the number of shards for the bucket index object,
+              a value of zero indicates there is no sharding. It is not
+              recommended to set a value too large (e.g. thousand) as it
+              increases the cost for bucket listing.
+
+:Type: Integer
+:Default: ``0``
+
+
 ``rgw num zone opstate shards``
 
 :Description: The maximum number of shards for keeping inter-region copy