From: J. Eric Ivancich <ivancich@redhat.com>
Date: Tue, 5 Oct 2021 23:27:27 +0000 (-0400)
Subject: rgw: document rgw_lc_debug_interval configuration option
X-Git-Tag: v17.1.0~632^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F43429%2Fhead;p=ceph.git

rgw: document rgw_lc_debug_interval configuration option

Updates the yaml describing this config option with a "desc" and a
"long_desc".

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
---

diff --git a/src/common/options/rgw.yaml.in b/src/common/options/rgw.yaml.in
index d7557ed5a22..8297fb81532 100644
--- a/src/common/options/rgw.yaml.in
+++ b/src/common/options/rgw.yaml.in
@@ -408,10 +408,12 @@ options:
 - name: rgw_lc_debug_interval
   type: int
   level: dev
-  desc: Lifecycle processing interval
-  long_desc: When set to greater than 0, treat this many seconds as a day.
-    This facilitates debugging and testing of lifecycle code without lengthy
-    delays.
+  desc: The number of seconds that simulate one "day" in order to debug RGW LifeCycle.
+    Do *not* modify for a production cluster.
+  long_desc: 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.
   default: -1
   services:
   - rgw