]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: Add documentation of missing osd commands.
authorAndre Noll <maan@systemlinux.org>
Fri, 9 Dec 2011 17:57:41 +0000 (18:57 +0100)
committerTommi Virtanen <tommi.virtanen@dreamhost.com>
Mon, 12 Dec 2011 22:31:10 +0000 (14:31 -0800)
The set of OSD commands which added by the previous commit is
incomplete. This patch adds documentation for the following
OSD commands which were previously missing: dump, tree, crush,
cluster_snap, lost, create, rm.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
doc/control.rst

index 15a668664a6dda4d45cb048bc38c7debb833e7b5..61e15233a1eea6bd7d0b0c77f8ef4ae61a763078 100644 (file)
@@ -64,9 +64,48 @@ file. This is functionally equivalent to ::
 
        $ ceph osd getmap -o /tmp/osdmap
        $ osdmaptool /tmp/osdmap --export-crush file
-
 ::
 
+       $ ceph osd dump [--format format>]
+
+Dump the osd map. Valid formats for -f are "plain" and "json". If no
+--format option is given, the osd map is dumped as plain text. ::
+
+       $ ceph osd tree [--format format]
+
+Dump the osd map as a tree with one line per osd containing weight
+and state. ::
+
+       $ ceph osd crush add <id> <name> <weight> [<loc1> [<loc2> ...]]
+
+Add a new item with the given id/name/weight at the specified
+location. ::
+
+       $ ceph osd crush remove <id>
+
+Remove an existing item from the crush map. ::
+
+       $ ceph osd crush reweight <name> <weight>
+
+Set the weight of the item given by ``<name>`` to ``<weight>``. ::
+
+       $ ceph osd cluster_snap <name>
+
+Create a cluster snapshot. ::
+
+       $ ceph osd lost [--yes-i-really-mean-it]
+
+Mark an OSD as lost. This may result in permanent data loss. Use with caution. ::
+
+       $ ceph osd create [<id>]
+
+Create a new OSD. If no ID is given, a new ID is automatically selected
+if possible. ::
+
+       $ ceph osd rm [<id>...]
+
+Remove the given OSD(s). ::
+
        $ ceph osd getmaxosd
 
 Query the current max_osd parameter in the osd map. ::
@@ -179,5 +218,4 @@ Enables debug messages. ::
 
 Displays the status of all metadata servers.
 
-dump, getmap, stop, set_max_mds, setmap: TODO
-
+set_max_mds: TODO