From: Kefu Chai <kchai@redhat.com>
Date: Wed, 26 May 2021 04:00:57 +0000 (+0800)
Subject: doc/mgr: use confval directive to define options
X-Git-Tag: v17.1.0~1810^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=dfdcf2cf92db84ff1483ca8b6c48aeae3d6b51f2;p=ceph.git

doc/mgr: use confval directive to define options

less repeating this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/doc/mgr/administrator.rst b/doc/mgr/administrator.rst
index cfe84af14b938..422aa5da99104 100644
--- a/doc/mgr/administrator.rst
+++ b/doc/mgr/administrator.rst
@@ -47,7 +47,7 @@ active by the monitors, and the others will be standbys.  There is
 no requirement for quorum among the ceph-mgr daemons.
 
 If the active daemon fails to send a beacon to the monitors for
-more than ``mon mgr beacon grace`` (default 30s), then it will be replaced
+more than :confval:`mon_mgr_beacon_grace`, then it will be replaced
 by a standby.
 
 If you want to pre-empt failover, you can explicitly mark a ceph-mgr
@@ -77,7 +77,7 @@ information about what functionality each module provides.
 
 Here is an example of enabling the :term:`Dashboard` module:
 
-::
+.. code-block:: console
 
 	$ ceph mgr module ls
 	{
@@ -109,14 +109,14 @@ Here is an example of enabling the :term:`Dashboard` module:
 	}
 
 
-The first time the cluster starts, it uses the ``mgr_initial_modules``
+The first time the cluster starts, it uses the :confval:`mgr_initial_modules`
 setting to override which modules to enable.  However, this setting
 is ignored through the rest of the lifetime of the cluster: only
 use it for bootstrapping.  For example, before starting your
 monitor daemons for the first time, you might add a section like
 this to your ``ceph.conf``:
 
-::
+.. code-block:: ini
 
     [mon]
         mgr_initial_modules = dashboard balancer
@@ -134,29 +134,10 @@ the module.::
 Configuration
 -------------
 
-``mgr_module_path``
-
-:Description: Path to load modules from
-:Type: String
-:Default: ``"<library dir>/mgr"``
-
-``mgr_data``
-
-:Description: Path to load daemon data (such as keyring)
-:Type: String
-:Default: ``"/var/lib/ceph/mgr/$cluster-$id"``
-
-``mgr_tick_period``
-
-:Description: How many seconds between mgr beacons to monitors, and other
-              periodic checks.
-:Type: Integer
-:Default: ``5``
-
-``mon_mgr_beacon_grace``
-
-:Description: How long after last beacon should a mgr be considered failed
-:Type: Integer
-:Default: ``30``
+.. confval:: mgr_module_path
+.. confval:: mgr_initial_modules
+.. confval:: mgr_data
+.. confval:: mgr_tick_period
+.. confval:: mon_mgr_beacon_grace
 
 .. _Modifying User Capabilities: ../../rados/operations/user-management/#modify-user-capabilities
diff --git a/src/common/options/mgr.yaml.in b/src/common/options/mgr.yaml.in
index 7a68905183d38..cabd21107467b 100644
--- a/src/common/options/mgr.yaml.in
+++ b/src/common/options/mgr.yaml.in
@@ -6,6 +6,7 @@ options:
   type: str
   level: advanced
   desc: Filesystem path to the ceph-mgr data directory, used to contain keyring.
+  fmt_desc: Path to load daemon data (such as keyring)
   default: /var/lib/ceph/mgr/$cluster-$id
   services:
   - mgr
@@ -89,6 +90,7 @@ options:
   type: str
   level: advanced
   desc: Filesystem path to manager modules.
+  fmt_desc: Path to load modules from
   default: @CEPH_INSTALL_DATADIR@/mgr
   services:
   - mgr
@@ -184,6 +186,8 @@ options:
   type: secs
   level: advanced
   desc: Period in seconds of beacon messages to monitor
+  fmt_desc: How many seconds between mgr beacons to monitors, and other
+    periodic checks.
   default: 2
   services:
   - mgr