From ecba8ecf96af4fab26cc263b80303ae3eb35bb6c Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Fri, 30 May 2025 22:27:03 +1000 Subject: [PATCH] doc/cephadm: edit host-management.rst 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 --- doc/cephadm/host-management.rst | 41 +++++++++++++++++---------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/doc/cephadm/host-management.rst b/doc/cephadm/host-management.rst index c4a4ea912e9c5..b25c476fda6a7 100644 --- a/doc/cephadm/host-management.rst +++ b/doc/cephadm/host-management.rst @@ -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 [--force] [--yes-i-really-mean-it] ceph orch host maintenance exit [--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` -- 2.39.5