doc: Import the list of ceph subcommands from wiki.

This adds the content of the wiki page at

http://ceph.newdream.net/wiki/Monitor_commands

to doc/control.rst in order to make it available at the new official
location for the ceph documentation. This first patch is just the
result of a cut-and-paste operation. There are no changes in content,
but the text was converted to rst format.

Signed-Off-By: Andre Noll <maan@systemlinux.org>

1 files changed, 183 insertions, 0 deletions

diff --git a/doc/control.rst b/doc/control.rst
new file mode 100644
index 00000000000..15a668664a6
--- /dev/null
+++ b/doc/control.rst
@@ -0,0 +1,183 @@
+.. index:: control, commands
+
+=================
+ Control commands
+=================
+
+Monitor commands
+----------------
+
+Monitor commands are issued using the ceph utility (in versions before
+Dec08 it was called cmonctl)::
+
+	$ ceph [-m monhost] command
+
+where the command is usually of the form::
+
+	$ ceph subsystem command
+
+System commands
+---------------
+
+::
+
+	$ ceph stop
+
+Cleanly shuts down the cluster.  ::
+
+	$ ceph -s
+
+Shows an overview of the current status of the cluster.  ::
+
+	$ ceph -w
+
+Shows a running summary of the status of the cluster, and major events.
+
+AUTH subsystem
+--------------
+::
+
+	$ ceph auth add <osd> <--in-file|-i> <path-to-osd-keyring>
+
+Add auth keyring for an osd.  ::
+
+	$ ceph auth list
+
+Show auth key OSD subsystem.
+
+OSD subsystem
+-------------
+::
+
+	$ ceph osd stat
+
+Query osd subsystem status. ::
+
+	$ ceph osd getmap -o file
+
+Write a copy of the most recent osd map to a file. See osdmaptool. ::
+
+	$ ceph osd getcrushmap -o file
+
+Write a copy of the crush map from the most recent osd map to
+file. This is functionally equivalent to ::
+
+	$ ceph osd getmap -o /tmp/osdmap
+	$ osdmaptool /tmp/osdmap --export-crush file
+
+::
+
+	$ ceph osd getmaxosd
+
+Query the current max_osd parameter in the osd map. ::
+
+	$ ceph osd setmap -i file
+
+Import the given osd map. Note that this can be a bit dangerous,
+since the osd map includes dynamic state about which OSDs are current
+on or offline; only do this if you've just modified a (very) recent
+copy of the map. ::
+
+	$ ceph osd setcrushmap -i file
+
+Import the given crush map. ::
+
+	$ ceph osd setmaxosd
+
+Set the max_osd parameter in the osd map. This is necessary when
+expanding the storage cluster. ::
+
+	$ ceph osd down N
+
+Mark osdN down. ::
+
+	$ ceph osd out N
+
+Mark osdN out of the distribution (i.e. allocated no data). ::
+
+	$ ceph osd in N
+
+Mark osdN in the distribution (i.e. allocated data). ::
+
+	$ ceph class list
+
+List classes that are loaded in the ceph cluster. ::
+
+	$ ceph osd pause
+	$ ceph osd unpause
+
+TODO ::
+
+	$ ceph osd reweight N W
+
+Sets the weight of osdN to W. ::
+
+	$ ceph osd reweight-by-utilization [threshold]
+
+Reweights all the OSDs by reducing the weight of OSDs which are
+heavily overused. By default it will adjust the weights downward on
+OSDs which have 120% of the average utilization, but if you include
+threshold it will use that percentage instead. ::
+
+	$ ceph osd blacklist add ADDRESS[:source_port] [TIME]
+	$ ceph osd blacklist rm ADDRESS[:source_port]
+
+Adds/removes the address to/from the blacklist. When adding an address,
+you can specify how long it should be blacklisted in seconds; otherwise
+it will default to 1 hour. A blacklisted address is prevented from
+connecting to any osd. Blacklisting is most often used to prevent a
+laggy mds making bad changes to data on the osds.
+
+These commands are mostly only useful for failure testing, as
+blacklists are normally maintained automatically and shouldn't need
+manual intervention. ::
+
+	$ ceph osd pool mksnap POOL SNAPNAME
+	$ ceph osd pool rmsnap POOL SNAPNAME
+
+Creates/deletes a snapshot of a pool. ::
+
+	$ ceph osd pool create POOL
+	$ ceph osd pool delete POOL
+
+Creates/deletes a storage pool. ::
+
+	$ ceph osd pool set POOL FIELD VALUE
+
+Changes a pool setting. Valid fields are:
+
+	* ``size``: Sets the number of copies of data in the pool.
+	* ``pg_num``: TODO
+	* ``pgp_num``: TODO
+
+::
+
+	$ ceph osd scrub N
+
+Sends a scrub command to osdN. To send the command to all osds, use ``*``.
+TODO: what does this actually do ::
+
+	$ ceph osd repair N
+
+Sends a repair command to osdN. To send the command to all osds, use ``*``.
+TODO: what does this actually do
+
+MDS subsystem
+-------------
+
+Change configuration parameters on a running mds. ::
+
+	$ ceph mds tell <mds-id> injectargs '--<switch> <value> [--<switch> <value>]'
+
+Example::
+
+	$ ceph mds tell 0 injectargs '--debug_ms 1 --debug_mds 10'
+
+Enables debug messages. ::
+
+	$ ceph mds stat
+
+Displays the status of all metadata servers.
+
+dump, getmap, stop, set_max_mds, setmap: TODO
+