From: Sage Weil <sage@newdream.net>
Date: Tue, 23 Feb 2021 15:56:24 +0000 (-0500)
Subject: doc/man/8/ceph: document --max option
X-Git-Tag: v14.2.22~25^2~16^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F40676%2Fhead;p=ceph.git

doc/man/8/ceph: document --max option

Signed-off-by: Sage Weil <sage@newdream.net>
(cherry picked from commit 98f1be85d9f329588cf8e21d7b49ceb0b07425fe)
---

diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst
index 847abb7a739f7..7a1352943dd9a 100644
--- a/doc/man/8/ceph.rst
+++ b/doc/man/8/ceph.rst
@@ -904,11 +904,16 @@ data should remain readable and writeable, although data redundancy
 may be reduced as some PGs may end up in a degraded (but active)
 state.  It will return a success code if it is okay to stop the
 OSD(s), or an error code and informative message if it is not or if no
-conclusion can be drawn at the current time.
+conclusion can be drawn at the current time.  When ``--max <num>`` is
+provided, up to <num> OSDs IDs will return (including the provided
+OSDs) that can all be stopped simultaneously.  This allows larger sets
+of stoppable OSDs to be generated easily by providing a single
+starting OSD and a max.  Additional OSDs are drawn from adjacent locations
+in the CRUSH hierarchy.
 
 Usage::
 
-  ceph osd ok-to-stop <id> [<ids>...]
+  ceph osd ok-to-stop <id> [<ids>...] [--max <num>]
 
 Subcommand ``pause`` pauses osd.