From: Zac Dover <zac.dover@gmail.com>
Date: Sat, 10 Dec 2022 04:34:46 +0000 (+1000)
Subject: doc/rados: add prompts to upmap.rst
X-Git-Tag: v17.2.6~287^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=b29547d6b1e105706cc21b5e45c3464d683dc877;p=ceph.git

doc/rados: add prompts to upmap.rst

Add unselectable prompts to doc/rados/operations/upmap.rst.

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

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

diff --git a/doc/rados/operations/upmap.rst b/doc/rados/operations/upmap.rst
index 6e7ce5f639457..343adf2c44cd4 100644
--- a/doc/rados/operations/upmap.rst
+++ b/doc/rados/operations/upmap.rst
@@ -15,20 +15,26 @@ Enabling
 --------
 
 New clusters will have this module on by default. The cluster must only
-have luminous (and newer) clients. You can the turn the balancer off with::
+have luminous (and newer) clients. You can the turn the balancer off with:
 
-  ceph balancer off
+.. prompt:: bash $
+
+   ceph balancer off
 
 To allow use of the feature on existing clusters, you must tell the
-cluster that it only needs to support luminous (and newer) clients with::
+cluster that it only needs to support luminous (and newer) clients with:
+
+.. prompt:: bash $
 
-  ceph osd set-require-min-compat-client luminous
+   ceph osd set-require-min-compat-client luminous
 
 This command will fail if any pre-luminous clients or daemons are
 connected to the monitors.  You can see what client versions are in
-use with::
+use with:
+
+.. prompt:: bash $
 
-  ceph features
+   ceph features
 
 Balancer module
 -----------------
@@ -42,15 +48,20 @@ Offline optimization
 
 Upmap entries are updated with an offline optimizer built into ``osdmaptool``.
 
-#. Grab the latest copy of your osdmap::
+#. Grab the latest copy of your osdmap:
 
-     ceph osd getmap -o om
+   .. prompt:: bash $
 
-#. Run the optimizer::
+      ceph osd getmap -o om
 
-     osdmaptool om --upmap out.txt [--upmap-pool <pool>]
-              [--upmap-max <max-optimizations>] [--upmap-deviation <max-deviation>]
-              [--upmap-active]
+#. Run the optimizer:
+
+   .. prompt:: bash $
+
+      osdmaptool om --upmap out.txt [--upmap-pool <pool>] \ 
+      [--upmap-max <max-optimizations>] \ 
+      [--upmap-deviation <max-deviation>] \ 
+      [--upmap-active]
 
    It is highly recommended that optimization be done for each pool
    individually, or for sets of similarly-utilized pools.  You can
@@ -75,9 +86,11 @@ Upmap entries are updated with an offline optimizer built into ``osdmaptool``.
    elapsed time for rounds indicates the CPU load ceph-mgr will be
    consuming when it tries to compute the next optimization plan.
 
-#. Apply the changes::
+#. Apply the changes:
+
+   .. prompt:: bash $
 
-     source out.txt
+      source out.txt
 
    The proposed changes are written to the output file ``out.txt`` in
    the example above.  These are normal ceph CLI commands that can be