CEPH filesystem development
 help / color / mirror / Atom feed
From: Andre Noll <maan@systemlinux.org>
To: Tommi Virtanen <tommi.virtanen@dreamhost.com>
Cc: Gregory Farnum <gregory.farnum@dreamhost.com>,
	Sage Weil <sage@newdream.net>,
	ceph-devel@vger.kernel.org, Andre Noll <maan@systemlinux.org>
Subject: [PATCH/RFC 1/6] doc: Import the list of ceph subcommands from wiki.
Date: Mon, 28 Nov 2011 15:04:31 +0100	[thread overview]
Message-ID: <1322489076-31364-2-git-send-email-maan@systemlinux.org> (raw)
In-Reply-To: <1322489076-31364-1-git-send-email-maan@systemlinux.org>

This adds the content of the wiki page at

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

to doc/ops/monitor.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>
---
 doc/ops/monitor.rst |  178 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 177 insertions(+), 1 deletions(-)

diff --git a/doc/ops/monitor.rst b/doc/ops/monitor.rst
index 98c75c3..626685e 100644
--- a/doc/ops/monitor.rst
+++ b/doc/ops/monitor.rst
@@ -4,4 +4,180 @@
  Monitoring Ceph
 =================
 
-.. todo:: write me
+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
+
-- 
1.7.8.rc1.14.g248db


  reply	other threads:[~2011-11-28 14:14 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-11  5:14 v0.38 released Sage Weil
2011-11-15 16:42 ` Andre Noll
2011-11-15 19:53   ` Gregory Farnum
2011-11-16  9:56     ` Andre Noll
2011-11-16 18:04       ` Tommi Virtanen
2011-11-17 10:35         ` Andre Noll
2011-11-17 18:01           ` Tommi Virtanen
2011-11-18 15:01             ` Andre Noll
2011-11-18 18:47               ` Tommi Virtanen
2011-11-21 17:32                 ` Andre Noll
2011-11-21 17:36                   ` Tommi Virtanen
2011-11-21 18:06                     ` Andre Noll
2011-11-28 14:04                       ` [PATCH/RFC 0/6]: Introduction Andre Noll
2011-11-28 14:04                         ` Andre Noll [this message]
2011-11-28 14:04                         ` [PATCH/RFC 2/6] doc: Add documentation of missing osd commands Andre Noll
2011-11-28 14:04                         ` [PATCH/RFC 3/6] doc: Document pause and unpause " Andre Noll
2011-11-28 14:04                         ` [PATCH/RFC 4/6] doc: Update the list of fields for the pool set command Andre Noll
2011-11-28 14:04                         ` [PATCH/RFC 5/6] doc: Add missing documentation for osd pool get Andre Noll
2011-11-28 18:37                           ` Gregory Farnum
2011-11-28 19:27                             ` Andre Noll
2011-11-28 14:04                         ` [PATCH/RFC 6/6] doc: Clarify documentation of reweight command Andre Noll
2011-12-05 21:09                         ` [PATCH/RFC 0/6]: Introduction Tommi Virtanen
2011-12-06 17:01                           ` Andre Noll

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1322489076-31364-2-git-send-email-maan@systemlinux.org \
    --to=maan@systemlinux.org \
    --cc=ceph-devel@vger.kernel.org \
    --cc=gregory.farnum@dreamhost.com \
    --cc=sage@newdream.net \
    --cc=tommi.virtanen@dreamhost.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox