]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
rgw: document rgw_lc_debug_interval configuration option 45453/head
authorJ. Eric Ivancich <ivancich@redhat.com>
Tue, 5 Oct 2021 23:27:27 +0000 (19:27 -0400)
committerCory Snyder <csnyder@iland.com>
Wed, 16 Mar 2022 18:07:48 +0000 (14:07 -0400)
Updates the yaml describing this config option with a "desc" and a
"long_desc".

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
(cherry picked from commit 9171d3626b5a0181456a68555d5742109abaabbc)

Conflicts:
src/common/options/rgw.yaml.in

Cherry-pick notes:
- options not defined in yaml in Pacific

src/common/options.cc

index 82db7846e7f1c06e72f14a797710f0625d720162..712a6642631fa531290f1c19f32b4bc27b4755dc 100644 (file)
@@ -6007,7 +6007,12 @@ std::vector<Option> get_rgw_options() {
 
     Option("rgw_lc_debug_interval", Option::TYPE_INT, Option::LEVEL_DEV)
     .set_default(-1)
-    .set_description(""),
+    .set_description("The number of seconds that simulate one \"day\" in order to debug RGW LifeCycle. "
+                     "Do *not* modify for a production cluster.")
+    .set_long_description("For debugging RGW LifeCycle, the number of seconds that are equivalent to "
+                          "one simulated \"day\". Values less than 1 are ignored and do not change LifeCycle behavior. "
+                          "For example, during debugging if one wanted every 10 minutes to be equivalent to one day, "
+                          "then this would be set to 600, the number of seconds in 10 minutes."),
 
     Option("rgw_mp_lock_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
     .set_default(600)