]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rados/configuration/mon-config-ref: use confval directive
authorKefu Chai <kchai@redhat.com>
Wed, 21 Apr 2021 04:36:43 +0000 (12:36 +0800)
committerKefu Chai <kchai@redhat.com>
Wed, 21 Apr 2021 04:37:03 +0000 (12:37 +0800)
for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/rados/configuration/mon-config-ref.rst
src/common/options/global.yaml.in

index 00cf057b0497f9abfe5b4ade03c9e4743f8c8b19..ffb15c2d35c39276bb5b11cd2584b6bcfd196863 100644 (file)
@@ -568,45 +568,11 @@ the level of acceptable clock drift without compromising Paxos guarantees.
 Ceph provides the following tunable options to allow you to find 
 acceptable values.
 
-
-``mon_tick_interval`` 
-
-:Description: A monitor's tick interval in seconds. 
-:Type: 32-bit Integer
-:Default: ``5`` 
-
-
-``mon_clock_drift_allowed`` 
-
-:Description: The clock drift in seconds allowed between monitors.
-:Type: Float
-:Default: ``0.05``
-
-
-``mon_clock_drift_warn_backoff`` 
-
-:Description: Exponential backoff for clock drift warnings
-:Type: Float
-:Default: ``5.00``
-
-
-``mon_timecheck_interval``
-
-:Description: The time check interval (clock drift check) in seconds 
-              for the Leader.
-
-:Type: Float
-:Default: ``300.00``
-
-
-``mon_timecheck_skew_interval``
-
-:Description: The time check interval (clock drift check) in seconds when in
-              presence of a skew in seconds for the Leader.
-
-:Type: Float
-:Default: ``30.00``
-
+.. confval:: mon_tick_interval
+.. confval:: mon_clock_drift_allowed
+.. confval:: mon_clock_drift_warn_backoff
+.. confval:: mon_timecheck_interval
+.. confval:: mon_timecheck_skew_interval
 
 Client
 ------
index 7bd032dcd0472c65a81ffffbdbce1902d33a92fe..53c54b0970f4e4b0ed0d157b7b566dddfd26a325 100644 (file)
@@ -1753,6 +1753,7 @@ options:
   type: int
   level: advanced
   desc: interval for internal mon background checks
+  fmt_desc: A monitor's tick interval in seconds.
   default: 5
   services:
   - mon
@@ -2181,6 +2182,8 @@ options:
   type: float
   level: advanced
   desc: frequency of clock synchronization checks between monitors (seconds)
+  fmt_desc: The time check interval (clock drift check) in seconds
+    for the Leader.
   default: 5_min
   services:
   - mon
@@ -2191,6 +2194,8 @@ options:
   level: advanced
   desc: frequency of clock synchronization (re)checks between monitors while clocks
     are believed to be skewed (seconds)
+  fmt_desc: The time check interval (clock drift check) in seconds when in
+    presence of a skew in seconds for the Leader.
   default: 30
   services:
   - mon