From: Casey Bodley <cbodley@redhat.com>
Date: Tue, 28 Jan 2020 21:35:55 +0000 (-0500)
Subject: rgw: add a config description for rgw_override_bucket_index_max_shards
X-Git-Tag: v15.1.1~171^2~5
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=fba41d6a84b6b28c0fd867c3b185a07fe967fb80;p=ceph.git

rgw: add a config description for rgw_override_bucket_index_max_shards

Signed-off-by: Casey Bodley <cbodley@redhat.com>
---

diff --git a/src/common/options.cc b/src/common/options.cc
index 4442e97ba822..8b05c691e85c 100644
--- a/src/common/options.cc
+++ b/src/common/options.cc
@@ -5391,7 +5391,10 @@ std::vector<Option> get_rgw_options() {
 
     Option("rgw_override_bucket_index_max_shards", Option::TYPE_UINT, Option::LEVEL_DEV)
     .set_default(0)
-    .set_description(""),
+    .set_description("The default number of bucket index shards for newly-created "
+        "buckets. This value overrides bucket_index_max_shards stored in the zone. "
+        "Setting this value in the zone is preferred, because it applies globally "
+        "to all radosgw daemons running in the zone."),
 
     Option("rgw_bucket_index_max_aio", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
     .set_default(128)