]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephadm: rewrite "dry run" section in osd.rst
authorZac Dover <zac.dover@gmail.com>
Wed, 24 Mar 2021 15:47:17 +0000 (01:47 +1000)
committerSage Weil <sage@newdream.net>
Fri, 23 Apr 2021 12:24:14 +0000 (07:24 -0500)
This rewrites the "dry run" section of the "OSD Service"
chapter of the Cephdam documentation. This commit makes
minor changes that reduce the cognitive load of the
reader.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit e61237f3a1f83b90d4ab22396c6e8291620a60fa)

doc/cephadm/osd.rst

index adf44d182e1ee7111be623f5978ee5a304e2b790..e61ef1534f5214db2e8f72936b8733f36b408f80 100644 (file)
@@ -150,16 +150,21 @@ There are a few ways to create new OSDs:
 Dry Run
 -------
 
-``--dry-run`` will cause the orchestrator to present a preview of what will happen
-without actually creating the OSDs.
+The ``--dry-run`` flag causes the orchestrator to present a preview of what
+will happen without actually creating the OSDs.
 
-Example::
+For example:
 
-    # ceph orch apply osd --all-available-devices --dry-run
-    NAME                  HOST  DATA     DB WAL
-    all-available-devices node1 /dev/vdb -  -
-    all-available-devices node2 /dev/vdc -  -
-    all-available-devices node3 /dev/vdd -  -
+   .. prompt:: bash #
+
+     ceph orch apply osd --all-available-devices --dry-run
+
+   ::
+
+     NAME                  HOST  DATA      DB  WAL
+     all-available-devices node1 /dev/vdb  -   -
+     all-available-devices node2 /dev/vdc  -   -
+     all-available-devices node3 /dev/vdd  -   -
 
 .. _cephadm-osd-declarative: