Merge pull request ceph#63422 from zdover23/wip-doc-2025-05-22-backport-63369-to-tentacle

tentacle: doc/mgr: edit diskpredictor.rst

Reviewed-by: Anthony D'Atri <[email protected]>

Author: zdover23

doc/mgr/diskprediction.rst

@@ -4,48 +4,61 @@
 Diskprediction Module
 =====================
 
-The *diskprediction* module leverages Ceph device health check to collect disk health metrics and uses internal predictor module to produce the disk failure prediction and returns back to Ceph. It doesn't require any external server for data analysis and output results. Its internal predictor's accuracy is around 70%.
+The ``diskprediction`` module leverages Ceph device health checks to collect
+disk health metrics and uses the internal predictor module to produce disk
+failure predictions and returns them back to Ceph. It requires no external
+server for data analysis and the outputting of results. Its internal
+predictor's accuracy is around 70%.
 
 Enabling
 ========
 
-Run the following command to enable the *diskprediction_local* module in the Ceph
-environment::
+Run the following command to enable the ``diskprediction_local`` module in the
+Ceph environment:
 
-    ceph mgr module enable diskprediction_local
+.. prompt:: bash #
 
+   ceph mgr module enable diskprediction_local
 
-To enable the local predictor::
 
-    ceph config set global device_failure_prediction_mode local
+Run the following command to enable the local predictor:
 
-To disable prediction::
+.. prompt:: bash #
 
-    ceph config set global device_failure_prediction_mode none
+   ceph config set global device_failure_prediction_mode local
 
+Run the following command to disable prediction:
 
-*diskprediction_local* requires at least six datasets of device health metrics to
-make prediction of the devices' life expectancy. And these health metrics are
-collected only if health monitoring is :ref:`enabled <enabling-monitoring>`.
+.. prompt:: bash #
 
-Run the following command to retrieve the life expectancy of given device.
+   ceph config set global device_failure_prediction_mode none
 
-::
 
-    ceph device predict-life-expectancy <device id>
+``diskprediction_local`` requires at least six datasets of device health
+metrics to make prediction of the devices' life expectancy. And these health
+metrics are collected only if health monitoring is :ref:`enabled
+<enabling-monitoring>`.
+
+Run the following command to retrieve the life expectancy of a given device:
+
+.. prompt:: bash #
+
+   ceph device predict-life-expectancy <device id>
 
 Configuration
 =============
 
-The module performs the prediction on a daily basis by default. You can adjust
-this interval with::
+The module performs the prediction on a daily basis by default. Adjust this
+interval by running a command of the following form:
+
+.. prompt:: bash #
 
-  ceph config set mgr mgr/diskprediction_local/predict_interval <interval-in-seconds>
+   ceph config set mgr mgr/diskprediction_local/predict_interval <interval-in-seconds>
 
 Debugging
 =========
 
-If you want to debug the DiskPrediction module mapping to Ceph logging level,
+To debug the DiskPrediction module mapping to Ceph logging level,
 use the following command.
 
 ::
@@ -54,6 +67,6 @@ use the following command.
 
         debug mgr = 20
 
-With logging set to debug for the manager the module will print out logging
-message with prefix *mgr[diskprediction]* for easy filtering.
+With logging set to ``debug`` for the Manager, the module will print logging
+messages with the prefix ``mgr[diskprediction]``. This facilitates filtering.