doc/rados: add prompts to devices.rst

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

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>

diff --git a/doc/rados/operations/devices.rst b/doc/rados/operations/devices.rst
index d404c3f10e776dca9bc12a94ae993b7a039aa6ce..1b6eaebdea069194ce8a1663c5af3377f853a92a 100644 (file)
--- a/doc/rados/operations/devices.rst
+++ b/doc/rados/operations/devices.rst
@@ -1,4 +1,3 @@
-
 .. _devices:
 
 Device Management
@@ -11,19 +10,25 @@ provide tools to predict and/or automatically respond to hardware failure.
 Device tracking
 ---------------
 
-You can query which storage devices are in use with::
+You can query which storage devices are in use with:
+
+.. prompt:: bash $
+
+   ceph device ls
 
-  ceph device ls
+You can also list devices by daemon or by host:
 
-You can also list devices by daemon or by host::
+.. prompt:: bash $
 
-  ceph device ls-by-daemon <daemon>
-  ceph device ls-by-host <host>
+   ceph device ls-by-daemon <daemon>
+   ceph device ls-by-host <host>
 
 For any individual device, you can query information about its
-location and how it is being consumed with::
+location and how it is being consumed with:
 
-  ceph device info <devid>
+.. prompt:: bash $
+
+   ceph device info <devid>
 
 Identifying physical devices
 ----------------------------
@@ -34,18 +39,22 @@ failed disks easy and less error-prone.  Use the following command::
   device light on|off <devid> [ident|fault] [--force]
 
 The ``<devid>`` parameter is the device identification. You can obtain this
-information using the following command::
+information using the following command:
+
+.. prompt:: bash $
 
-  ceph device ls
+   ceph device ls
 
 The ``[ident|fault]`` parameter is used to set the kind of light to blink.
 By default, the `identification` light is used.
 
 .. note::
    This command needs the Cephadm or the Rook `orchestrator <https://docs.ceph.com/docs/master/mgr/orchestrator/#orchestrator-cli-module>`_ module enabled.
-   The orchestrator module enabled is shown by executing the following command::
+   The orchestrator module enabled is shown by executing the following command:
 
-     ceph orch status
+   .. prompt:: bash $
+
+      ceph orch status
 
 The command behind the scene to blink the drive LEDs is `lsmcli`. If you need
 to customize this command you can configure this via a Jinja2 template::
@@ -77,40 +86,54 @@ or unrecoverable read errors.  Other device types like SAS and NVMe
 implement a similar set of metrics (via slightly different standards).
 All of these can be collected by Ceph via the ``smartctl`` tool.
 
-You can enable or disable health monitoring with::
+You can enable or disable health monitoring with:
+
+.. prompt:: bash $
 
-  ceph device monitoring on
+   ceph device monitoring on
 
-or::
+or:
 
-  ceph device monitoring off
+.. prompt:: bash $
+
+   ceph device monitoring off
 
 
 Scraping
 --------
 
-If monitoring is enabled, metrics will automatically be scraped at regular intervals.  That interval can be configured with::
+If monitoring is enabled, metrics will automatically be scraped at regular intervals.  That interval can be configured with:
+
+.. prompt:: bash $
 
-  ceph config set mgr mgr/devicehealth/scrape_frequency <seconds>
+   ceph config set mgr mgr/devicehealth/scrape_frequency <seconds>
 
 The default is to scrape once every 24 hours.
 
-You can manually trigger a scrape of all devices with::
+You can manually trigger a scrape of all devices with:
+   
+.. prompt:: bash $
 
-  ceph device scrape-health-metrics
+   ceph device scrape-health-metrics
 
-A single device can be scraped with::
+A single device can be scraped with:
 
-  ceph device scrape-health-metrics <device-id>
+.. prompt:: bash $
 
-Or a single daemon's devices can be scraped with::
+   ceph device scrape-health-metrics <device-id>
 
-  ceph device scrape-daemon-health-metrics <who>
+Or a single daemon's devices can be scraped with:
+
+.. prompt:: bash $
+
+   ceph device scrape-daemon-health-metrics <who>
 
 The stored health metrics for a device can be retrieved (optionally
-for a specific timestamp) with::
+for a specific timestamp) with:
+
+.. prompt:: bash $
 
-  ceph device get-health-metrics <devid> [sample-timestamp]
+   ceph device get-health-metrics <devid> [sample-timestamp]
 
 Failure prediction
 ------------------
@@ -121,29 +144,39 @@ health metrics it collects.  There are three modes:
 * *none*: disable device failure prediction.
 * *local*: use a pre-trained prediction model from the ceph-mgr daemon
 
-The prediction mode can be configured with::
+The prediction mode can be configured with:
 
-  ceph config set global device_failure_prediction_mode <mode>
+.. prompt:: bash $
+
+   ceph config set global device_failure_prediction_mode <mode>
 
 Prediction normally runs in the background on a periodic basis, so it
 may take some time before life expectancy values are populated.  You
-can see the life expectancy of all devices in output from::
+can see the life expectancy of all devices in output from:
+
+.. prompt:: bash $
 
-  ceph device ls
+   ceph device ls
 
-You can also query the metadata for a specific device with::
+You can also query the metadata for a specific device with:
 
-  ceph device info <devid>
+.. prompt:: bash $
 
-You can explicitly force prediction of a device's life expectancy with::
+   ceph device info <devid>
 
-  ceph device predict-life-expectancy <devid>
+You can explicitly force prediction of a device's life expectancy with:
+
+.. prompt:: bash $
+
+   ceph device predict-life-expectancy <devid>
 
 If you are not using Ceph's internal device failure prediction but
 have some external source of information about device failures, you
-can inform Ceph of a device's life expectancy with::
+can inform Ceph of a device's life expectancy with:
 
-  ceph device set-life-expectancy <devid> <from> [<to>]
+.. prompt:: bash $
+
+   ceph device set-life-expectancy <devid> <from> [<to>]
 
 Life expectancies are expressed as a time interval so that
 uncertainty can be expressed in the form of a wide interval. The
@@ -156,9 +189,11 @@ The ``mgr/devicehealth/warn_threshold`` controls how soon an expected
 device failure must be before we generate a health warning.
 
 The stored life expectancy of all devices can be checked, and any
-appropriate health alerts generated, with::
+appropriate health alerts generated, with:
+
+.. prompt:: bash $
 
-  ceph device check-health
+   ceph device check-health
 
 Automatic Mitigation
 --------------------