]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephadm: edit host-management.rst 63613/head
authorZac Dover <zac.dover@proton.me>
Fri, 30 May 2025 12:27:03 +0000 (22:27 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 30 May 2025 12:27:03 +0000 (22:27 +1000)
Make the improvements to doc/cephadm/host-management.rst that Anthony
D'Atri suggested in https://github.com/ceph/ceph/pull/62600.

Signed-off-by: Zac Dover <zac.dover@proton.me>
doc/cephadm/host-management.rst

index c4a4ea912e9c57426f2408ce60a6c9b42f18a3e4..b25c476fda6a7312f7fbda71ac5dfe0a39fa559b 100644 (file)
@@ -228,34 +228,35 @@ The following host labels have a special meaning to cephadm.  All start with ``_
 Maintenance Mode
 ================
 
-Putting a host into "maintenance mode" stops all Ceph daemons on the host. Run
-a command of the following form to put a host into maintenance mode or to take
-a host out of maintenance mode: 
+Putting a host into *maintenance mode* stops all Ceph daemons on the host.
+Run a command of the following form to put a host into maintenance mode or
+to take a host out of maintenance mode: 
 
 .. prompt:: bash #
 
    ceph orch host maintenance enter <hostname> [--force] [--yes-i-really-mean-it]
    ceph orch host maintenance exit <hostname> [--force] [--offline]
 
-* Adding the ``--force`` flag to the ``enter`` command allows the user to bypass
-  warnings (but not alerts). 
-* Adding the ``--yes-i-really-mean-it`` flag to the ``enter`` command bypasses
-  all safety checks and makes an attempt to force the host into maintenance
-  mode.
-* Adding the ``--force`` and ``--offline`` flags to the ``exit`` command cause
-  cephadm to mark hosts that are in maintenance mode and offline as no longer
-  in maintenance mode. Note that if the host comes online, the Ceph daemons on
-  the host will remain in the stopped state. The ``--force`` and ``--offline``
-  flags of the ``exit`` command are meant to be run on hosts that are in
-  maintenance mode and that are permanently offline prior to the removal of
-  those hosts from cephadm management by running the ``ceph orch host rm``
-  command.
+* Adding the ``--force`` flag to the ``enter`` command allows the user to
+  bypass warnings (but not alerts). 
+* Adding the ``--yes-i-really-mean-it`` flag to the ``enter`` command
+  bypasses all safety checks and makes an attempt to force the host into
+  maintenance mode.
+* Adding the ``--force`` and ``--offline`` flags to the ``exit`` command
+  causes cephadm to mark hosts that are in maintenance mode and offline as
+  no longer in maintenance mode. Note that if the host comes online, the
+  Ceph daemons on the host will remain in the stopped state. The ``--force``
+  and ``--offline`` flags of the ``exit`` command are meant to be run on
+  hosts that are in maintenance mode and that are permanently offline prior
+  to the removal of those hosts from cephadm management by running the
+  ``ceph orch host rm`` command.
 
 .. warning:: Using the ``--yes-i-really-mean-it`` flag to force the host to
-   enter maintenance mode can cause loss of data availability, breakdown of the
-   mon quorum due to too few running monitors, unresponsive mgr module commands
-   (such as ``ceph orch . . .`` commands), and other issues. Use this flag only
-   if you're absolutely certain that you know what you're doing.
+   enter maintenance mode can cause loss of data availability, breakdown of
+   the mon quorum due to too few running monitors, unresponsive Manager
+   module commands (such as ``ceph orch . . .`` commands), and other issues.
+   Use this flag only if you're absolutely certain that you know what you're
+   doing.
 
 See also :ref:`cephadm-fqdn`