]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rados/configuration/mon-config-ref: use confval directive
authorKefu Chai <kchai@redhat.com>
Mon, 19 Apr 2021 13:56:14 +0000 (21:56 +0800)
committerKefu Chai <kchai@redhat.com>
Mon, 19 Apr 2021 14:03:45 +0000 (22:03 +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 e0904dbaae676ff8fadc85970cd9f2ee79fe7637..00cf057b0497f9abfe5b4ade03c9e4743f8c8b19 100644 (file)
@@ -513,187 +513,28 @@ Once synchronization is complete, Ceph performs trimming across the cluster.
 Trimming requires that the placement groups are ``active+clean``.
 
 
-``mon_sync_timeout``
-
-:Description: Number of seconds the monitor will wait for the next update
-              message from its sync provider before it gives up and bootstrap
-              again.
-
-:Type: Double
-:Default: ``60.0``
-
-
-``mon_sync_max_payload_size``
-
-:Description: The maximum size for a sync payload (in bytes).
-:Type: 32-bit Integer
-:Default: ``1048576``
-
-
-``paxos_max_join_drift``
-
-:Description: The maximum Paxos iterations before we must first sync the
-              monitor data stores. When a monitor finds that its peer is too
-              far ahead of it, it will first sync with data stores before moving
-              on.
-
-:Type: Integer
-:Default: ``10``
-
-
-``paxos_stash_full_interval``
-
-:Description: How often (in commits) to stash a full copy of the PaxosService state.
-              Current this setting only affects ``mds``, ``mon``, ``auth`` and ``mgr``
-              PaxosServices.
-
-:Type: Integer
-:Default: ``25``
-
-
-``paxos_propose_interval``
-
-:Description: Gather updates for this time interval before proposing 
-              a map update.
-
-:Type: Double
-:Default: ``1.0``
-
-
-``paxos_min``
-
-:Description: The minimum number of Paxos states to keep around
-:Type: Integer
-:Default: ``500``
-
-
-``paxos_min_wait``
-
-:Description: The minimum amount of time to gather updates after a period of 
-              inactivity.
-
-:Type: Double
-:Default: ``0.05``
-
-
-``paxos_trim_min``
-
-:Description: Number of extra proposals tolerated before trimming
-:Type: Integer
-:Default: ``250``
-
-
-``paxos_trim_max``
-
-:Description: The maximum number of extra proposals to trim at a time
-:Type: Integer
-:Default: ``500``
-
-
-``paxos_service_trim_min``
-
-:Description: The minimum amount of versions to trigger a trim (0 disables it)
-:Type: Integer
-:Default: ``250``
-
-
-``paxos_service_trim_max``
-
-:Description: The maximum amount of versions to trim during a single proposal (0 disables it)
-:Type: Integer
-:Default: ``500``
-
-
-``paxos service trim max multiplier``
-
-:Description: The factor by which paxos service trim max will be multiplied
-              to get a new upper bound when trim sizes are high (0 disables it)
-:Type: Integer
-:Default: ``20``
-
-
-``mon mds force trim to``
-
-:Description: Force monitor to trim mdsmaps to this point (0 disables it.
-              dangerous, use with care)
-
-:Type: Integer
-:Default: ``0``
-
-
-``mon_osd_force_trim_to``
-
-:Description: Force monitor to trim osdmaps to this point, even if there is
-              PGs not clean at the specified epoch (0 disables it. dangerous,
-              use with care)
-
-:Type: Integer
-:Default: ``0``
-
-
-``mon_osd_cache_size``
-
-:Description: The size of osdmaps cache, not to rely on underlying store's cache
-:Type: Integer
-:Default: ``500``
-
-
-``mon_election_timeout``
-
-:Description: On election proposer, maximum waiting time for all ACKs in seconds.
-:Type: Float
-:Default: ``5.00``
-
-
-``mon_lease`` 
-
-:Description: The length (in seconds) of the lease on the monitor's versions.
-:Type: Float
-:Default: ``5.00``
-
-
-``mon_lease_renew_interval_factor``
-
-:Description: ``mon_lease`` \* ``mon_lease_renew_interval_factor`` will be the
-              interval for the Leader to renew the other monitor's leases. The
-              factor should be less than ``1.0``.
-
-:Type: Float
-:Default: ``0.60``
-
-
-``mon_lease_ack_timeout_factor``
-
-:Description: The Leader will wait ``mon_lease`` \* ``mon_lease_ack_timeout_factor``
-              for the Providers to acknowledge the lease extension.
-
-:Type: Float
-:Default: ``2.00``
-
-
-``mon_accept_timeout_factor``
-
-:Description: The Leader will wait ``mon_lease`` \* ``mon_accept_timeout_factor``
-              for the Requester(s) to accept a Paxos update. It is also used
-              during the Paxos recovery phase for similar purposes.
-
-:Type: Float
-:Default: ``2.00``
-
-
-``mon_min_osdmap_epochs`` 
-
-:Description: Minimum number of OSD map epochs to keep at all times.
-:Type: 32-bit Integer
-:Default: ``500``
-
-
-``mon_max_log_epochs`` 
-
-:Description: Maximum number of Log epochs the monitor should keep.
-:Type: 32-bit Integer
-:Default: ``500``
-
+.. confval:: mon_sync_timeout
+.. confval:: mon_sync_max_payload_size
+.. confval:: paxos_max_join_drift
+.. confval:: paxos_stash_full_interval
+.. confval:: paxos_propose_interval
+.. confval:: paxos_min
+.. confval:: paxos_min_wait
+.. confval:: paxos_trim_min
+.. confval:: paxos_trim_max
+.. confval:: paxos_service_trim_min
+.. confval:: paxos_service_trim_max
+.. confval:: paxos_service_trim_max_multiplier
+.. confval:: mon_mds_force_trim_to
+.. confval:: mon_osd_force_trim_to
+.. confval:: mon_osd_cache_size
+.. confval:: mon_election_timeout
+.. confval:: mon_lease
+.. confval:: mon_lease_renew_interval_factor
+.. confval:: mon_lease_ack_timeout_factor
+.. confval:: mon_accept_timeout_factor
+.. confval:: mon_min_osdmap_epochs
+.. confval:: mon_max_log_epochs
 
 
 .. index:: Ceph Monitor; clock
index ed6c15ebbfc8f769c6163845c95a8da9767ddc13..efaf77add95143253de5bf6953f451eaefb231dd 100644 (file)
@@ -1661,6 +1661,7 @@ options:
   type: int
   level: advanced
   desc: maximum number of OSDMaps to cache in memory
+  fmt_desc: The size of osdmaps cache, not to rely on underlying store's cache
   default: 500
   services:
   - mon
@@ -1991,6 +1992,7 @@ options:
   type: float
   level: advanced
   desc: maximum time for a mon election (seconds)
+  fmt_desc: On election proposer, maximum waiting time for all ACKs in seconds.
   default: 5
   services:
   - mon
@@ -2008,6 +2010,7 @@ options:
   desc: lease interval between quorum monitors (seconds)
   long_desc: This setting controls how sensitive your mon quorum is to intermittent
     network issues or other failures.
+  fmt_desc: The length (in seconds) of the lease on the monitor's versions.
   default: 5
   services:
   - mon
@@ -2018,6 +2021,10 @@ options:
   desc: multiple of mon_lease for the lease renewal interval
   long_desc: Leases must be renewed before they time out.  A smaller value means frequent
     renewals, while a value close to 1 makes a lease expiration more likely.
+  fmt_desc: |
+    ``mon_lease`` \* ``mon_lease_renew_interval_factor`` will be the
+    interval for the Leader to renew the other monitor's leases. The
+    factor should be less than ``1.0``.
   default: 0.6
   services:
   - mon
@@ -2030,6 +2037,8 @@ options:
   type: float
   level: advanced
   desc: multiple of mon_lease for the lease ack interval before calling new election
+  fmt_desc: The Leader will wait ``mon_lease`` \* ``mon_lease_ack_timeout_factor``
+    for the Providers to acknowledge the lease extension.
   default: 2
   services:
   - mon
@@ -2043,6 +2052,9 @@ options:
   level: advanced
   desc: multiple of mon_lease for follower mons to accept proposed state changes before
     calling a new election
+  fmt_desc: The Leader will wait ``mon_lease`` \* ``mon_accept_timeout_factor``
+    for the Requester(s) to accept a Paxos update. It is also used
+    during the Paxos recovery phase for similar purposes.
   default: 2
   services:
   - mon
@@ -2518,6 +2530,7 @@ options:
   type: int
   level: advanced
   desc: min number of OSDMaps to store
+  fmt_desc: Minimum number of OSD map epochs to keep at all times.
   default: 500
   services:
   - mon
@@ -2526,6 +2539,7 @@ options:
   type: int
   level: advanced
   desc: max number of past cluster log epochs to store
+  fmt_desc: Maximum number of Log epochs the monitor should keep.
   default: 500
   services:
   - mon
@@ -2791,6 +2805,9 @@ options:
   type: float
   level: advanced
   desc: timeout before canceling sync if syncing mon does not respond
+  fmt_desc: Number of seconds the monitor will wait for the next update
+    message from its sync provider before it gives up and bootstrap
+    again.
   default: 1_min
   services:
   - mon
@@ -2799,6 +2816,7 @@ options:
   type: size
   level: advanced
   desc: target max message payload for mon sync
+  fmt_desc: The maximum size for a sync payload (in bytes).
   default: 1_M
   services:
   - mon
@@ -2866,6 +2884,9 @@ options:
   type: int
   level: dev
   desc: force mons to trim osdmaps through this epoch
+  fmt_desc: Force monitor to trim osdmaps to this point, even if there is
+    PGs not clean at the specified epoch (0 disables it. dangerous,
+    use with care)
   default: 0
   services:
   - mon
@@ -2875,6 +2896,8 @@ options:
   type: int
   level: dev
   desc: force mons to trim mdsmaps/fsmaps through this epoch
+  fmt_desc: Force monitor to trim mdsmaps to this point (0 disables it.
+    dangerous, use with care)
   default: 0
   services:
   - mon
@@ -3132,6 +3155,9 @@ options:
   default: 25
   services:
   - mon
+  fmt_desc: How often (in commits) to stash a full copy of the PaxosService state.
+    Current this setting only affects ``mds``, ``mon``, ``auth`` and ``mgr``
+    PaxosServices.
   with_legacy: true
 # max paxos iterations before we must first sync the monitor stores
 - name: paxos_max_join_drift
@@ -3140,6 +3166,10 @@ options:
   default: 10
   services:
   - mon
+  fmt_desc: The maximum Paxos iterations before we must first sync the
+    monitor data stores. When a monitor finds that its peer is too
+    far ahead of it, it will first sync with data stores before moving
+    on.
   with_legacy: true
 # gather updates for this long before proposing a map update
 - name: paxos_propose_interval
@@ -3148,6 +3178,8 @@ options:
   default: 1
   services:
   - mon
+  fmt_desc: Gather updates for this time interval before proposing
+    a map update.
   with_legacy: true
 # min time to gather updates for after period of inactivity
 - name: paxos_min_wait
@@ -3156,6 +3188,8 @@ options:
   default: 0.05
   services:
   - mon
+  fmt_desc: The minimum amount of time to gather updates after a period of
+    inactivity.
   with_legacy: true
 # minimum number of paxos states to keep around
 - name: paxos_min
@@ -3164,6 +3198,7 @@ options:
   default: 500
   services:
   - mon
+  fmt_desc: The minimum number of Paxos states to keep around
   with_legacy: true
 # number of extra proposals tolerated before trimming
 - name: paxos_trim_min
@@ -3172,6 +3207,7 @@ options:
   default: 250
   services:
   - mon
+  fmt_desc: Number of extra proposals tolerated before trimming
   with_legacy: true
 # maximum amount of versions to trim during a single proposal (0 disables it)
 - name: paxos_trim_max
@@ -3180,6 +3216,7 @@ options:
   default: 500
   services:
   - mon
+  fmt_desc: The maximum number of extra proposals to trim at a time
   with_legacy: true
 # minimum amount of versions to trigger a trim (0 disables it)
 - name: paxos_service_trim_min
@@ -3188,6 +3225,7 @@ options:
   default: 250
   services:
   - mon
+  fmt_desc: The minimum amount of versions to trigger a trim (0 disables it)
   with_legacy: true
 # maximum amount of versions to trim during a single proposal (0 disables it)
 - name: paxos_service_trim_max
@@ -3196,6 +3234,7 @@ options:
   default: 500
   services:
   - mon
+  fmt_desc: The maximum amount of versions to trim during a single proposal (0 disables it)
   with_legacy: true
 - name: paxos_service_trim_max_multiplier
   type: uint