Skip to content

Commit d1a0039

Browse files
Merge pull request ceph#63613 from zdover23/wip-doc-2025-05-30-cephadm-host-management-62600-followup
doc/cephadm: edit host-management.rst
2 parents 5923abb + ecba8ec commit d1a0039

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

doc/cephadm/host-management.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -228,34 +228,35 @@ The following host labels have a special meaning to cephadm. All start with ``_
228228
Maintenance Mode
229229
================
230230

231-
Putting a host into "maintenance mode" stops all Ceph daemons on the host. Run
232-
a command of the following form to put a host into maintenance mode or to take
233-
a host out of maintenance mode:
231+
Putting a host into *maintenance mode* stops all Ceph daemons on the host.
232+
Run a command of the following form to put a host into maintenance mode or
233+
to take a host out of maintenance mode:
234234

235235
.. prompt:: bash #
236236

237237
ceph orch host maintenance enter <hostname> [--force] [--yes-i-really-mean-it]
238238
ceph orch host maintenance exit <hostname> [--force] [--offline]
239239

240-
* Adding the ``--force`` flag to the ``enter`` command allows the user to bypass
241-
warnings (but not alerts).
242-
* Adding the ``--yes-i-really-mean-it`` flag to the ``enter`` command bypasses
243-
all safety checks and makes an attempt to force the host into maintenance
244-
mode.
245-
* Adding the ``--force`` and ``--offline`` flags to the ``exit`` command cause
246-
cephadm to mark hosts that are in maintenance mode and offline as no longer
247-
in maintenance mode. Note that if the host comes online, the Ceph daemons on
248-
the host will remain in the stopped state. The ``--force`` and ``--offline``
249-
flags of the ``exit`` command are meant to be run on hosts that are in
250-
maintenance mode and that are permanently offline prior to the removal of
251-
those hosts from cephadm management by running the ``ceph orch host rm``
252-
command.
240+
* Adding the ``--force`` flag to the ``enter`` command allows the user to
241+
bypass warnings (but not alerts).
242+
* Adding the ``--yes-i-really-mean-it`` flag to the ``enter`` command
243+
bypasses all safety checks and makes an attempt to force the host into
244+
maintenance mode.
245+
* Adding the ``--force`` and ``--offline`` flags to the ``exit`` command
246+
causes cephadm to mark hosts that are in maintenance mode and offline as
247+
no longer in maintenance mode. Note that if the host comes online, the
248+
Ceph daemons on the host will remain in the stopped state. The ``--force``
249+
and ``--offline`` flags of the ``exit`` command are meant to be run on
250+
hosts that are in maintenance mode and that are permanently offline prior
251+
to the removal of those hosts from cephadm management by running the
252+
``ceph orch host rm`` command.
253253

254254
.. warning:: Using the ``--yes-i-really-mean-it`` flag to force the host to
255-
enter maintenance mode can cause loss of data availability, breakdown of the
256-
mon quorum due to too few running monitors, unresponsive mgr module commands
257-
(such as ``ceph orch . . .`` commands), and other issues. Use this flag only
258-
if you're absolutely certain that you know what you're doing.
255+
enter maintenance mode can cause loss of data availability, breakdown of
256+
the mon quorum due to too few running monitors, unresponsive Manager
257+
module commands (such as ``ceph orch . . .`` commands), and other issues.
258+
Use this flag only if you're absolutely certain that you know what you're
259+
doing.
259260

260261
See also :ref:`cephadm-fqdn`
261262

0 commit comments

Comments
 (0)