summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam King <adking@redhat.com>2024-10-02 22:20:15 +0200
committerAdam King <adking@redhat.com>2024-10-16 19:59:36 +0200
commit565bb1407a9502bd6054fd625f7b7c8fb28b00bf (patch)
tree47a5af8886eba2bbfbc2dc90b40a215a6637fab0
parentmgr/cephadm: add offline host handling to maintenance exit (diff)
downloadceph-565bb1407a9502bd6054fd625f7b7c8fb28b00bf.tar.xz
ceph-565bb1407a9502bd6054fd625f7b7c8fb28b00bf.zip
doc/cephadm: document new flags on maintenance exit command
Signed-off-by: Adam King <adking@redhat.com>
-rw-r--r--doc/cephadm/host-management.rst15
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/cephadm/host-management.rst b/doc/cephadm/host-management.rst
index 7b8ca2cd5ba..197647b608e 100644
--- a/doc/cephadm/host-management.rst
+++ b/doc/cephadm/host-management.rst
@@ -233,11 +233,16 @@ Place a host in and out of maintenance mode (stops all Ceph daemons on host):
.. prompt:: bash #
ceph orch host maintenance enter <hostname> [--force] [--yes-i-really-mean-it]
- ceph orch host maintenance exit <hostname>
-
-The ``--force`` flag allows the user to bypass warnings (but not alerts). The ``--yes-i-really-mean-it``
-flag bypasses all safety checks and will attempt to force the host into maintenance mode no
-matter what.
+ ceph orch host maintenance exit <hostname> [--force] [--offline]
+
+The ``--force`` flag on the ``enter`` command allows the user to bypass warnings (but not alerts).
+The ``--yes-i-really-mean-it`` flag bypasses all safety checks and will attempt to force the
+host into maintenance mode no matter what. The ``--force`` and ``--offline`` flags to the ``exit`` command
+can be used to to have cephadm mark a host that is in maintenance mode and offline as no longer
+in maintenance mode. Note in this case if the host comes online, the Ceph daemons
+on the host will remain in the stopped state. The ``--force`` and ``--offline`` flags to the ``exit``
+command are intended to be run for hosts in maintenance mode that are permanently offline
+before removing the host entirely from cephadm management using the ``ceph orch host rm`` command.
.. warning:: Using the --yes-i-really-mean-it flag to force the host to enter maintenance
mode can potentially cause loss of data availability, the mon quorum to break down due