doc/rados/configuration/ceph-conf: use confval directive

for defining options

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

diff --git a/doc/rados/configuration/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst
index a88c801a7241485500fa1d838820956992b00d4e..3e25fb30bf46494db798bec27ed0bb435c679ec2 100644 (file)
--- a/doc/rados/configuration/ceph-conf.rst
+++ b/doc/rados/configuration/ceph-conf.rst
@@ -72,24 +72,20 @@ contact the monitors, authenticate, and retrieve the cluster-stored
 configuration, they may need to be stored locally on the node and set
 in a local configuration file.  These options include:
 
-  - ``mon_host``, the list of monitors for the cluster
-  - ``mon_host_override``, the list of monitors for the cluster to
-    **initially** contact when beginning a new instance of communication with the
-    Ceph cluster.  This overrides the known monitor list derived from MonMap
-    updates sent to older Ceph instances (like librados cluster handles).  It is
-    expected this option is primarily useful for debugging.
-  - ``mon_dns_srv_name`` (default: `ceph-mon`), the name of the DNS
-    SRV record to check to identify the cluster monitors via DNS
-  - ``mon_data``, ``osd_data``, ``mds_data``, ``mgr_data``, and
-    similar options that define which local directory the daemon
-    stores its data in.
-  - ``keyring``, ``keyfile``, and/or ``key``, which can be used to
-    specify the authentication credential to use to authenticate with
-    the monitor.  Note that in most cases the default keyring location
-    is in the data directory specified above.
+.. confval:: mon_host
+.. confval:: mon_host_override
+
+- :confval:`mon_dns_srv_name`
+- ``mon_data``, ``osd_data``, ``mds_data``, ``mgr_data``, and
+  similar options that define which local directory the daemon
+  stores its data in.
+- :confval:`keyring`, :confval:`keyfile`, and/or :confval:`key`, which can be used to
+  specify the authentication credential to use to authenticate with
+  the monitor.  Note that in most cases the default keyring location
+  is in the data directory specified above.
 
 In the vast majority of cases the default values of these are
-appropriate, with the exception of the ``mon_host`` option that
+appropriate, with the exception of the :confval:`mon_host` option that
 identifies the addresses of the cluster's monitors.  When DNS is used
 to identify monitors a local ceph configuration file can be avoided
 entirely.

diff --git a/src/common/options/global.yaml.in b/src/common/options/global.yaml.in
index c13b9964b8eacc99cc34bc21155efd8bc6cd5b43..29d1b36100673ca4db95606b96cccf04bb40cdf1 100644 (file)
--- a/src/common/options/global.yaml.in
+++ b/src/common/options/global.yaml.in
@@ -171,6 +171,11 @@ options:
   type: str
   level: advanced
   desc: monitor(s) to use overriding the MonMap
+  fmt_desc: the list of monitors for the cluster to
+    **initially** contact when beginning a new instance of communication with the
+    Ceph cluster.  This overrides the known monitor list derived from MonMap
+    updates sent to older Ceph instances (like librados cluster handles).  It is
+    expected this option is primarily useful for debugging.
   services:
   - common
   flags: