From: Zac Dover <zac.dover@gmail.com>
Date: Sun, 18 Dec 2022 15:29:33 +0000 (+1000)
Subject: doc/rados: add prompts to ceph-conf.rst
X-Git-Tag: v17.2.6~273^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F49492%2Fhead;p=ceph.git

doc/rados: add prompts to ceph-conf.rst

Add unselectable prompts to doc/rados/ceph-conf.rst.

https://tracker.ceph.com/issues/57108

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 874152535c5f8ca4a447b68040d62d1c34c3c24e)
---

diff --git a/doc/rados/configuration/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst
index 3e11bcc19ab05..eb617d399dbbc 100644
--- a/doc/rados/configuration/ceph-conf.rst
+++ b/doc/rados/configuration/ceph-conf.rst
@@ -486,17 +486,26 @@ The following CLI commands are used to configure the cluster:
 Help
 ====
 
-You can get help for a particular option with::
+You can get help for a particular option with:
 
-  ceph config help <option>
+.. prompt:: bash $
 
-Note that this will use the configuration schema that is compiled into the running monitors.  If you have a mixed-version cluster (e.g., during an upgrade), you might also want to query the option schema from a specific running daemon::
+   ceph config help <option>
 
-  ceph daemon <name> config help [option]
+Note that this will use the configuration schema that is compiled into the running monitors.  If you have a mixed-version cluster (e.g., during an upgrade), you might also want to query the option schema from a specific running daemon:
 
-For example,::
+.. prompt:: bash $
+
+   ceph daemon <name> config help [option]
+
+For example:
+
+.. prompt:: bash $
+
+   ceph config help log_file
+
+:: 
 
-  $ ceph config help log_file
   log_file - path to log file
     (std::string, basic)
     Default (non-daemon):
@@ -504,9 +513,14 @@ For example,::
     Can update at runtime: false
     See also: [log_to_stderr,err_to_stderr,log_to_syslog,err_to_syslog]
 
-or::
+or:
+
+.. prompt:: bash $
+
+   ceph config help log_file -f json-pretty
+
+::
 
-  $ ceph config help log_file -f json-pretty
   {
       "name": "log_file",
       "type": "std::string",
@@ -543,9 +557,11 @@ increasing/decreasing logging output, enabling/disabling debug
 settings, and even for runtime optimization.
 
 Generally speaking, configuration options can be updated in the usual
-way via the ``ceph config set`` command.  For example, do enable the debug log level on a specific OSD,::
+way via the ``ceph config set`` command.  For example, do enable the debug log level on a specific OSD:
 
-  ceph config set osd.123 debug_ms 20
+.. prompt:: bash $
+
+   ceph config set osd.123 debug_ms 20
 
 Note that if the same option is also customized in a local
 configuration file, the monitor setting will be ignored (it has a
@@ -561,28 +577,38 @@ the daemon or process restarts.
 
 Override values can be set in two ways:
 
-#. From any host, we can send a message to a daemon over the network with::
+#. From any host, we can send a message to a daemon over the network with:
+   
+   .. prompt:: bash $
 
-     ceph tell <name> config set <option> <value>
+      ceph tell <name> config set <option> <value>
 
-   For example,::
+   For example:
+   
+   .. prompt:: bash $
 
-     ceph tell osd.123 config set debug_osd 20
+      ceph tell osd.123 config set debug_osd 20
 
    The `tell` command can also accept a wildcard for the daemon
    identifier.  For example, to adjust the debug level on all OSD
-   daemons,::
+   daemons:
+   
+   .. prompt:: bash $
 
-     ceph tell osd.* config set debug_osd 20
+      ceph tell osd.* config set debug_osd 20
 
 #. From the host the process is running on, we can connect directly to
-   the process via a socket in ``/var/run/ceph`` with::
+   the process via a socket in ``/var/run/ceph`` with:
+
+   .. prompt:: bash $
 
-     ceph daemon <name> config set <option> <value>
+      ceph daemon <name> config set <option> <value>
 
-   For example,::
+   For example:
+   
+   .. prompt:: bash $
 
-     ceph daemon osd.4 config set debug_osd 20
+      ceph daemon osd.4 config set debug_osd 20
 
 Note that in the ``ceph config show`` command output these temporary
 values will be shown with a source of ``override``.
@@ -591,29 +617,41 @@ values will be shown with a source of ``override``.
 Viewing runtime settings
 ========================
 
-You can see the current options set for a running daemon with the ``ceph config show`` command.  For example,::
+You can see the current options set for a running daemon with the ``ceph config show`` command.  For example:
+
+.. prompt:: bash $
+
+   ceph config show osd.0
+
+will show you the (non-default) options for that daemon.  You can also look at a specific option with:
+
+.. prompt:: bash $
+
+   ceph config show osd.0 debug_osd
+
+or view all options (even those with default values) with:
 
-  ceph config show osd.0
+.. prompt:: bash $
 
-will show you the (non-default) options for that daemon.  You can also look at a specific option with::
+   ceph config show-with-defaults osd.0
 
-  ceph config show osd.0 debug_osd
+You can also observe settings for a running daemon by connecting to it from the local host via the admin socket.  For example:
 
-or view all options (even those with default values) with::
+.. prompt:: bash $
 
-  ceph config show-with-defaults osd.0
+   ceph daemon osd.0 config show
 
-You can also observe settings for a running daemon by connecting to it from the local host via the admin socket.  For example,::
+will dump all current settings:
 
-  ceph daemon osd.0 config show
+.. prompt:: bash $
 
-will dump all current settings,::
+   ceph daemon osd.0 config diff
 
-  ceph daemon osd.0 config diff
+will show only non-default settings (as well as where the value came from: a config file, the monitor, an override, etc.), and:
 
-will show only non-default settings (as well as where the value came from: a config file, the monitor, an override, etc.), and::
+.. prompt:: bash $
 
-  ceph daemon osd.0 config get debug_osd
+   ceph daemon osd.0 config get debug_osd
 
 will report the value of a single option.