From f5f48327e45be0b3da45c83672e0c2c7c0fe9dce Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Mon, 23 Mar 2015 22:53:29 +0800 Subject: [PATCH] doc: remove generated man pages Signed-off-by: Kefu Chai --- man/ceph-authtool.8 | 299 ----- man/ceph-clsinfo.8 | 96 -- man/ceph-conf.8 | 159 --- man/ceph-debugpack.8 | 95 -- man/ceph-dencoder.8 | 193 --- man/ceph-deploy.8 | 841 ------------- man/ceph-disk.8 | 400 ------ man/ceph-fuse.8 | 120 -- man/ceph-mds.8 | 121 -- man/ceph-mon.8 | 137 -- man/ceph-osd.8 | 169 --- man/ceph-post-file.8 | 130 -- man/ceph-rbdnamer.8 | 92 -- man/ceph-rest-api.8 | 208 --- man/ceph-run.8 | 89 -- man/ceph-syn.8 | 148 --- man/ceph.8 | 2800 ----------------------------------------- man/cephfs.8 | 144 --- man/crushtool.8 | 433 ------- man/librados-config.8 | 94 -- man/monmaptool.8 | 188 --- man/mount.ceph.8 | 257 ---- man/osdmaptool.8 | 139 -- man/rados.8 | 267 ---- man/radosgw-admin.8 | 616 --------- man/radosgw.8 | 380 ------ man/rbd-fuse.8 | 110 -- man/rbd-replay-many.8 | 134 -- man/rbd-replay-prep.8 | 103 -- man/rbd-replay.8 | 141 --- man/rbd.8 | 667 ---------- 31 files changed, 9770 deletions(-) delete mode 100644 man/ceph-authtool.8 delete mode 100644 man/ceph-clsinfo.8 delete mode 100644 man/ceph-conf.8 delete mode 100644 man/ceph-debugpack.8 delete mode 100644 man/ceph-dencoder.8 delete mode 100644 man/ceph-deploy.8 delete mode 100644 man/ceph-disk.8 delete mode 100644 man/ceph-fuse.8 delete mode 100644 man/ceph-mds.8 delete mode 100644 man/ceph-mon.8 delete mode 100644 man/ceph-osd.8 delete mode 100644 man/ceph-post-file.8 delete mode 100644 man/ceph-rbdnamer.8 delete mode 100644 man/ceph-rest-api.8 delete mode 100644 man/ceph-run.8 delete mode 100644 man/ceph-syn.8 delete mode 100644 man/ceph.8 delete mode 100644 man/cephfs.8 delete mode 100644 man/crushtool.8 delete mode 100644 man/librados-config.8 delete mode 100644 man/monmaptool.8 delete mode 100644 man/mount.ceph.8 delete mode 100644 man/osdmaptool.8 delete mode 100644 man/rados.8 delete mode 100644 man/radosgw-admin.8 delete mode 100644 man/radosgw.8 delete mode 100644 man/rbd-fuse.8 delete mode 100644 man/rbd-replay-many.8 delete mode 100644 man/rbd-replay-prep.8 delete mode 100644 man/rbd-replay.8 delete mode 100644 man/rbd.8 diff --git a/man/ceph-authtool.8 b/man/ceph-authtool.8 deleted file mode 100644 index ec4c7b28e15ef..0000000000000 --- a/man/ceph-authtool.8 +++ /dev/null @@ -1,299 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-AUTHTOOL" "8" "November 30, 2014" "dev" "Ceph" -.SH NAME -ceph-authtool \- ceph keyring manipulation tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-authtool\fP \fIkeyringfile\fP [ \-l | \-\-list ] [ \-C | \-\-create\-keyring -] [ \-p | \-\-print ] [ \-n | \-\-name \fIentityname\fP ] [ \-\-gen\-key ] [ \-a | -\-\-add\-key \fIbase64_key\fP ] [ \-\-caps \fIcapfile\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-authtool\fP is a utility to create, view, and modify a Ceph keyring -file. A keyring file stores one or more Ceph authentication keys and -possibly an associated capability specification. Each key is -associated with an entity name, of the form -\fB{client,mon,mds,osd}.name\fP\&. -.sp -\fBWARNING\fP Ceph provides authentication and protection against -man\-in\-the\-middle attacks once secret keys are in place. However, -data over the wire is not encrypted, which may include the messages -used to configure said keys. The system is primarily intended to be -used in trusted environments. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-l, \-\-list -will list all keys and capabilities present in the keyring -.UNINDENT -.INDENT 0.0 -.TP -.B \-p, \-\-print -will print an encoded key for the specified entityname. This is -suitable for the \fBmount \-o secret=\fP argument -.UNINDENT -.INDENT 0.0 -.TP -.B \-C, \-\-create\-keyring -will create a new keyring, overwriting any existing keyringfile -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gen\-key -will generate a new secret key for the specified entityname -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-add\-key -will add an encoded key to the keyring -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cap subsystem capability -will set the capability for given subsystem -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-caps capsfile -will set all of capabilities associated with a given key, for all subsystems -.UNINDENT -.SH CAPABILITIES -.sp -The subsystem is the name of a Ceph subsystem: \fBmon\fP, \fBmds\fP, or -\fBosd\fP\&. -.sp -The capability is a string describing what the given user is allowed -to do. This takes the form of a comma separated list of allow -clauses with a permission specifier containing one or more of rwx for -read, write, and execute permission. The \fBallow *\fP grants full -superuser permissions for the given subsystem. -.sp -For example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -# can read, write, and execute objects -osd = "allow rwx" - -# can access mds server -mds = "allow" - -# can modify cluster state (i.e., is a server daemon) -mon = "allow rwx" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A librados user restricted to a single pool might look like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mon = "allow r" - -osd = "allow rw pool foo" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A client using rbd with read access to one pool and read/write access to another: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mon = "allow r" - -osd = "allow class\-read object_prefix rbd_children, allow pool templates r class\-read, allow pool vms rwx" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A client mounting the file system with minimal permissions would need caps like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mds = "allow" - -osd = "allow rw pool data" - -mon = "allow r" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH OSD CAPABILITIES -.sp -In general, an osd capability follows the grammar: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -osdcap := grant[,grant...] -grant := allow (match capspec | capspec match) -match := [pool[=] | object_prefix ] -capspec := * | [r][w][x] [class\-read] [class\-write] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The capspec determines what kind of operations the entity can perform: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -r = read access to objects -w = write access to objects -x = can call any class method (same as class\-read class\-write) -class\-read = can call class methods that are reads -class\-write = can call class methods that are writes -* = equivalent to rwx, plus the ability to run osd admin commands, - i.e. ceph osd tell ... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The match criteria restrict a grant based on the pool being accessed. -Grants are additive if the client fulfills the match condition. For -example, if a client has the osd capabilities: "allow r object_prefix -prefix, allow w pool foo, allow x pool bar", then it has rw access to -pool foo, rx access to pool bar, and r access to objects whose -names begin with \(aqprefix\(aq in any pool. -.SH CAPS FILE FORMAT -.sp -The caps file format consists of zero or more key/value pairs, one per -line. The key and value are separated by an \fB=\fP, and the value must -be quoted (with \fB\(aq\fP or \fB"\fP) if it contains any whitespace. The key -is the name of the Ceph subsystem (\fBosd\fP, \fBmds\fP, \fBmon\fP), and the -value is the capability string (see above). -.SH EXAMPLE -.sp -To create a new keyring containing a key for client.foo: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-authtool \-C \-n client.foo \-\-gen\-key keyring -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To associate some capabilities with the key (namely, the ability to -mount a Ceph filesystem): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-authtool \-n client.foo \-\-cap mds \(aqallow\(aq \-\-cap osd \(aqallow rw pool=data\(aq \-\-cap mon \(aqallow r\(aq keyring -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To display the contents of the keyring: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-authtool \-l keyring -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -When mounting a Ceph file system, you can grab the appropriately encoded secret key with: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mount \-t ceph serverhost:/ mountpoint \-o name=foo,secret=\(gaceph\-authtool \-p \-n client.foo keyring\(ga -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-authtool\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-clsinfo.8 b/man/ceph-clsinfo.8 deleted file mode 100644 index 684cb9ed0c8d7..0000000000000 --- a/man/ceph-clsinfo.8 +++ /dev/null @@ -1,96 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-CLSINFO" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-clsinfo \- show class object information -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-clsinfo\fP [ \fIoptions\fP ] ... \fIfilename\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-clsinfo\fP can show name, version, and architecture information -about a specific class object. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-n, \-\-name -Shows the class name -.UNINDENT -.INDENT 0.0 -.TP -.B \-v, \-\-version -Shows the class version -.UNINDENT -.INDENT 0.0 -.TP -.B \-a, \-\-arch -Shows the class architecture -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-clsinfo\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-conf.8 b/man/ceph-conf.8 deleted file mode 100644 index cbe59a02d7f61..0000000000000 --- a/man/ceph-conf.8 +++ /dev/null @@ -1,159 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-CONF" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-conf \- ceph conf file tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-conf\fP \-c \fIconffile\fP \-\-list\-all\-sections -\fBceph\-conf\fP \-c \fIconffile\fP \-L -\fBceph\-conf\fP \-c \fIconffile\fP \-l \fIprefix\fP -\fBceph\-conf\fP \fIkey\fP \-s \fIsection1\fP ... -\fBceph\-conf\fP [\-s \fIsection\fP ] \-\-lookup \fIkey\fP -\fBceph\-conf\fP [\-s \fIsection\fP ] \fIkey\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-conf\fP is a utility for getting information about a ceph -configuration file. As with most Ceph programs, you can specify which -Ceph configuration file to use with the \fB\-c\fP flag. -.SH ACTIONS -.sp -\fBceph\-conf\fP will perform one of the following actions: -.sp -\-\-list\-all\-sections or \-L prints out a list of all the section names in the configuration -file. -.sp -\-\-list\-sections or \-l prints out a list of all the sections that begin -with a given prefix. For example, \-\-list\-sections mon would list all -sections beginning with mon. -.sp -\-\-lookup will search the configuration for a given value. By default, the sections that -are searched are determined by the Ceph name that we are using. The Ceph name defaults to -client.admin. It can be specified with \-\-name. -.sp -For example, if we specify \-\-name osd.0, the following sections will be searched: -[osd.0], [osd], [global] -.sp -You can specify additional sections to search with \-\-section or \-s. These additional -sections will be searched before the sections that would normally be searched. As always, -the first matching entry we find will be returned. -.sp -Note: \-\-lookup is the default action. If no other actions are given on the command line, -we will default to doing a lookup. -.SH EXAMPLES -.sp -To find out what value osd 0 will use for the "osd data" option: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-conf \-c foo.conf \-\-name osd.0 \-\-lookup "osd data" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To find out what value will mds a use for the "log file" option: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-conf \-c foo.conf \-\-name mds.a "log file" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To list all sections that begin with osd: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-conf \-c foo.conf \-l osd -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To list all sections: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-conf \-c foo.conf \-L -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-conf\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer -to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-debugpack.8 b/man/ceph-debugpack.8 deleted file mode 100644 index e232ee658623e..0000000000000 --- a/man/ceph-debugpack.8 +++ /dev/null @@ -1,95 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-DEBUGPACK" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-debugpack \- ceph debug packer utility -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-debugpack\fP [ \fIoptions\fP ] \fIfilename.tar.gz\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-debugpack\fP will build a tarball containing various items that are -useful for debugging crashes. The resulting tarball can be shared with -Ceph developers when debugging a problem. -.sp -The tarball will include the binaries for ceph\-mds, ceph\-osd, and ceph\-mon, radosgw, any -log files, the ceph.conf configuration file, any core files we can -find, and (if the system is running) dumps of the current cluster state -as reported by \(aqceph report\(aq. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fIceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during -startup. -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-debugpack\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -\fBceph\-post\-file\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-dencoder.8 b/man/ceph-dencoder.8 deleted file mode 100644 index caf626aa95076..0000000000000 --- a/man/ceph-dencoder.8 +++ /dev/null @@ -1,193 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-DENCODER" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-dencoder \- ceph encoder/decoder utility -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-dencoder\fP [commands...] -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-dencoder\fP is a utility to encode, decode, and dump ceph data -structures. It is used for debugging and for testing inter\-version -compatibility. -.sp -\fBceph\-dencoder\fP takes a simple list of commands and performs them -in order. -.SH COMMANDS -.INDENT 0.0 -.TP -.B version -Print the version string for the \fBceph\-dencoder\fP binary. -.UNINDENT -.INDENT 0.0 -.TP -.B import -Read a binary blob of encoded data from the given file. It will be -placed in an in\-memory buffer. -.UNINDENT -.INDENT 0.0 -.TP -.B export -Write the contents of the current in\-memory buffer to the given -file. -.UNINDENT -.INDENT 0.0 -.TP -.B list_types -List the data types known to this build of \fBceph\-dencoder\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B type -Select the given type for future \fBencode\fP or \fBdecode\fP operations. -.UNINDENT -.INDENT 0.0 -.TP -.B decode -Decode the contents of the in\-memory buffer into an instance of the -previously selected type. If there is an error, report it. -.UNINDENT -.INDENT 0.0 -.TP -.B encode -Encode the contents of the in\-memory instance of the previously -selected type to the in\-memory buffer. -.UNINDENT -.INDENT 0.0 -.TP -.B dump_json -Print a JSON\-formatted description of the in\-memory object. -.UNINDENT -.INDENT 0.0 -.TP -.B count_tests -Print the number of built\-in test instances of the previosly -selected type that \fBceph\-dencoder\fP is able to generate. -.UNINDENT -.INDENT 0.0 -.TP -.B select_test -Select the given build\-in test instance as a the in\-memory instance -of the type. -.UNINDENT -.INDENT 0.0 -.TP -.B get_features -Print the decimal value of the feature set supported by this version -of \fBceph\-dencoder\fP\&. Each bit represents a feature. These correspond to -CEPH_FEATURE_* defines in src/include/ceph_features.h. -.UNINDENT -.INDENT 0.0 -.TP -.B set_features -Set the feature bits provided to \fBencode\fP to \fIf\fP\&. This allows -you to encode objects such that they can be understood by old -versions of the software (for those types that support it). -.UNINDENT -.SH EXAMPLE -.sp -Say you want to examine an attribute on an object stored by \fBceph\-osd\fP\&. You can do: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ cd /mnt/osd.12/current/2.b_head -$ attr \-l foo_bar_head_EFE6384B -Attribute "ceph.snapset" has a 31 byte value for foo_bar_head_EFE6384B -Attribute "ceph._" has a 195 byte value for foo_bar_head_EFE6384B -$ attr foo_bar_head_EFE6384B \-g ceph._ \-q > /tmp/a -$ ceph\-dencoder type object_info_t import /tmp/a decode dump_json -{ "oid": { "oid": "foo", - "key": "bar", - "snapid": \-2, - "hash": 4024842315, - "max": 0}, - "locator": { "pool": 2, - "preferred": \-1, - "key": "bar"}, - "category": "", - "version": "9\(aq1", - "prior_version": "0\(aq0", - "last_reqid": "client.4116.0:1", - "size": 1681, - "mtime": "2012\-02\-21 08:58:23.666639", - "lost": 0, - "wrlock_by": "unknown.0.0:0", - "snaps": [], - "truncate_seq": 0, - "truncate_size": 0, - "watchers": {}} -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-dencoder\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-deploy.8 b/man/ceph-deploy.8 deleted file mode 100644 index 3a9a1209bfe93..0000000000000 --- a/man/ceph-deploy.8 +++ /dev/null @@ -1,841 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-DEPLOY" "8" "December 20, 2014" "dev" "Ceph" -.SH NAME -ceph-deploy \- Ceph deployment tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-deploy\fP \fBnew\fP [\fIinitial\-monitor\-node(s)\fP] -.fi -.sp -.nf -\fBceph\-deploy\fP \fBinstall\fP [\fIceph\-node\fP] [\fIceph\-node\fP\&...] -.fi -.sp -.nf -\fBceph\-deploy\fP \fBmon\fP \fIcreate\-initial\fP -.fi -.sp -.nf -\fBceph\-deploy\fP \fBosd\fP \fIprepare\fP [\fIceph\-node\fP]:[\fIdir\-path\fP] -.fi -.sp -.nf -\fBceph\-deploy\fP \fBosd\fP \fIactivate\fP [\fIceph\-node\fP]:[\fIdir\-path\fP] -.fi -.sp -.nf -\fBceph\-deploy\fP \fBosd\fP \fIcreate\fP [\fIceph\-node\fP]:[\fIdir\-path\fP] -.fi -.sp -.nf -\fBceph\-deploy\fP \fBadmin\fP [\fIadmin\-node\fP][\fIceph\-node\fP\&...] -.fi -.sp -.nf -\fBceph\-deploy\fP \fBpurgedata\fP [\fIceph\-node\fP][\fIceph\-node\fP\&...] -.fi -.sp -.nf -\fBceph\-deploy\fP \fBforgetkeys\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-deploy\fP is a tool which allows easy and quick deployment of a -Ceph cluster without involving complex and detailed manual configuration. It -uses ssh to gain access to other Ceph nodes from the admin node, sudo for -administrator privileges on them and the underlying Python scripts automates -the manual process of Ceph installation on each node from the admin node itself. -It can be easily run on an workstation and doesn\(aqt require servers, databases or -any other automated tools. With \fBceph\-deploy\fP, it is really easy to set -up and take down a cluster. However, it is not a generic deployment tool. It is -a specific tool which is designed for those who want to get Ceph up and running -quickly with only the unavoidable initial configuration settings and without the -overhead of installing other tools like \fBChef\fP, \fBPuppet\fP or \fBJuju\fP\&. Those -who want to customize security settings, partitions or directory locations and -want to set up a cluster following detailed manual steps, should use other tools -i.e, \fBChef\fP, \fBPuppet\fP, \fBJuju\fP or \fBCrowbar\fP\&. -.sp -With \fBceph\-deploy\fP, you can install Ceph packages on remote nodes, -create a cluster, add monitors, gather/forget keys, add OSDs and metadata -servers, configure admin hosts or take down the cluster. -.SH COMMANDS -.SS new -.sp -Start deploying a new cluster and write a configuration file and keyring for it. -It tries to copy ssh keys from admin node to gain passwordless ssh to monitor -node(s), validates host IP, creates a cluster with a new initial monitor node or -nodes for monitor quorum, a ceph configuration file, a monitor secret keyring and -a log file for the new cluster. It populates the newly created Ceph configuration -file with \fBfsid\fP of cluster, hostnames and IP addresses of initial monitor -members under \fB[global]\fP section. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy new [MON][MON...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [MON] is initial monitor hostname (short hostname i.e, \fBhostname \-s\fP). -.sp -Other options like \fI\%--no-ssh-copykey\fP, \fI\%--fsid\fP, -\fI\%--cluster-network\fP and \fI\%--public-network\fP can also be used with -this command. -.sp -If more than one network interface is used, \fBpublic network\fP setting has to be -added under \fB[global]\fP section of Ceph configuration file. If the public subnet -is given, \fBnew\fP command will choose the one IP from the remote host that exists -within the subnet range. Public network can also be added at runtime using -\fI\%--public-network\fP option with the command as mentioned above. -.SS install -.sp -Install Ceph packages on remote hosts. As a first step it installs -\fByum\-plugin\-priorities\fP in admin and other nodes using passwordless ssh and sudo -so that Ceph packages from upstream repository get more priority. It then detects -the platform and distribution for the hosts and installs Ceph normally by -downloading distro compatible packages if adequate repo for Ceph is already added. -\fB\-\-release\fP flag is used to get the latest release for installation. During -detection of platform and distribution before installation, if it finds the -\fBdistro.init\fP to be \fBsysvinit\fP (Fedora, CentOS/RHEL etc), it doesn\(aqt allow -installation with custom cluster name and uses the default name \fBceph\fP for the -cluster. -.sp -If the user explicitly specifies a custom repo url with \fI\%--repo-url\fP for -installation, anything detected from the configuration will be overridden and -the custom repository location will be used for installation of Ceph packages. -If required, valid custom repositories are also detected and installed. In case -of installation from a custom repo a boolean is used to determine the logic -needed to proceed with a custom repo installation. A custom repo install helper -is used that goes through config checks to retrieve repos (and any extra repos -defined) and installs them. \fBcd_conf\fP is the object built from \fBargparse\fP -that holds the flags and information needed to determine what metadata from the -configuration is to be used. -.sp -A user can also opt to install only the repository without installing Ceph and -its dependencies by using \fI\%--repo\fP option. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy install [HOST][HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is/are the host node(s) where Ceph is to be installed. -.sp -An option \fB\-\-release\fP is used to install a release known as CODENAME -(default: firefly). -.sp -Other options like \fI\%--testing\fP, \fI\%--dev\fP, \fI\%--adjust-repos\fP, -\fI\%--no-adjust-repos\fP, \fI\%--repo\fP, \fI\%--local-mirror\fP, -\fI\%--repo-url\fP and \fI\%--gpg-url\fP can also be used with this command. -.SS mds -.sp -Deploy Ceph mds on remote hosts. A metadata server is needed to use CephFS and -the \fBmds\fP command is used to create one on the desired host node. It uses the -subcommand \fBcreate\fP to do so. \fBcreate\fP first gets the hostname and distro -information of the desired mds host. It then tries to read the \fBbootstrap\-mds\fP -key for the cluster and deploy it in the desired host. The key generally has a -format of \fB{cluster}.bootstrap\-mds.keyring\fP\&. If it doesn\(aqt finds a keyring, -it runs \fBgatherkeys\fP to get the keyring. It then creates a mds on the desired -host under the path \fB/var/lib/ceph/mds/\fP in \fB/var/lib/ceph/mds/{cluster}\-{name}\fP -format and a bootstrap keyring under \fB/var/lib/ceph/bootstrap\-mds/\fP in -\fB/var/lib/ceph/bootstrap\-mds/{cluster}.keyring\fP format. It then runs appropriate -commands based on \fBdistro.init\fP to start the \fBmds\fP\&. To remove the mds, -subcommand \fBdestroy\fP is used. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy mds create [HOST[:DAEMON\-NAME]] [HOST[:DAEMON\-NAME]...] - -ceph\-deploy mds destroy [HOST[:DAEMON\-NAME]] [HOST[:DAEMON\-NAME]...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The [DAEMON\-NAME] is optional. -.SS mon -.sp -Deploy Ceph monitor on remote hosts. \fBmon\fP makes use of certain subcommands -to deploy Ceph monitors on other nodes. -.sp -Subcommand \fBcreate\-initial\fP deploys for monitors defined in -\fBmon initial members\fP under \fB[global]\fP section in Ceph configuration file, -wait until they form quorum and then gatherkeys, reporting the monitor status -along the process. If monitors don\(aqt form quorum the command will eventually -time out. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy mon create\-initial -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcreate\fP is used to deploy Ceph monitors by explicitly specifying -the hosts which are desired to be made monitors. If no hosts are specified it -will default to use the \fBmon initial members\fP defined under \fB[global]\fP -section of Ceph configuration file. \fBcreate\fP first detects platform and distro -for desired hosts and checks if hostname is compatible for deployment. It then -uses the monitor keyring initially created using \fBnew\fP command and deploys the -monitor in desired host. If multiple hosts were specified during \fBnew\fP command -i.e, if there are multiple hosts in \fBmon initial members\fP and multiple keyrings -were created then a concatenated keyring is used for deployment of monitors. In -this process a keyring parser is used which looks for \fB[entity]\fP sections in -monitor keyrings and returns a list of those sections. A helper is then used to -collect all keyrings into a single blob that will be used to inject it to monitors -with \fI\-\-mkfs\fP on remote nodes. All keyring files are concatenated to be -in a directory ending with \fB\&.keyring\fP\&. During this process the helper uses list -of sections returned by keyring parser to check if an entity is already present -in a keyring and if not, adds it. The concatenated keyring is used for deployment -of monitors to desired multiple hosts. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy mon create [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of desired monitor host(s). -.sp -Subcommand \fBadd\fP is used to add a monitor to an existing cluster. It first -detects platform and distro for desired host and checks if hostname is compatible -for deployment. It then uses the monitor keyring, ensures configuration for new -monitor host and adds the monitor to the cluster. If the section for the monitor -exists and defines a mon addr that will be used, otherwise it will fallback by -resolving the hostname to an IP. If \fI\%--address\fP is used it will override -all other options. After adding the monitor to the cluster, it gives it some time -to start. It then looks for any monitor errors and checks monitor status. Monitor -errors arise if the monitor is not added in \fBmon initial members\fP, if it doesn\(aqt -exist in \fBmonmap\fP and if neither \fBpublic_addr\fP nor \fBpublic_network\fP keys -were defined for monitors. Under such conditions, monitors may not be able to -form quorum. Monitor status tells if the monitor is up and running normally. The -status is checked by running \fBceph daemon mon.hostname mon_status\fP on remote -end which provides the output and returns a boolean status of what is going on. -\fBFalse\fP means a monitor that is not fine even if it is up and running, while -\fBTrue\fP means the monitor is up and running correctly. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy mon add [HOST] - -ceph\-deploy mon add [HOST] \-\-address [IP] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is the hostname and [IP] is the IP address of the desired monitor -node. -.sp -Subcommand \fBdestroy\fP is used to completely remove monitors on remote hosts. -It takes hostnames as arguments. It stops the monitor, verifies if \fBceph\-mon\fP -daemon really stopped, creates an archive directory \fBmon\-remove\fP under -\fB/var/lib/ceph/\fP, archives old monitor directory in -\fB{cluster}\-{hostname}\-{stamp}\fP format in it and removes the monitor from -cluster by running \fBceph remove...\fP command. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy mon destroy [HOST] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of monitor that is to be removed. -.SS gatherkeys -.sp -Gather authentication keys for provisioning new nodes. It takes hostnames as -arguments. It checks for and fetches \fBclient.admin\fP keyring, monitor keyring -and \fBbootstrap\-mds/bootstrap\-osd\fP keyring from monitor host. These -authentication keys are used when new \fBmonitors/OSDs/MDS\fP are added to the -cluster. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy gatherkeys [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the monitor from where keys are to be pulled. -.SS disk -.sp -Manage disks on a remote host. It actually triggers the \fBceph\-disk\fP utility -and it\(aqs subcommands to manage disks. -.sp -Subcommand \fBlist\fP lists disk partitions and Ceph OSDs. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy disk list [HOST:[DISK]] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the node and [DISK] is disk name or path. -.sp -Subcommand \fBprepare\fP prepares a directory, disk or drive for a Ceph OSD. It -creates a GPT partition, marks the partition with Ceph type uuid, creates a -file system, marks the file system as ready for Ceph consumption, uses entire -partition and adds a new partition to the journal disk. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy disk prepare [HOST:[DISK]] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the node and [DISK] is disk name or path. -.sp -Subcommand \fBactivate\fP activates the Ceph OSD. It mounts the volume in a -temporary location, allocates an OSD id (if needed), remounts in the correct -location \fB/var/lib/ceph/osd/$cluster\-$id\fP and starts \fBceph\-osd\fP\&. It is -triggered by \fBudev\fP when it sees the OSD GPT partition type or on ceph service -start with \fBceph disk activate\-all\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy disk activate [HOST:[DISK]] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the node and [DISK] is disk name or path. -.sp -Subcommand \fBzap\fP zaps/erases/destroys a device\(aqs partition table and contents. -It actually uses \fBsgdisk\fP and it\(aqs option \fB\-\-zap\-all\fP to destroy both GPT and -MBR data structures so that the disk becomes suitable for repartitioning. -\fBsgdisk\fP then uses \fB\-\-mbrtogpt\fP to convert the MBR or BSD disklabel disk to a -GPT disk. The \fBprepare\fP subcommand can now be executed which will create a new -GPT partition. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy disk zap [HOST:[DISK]] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the node and [DISK] is disk name or path. -.SS osd -.sp -Manage OSDs by preparing data disk on remote host. \fBosd\fP makes use of certain -subcommands for managing OSDs. -.sp -Subcommand \fBprepare\fP prepares a directory, disk or drive for a Ceph OSD. It -first checks against multiple OSDs getting created and warns about the -possibility of more than the recommended which would cause issues with max -allowed PIDs in a system. It then reads the bootstrap\-osd key for the cluster or -writes the bootstrap key if not found. It then uses \fBceph\-disk\fP -utility\(aqs \fBprepare\fP subcommand to prepare the disk, journal and deploy the OSD -on the desired host. Once prepared, it gives some time to the OSD to settle and -checks for any possible errors and if found, reports to the user. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy osd prepare HOST:DISK[:JOURNAL] [HOST:DISK[:JOURNAL]...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBactivate\fP activates the OSD prepared using \fBprepare\fP subcommand. -It actually uses \fBceph\-disk\fP utility\(aqs \fBactivate\fP subcommand with -appropriate init type based on distro to activate the OSD. Once activated, it -gives some time to the OSD to start and checks for any possible errors and if -found, reports to the user. It checks the status of the prepared OSD, checks the -OSD tree and makes sure the OSDs are up and in. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy osd activate HOST:DISK[:JOURNAL] [HOST:DISK[:JOURNAL]...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcreate\fP uses \fBprepare\fP and \fBactivate\fP subcommands to create an -OSD. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy osd create HOST:DISK[:JOURNAL] [HOST:DISK[:JOURNAL]...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBlist\fP lists disk partitions, Ceph OSDs and prints OSD metadata. -It gets the osd tree from a monitor host, uses the \fBceph\-disk\-list\fP output -and gets the mount point by matching the line where the partition mentions -the OSD name, reads metadata from files, checks if a journal path exists, -if the OSD is in a OSD tree and prints the OSD metadata. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy osd list HOST:DISK[:JOURNAL] [HOST:DISK[:JOURNAL]...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SS admin -.sp -Push configuration and \fBclient.admin\fP key to a remote host. It takes -the \fB{cluster}.client.admin.keyring\fP from admin node and writes it under -\fB/etc/ceph\fP directory of desired node. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy admin [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is desired host to be configured for Ceph administration. -.SS config -.sp -Push/pull configuration file to/from a remote host. It uses \fBpush\fP subcommand -to takes the configuration file from admin host and write it to remote host under -\fB/etc/ceph\fP directory. It uses \fBpull\fP subcommand to do the opposite i.e, pull -the configuration file under \fB/etc/ceph\fP directory of remote host to admin node. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy push [HOST] [HOST...] - -ceph\-deploy pull [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is the hostname of the node where config file will be pushed to or -pulled from. -.SS uninstall -.sp -Remove Ceph packages from remote hosts. It detects the platform and distro of -selected host and uninstalls Ceph packages from it. However, some dependencies -like \fBlibrbd1\fP and \fBlibrados2\fP will not be removed because they can cause -issues with \fBqemu\-kvm\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy uninstall [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the node from where Ceph will be uninstalled. -.SS purge -.sp -Remove Ceph packages from remote hosts and purge all data. It detects the -platform and distro of selected host, uninstalls Ceph packages and purges all -data. However, some dependencies like \fBlibrbd1\fP and \fBlibrados2\fP will not be -removed because they can cause issues with \fBqemu\-kvm\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy purge [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the node from where Ceph will be purged. -.SS purgedata -.sp -Purge (delete, destroy, discard, shred) any Ceph data from \fB/var/lib/ceph\fP\&. -Once it detects the platform and distro of desired host, it first checks if Ceph -is still installed on the selected host and if installed, it won\(aqt purge data -from it. If Ceph is already uninstalled from the host, it tries to remove the -contents of \fB/var/lib/ceph\fP\&. If it fails then probably OSDs are still mounted -and needs to be unmounted to continue. It unmount the OSDs and tries to remove -the contents of \fB/var/lib/ceph\fP again and checks for errors. It also removes -contents of \fB/etc/ceph\fP\&. Once all steps are successfully completed, all the -Ceph data from the selected host are removed. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy purgedata [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is hostname of the node from where Ceph data will be purged. -.SS forgetkeys -.sp -Remove authentication keys from the local directory. It removes all the -authentication keys i.e, monitor keyring, client.admin keyring, bootstrap\-osd -and bootstrap\-mds keyring from the node. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy forgetkeys -.ft P -.fi -.UNINDENT -.UNINDENT -.SS pkg -.sp -Manage packages on remote hosts. It is used for installing or removing packages -from remote hosts. The package names for installation or removal are to be -specified after the command. Two options \fI\%--install\fP and -\fI\%--remove\fP are used for this purpose. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy pkg \-\-install [PKGs] [HOST] [HOST...] - -ceph\-deploy pkg \-\-remove [PKGs] [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [PKGs] is comma\-separated package names and [HOST] is hostname of the -remote node where packages are to be installed or removed from. -.SS calamari -.sp -Install and configure Calamari nodes. It first checks if distro is supported -for Calamari installation by ceph\-deploy. An argument \fBconnect\fP is used for -installation and configuration. It checks for \fBceph\-deploy\fP configuration -file (cd_conf) and Calamari release repo or \fBcalamari\-minion\fP repo. It relies -on default for repo installation as it doesn\(aqt install Ceph unless specified -otherwise. \fBoptions\fP dictionary is also defined because \fBceph\-deploy\fP -pops items internally which causes issues when those items are needed to be -available for every host. If the distro is Debian/Ubuntu, it is ensured that -proxy is disabled for \fBcalamari\-minion\fP repo. \fBcalamari\-minion\fP package is -then installed and custom repository files are added. minion config is placed -prior to installation so that it is present when the minion first starts. -config directory, calamari salt config are created and salt\-minion package -is installed. If the distro is Redhat/CentOS, the salt\-minion service needs to -be started. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-deploy calamari {connect} [HOST] [HOST...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [HOST] is the hostname where Calamari is to be installed. -.sp -An option \fB\-\-release\fP can be used to use a given release from repositories -defined in \fBceph\-deploy\fP\(aqs configuration. Defaults to \fBcalamari\-minion\fP\&. -.sp -Another option \fI\%--master\fP can also be used with this command. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-version -The current installed version of \fBceph\-deploy\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-username -The username to connect to the remote host. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-overwrite\-conf -Overwrite an existing conf file on remote host (if present). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cluster -Name of the cluster. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ceph\-conf -Use (or reuse) a given \fBceph.conf\fP file. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-no\-ssh\-copykey -Do not attempt to copy ssh keys. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fsid -Provide an alternate FSID for \fBceph.conf\fP generation. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cluster\-network -Specify the (internal) cluster network. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-public\-network -Specify the public network for a cluster. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-testing -Install the latest development release. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dev -Install a bleeding edge built from Git branch or tag (default: master). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-adjust\-repos -Install packages modifying source repos. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-no\-adjust\-repos -Install packages without modifying source repos. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-repo -Install repo files only (skips package installation). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-local\-mirror -Fetch packages and push them to hosts for a local repo mirror. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-repo\-url -Specify a repo url that mirrors/contains Ceph packages. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gpg\-url -Specify a GPG key url to be used with custom repos (defaults to ceph.com). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-address -IP address of the host node to be added to the cluster. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyrings -Concatenate multiple keyrings to be seeded on new monitors. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-zap\-disk -Destroy the partition table and content of a disk. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fs\-type -Filesystem to use to format disk \fB(xfs, btrfs or ext4)\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dmcrypt -Encrypt [data\-path] and/or journal devices with \fBdm\-crypt\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dmcrypt\-key\-dir -Directory where \fBdm\-crypt\fP keys are stored. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-install -Comma\-separated package(s) to install on remote hosts. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-remove -Comma\-separated package(s) to remove from remote hosts. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-master -The domain for the Calamari master server. -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-deploy\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the documentation at \fI\%http://ceph.com/ceph-deploy/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\-mon\fP(8), -\fBceph\-osd\fP(8), -\fBceph\-disk\fP(8), -\fBceph\-mds\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-disk.8 b/man/ceph-disk.8 deleted file mode 100644 index 41a5139f6a0e8..0000000000000 --- a/man/ceph-disk.8 +++ /dev/null @@ -1,400 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-DISK" "8" "December 18, 2014" "dev" "Ceph" -.SH NAME -ceph-disk \- Ceph disk preparation and activation utility for OSD -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-disk\fP \fBprepare\fP [\-\-cluster \fIclustername\fP] [\-\-cluster\-uuid \fIuuid\fP] -[\-\-fs\-type \fIxfs|ext4|btrfs\fP] [\fIdata\-path\fP] [\fIjournal\-path\fP] -.fi -.sp -.nf -\fBceph\-disk\fP \fBactivate\fP [\fIdata\-path\fP] [\-\-activate\-key \fIpath\fP] -.fi -.sp -.nf -\fBceph\-disk\fP \fBactivate\-all\fP -.fi -.sp -.nf -\fBceph\-disk\fP \fBlist\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-disk\fP is a utility that can prepare and activate a disk, partition or -directory as a Ceph OSD. It is run directly or triggered by \fBceph\-deploy\fP -or \fBudev\fP\&. It can also be triggered by other deployment utilities like \fBChef\fP, -\fBJuju\fP, \fBPuppet\fP etc. -.sp -It actually automates the multiple steps involved in manual creation and start -of an OSD into two steps of preparing and activating the OSD by using the -subcommands \fBprepare\fP and \fBactivate\fP\&. -.SH SUBCOMMANDS -.SS prepare -.sp -Prepare a directory, disk or drive for a Ceph OSD. It creates a GPT partition, -marks the partition with Ceph type \fBuuid\fP, creates a file system, marks the -file system as ready for Ceph consumption, uses entire partition and adds a new -partition to the journal disk. It is run directly or triggered by -\fBceph\-deploy\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk prepare \-\-cluster [cluster\-name] \-\-cluster\-uuid [uuid] \-\-fs\-type -[ext4|xfs|btrfs] [data\-path] [journal\-path] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other options like \fI\%--osd-uuid\fP, \fI\%--journal-uuid\fP, -\fI\%--zap-disk\fP, \fI\%--data-dir\fP, \fI\%--data-dev\fP, -\fI\%--journal-file\fP, \fI\%--journal-dev\fP, \fI\%--dmcrypt\fP -and \fI\%--dmcrypt-key-dir\fP can also be used with the subcommand. -.SS activate -.sp -Activate the Ceph OSD. It mounts the volume in a temporary location, allocates -an OSD id (if needed), remounts in the correct location -\fB/var/lib/ceph/osd/$cluster\-$id\fP and starts ceph\-osd. It is triggered by -\fBudev\fP when it sees the OSD GPT partition type or on ceph service start with -\fBceph disk activate\-all\fP\&. It is also run directly or triggered by -\fBceph\-deploy\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk activate [PATH] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [PATH] is path to a block device or a directory. -.sp -An additional option \fI\%--activate-key\fP has to be used with this -subcommand when a copy of \fB/var/lib/ceph/bootstrap\-osd/{cluster}.keyring\fP -isn\(aqt present in the OSD node. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk activate [PATH] [\-\-activate\-key PATH] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Another option \fI\%--mark-init\fP can also be used with this subcommand. -\fB\-\-mark\-init\fP provides init system to manage the OSD directory. -.SS activate\-journal -.sp -Activate an OSD via it\(aqs journal device. \fBudev\fP triggers -\fBceph\-disk activate\-journal \fP based on the partition type. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk activate\-journal [DEV] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [DEV] is the path to a journal block device. -.sp -Others options like \fI\%--activate-key\fP and \fI\%--mark-init\fP can also -be used with this subcommand. -.sp -\fB\-\-mark\-init\fP provides init system to manage the OSD directory. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk activate\-journal [\-\-activate\-key PATH] [\-\-mark\-init INITSYSTEM] [DEV] -.ft P -.fi -.UNINDENT -.UNINDENT -.SS activate\-all -.sp -Activate all tagged OSD partitions. \fBactivate\-all\fP relies on -\fB/dev/disk/by\-parttype\-uuid/$typeuuid.$uuid\fP to find all partitions. Special -\fBudev\fP rules are installed to create these links. It is triggered on ceph -service start or run directly. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk activate\-all -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Others options like \fI\%--activate-key\fP and \fI\%--mark-init\fP can -also be used with this subcommand. -.sp -\fB\-\-mark\-init\fP provides init system to manage the OSD directory. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk activate\-all [\-\-activate\-key PATH] [\-\-mark\-init INITSYSTEM] -.ft P -.fi -.UNINDENT -.UNINDENT -.SS list -.sp -List disk partitions and Ceph OSDs. It is run directly or triggered by -\fBceph\-deploy\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk list -.ft P -.fi -.UNINDENT -.UNINDENT -.SS suppress\-activate -.sp -Suppress activate on a device (prefix). Mark devices that you don\(aqt want to -activate with a file like \fB/var/lib/ceph/tmp/suppress\-activate.sdb\fP where the -last bit is the sanitized device name (/dev/X without the /dev/ prefix). A -function \fBis_suppressed()\fP checks for and matches a prefix (/dev/). It means -suppressing sdb will stop activate on sdb1, sdb2, etc. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk suppress\-activate [PATH] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [PATH] is path to a block device or a directory. -.SS unsuppress\-activate -.sp -Stop suppressing activate on a device (prefix). It is used to activate a device -that was earlier kept deactivated using \fBsuppress\-activate\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk unsuppress\-activate [PATH] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [PATH] is path to a block device or a directory. -.SS zap -.sp -Zap/erase/destroy a device\(aqs partition table and contents. It actually uses -\fBsgdisk\fP and it\(aqs option \fB\-\-zap\-all\fP to destroy both GPT and MBR data -structures so that the disk becomes suitable for repartitioning. \fBsgdisk\fP -then uses \fB\-\-mbrtogpt\fP to convert the MBR or BSD disklabel disk to a GPT -disk. The \fBprepare\fP subcommand can now be executed which will create a new -GPT partition. It is also run directly or triggered by \fBceph\-deploy\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-disk zap [DEV] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, [DEV] is path to a block device. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-prepend\-to\-path PATH -Prepend PATH to $PATH for backward compatibility (default \fB/usr/bin\fP). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-statedir PATH -Directory in which ceph configuration is preserved (default \fB/usr/lib/ceph\fP). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sysconfdir PATH -Directory in which ceph configuration files are found (default \fB/etc/ceph\fP). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cluster -Provide name of the ceph cluster in which the OSD is being prepared. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cluster\-uuid -Provide uuid of the ceph cluster in which the OSD is being prepared. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fs\-type -Provide the filesytem type for the OSD. e.g. \fBxfs/ext4/btrfs\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-osd\-uuid -Unique OSD uuid to assign to the disk. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-journal\-uuid -Unique uuid to assign to the journal. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-zap\-disk -Destroy the partition table and content of a disk. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-data\-dir -Verify that \fB[data\-path]\fP is of a directory. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-data\-dev -Verify that \fB[data\-path]\fP is of a block device. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-journal\-file -Verify that journal is a file. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-journal\-dev -Verify that journal is a block device. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dmcrypt -Encrypt \fB[data\-path]\fP and/or journal devices with \fBdm\-crypt\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dmcrypt\-key\-dir -Directory where \fBdm\-crypt\fP keys are stored. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-activate\-key -Use when a copy of \fB/var/lib/ceph/bootstrap\-osd/{cluster}.keyring\fP isn\(aqt -present in the OSD node. Suffix the option by the path to the keyring. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-mark\-init -Provide init system to manage the OSD directory. -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-disk\fP is a part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\-osd\fP(8), -\fBceph\-deploy\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-fuse.8 b/man/ceph-fuse.8 deleted file mode 100644 index 60bc7d259c4d6..0000000000000 --- a/man/ceph-fuse.8 +++ /dev/null @@ -1,120 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-FUSE" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-fuse \- FUSE-based client for ceph -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-fuse\fP [ \-m \fImonaddr\fP:\fIport\fP ] \fImountpoint\fP [ \fIfuse options\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-fuse\fP is a FUSE (File system in USErspace) client for Ceph -distributed file system. It will mount a ceph file system (specified -via the \-m option for described by ceph.conf (see below) at the -specific mount point. -.sp -The file system can be unmounted with: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -fusermount \-u mountpoint -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or by sending \fBSIGINT\fP to the \fBceph\-fuse\fP process. -.SH OPTIONS -.sp -Any options not recognized by ceph\-fuse will be passed on to libfuse. -.INDENT 0.0 -.TP -.B \-d -Detach from console and daemonize after startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fIceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through ceph.conf). -.UNINDENT -.INDENT 0.0 -.TP -.B \-r root_directory -Use root_directory as the mounted root, rather than the full Ceph tree. -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-fuse\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -fusermount(8), -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-mds.8 b/man/ceph-mds.8 deleted file mode 100644 index 3667a1b75c10f..0000000000000 --- a/man/ceph-mds.8 +++ /dev/null @@ -1,121 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-MDS" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-mds \- ceph metadata server daemon -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-mds\fP \-i \fIname\fP [[ \-\-hot\-standby [\fIrank\fP] ]|[\-\-journal_check \fIrank\fP]] -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-mds\fP is the metadata server daemon for the Ceph distributed file -system. One or more instances of ceph\-mds collectively manage the file -system namespace, coordinating access to the shared OSD cluster. -.sp -Each ceph\-mds daemon instance should have a unique name. The name is used -to identify daemon instances in the ceph.conf. -.sp -Once the daemon has started, the monitor cluster will normally assign -it a logical rank, or put it in a standby pool to take over for -another daemon that crashes. Some of the specified options can cause -other behaviors. -.sp -If you specify hot\-standby or journal\-check, you must either specify -the rank on the command line, or specify one of the -mds_standby_for_[rank|name] parameters in the config. The command -line specification overrides the config, and specifying the rank -overrides specifying the name. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-f, \-\-foreground -Foreground: do not daemonize after startup (run in foreground). Do -not generate a pid file. Useful when run via \fBceph\-run\fP(8). -.UNINDENT -.INDENT 0.0 -.TP -.B \-d -Debug mode: like \fB\-f\fP, but also send all log output to stderr. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fIceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during -startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through -\fBceph.conf\fP). -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-mon\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at -\fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBceph\-mon\fP(8), -\fBceph\-osd\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-mon.8 b/man/ceph-mon.8 deleted file mode 100644 index 6474f767b9ab9..0000000000000 --- a/man/ceph-mon.8 +++ /dev/null @@ -1,137 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-MON" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-mon \- ceph monitor daemon -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-mon\fP \-i \fImonid\fP [ \-\-mon\-data \fImondatapath\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-mon\fP is the cluster monitor daemon for the Ceph distributed -file system. One or more instances of \fBceph\-mon\fP form a Paxos -part\-time parliament cluster that provides extremely reliable and -durable storage of cluster membership, configuration, and state. -.sp -The \fImondatapath\fP refers to a directory on a local file system storing -monitor data. It is normally specified via the \fBmon data\fP option in -the configuration file. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-f, \-\-foreground -Foreground: do not daemonize after startup (run in foreground). Do -not generate a pid file. Useful when run via \fBceph\-run\fP(8). -.UNINDENT -.INDENT 0.0 -.TP -.B \-d -Debug mode: like \fB\-f\fP, but also send all log output to stderr. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fIceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during -startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-mkfs -Initialize the \fBmon data\fP directory with seed information to form -and initial ceph file system or to join an existing monitor -cluster. Three pieces of information must be provided: -.INDENT 7.0 -.IP \(bu 2 -The cluster fsid. This can come from a monmap (\fB\-\-monmap \fP) or -explicitly via \fB\-\-fsid \fP\&. -.IP \(bu 2 -A list of monitors and their addresses. This list of monitors -can come from a monmap (\fB\-\-monmap \fP), the \fBmon host\fP -configuration value (in \fIceph.conf\fP or via \fB\-m -host1,host2,...\fP), or \fBmon addr\fP lines in \fIceph.conf\fP\&. If this -monitor is to be part of the initial monitor quorum for a new -Ceph cluster, then it must be included in the initial list, -matching either the name or address of a monitor in the list. -When matching by address, either the \fBpublic addr\fP or \fBpublic -subnet\fP options may be used. -.IP \(bu 2 -The monitor secret key \fBmon.\fP\&. This must be included in the -keyring provided via \fB\-\-keyring \fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyring -Specify a keyring for use with \fB\-\-mkfs\fP\&. -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-mon\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer -to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBceph\-mds\fP(8), -\fBceph\-osd\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-osd.8 b/man/ceph-osd.8 deleted file mode 100644 index 4e953de4b3948..0000000000000 --- a/man/ceph-osd.8 +++ /dev/null @@ -1,169 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-OSD" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-osd \- ceph object storage daemon -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-osd\fP \-i \fIosdnum\fP [ \-\-osd\-data \fIdatapath\fP ] [ \-\-osd\-journal -\fIjournal\fP ] [ \-\-mkfs ] [ \-\-mkjournal ] [ \-\-mkkey ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-osd\fP is the object storage daemon for the Ceph distributed file -system. It is responsible for storing objects on a local file system -and providing access to them over the network. -.sp -The datapath argument should be a directory on a btrfs file system -where the object data resides. The journal is optional, and is only -useful performance\-wise when it resides on a different disk than -datapath with low latency (ideally, an NVRAM device). -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-f, \-\-foreground -Foreground: do not daemonize after startup (run in foreground). Do -not generate a pid file. Useful when run via \fBceph\-run\fP(8). -.UNINDENT -.INDENT 0.0 -.TP -.B \-d -Debug mode: like \fB\-f\fP, but also send all log output to stderr. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-osd\-data osddata -Use object store at \fIosddata\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-osd\-journal journal -Journal updates to \fIjournal\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-mkfs -Create an empty object repository. This also initializes the journal -(if one is defined). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-mkkey -Generate a new secret key. This is normally used in combination -with \fB\-\-mkfs\fP as it is more convenient than generating a key by -hand with \fBceph\-authtool\fP(8). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-mkjournal -Create a new journal file to match an existing object repository. -This is useful if the journal device or file is wiped out due to a -disk or file system failure. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-flush\-journal -Flush the journal to permanent store. This runs in the foreground -so you know when it\(aqs completed. This can be useful if you want to -resize the journal or need to otherwise destroy it: this guarantees -you won\(aqt lose data. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-get\-cluster\-fsid -Print the cluster fsid (uuid) and exit. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-get\-osd\-fsid -Print the OSD\(aqs fsid and exit. The OSD\(aqs uuid is generated at -\-\-mkfs time and is thus unique to a particular instantiation of -this OSD. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-get\-journal\-fsid -Print the journal\(aqs uuid. The journal fsid is set to match the OSD -fsid at \-\-mkfs time. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fIceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP for runtime configuration options. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through -\fBceph.conf\fP). -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-osd\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBceph\-mds\fP(8), -\fBceph\-mon\fP(8), -\fBceph\-authtool\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-post-file.8 b/man/ceph-post-file.8 deleted file mode 100644 index b3ecb20558bd1..0000000000000 --- a/man/ceph-post-file.8 +++ /dev/null @@ -1,130 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-POST-FILE" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-post-file \- post files for ceph developers -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-post\-file\fP [\-d \fIdescription] [\-u *user\fP] \fIfile or dir\fP ... -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-post\-file\fP will upload files or directories to ceph.com for -later analysis by Ceph developers. -.sp -Each invocation uploads files or directories to a separate directory -with a unique tag. That tag can be passed to a developer or -referenced in a bug report (\fI\%http://tracker.ceph.com/\fP). Once the -upload completes, the directory is marked non\-readable and -non\-writeable to prevent access or modification by other users. -.SH WARNING -.sp -Basic measures are taken to make posted data be visible only to -developers with access to ceph.com infrastructure. However, users -should think twice and/or take appropriate precautions before -posting potentially sensitive data (for example, logs or data -directories that contain Ceph secrets). -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-d *description*, \-\-description *description* -Add a short description for the upload. This is a good opportunity -to reference a bug number. There is no default value. -.UNINDENT -.INDENT 0.0 -.TP -.B \-u *user* -Set the user metadata for the upload. This defaults to \fIwhoami\(ga@\(gahostname \-f\fP\&. -.UNINDENT -.SH EXAMPLES -.sp -To upload a single log: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-post\-file /var/log/ceph/ceph\-mon.\(gahostname\(ga.log -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To upload several directories: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-post\-file \-d \(aqmon data directories\(aq /var/log/ceph/mon/* -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-post\-file\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBceph\-debugpack\fP(8), -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-rbdnamer.8 b/man/ceph-rbdnamer.8 deleted file mode 100644 index d6f7fd4556f1a..0000000000000 --- a/man/ceph-rbdnamer.8 +++ /dev/null @@ -1,92 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-RBDNAMER" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-rbdnamer \- udev helper to name RBD devices -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-rbdnamer\fP \fInum\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-rbdnamer\fP prints the pool and image name for the given RBD devices -to stdout. It is used by \fIudev\fP (using a rule like the one below) to -set up a device symlink. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -KERNEL=="rbd[0\-9]*", PROGRAM="/usr/bin/ceph\-rbdnamer %n", SYMLINK+="rbd/%c{1}/%c{2}" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-rbdnamer\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBrbd\fP(8), -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-rest-api.8 b/man/ceph-rest-api.8 deleted file mode 100644 index 41120c8412a65..0000000000000 --- a/man/ceph-rest-api.8 +++ /dev/null @@ -1,208 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-REST-API" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-rest-api \- ceph RESTlike administration server -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-rest\-api\fP [ \-c \fIconffile\fP ] [\-\-cluster \fIclustername\fP ] [ \-n \fIname\fP ] [\-i \fIid\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-rest\-api\fP is a WSGI application that can run as a -standalone web service or run under a web server that supports -WSGI. It provides much of the functionality of the \fBceph\fP -command\-line tool through an HTTP\-accessible interface. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-c/\-\-conf conffile -names the ceph.conf file to use for configuration. If \-c is not -specified, the default depends on the state of the \-\-cluster option -(default \(aqceph\(aq; see below). The configuration file is searched -for in this order: -.INDENT 7.0 -.IP \(bu 2 -$CEPH_CONF -.IP \(bu 2 -/etc/ceph/${cluster}.conf -.IP \(bu 2 -~/.ceph/${cluster}.conf -.IP \(bu 2 -${cluster}.conf (in the current directory) -.UNINDENT -.sp -so you can also pass this option in the environment as CEPH_CONF. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cluster clustername -set \fIclustername\fP for use in the $cluster metavariable, for -locating the ceph.conf file. The default is \(aqceph\(aq. -.UNINDENT -.INDENT 0.0 -.TP -.B \-n/\-\-name name -specifies the client \(aqname\(aq, which is used to find the -client\-specific configuration options in the config file, and -also is the name used for authentication when connecting -to the cluster (the entity name appearing in ceph auth list output, -for example). The default is \(aqclient.restapi\(aq. -.UNINDENT -.INDENT 0.0 -.TP -.B \-i/\-\-id id -specifies the client \(aqid\(aq, which will form the clientname -as \(aqclient.\(aq if clientname is not set. If \-n/\-name is -set, that takes precedence. -.sp -Also, global Ceph options are supported. -.UNINDENT -.SH CONFIGURATION PARAMETERS -.sp -Supported configuration parameters include: -.INDENT 0.0 -.IP \(bu 2 -\fBkeyring\fP the keyring file holding the key for \(aqclientname\(aq -.IP \(bu 2 -\fBpublic addr\fP ip:port to listen on (default 0.0.0.0:5000) -.IP \(bu 2 -\fBlog file\fP (usual Ceph default) -.IP \(bu 2 -\fBrestapi base url\fP the base URL to answer requests on (default /api/v0.1) -.IP \(bu 2 -\fBrestapi log level\fP critical, error, warning, info, debug (default warning) -.UNINDENT -.sp -Configuration parameters are searched in the standard order: -first in the section named \(aq\(aq, then \(aqclient\(aq, then \(aqglobal\(aq. -.sp - is either supplied by \-n/\-\-name, "client." where - is supplied by \-i/\-\-id, or \(aqclient.restapi\(aq if neither option -is present. -.sp -A single\-threaded server will run on \fBpublic addr\fP if the ceph\-rest\-api -executed directly; otherwise, configuration is specified by the enclosing -WSGI web server. -.SH COMMANDS -.sp -Commands are submitted with HTTP GET requests (for commands that -primarily return data) or PUT (for commands that affect cluster state). -HEAD and OPTIONS are also supported. Standard HTTP status codes -are returned. -.sp -For commands that return bulk data, the request can include -Accept: application/json or Accept: application/xml to select the -desired structured output, or you may use a .json or .xml addition -to the requested PATH. Parameters are supplied as query parameters -in the request; for parameters that take more than one value, repeat -the key=val construct. For instance, to remove OSDs 2 and 3, -send a PUT request to \fBosd/rm?ids=2&ids=3\fP\&. -.SH DISCOVERY -.sp -Human\-readable discovery of supported commands and parameters, along -with a small description of each command, is provided when the requested -path is incomplete/partially matching. Requesting / will redirect to -the value of \fBrestapi base url\fP, and that path will give a full list -of all known commands. -For example, requesting \fBapi/vX.X/mon\fP will return the list of API calls for -monitors \- \fBapi/vX.X/osd\fP will return the list of API calls for OSD and so on. -.sp -The command set is very similar to the commands -supported by the \fBceph\fP tool. One notable exception is that the -\fBceph pg \fP style of commands is supported here -as \fBtell//command?args\fP\&. -.SH DEPLOYMENT AS WSGI APPLICATION -.sp -When deploying as WSGI application (say, with Apache/mod_wsgi, -or nginx/uwsgi, or gunicorn, etc.), use the \fBceph_rest_api.py\fP module -(\fBceph\-rest\-api\fP is a thin layer around this module). The standalone web -server is of course not used, so address/port configuration is done in -the WSGI server. Use a python .wsgi module or the equivalent to call -\fBapp = generate_app(conf, cluster, clientname, clientid, args)\fP where: -.INDENT 0.0 -.IP \(bu 2 -conf is as \-c/\-\-conf above -.IP \(bu 2 -cluster is as \-\-cluster above -.IP \(bu 2 -clientname, \-n/\-\-name -.IP \(bu 2 -clientid, \-i/\-\-id, and -.IP \(bu 2 -args are any other generic Ceph arguments -.UNINDENT -.sp -When app is returned, it will have attributes \(aqceph_addr\(aq and \(aqceph_port\(aq -set to what the address and port are in the Ceph configuration; -those may be used for the server, or ignored. -.sp -Any errors reading configuration or connecting to the cluster cause an -exception to be raised; see your WSGI server documentation for how to -see those messages in case of problem. -.SH AVAILABILITY -.sp -\fBceph\-rest\-api\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at -\fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-run.8 b/man/ceph-run.8 deleted file mode 100644 index dab4d125f0aa0..0000000000000 --- a/man/ceph-run.8 +++ /dev/null @@ -1,89 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-RUN" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-run \- restart daemon on core dump -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-run\fP \fIcommand\fP ... -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-run\fP is a simple wrapper that will restart a daemon if it exits -with a signal indicating it crashed and possibly core dumped (that is, -signals 3, 4, 5, 6, 8, or 11). -.sp -The command should run the daemon in the foreground. For Ceph daemons, -that means the \fB\-f\fP option. -.SH OPTIONS -.sp -None -.SH AVAILABILITY -.sp -\fBceph\-run\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBceph\-mon\fP(8), -\fBceph\-mds\fP(8), -\fBceph\-osd\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph-syn.8 b/man/ceph-syn.8 deleted file mode 100644 index 92aeb5a63852d..0000000000000 --- a/man/ceph-syn.8 +++ /dev/null @@ -1,148 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH-SYN" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -ceph-syn \- ceph synthetic workload generator -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\-syn\fP [ \-m \fImonaddr\fP:\fIport\fP ] \-\-syn \fIcommand\fP \fI\&...\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\-syn\fP is a simple synthetic workload generator for the Ceph -distributed file system. It uses the userspace client library to -generate simple workloads against a currently running file system. The -file system need not be mounted via ceph\-fuse(8) or the kernel client. -.sp -One or more \fB\-\-syn\fP command arguments specify the particular -workload, as documented below. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-d -Detach from console and daemonize after startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fIceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during -startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through -\fBceph.conf\fP). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-num_client num -Run num different clients, each in a separate thread. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syn workloadspec -Run the given workload. May be specified as many times as -needed. Workloads will normally run sequentially. -.UNINDENT -.SH WORKLOADS -.sp -Each workload should be preceded by \fB\-\-syn\fP on the command -line. This is not a complete list. -.INDENT 0.0 -.TP -.B \fBmknap\fP \fIpath\fP \fIsnapname\fP -Create a snapshot called \fIsnapname\fP on \fIpath\fP\&. -.TP -.B \fBrmsnap\fP \fIpath\fP \fIsnapname\fP -Delete snapshot called \fIsnapname\fP on \fIpath\fP\&. -.TP -.B \fBrmfile\fP \fIpath\fP -Delete/unlink \fIpath\fP\&. -.TP -.B \fBwritefile\fP \fIsizeinmb\fP \fIblocksize\fP -Create a file, named after our client id, that is \fIsizeinmb\fP MB by -writing \fIblocksize\fP chunks. -.TP -.B \fBreadfile\fP \fIsizeinmb\fP \fIblocksize\fP -Read file, named after our client id, that is \fIsizeinmb\fP MB by -writing \fIblocksize\fP chunks. -.TP -.B \fBrw\fP \fIsizeinmb\fP \fIblocksize\fP -Write file, then read it back, as above. -.TP -.B \fBmakedirs\fP \fInumsubdirs\fP \fInumfiles\fP \fIdepth\fP -Create a hierarchy of directories that is \fIdepth\fP levels deep. Give -each directory \fInumsubdirs\fP subdirectories and \fInumfiles\fP files. -.TP -.B \fBwalk\fP -Recursively walk the file system (like find). -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\-syn\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBceph\-fuse\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/ceph.8 b/man/ceph.8 deleted file mode 100644 index 0ec9d53858338..0000000000000 --- a/man/ceph.8 +++ /dev/null @@ -1,2800 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPH" "8" "March 22, 2015" "dev" "Ceph" -.SH NAME -ceph \- ceph administration tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBceph\fP \fBauth\fP [ \fIadd\fP | \fIcaps\fP | \fIdel\fP | \fIexport\fP | \fIget\fP | \fIget\-key\fP | \fIget\-or\-create\fP | \fIget\-or\-create\-key\fP | \fIimport\fP | \fIlist\fP | \fIprint\-key\fP | \fIprint_key\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBcompact\fP -.fi -.sp -.nf -\fBceph\fP \fBconfig\-key\fP [ \fIdel\fP | \fIexists\fP | \fIget\fP | \fIlist\fP | \fIput\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBdf\fP \fI{detail}\fP -.fi -.sp -.nf -\fBceph\fP \fBfs\fP [ \fIls\fP | \fInew\fP | \fIreset\fP | \fIrm\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBfsid\fP -.fi -.sp -.nf -\fBceph\fP \fBhealth\fP \fI{detail}\fP -.fi -.sp -.nf -\fBceph\fP \fBheap\fP [ \fIdump\fP | \fIstart_profiler\fP | \fIstop_profiler\fP | \fIrelease\fP | \fIstats\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBinjectargs\fP \fI\fP [ \fI\fP\&... ] -.fi -.sp -.nf -\fBceph\fP \fBlog\fP \fI\fP [ \fI\fP\&... ] -.fi -.sp -.nf -\fBceph\fP \fBmds\fP [ \fIadd_data_pool\fP | \fIcluster_down\fP | \fIcluster_up\fP | \fIcompat\fP | \fIdeactivate\fP | \fIdump\fP | \fIfail\fP | \fIgetmap\fP | \fInewfs\fP | \fIremove_data_pool\fP | \fIrm\fP | \fIrmfailed\fP | \fIset\fP | \fIset_max_mds\fP | \fIset_state\fP | \fIsetmap\fP | \fIstat\fP | \fIstop\fP | \fItell\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBmon\fP [ \fIadd\fP | \fIdump\fP | \fIgetmap\fP | \fIremove\fP | \fIstat\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBmon_status\fP -.fi -.sp -.nf -\fBceph\fP \fBosd\fP [ \fIblacklist\fP | \fIblocked\-by\fP | \fIcreate\fP | \fIdeep\-scrub\fP | \fIdf\fP | \fIdown\fP | \fIdump\fP | \fIerasure\-code\-profile\fP | \fIfind\fP | \fIgetcrushmap\fP | \fIgetmap\fP | \fIgetmaxosd\fP | \fIin\fP | \fIlspools\fP | \fImap\fP | \fImetadata\fP | \fIout\fP | \fIpause\fP | \fIperf\fP | \fIpg\-temp\fP | \fIprimary\-affinity\fP | \fIprimary\-temp\fP | \fIrepair\fP | \fIreweight\fP | \fIreweight\-by\-pg\fP | \fIrm\fP | \fIscrub\fP | \fIset\fP | \fIsetcrushmap\fP | \fIsetmaxosd\fP | \fIstat\fP | \fIthrash\fP | \fItree\fP | \fIunpause\fP | \fIunset\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBosd\fP \fBcrush\fP [ \fIadd\fP | \fIadd\-bucket\fP | \fIcreate\-or\-move\fP | \fIdump\fP | \fIget\-tunable\fP | \fIlink\fP | \fImove\fP | \fIremove\fP | \fIrename\-bucket\fP | \fIreweight\fP | \fIreweight\-all\fP | \fIreweight\-subtree\fP | \fIrm\fP | \fIrule\fP | \fIset\fP | \fIset\-tunable\fP | \fIshow\-tunables\fP | \fItunables\fP | \fIunlink\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBosd\fP \fBpool\fP [ \fIcreate\fP | \fIdelete\fP | \fIget\fP | \fIget\-quota\fP | \fIls\fP | \fImksnap\fP | \fIrename\fP | \fIrmsnap\fP | \fIset\fP | \fIset\-quota\fP | \fIstats\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBosd\fP \fBtier\fP [ \fIadd\fP | \fIadd\-cache\fP | \fIcache\-mode\fP | \fIremove\fP | \fIremove\-overlay\fP | \fIset\-overlay\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBpg\fP [ \fIdebug\fP | \fIdeep\-scrub\fP | \fIdump\fP | \fIdump_json\fP | \fIdump_pools_json\fP | \fIdump_stuck\fP | \fIforce_create_pg\fP | \fIgetmap\fP | \fIls\fP | \fIls\-by\-osd\fP | \fIls\-by\-pool\fP | \fIls\-by\-primary\fP | \fImap\fP | \fIrepair\fP | \fIscrub\fP | \fIsend_pg_creates\fP | \fIset_full_ratio\fP | \fIset_nearfull_ratio\fP | \fIstat\fP ] ... -.fi -.sp -.nf -\fBceph\fP \fBquorum\fP [ \fIenter\fP | \fIexit\fP ] -.fi -.sp -.nf -\fBceph\fP \fBquorum_status\fP -.fi -.sp -.nf -\fBceph\fP \fBreport\fP { \fI\fP [ \fI...\fP ] } -.fi -.sp -.nf -\fBceph\fP \fBscrub\fP -.fi -.sp -.nf -\fBceph\fP \fBstatus\fP -.fi -.sp -.nf -\fBceph\fP \fBsync\fP \fBforce\fP {\-\-yes\-i\-really\-mean\-it} {\-\-i\-know\-what\-i\-am\-doing} -.fi -.sp -.nf -\fBceph\fP \fBtell\fP \fI [...]\fP -.fi -.sp -.nf -\fBceph\fP \fBversion\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBceph\fP is a control utility which is used for manual deployment and maintenance -of a Ceph cluster. It provides a diverse set of commands that allows deployment of -monitors, OSDs, placement groups, MDS and overall maintenance, administration -of the cluster. -.SH COMMANDS -.SS auth -.sp -Manage authentication keys. It is used for adding, removing, exporting -or updating of authentication keys for a particular entity such as a monitor or -OSD. It uses some additional subcommands. -.sp -Subcommand \fBadd\fP adds authentication info for a particular entity from input -file, or random key if no input is given and/or any caps specified in the command. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth add { [...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcaps\fP updates caps for \fBname\fP from caps specified in the command. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth caps [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdel\fP deletes all caps for \fBname\fP\&. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth del -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBexport\fP writes keyring for requested entity, or master keyring if -none given. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth export {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\fP writes keyring file with requested key. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth get -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\-key\fP displays requested key. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth get\-key -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\-or\-create\fP adds authentication info for a particular entity -from input file, or random key if no input given and/or any caps specified in the -command. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth get\-or\-create { [...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\-or\-create\-key\fP gets or adds key for \fBname\fP from system/caps -pairs specified in the command. If key already exists, any given caps must match -the existing caps for that key. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth get\-or\-create\-key { [...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBimport\fP reads keyring from input file. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth import -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBlist\fP lists authentication state. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBprint\-key\fP displays requested key. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth print\-key -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBprint_key\fP displays requested key. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth print_key -.ft P -.fi -.UNINDENT -.UNINDENT -.SS compact -.sp -Causes compaction of monitor\(aqs leveldb storage. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph compact -.ft P -.fi -.UNINDENT -.UNINDENT -.SS config\-key -.sp -Manage configuration key. It uses some additional subcommands. -.sp -Subcommand \fBdel\fP deletes configuration key. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph config\-key del -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBexists\fP checks for configuration keys existence. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph config\-key exists -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\fP gets the configuration key. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph config\-key get -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBlist\fP lists configuration keys. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph config\-key list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBput\fP puts configuration key and values. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph config\-key put {} -.ft P -.fi -.UNINDENT -.UNINDENT -.SS df -.sp -Show cluster\(aqs free space status. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph df {detail} -.ft P -.fi -.UNINDENT -.UNINDENT -.SS fs -.sp -Manage cephfs filesystems. It uses some additional subcommands. -.sp -Subcommand \fBls\fP to list filesystems -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph fs ls -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBnew\fP to make a new filesystem using named pools and -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph fs new -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBreset\fP is used for disaster recovery only: reset to a single\-MDS map -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph fs reset {\-\-yes\-i\-really\-mean\-it} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm\fP to disable the named filesystem -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph fs rm {\-\-yes\-i\-really\-mean\-it} -.ft P -.fi -.UNINDENT -.UNINDENT -.SS fsid -.sp -Show cluster\(aqs FSID/UUID. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph fsid -.ft P -.fi -.UNINDENT -.UNINDENT -.SS health -.sp -Show cluster\(aqs health. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph health {detail} -.ft P -.fi -.UNINDENT -.UNINDENT -.SS heap -.sp -Show heap usage info (available only if compiled with tcmalloc) -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph heap dump|start_profiler|stop_profiler|release|stats -.ft P -.fi -.UNINDENT -.UNINDENT -.SS injectargs -.sp -Inject configuration arguments into monitor. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph injectargs [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SS log -.sp -Log supplied text to the monitor log. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph log [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SS mds -.sp -Manage metadata server configuration and administration. It uses some -additional subcommands. -.sp -Subcommand \fBadd_data_pool\fP adds data pool. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds add_data_pool -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcluster_down\fP takes mds cluster down. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds cluster_down -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcluster_up\fP brings mds cluster up. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds cluster_up -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcompat\fP manages compatible features. It uses some additional -subcommands. -.sp -Subcommand \fBrm_compat\fP removes compatible feature. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds compat rm_compat -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm_incompat\fP removes incompatible feature. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds compat rm_incompat -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBshow\fP shows mds compatibility settings. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds compat show -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdeactivate\fP stops mds. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds deactivate -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump\fP dumps information, optionally from epoch. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds dump {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBfail\fP forces mds to status fail. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds fail -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBgetmap\fP gets MDS map, optionally from epoch. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds getmap {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBnewfs\fP makes new filesystem using pools and . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds newfs {\-\-yes\-i\-really\-mean\-it} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBremove_data_pool\fP removes data pool. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds remove_data_pool -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm\fP removes inactive mds. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds rm (type.id)> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrmfailed\fP removes failed mds. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds rmfailed -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\fP set mds parameter to -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds set max_mds|max_file_size|allow_new_snaps|inline_data {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset_max_mds\fP sets max MDS index. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds set_max_mds -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset_state\fP sets mds state of to . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds set_state -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBsetmap\fP sets mds map; must supply correct epoch number. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds setmap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBstat\fP shows MDS status. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds stat -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBstop\fP stops mds. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds stop -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBtell\fP sends command to particular mds. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mds tell [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SS mon -.sp -Manage monitor configuration and administration. It uses some additional -subcommands. -.sp -Subcommand \fBadd\fP adds new monitor named at . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mon add -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump\fP dumps formatted monmap (optionally from epoch) -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mon dump {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBgetmap\fP gets monmap. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mon getmap {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBremove\fP removes monitor named . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mon remove -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBstat\fP summarizes monitor status. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mon stat -.ft P -.fi -.UNINDENT -.UNINDENT -.SS mon_status -.sp -Reports status of monitors. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph mon_status -.ft P -.fi -.UNINDENT -.UNINDENT -.SS osd -.sp -Manage OSD configuration and administration. It uses some additional -subcommands. -.sp -Subcommand \fBblacklist\fP manage blacklisted clients. It uses some additional -subcommands. -.sp -Subcommand \fBadd\fP add to blacklist (optionally until seconds -from now) -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd blacklist add {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\fP show blacklisted clients -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd blacklist ls -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm\fP remove from blacklist -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd blacklist rm -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBblocked\-by\fP prints a histogram of which OSDs are blocking their peers -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd blocked\-by -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcreate\fP creates new osd (with optional UUID). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd create {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcrush\fP is used for CRUSH management. It uses some additional -subcommands. -.sp -Subcommand \fBadd\fP adds or updates crushmap position and weight for with - and location . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush add [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBadd\-bucket\fP adds no\-parent (probably root) crush bucket of -type . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush add\-bucket -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcreate\-or\-move\fP creates entry or moves existing entry for - at/to location . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush create\-or\-move -[...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump\fP dumps crush map. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush dump -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\-tunable\fP get crush tunable straw_calc_version -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush get\-tunable straw_calc_version -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBlink\fP links existing entry for under location . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush link [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBmove\fP moves existing entry for to location . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush move [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBremove\fP removes from crush map (everywhere, or just at -). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush remove {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrename\-bucket\fP renames buchket to -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rename\-bucket -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBreweight\fP change \(aqs weight to in crush map. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush reweight -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBreweight\-all\fP recalculate the weights for the tree to -ensure they sum correctly -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush reweight\-all -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBreweight\-subtree\fP changes all leaf items beneath -to in crush map -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush reweight\-subtree -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm\fP removes from crush map (everywhere, or just at -). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rm {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrule\fP is used for creating crush rules. It uses some additional -subcommands. -.sp -Subcommand \fBcreate\-erasure\fP creates crush rule for erasure coded pool -created with (default default). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rule create\-erasure {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcreate\-simple\fP creates crush rule to start from , -replicate across buckets of type , using a choose mode of -(default firstn; indep best for erasure pools). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rule create\-simple {firstn|indep} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump\fP dumps crush rule (default all). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rule dump {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBlist\fP lists crush rules. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rule list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\fP lists crush rules. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rule ls -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm\fP removes crush rule . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush rule rm -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\fP used alone, sets crush map from input file. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush set -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\fP with osdname/osd.id update crushmap position and weight -for to with location . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush set [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\-tunable\fP set crush tunable to . The only -tunable that can be set is straw_calc_version. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush set\-tunable straw_calc_version -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBshow\-tunables\fP shows current crush tunables. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush show\-tunables -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBtunables\fP sets crush tunables values to . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush tunables legacy|argonaut|bobtail|firefly|hammer|optimal|default -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBunlink\fP unlinks from crush map (everywhere, or just at -). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd crush unlink {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdf\fP shows OSD utilization -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd df {plain|tree} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdeep\-scrub\fP initiates deep scrub on specified osd. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd deep\-scrub -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdown\fP sets osd(s) [...] down. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd down [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump\fP prints summary of OSD map. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd dump {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBerasure\-code\-profile\fP is used for managing the erasure code -profiles. It uses some additional subcommands. -.sp -Subcommand \fBget\fP gets erasure code profile . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd erasure\-code\-profile get -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\fP lists all erasure code profiles. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd erasure\-code\-profile ls -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm\fP removes erasure code profile . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd erasure\-code\-profile rm -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\fP creates erasure code profile with [ ...] -pairs. Add a \-\-force at the end to override an existing profile (IT IS RISKY). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd erasure\-code\-profile set { [...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBfind\fP find osd in the CRUSH map and shows its location. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd find -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBgetcrushmap\fP gets CRUSH map. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd getcrushmap {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBgetmap\fP gets OSD map. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd getmap {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBgetmaxosd\fP shows largest OSD id. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd getmaxosd -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBin\fP sets osd(s) [...] in. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd in [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBlost\fP marks osd as permanently lost. THIS DESTROYS DATA IF NO -MORE REPLICAS EXIST, BE CAREFUL. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd lost {\-\-yes\-i\-really\-mean\-it} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\fP shows all OSD ids. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd ls {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBlspools\fP lists pools. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd lspools {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBmap\fP finds pg for in . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd map -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBmetadata\fP fetches metadata for osd . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd metadata -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBout\fP sets osd(s) [...] out. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd out [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBpause\fP pauses osd. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pause -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBperf\fP prints dump of OSD perf summary stats. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd perf -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBpg\-temp\fP set pg_temp mapping pgid:[ [...]] (developers -only). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pg\-temp { [...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBpool\fP is used for managing data pools. It uses some additional -subcommands. -.sp -Subcommand \fBcreate\fP creates pool. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool create {} {replicated|erasure} -{} {} {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdelete\fP deletes pool. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool delete {} {\-\-yes\-i\-really\-really\-mean\-it} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\fP gets pool parameter . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool get size|min_size|crash_replay_interval|pg_num| -pgp_num|crush_ruleset|auid|write_fadvise_dontneed -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Only for tiered pools: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool get hit_set_type|hit_set_period|hit_set_count|hit_set_fpp| -target_max_objects|target_max_bytes|cache_target_dirty_ratio| -cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age| -min_read_recency_for_promote -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Only for erasure coded pools: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool get erasure_code_profile -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBget\-quota\fP obtains object or byte limits for pool. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool get\-quota -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\fP list pools -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool ls {detail} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBmksnap\fP makes snapshot in . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool mksnap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrename\fP renames to . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool rename -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrmsnap\fP removes snapshot from . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool rmsnap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\fP sets pool parameter to . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool set size|min_size|crash_replay_interval|pg_num| -pgp_num|crush_ruleset|hashpspool|nodelete|nopgchange|nosizechange| -hit_set_type|hit_set_period|hit_set_count|hit_set_fpp|debug_fake_ec_pool| -target_max_bytes|target_max_objects|cache_target_dirty_ratio| -cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age|auid| -min_read_recency_for_promote|write_fadvise_dontneed - {\-\-yes\-i\-really\-mean\-it} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\-quota\fP sets object or byte limit on pool. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool set\-quota max_objects|max_bytes -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBstats\fP obtain stats from all pools, or from specified pool. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd pool stats {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBprimary\-affinity\fP adjust osd primary\-affinity from 0.0 <= -<= 1.0 -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd primary\-affinity -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBprimary\-temp\fP sets primary_temp mapping pgid:|\-1 (developers -only). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd primary\-temp -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrepair\fP initiates repair on a specified osd. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd repair -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBreweight\fP reweights osd to 0.0 < < 1.0. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -osd reweight -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBreweight\-by\-pg\fP reweight OSDs by PG distribution -[overload\-percentage\-for\-consideration, default 120]. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd reweight\-by\-pg {} { [} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrm\fP removes osd(s) [...] in the cluster. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd rm [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBscrub\fP initiates scrub on specified osd. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd scrub -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\fP sets . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd set full|pause|noup|nodown|noout|noin|nobackfill| -norebalance|norecover|noscrub|nodeep\-scrub|notieragent -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBsetcrushmap\fP sets crush map from input file. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd setcrushmap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBsetmaxosd\fP sets new maximum osd value. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd setmaxosd -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBstat\fP prints summary of OSD map. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd stat -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBthrash\fP thrashes OSDs for . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd thrash -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBtier\fP is used for managing tiers. It uses some additional -subcommands. -.sp -Subcommand \fBadd\fP adds the tier (the second one) to base pool -(the first one). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd tier add {\-\-force\-nonempty} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBadd\-cache\fP adds a cache (the second one) of size -to existing pool (the first one). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd tier add\-cache -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBcache\-mode\fP specifies the caching mode for cache tier . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd tier cache\-mode none|writeback|forward|readonly| -readforward|readproxy -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBremove\fP removes the tier (the second one) from base pool - (the first one). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd tier remove -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBremove\-overlay\fP removes the overlay pool for base pool . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd tier remove\-overlay -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset\-overlay\fP set the overlay pool for base pool to be -. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd tier set\-overlay -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBtree\fP prints OSD tree. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd tree {} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBunpause\fP unpauses osd. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd unpause -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBunset\fP unsets . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph osd unset full|pause|noup|nodown|noout|noin|nobackfill| -norebalance|norecover|noscrub|nodeep\-scrub|notieragent -.ft P -.fi -.UNINDENT -.UNINDENT -.SS pg -.sp -It is used for managing the placement groups in OSDs. It uses some -additional subcommands. -.sp -Subcommand \fBdebug\fP shows debug info about pgs. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg debug unfound_objects_exist|degraded_pgs_exist -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdeep\-scrub\fP starts deep\-scrub on . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg deep\-scrub -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump\fP shows human\-readable versions of pg map (only \(aqall\(aq valid -with plain). -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg dump {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump_json\fP shows human\-readable version of pg map in json only. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg dump_json {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump_pools_json\fP shows pg pools info in json only. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg dump_pools_json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBdump_stuck\fP shows information about stuck pgs. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg dump_stuck {inactive|unclean|stale|undersized|degraded [inactive|unclean|stale|undersized|degraded...]} -{} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBforce_create_pg\fP forces creation of pg . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg force_create_pg -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBgetmap\fP gets binary pg map to \-o/stdout. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg getmap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\fP lists pg with specific pool, osd, state -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg ls {} {active|clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale| remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized [active|clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale|remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\-by\-osd\fP lists pg on osd [osd] -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg ls\-by\-osd {} -{active|clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale| remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized [active|clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale|remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\-by\-pool\fP lists pg with pool = [poolname | poolid] -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg ls\-by\-pool {} {active| -clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale| remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized [active|clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale|remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBls\-by\-primary\fP lists pg with primary = [osd] -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg ls\-by\-primary {} -{active|clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale| remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized [active|clean|down|replay|splitting| -scrubbing|scrubq|degraded|inconsistent|peering|repair| -recovery|backfill_wait|incomplete|stale|remapped| -deep_scrub|backfill|backfill_toofull|recovery_wait| -undersized...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBmap\fP shows mapping of pg to osds. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg map -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBrepair\fP starts repair on . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg repair -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBscrub\fP starts scrub on . -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg scrub -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBsend_pg_creates\fP triggers pg creates to be issued. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg send_pg_creates -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset_full_ratio\fP sets ratio at which pgs are considered full. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg set_full_ratio -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBset_nearfull_ratio\fP sets ratio at which pgs are considered nearly -full. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg set_nearfull_ratio -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Subcommand \fBstat\fP shows placement group status. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph pg stat -.ft P -.fi -.UNINDENT -.UNINDENT -.SS quorum -.sp -Enter or exit quorum. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph quorum enter|exit -.ft P -.fi -.UNINDENT -.UNINDENT -.SS quorum_status -.sp -Reports status of monitor quorum. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph quorum_status -.ft P -.fi -.UNINDENT -.UNINDENT -.SS report -.sp -Reports full status of cluster, optional title tag strings. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph report { [...]} -.ft P -.fi -.UNINDENT -.UNINDENT -.SS scrub -.sp -Scrubs the monitor stores. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph scrub -.ft P -.fi -.UNINDENT -.UNINDENT -.SS status -.sp -Shows cluster status. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph status -.ft P -.fi -.UNINDENT -.UNINDENT -.SS sync force -.sp -Forces sync of and clear monitor store. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph sync force {\-\-yes\-i\-really\-mean\-it} {\-\-i\-know\-what\-i\-am\-doing} -.ft P -.fi -.UNINDENT -.UNINDENT -.SS tell -.sp -Sends a command to a specific daemon. -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph tell [...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SS version -.sp -Show mon daemon version -.sp -Usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph version -.ft P -.fi -.UNINDENT -.UNINDENT -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-i infile -will specify an input file to be passed along as a payload with the -command to the monitor cluster. This is only used for specific -monitor commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-o outfile -will write any payload returned by the monitor cluster with its -reply to outfile. Only specific monitor commands (e.g. osd getmap) -return a payload. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use ceph.conf configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-id CLIENT_ID, \-\-user CLIENT_ID -Client id for authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-name CLIENT_NAME, \-n CLIENT_NAME -Client name for authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cluster CLUSTER -Name of the Ceph cluster. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-admin\-daemon ADMIN_SOCKET -Submit admin\-socket commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-admin\-socket ADMIN_SOCKET_NOPE -You probably mean \-\-admin\-daemon -.UNINDENT -.INDENT 0.0 -.TP -.B \-s, \-\-status -Show cluster status. -.UNINDENT -.INDENT 0.0 -.TP -.B \-w, \-\-watch -Watch live cluster changes. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-watch\-debug -Watch debug events. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-watch\-info -Watch info events. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-watch\-sec -Watch security events. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-watch\-warn -Watch warning events. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-watch\-error -Watch error events. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-version, \-v -Display version. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-verbose -Make verbose. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-concise -Make less verbose. -.UNINDENT -.INDENT 0.0 -.TP -.B \-f {json,json\-pretty,xml,xml\-pretty,plain}, \-\-format -Format of output. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-connect\-timeout CLUSTER_TIMEOUT -Set a timeout for connecting to the cluster. -.UNINDENT -.SH AVAILABILITY -.sp -\fBceph\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\-mon\fP(8), -\fBceph\-osd\fP(8), -\fBceph\-mds\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/cephfs.8 b/man/cephfs.8 deleted file mode 100644 index 767fd3851b0cf..0000000000000 --- a/man/cephfs.8 +++ /dev/null @@ -1,144 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CEPHFS" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -cephfs \- ceph file system options utility -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBcephfs\fP [ \fIpath\fP \fIcommand\fP \fIoptions\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBcephfs\fP is a control utility for accessing and manipulating file -layout and location data in the Ceph distributed storage system. -.sp -Choose one of the following three commands: -.INDENT 0.0 -.IP \(bu 2 -\fBshow_layout\fP View the layout information on a file or directory -.IP \(bu 2 -\fBset_layout\fP Set the layout information on a file or directory -.IP \(bu 2 -\fBshow_location\fP View the location information on a file -.UNINDENT -.SH OPTIONS -.sp -Your applicable options differ depending on whether you are setting or viewing layout/location. -.SS Viewing options: -.INDENT 0.0 -.TP -.B \-l \-\-offset -Specify an offset for which to retrieve location data -.UNINDENT -.SS Setting options: -.INDENT 0.0 -.TP -.B \-u \-\-stripe_unit -Set the size of each stripe -.UNINDENT -.INDENT 0.0 -.TP -.B \-c \-\-stripe_count -Set the number of objects to stripe across -.UNINDENT -.INDENT 0.0 -.TP -.B \-s \-\-object_size -Set the size of the objects to stripe across -.UNINDENT -.INDENT 0.0 -.TP -.B \-p \-\-pool -Set the pool (by numeric value, not name!) to use -.UNINDENT -.INDENT 0.0 -.TP -.B \-o \-\-osd -Set the preferred OSD to use as the primary (deprecated and ignored) -.UNINDENT -.SH LIMITATIONS -.sp -When setting layout data, the specified object size must evenly divide -by the specified stripe unit. Any parameters you don\(aqt set -explicitly are left at the system defaults. -.sp -Obviously setting the layout of a file and a directory means different -things. Setting the layout of a file specifies exactly how to place -the individual file. This must be done before writing \fIany\fP data to -it. Truncating a file does not allow you to change the layout either. -.sp -Setting the layout of a directory sets the "default layout", which is -used to set the file layouts on any files subsequently created in the -directory (or any subdirectory). Pre\-existing files do not have their -layouts changed. -.sp -You\(aqll notice that the layout information allows you to specify a -preferred OSD for placement. This feature is unsupported and ignored -in modern versions of the Ceph servers; do not use it. -.SH AVAILABILITY -.sp -\fBcephfs\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer -to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/crushtool.8 b/man/crushtool.8 deleted file mode 100644 index 1fad24fddd885..0000000000000 --- a/man/crushtool.8 +++ /dev/null @@ -1,433 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CRUSHTOOL" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -crushtool \- CRUSH map manipulation tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBcrushtool\fP ( \-d \fImap\fP | \-c \fImap.txt\fP | \-\-build \-\-num_osds \fInumosds\fP -\fIlayer1\fP \fI\&...\fP | \-\-test ) [ \-o \fIoutfile\fP ] -.fi -.sp -.SH DESCRIPTION -.INDENT 0.0 -.TP -.B \fBcrushtool\fP is a utility that lets you create, compile, decompile -and test CRUSH map files. -.UNINDENT -.sp -CRUSH is a pseudo\-random data distribution algorithm that efficiently -maps input values (typically data objects) across a heterogeneous, -hierarchically structured device map. The algorithm was originally -described in detail in the following paper (although it has evolved -some since then): -.INDENT 0.0 -.INDENT 3.5 -\fI\%http://www.ssrc.ucsc.edu/Papers/weil-sc06.pdf\fP -.UNINDENT -.UNINDENT -.sp -The tool has four modes of operation. -.INDENT 0.0 -.TP -.B \-\-compile|\-c map.txt -will compile a plaintext map.txt into a binary map file. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-decompile|\-d map -will take the compiled map and decompile it into a plaintext source -file, suitable for editing. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-build \-\-num_osds {num\-osds} layer1 ... -will create map with the given layer structure. See below for a -detailed explanation. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-test -will perform a dry run of a CRUSH mapping for a range of input -object names. See below for a detailed explanation. -.UNINDENT -.sp -Unlike other Ceph tools, \fBcrushtool\fP does not accept generic options -such as \fB\-\-debug\-crush\fP from the command line. They can however be -provided via the CEPH_ARGS environment variable. For instance, to -silence all output from the CRUSH subsystem: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -CEPH_ARGS="\-\-debug\-crush 0" crushtool ... -.ft P -.fi -.UNINDENT -.UNINDENT -.SH RUNNING TESTS WITH --TEST -.sp -The test mode will use the input crush map ( as specified with \fB\-i -map\fP ) and perform a dry run of CRUSH mapping or random placement ( -if \fB\-\-simulate\fP is set ). On completion, two kinds of reports can be -created. The \fB\-\-show\-...\fP options output human readable information -on stderr. The \fB\-\-output\-csv\fP option creates CSV files that are -documented by the \fB\-\-help\-output\fP option. -.INDENT 0.0 -.TP -.B \-\-show\-statistics -for each rule display the mapping of each object. For instance: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -CRUSH rule 1 x 24 [11,6] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -shows that object \fB24\fP is mapped to devices \fB[11,6]\fP by rule -\fB1\fP\&. At the end of the mapping details, a summary of the -distribution is displayed. For instance: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -rule 1 (metadata) num_rep 5 result size == 5: 1024/1024 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -shows that rule \fB1\fP which is named \fBmetadata\fP successfully -mapped \fB1024\fP objects to \fBresult size == 5\fP devices when trying -to map them to \fBnum_rep 5\fP replicas. When it fails to provide the -required mapping, presumably because the number of \fBtries\fP must -be increased, a breakdown of the failures is displays. For instance: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -rule 1 (metadata) num_rep 10 result size == 8: 4/1024 -rule 1 (metadata) num_rep 10 result size == 9: 93/1024 -rule 1 (metadata) num_rep 10 result size == 10: 927/1024 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -shows that although \fBnum_rep 10\fP replicas were required, \fB4\fP -out of \fB1024\fP objects ( \fB4/1024\fP ) were mapped to \fBresult size -== 8\fP devices only. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-show\-bad\-mappings -display which object failed to be mapped to the required number of -devices. For instance: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -bad mapping rule 1 x 781 num_rep 7 result [8,10,2,11,6,9] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -shows that when rule \fB1\fP was required to map \fB7\fP devices, it -could only map six : \fB[8,10,2,11,6,9]\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-show\-utilization -display the expected and actual utilisation for each device, for -each number of replicas. For instance: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -device 0: stored : 951 expected : 853.333 -device 1: stored : 963 expected : 853.333 -\&... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -shows that device \fB0\fP stored \fB951\fP objects and was expected to store \fB853\fP\&. -Implies \fB\-\-show\-statistics\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-show\-utilization\-all -displays the same as \fB\-\-show\-utilization\fP but does not suppress -output when the weight of a device is zero. -Implies \fB\-\-show\-statistics\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-show\-choose\-tries -display how many attempts were needed to find a device mapping. -For instance: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -0: 95224 -1: 3745 -2: 2225 -\&.. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -shows that \fB95224\fP mappings succeeded without retries, \fB3745\fP -mappings succeeded with one attempts, etc. There are as many rows -as the value of the \fB\-\-set\-choose\-total\-tries\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-output\-csv -create CSV files (in the current directory) containing information -documented by \fB\-\-help\-output\fP\&. The files are named after the rule -used when collecting the statistics. For instance, if the rule -metadata is used, the CSV files will be: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -metadata\-absolute_weights.csv -metadata\-device_utilization.csv -\&... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The first line of the file shortly explains the column layout. For -instance: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -metadata\-absolute_weights.csv -Device ID, Absolute Weight -0,1 -\&... -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-output\-name NAME -prepend \fBNAME\fP to the file names generated when \fB\-\-output\-csv\fP -is specified. For instance \fB\-\-output\-name FOO\fP will create -files: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -FOO\-metadata\-absolute_weights.csv -FOO\-metadata\-device_utilization.csv -\&... -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.sp -The \fB\-\-set\-...\fP options can be used to modify the tunables of the -input crush map. The input crush map is modified in -memory. For example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ crushtool \-i mymap \-\-test \-\-show\-bad\-mappings -bad mapping rule 1 x 781 num_rep 7 result [8,10,2,11,6,9] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -could be fixed by increasing the \fBchoose\-total\-tries\fP as follows: -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.TP -.B $ crushtool \-i mymap \-\-test -\-\-show\-bad\-mappings \-\-set\-choose\-total\-tries 500 -.UNINDENT -.UNINDENT -.UNINDENT -.SH BUILDING A MAP WITH --BUILD -.sp -The build mode will generate hierarchical maps. The first argument -specifies the number of devices (leaves) in the CRUSH hierarchy. Each -layer describes how the layer (or devices) preceding it should be -grouped. -.sp -Each layer consists of: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -bucket ( uniform | list | tree | straw ) size -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fBbucket\fP is the type of the buckets in the layer -(e.g. "rack"). Each bucket name will be built by appending a unique -number to the \fBbucket\fP string (e.g. "rack0", "rack1"...). -.sp -The second component is the type of bucket: \fBstraw\fP should be used -most of the time. -.sp -The third component is the maximum size of the bucket. A size of zero -means a bucket of infinite capacity. -.SH EXAMPLE -.sp -Suppose we have two rows with two racks each and 20 nodes per rack. Suppose -each node contains 4 storage devices for Ceph OSD Daemons. This configuration -allows us to deploy 320 Ceph OSD Daemons. Lets assume a 42U rack with 2U nodes, -leaving an extra 2U for a rack switch. -.sp -To reflect our hierarchy of devices, nodes, racks and rows, we would execute -the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ crushtool \-o crushmap \-\-build \-\-num_osds 320 \e - node straw 4 \e - rack straw 20 \e - row straw 2 \e - root straw 0 -# id weight type name reweight -\-87 320 root root -\-85 160 row row0 -\-81 80 rack rack0 -\-1 4 node node0 -0 1 osd.0 1 -1 1 osd.1 1 -2 1 osd.2 1 -3 1 osd.3 1 -\-2 4 node node1 -4 1 osd.4 1 -5 1 osd.5 1 -\&... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -CRUSH rulesets are created so the generated crushmap can be -tested. They are the same rulesets as the one created by default when -creating a new Ceph cluster. They can be further edited with: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -# decompile -crushtool \-d crushmap \-o map.txt - -# edit -emacs map.txt - -# recompile -crushtool \-c map.txt \-o crushmap -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBcrushtool\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBosdmaptool\fP(8), -.SH AUTHORS -.sp -John Wilkins, Sage Weil, Loic Dachary -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/librados-config.8 b/man/librados-config.8 deleted file mode 100644 index 1e728c721fcd5..0000000000000 --- a/man/librados-config.8 +++ /dev/null @@ -1,94 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "LIBRADOS-CONFIG" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -librados-config \- display information about librados -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBlibrados\-config\fP [ \-\-version ] [ \-\-vernum ] -.fi -.sp -.SH DESCRIPTION -.INDENT 0.0 -.TP -.B \fBlibrados\-config\fP is a utility that displays information about the -installed \fBlibrados\fP\&. -.UNINDENT -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-version -Display \fBlibrados\fP version -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-vernum -Display the \fBlibrados\fP version code -.UNINDENT -.SH AVAILABILITY -.sp -\fBlibrados\-config\fP is part of Ceph, a massively scalable, open-source, distributed storage system. -Please refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for -more information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBrados\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/monmaptool.8 b/man/monmaptool.8 deleted file mode 100644 index a8862e3f0c118..0000000000000 --- a/man/monmaptool.8 +++ /dev/null @@ -1,188 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONMAPTOOL" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -monmaptool \- ceph monitor cluster map manipulation tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBmonmaptool\fP \fImapfilename\fP [ \-\-clobber ] [ \-\-print ] [ \-\-create ] -[ \-\-add \fIip\fP:\fIport\fP \fI\&...\fP ] [ \-\-rm \fIip\fP:\fIport\fP \fI\&...\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBmonmaptool\fP is a utility to create, view, and modify a monitor -cluster map for the Ceph distributed storage system. The monitor map -specifies the only fixed addresses in the Ceph distributed system. -All other daemons bind to arbitrary addresses and register themselves -with the monitors. -.sp -When creating a map with \-\-create, a new monitor map with a new, -random UUID will be created. It should be followed by one or more -monitor addresses. -.sp -The default Ceph monitor port is 6789. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-print -will print a plaintext dump of the map, after any modifications are -made. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-clobber -will allow monmaptool to overwrite mapfilename if changes are made. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-create -will create a new monitor map with a new UUID (and with it, a new, -empty Ceph file system). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-generate -generate a new monmap based on the values on the command line or specified -in the ceph configuration. This is, in order of preference, -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP 1. 3 -\fB\-\-monmap filename\fP to specify a monmap to load -.IP 2. 3 -\fB\-\-mon\-host \(aqhost1,ip2\(aq\fP to specify a list of hosts or ip addresses -.IP 3. 3 -\fB[mon.foo]\fP sections containing \fBmon addr\fP settings in the config -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-filter\-initial\-members -filter the initial monmap by applying the \fBmon initial members\fP -setting. Monitors not present in that list will be removed, and -initial members not present in the map will be added with dummy -addresses. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-add name ip:port -will add a monitor with the specified ip:port to the map. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-rm name -will remove the monitor with the specified ip:port from the map. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fsid uuid -will set the fsid to the given uuid. If not specified with \-\-create, a random fsid will be generated. -.UNINDENT -.SH EXAMPLE -.sp -To create a new map with three monitors (for a fresh Ceph file system): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -monmaptool \-\-create \-\-add mon.a 192.168.0.10:6789 \-\-add mon.b 192.168.0.11:6789 \e - \-\-add mon.c 192.168.0.12:6789 \-\-clobber monmap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To display the contents of the map: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -monmaptool \-\-print monmap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To replace one monitor: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -monmaptool \-\-rm mon.a \-\-add mon.a 192.168.0.9:6789 \-\-clobber monmap -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBmonmaptool\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBcrushtool\fP(8), -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/mount.ceph.8 b/man/mount.ceph.8 deleted file mode 100644 index 1159d91668ce3..0000000000000 --- a/man/mount.ceph.8 +++ /dev/null @@ -1,257 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "MOUNT.CEPH" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -mount.ceph \- mount a ceph file system -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBmount.ceph\fP \fImonaddr1\fP[,\fImonaddr2\fP,...]:/[\fIsubdir\fP] \fIdir\fP [ -\-o \fIoptions\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBmount.ceph\fP is a simple helper for mounting the Ceph file system on -a Linux host. It serves to resolve monitor hostname(s) into IP -addresses and read authentication keys from disk; the Linux kernel -client component does most of the real work. In fact, it is possible -to mount a non\-authenticated Ceph file system without mount.ceph by -specifying monitor address(es) by IP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mount \-t ceph 1.2.3.4:/ mountpoint -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Each monitor address monaddr takes the form host[:port]. If the port -is not specified, the Ceph default of 6789 is assumed. -.sp -Multiple monitor addresses can be separated by commas. Only one -responsible monitor is needed to successfully mount; the client will -learn about all monitors from any responsive monitor. However, it is a -good idea to specify more than one in case one happens to be down at -the time of mount. -.sp -A subdirectory subdir may be specified if a subset of the file system -is to be mounted. -.sp -Mount helper application conventions dictate that the first two -options are device to be mounted and destination path. Options must be -passed only after these fixed arguments. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \fBwsize\fP -int, max write size. Default: none (writeback uses smaller of wsize -and stripe unit) -.TP -.B \fBrsize\fP -int (bytes), max readahead, multiple of 1024, Default: 524288 -(512*1024) -.TP -.B \fBosdtimeout\fP -int (seconds), Default: 60 -.TP -.B \fBosdkeepalivetimeout\fP -int, Default: 5 -.TP -.B \fBmount_timeout\fP -int (seconds), Default: 60 -.TP -.B \fBosd_idle_ttl\fP -int (seconds), Default: 60 -.TP -.B \fBcaps_wanted_delay_min\fP -int, cap release delay, Default: 5 -.TP -.B \fBcaps_wanted_delay_max\fP -int, cap release delay, Default: 60 -.TP -.B \fBcap_release_safety\fP -int, Default: calculated -.TP -.B \fBreaddir_max_entries\fP -int, Default: 1024 -.TP -.B \fBreaddir_max_bytes\fP -int, Default: 524288 (512*1024) -.TP -.B \fBwrite_congestion_kb\fP -int (kb), max writeback in flight. scale with available -memory. Default: calculated from available memory -.TP -.B \fBsnapdirname\fP -string, set the name of the hidden snapdir. Default: .snap -.TP -.B \fBname\fP -RADOS user to authenticate as when using cephx. Default: guest -.TP -.B \fBsecret\fP -secret key for use with cephx. This option is insecure because it exposes -the secret on the command line. To avoid this, use the secretfile option. -.TP -.B \fBsecretfile\fP -path to file containing the secret key to use with cephx -.TP -.B \fBip\fP -my ip -.TP -.B \fBnoshare\fP -create a new client instance, instead of sharing an existing -instance of a client mounting the same cluster -.TP -.B \fBdirstat\fP -funky \fIcat dirname\fP for stats, Default: off -.TP -.B \fBnodirstat\fP -no funky \fIcat dirname\fP for stats -.TP -.B \fBrbytes\fP -Report the recursive size of the directory contents for st_size on -directories. Default: on -.TP -.B \fBnorbytes\fP -Do not report the recursive size of the directory contents for -st_size on directories. -.TP -.B \fBnocrc\fP -no data crc on writes -.TP -.B \fBnoasyncreaddir\fP -no dcache readdir -.UNINDENT -.SH EXAMPLES -.sp -Mount the full file system: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mount.ceph monhost:/ /mnt/foo -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If there are multiple monitors: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mount.ceph monhost1,monhost2,monhost3:/ /mnt/foo -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If \fBceph\-mon\fP(8) is running on a non\-standard -port: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mount.ceph monhost1:7000,monhost2:7000,monhost3:7000:/ /mnt/foo -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To mount only part of the namespace: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mount.ceph monhost1:/some/small/thing /mnt/thing -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Assuming mount.ceph(8) is installed properly, it should be -automatically invoked by mount(8) like so: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mount \-t ceph monhost:/ /mnt/foo -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBmount.ceph\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\-fuse\fP(8), -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/osdmaptool.8 b/man/osdmaptool.8 deleted file mode 100644 index 99b7bacef26a3..0000000000000 --- a/man/osdmaptool.8 +++ /dev/null @@ -1,139 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "OSDMAPTOOL" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -osdmaptool \- ceph osd cluster map manipulation tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBosdmaptool\fP \fImapfilename\fP [\-\-print] [\-\-createsimple \fInumosd\fP -[\-\-pgbits \fIbitsperosd\fP ] ] [\-\-clobber] -.fi -.sp -.SH DESCRIPTION -.sp -\fBosdmaptool\fP is a utility that lets you create, view, and manipulate -OSD cluster maps from the Ceph distributed storage system. Notably, it -lets you extract the embedded CRUSH map or import a new CRUSH map. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-print -will simply make the tool print a plaintext dump of the map, after -any modifications are made. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-clobber -will allow osdmaptool to overwrite mapfilename if changes are made. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-import\-crush mapfile -will load the CRUSH map from mapfile and embed it in the OSD map. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-export\-crush mapfile -will extract the CRUSH map from the OSD map and write it to -mapfile. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-createsimple numosd [\-\-pgbits bitsperosd] -will create a relatively generic OSD map with the numosd devices. -If \-\-pgbits is specified, the initial placement group counts will -be set with bitsperosd bits per OSD. That is, the pg_num map -attribute will be set to numosd shifted by bitsperosd. -.UNINDENT -.SH EXAMPLE -.sp -To create a simple map with 16 devices: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -osdmaptool \-\-createsimple 16 osdmap \-\-clobber -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view the result: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -osdmaptool \-\-print osdmap -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBosdmaptool\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBcrushtool\fP(8), -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/rados.8 b/man/rados.8 deleted file mode 100644 index 94b67c919ca9c..0000000000000 --- a/man/rados.8 +++ /dev/null @@ -1,267 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RADOS" "8" "May 29, 2014" "dev" "Ceph" -.SH NAME -rados \- rados object storage utility -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBrados\fP [ \-m \fImonaddr\fP ] [ mkpool | rmpool \fIfoo\fP ] [ \-p | \-\-pool -\fIpool\fP ] [ \-s | \-\-snap \fIsnap\fP ] [ \-i \fIinfile\fP ] [ \-o \fIoutfile\fP ] -\fIcommand\fP ... -.fi -.sp -.SH DESCRIPTION -.sp -\fBrados\fP is a utility for interacting with a Ceph object storage -cluster (RADOS), part of the Ceph distributed storage system. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-p pool, \-\-pool pool -Interact with the given pool. Required by most commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-s snap, \-\-snap snap -Read from the given pool snapshot. Valid for all pool\-specific read operations. -.UNINDENT -.INDENT 0.0 -.TP -.B \-i infile -will specify an input file to be passed along as a payload with the -command to the monitor cluster. This is only used for specific -monitor commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-o outfile -will write any payload returned by the monitor cluster with its -reply to outfile. Only specific monitor commands (e.g. osd getmap) -return a payload. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use ceph.conf configuration file instead of the default -/etc/ceph/ceph.conf to determine monitor addresses during startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through ceph.conf). -.UNINDENT -.SH GLOBAL COMMANDS -.INDENT 0.0 -.TP -.B \fBlspools\fP -List object pools -.TP -.B \fBdf\fP -Show utilization statistics, including disk usage (bytes) and object -counts, over the entire system and broken down by pool. -.TP -.B \fBmkpool\fP \fIfoo\fP -Create a pool with name foo. -.TP -.B \fBrmpool\fP \fIfoo\fP [ \fIfoo\fP \-\-yes\-i\-really\-really\-mean\-it ] -Delete the pool foo (and all its data) -.UNINDENT -.SH POOL SPECIFIC COMMANDS -.INDENT 0.0 -.TP -.B \fBget\fP \fIname\fP \fIoutfile\fP -Read object name from the cluster and write it to outfile. -.TP -.B \fBput\fP \fIname\fP \fIinfile\fP -Write object name to the cluster with contents from infile. -.TP -.B \fBrm\fP \fIname\fP -Remove object name. -.TP -.B \fBls\fP \fIoutfile\fP -List objects in given pool and write to outfile. -.TP -.B \fBlssnap\fP -List snapshots for given pool. -.TP -.B \fBclonedata\fP \fIsrcname\fP \fIdstname\fP \-\-object\-locator \fIkey\fP -Clone object byte data from \fIsrcname\fP to \fIdstname\fP\&. Both objects must be stored with the locator key \fIkey\fP (usually either \fIsrcname\fP or \fIdstname\fP). Object attributes and omap keys are not copied or cloned. -.TP -.B \fBmksnap\fP \fIfoo\fP -Create pool snapshot named \fIfoo\fP\&. -.TP -.B \fBrmsnap\fP \fIfoo\fP -Remove pool snapshot named \fIfoo\fP\&. -.TP -.B \fBbench\fP \fIseconds\fP \fImode\fP [ \-b \fIobjsize\fP ] [ \-t \fIthreads\fP ] -Benchmark for \fIseconds\fP\&. The mode can be \fIwrite\fP, \fIseq\fP, or -\fIrand\fP\&. \fIseq\fP and \fIrand\fP are read benchmarks, either -sequential or random. Before running one of the reading benchmarks, -run a write benchmark with the \fI\-\-no\-cleanup\fP option. The default -object size is 4 MB, and the default number of simulated threads -(parallel writes) is 16. -.UNINDENT -.sp -\fBcleanup\fP -.INDENT 0.0 -.TP -.B \fBlistomapkeys\fP \fIname\fP -List all the keys stored in the object map of object name. -.TP -.B \fBlistomapvals\fP \fIname\fP -List all key/value pairs stored in the object map of object name. -The values are dumped in hexadecimal. -.TP -.B \fBgetomapval\fP \fIname\fP \fIkey\fP -Dump the hexadecimal value of key in the object map of object name. -.TP -.B \fBsetomapval\fP \fIname\fP \fIkey\fP \fIvalue\fP -Set the value of key in the object map of object name. -.TP -.B \fBrmomapkey\fP \fIname\fP \fIkey\fP -Remove key from the object map of object name. -.TP -.B \fBgetomapheader\fP \fIname\fP -Dump the hexadecimal value of the object map header of object name. -.TP -.B \fBsetomapheader\fP \fIname\fP \fIvalue\fP -Set the value of the object map header of object name. -.UNINDENT -.SH EXAMPLES -.sp -To view cluster utilization: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rados df -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To get a list object in pool foo sent to stdout: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rados \-p foo ls \- -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To write an object: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rados \-p foo put myobject blah.txt -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To create a snapshot: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rados \-p foo mksnap mysnap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To delete the object: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rados \-p foo rm myobject -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To read a previously snapshotted version of an object: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rados \-p foo \-s mysnap get myobject blah.txt.old -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBrados\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/radosgw-admin.8 b/man/radosgw-admin.8 deleted file mode 100644 index 8d229e3077b53..0000000000000 --- a/man/radosgw-admin.8 +++ /dev/null @@ -1,616 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RADOSGW-ADMIN" "8" "January 22, 2015" "dev" "Ceph" -.SH NAME -radosgw-admin \- rados REST gateway user administration utility -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBradosgw\-admin\fP \fIcommand\fP [ \fIoptions\fP \fI\&...\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBradosgw\-admin\fP is a RADOS gateway user administration utility. It -allows creating and modifying users. -.SH COMMANDS -.sp -\fBradosgw\-admin\fP utility uses many commands for administration purpose -which are as follows: -.INDENT 0.0 -.TP -.B \fBuser create\fP -Create a new user. -.TP -.B \fBuser modify\fP -Modify a user. -.TP -.B \fBuser info\fP -Display information of a user, and any potentially available -subusers and keys. -.TP -.B \fBuser rm\fP -Remove a user. -.TP -.B \fBuser suspend\fP -Suspend a user. -.TP -.B \fBuser enable\fP -Re\-enable user after suspension. -.TP -.B \fBuser check\fP -Check user info. -.TP -.B \fBuser stats\fP -Show user stats as accounted by quota subsystem. -.TP -.B \fBcaps add\fP -Add user capabilities. -.TP -.B \fBcaps rm\fP -Remove user capabilities. -.TP -.B \fBsubuser create\fP -Create a new subuser (primarily useful for clients using the Swift API). -.TP -.B \fBsubuser modify\fP -Modify a subuser. -.TP -.B \fBsubuser rm\fP -Remove a subuser. -.TP -.B \fBkey create\fP -Create access key. -.TP -.B \fBkey rm\fP -Remove access key. -.TP -.B \fBbucket list\fP -List all buckets. -.TP -.B \fBbucket link\fP -Link bucket to specified user. -.TP -.B \fBbucket unlink\fP -Unlink bucket from specified user. -.TP -.B \fBbucket stats\fP -Returns bucket statistics. -.TP -.B \fBbucket rm\fP -Remove a bucket. -.TP -.B \fBbucket check\fP -Check bucket index. -.TP -.B \fBobject rm\fP -Remove an object. -.TP -.B \fBobject unlink\fP -Unlink object from bucket index. -.TP -.B \fBquota set\fP -Set quota params. -.TP -.B \fBquota enable\fP -Enable quota. -.TP -.B \fBquota disable\fP -Disable quota. -.TP -.B \fBregion get\fP -Show region info. -.TP -.B \fBregions list\fP -List all regions set on this cluster. -.TP -.B \fBregion set\fP -Set region info (requires infile). -.TP -.B \fBregion default\fP -Set default region. -.TP -.B \fBregion\-map get\fP -Show region\-map. -.TP -.B \fBregion\-map set\fP -Set region\-map (requires infile). -.TP -.B \fBzone get\fP -Show zone cluster params. -.TP -.B \fBzone set\fP -Set zone cluster params (requires infile). -.TP -.B \fBzone list\fP -List all zones set on this cluster. -.TP -.B \fBpool add\fP -Add an existing pool for data placement. -.TP -.B \fBpool rm\fP -Remove an existing pool from data placement set. -.TP -.B \fBpools list\fP -List placement active set. -.TP -.B \fBpolicy\fP -Display bucket/object policy. -.TP -.B \fBlog list\fP -List log objects. -.TP -.B \fBlog show\fP -Dump a log from specific object or (bucket + date + bucket\-id). -.TP -.B \fBlog rm\fP -Remove log object. -.TP -.B \fBusage show\fP -Show the usage information (with optional user and date range). -.TP -.B \fBusage trim\fP -Trim usage information (with optional user and date range). -.TP -.B \fBtemp remove\fP -Remove temporary objects that were created up to specified date -(and optional time). -.TP -.B \fBgc list\fP -Dump expired garbage collection objects (specify \-\-include\-all to list all -entries, including unexpired). -.TP -.B \fBgc process\fP -Manually process garbage. -.TP -.B \fBmetadata get\fP -Get metadata info. -.TP -.B \fBmetadata put\fP -Put metadata info. -.TP -.B \fBmetadata rm\fP -Remove metadata info. -.TP -.B \fBmetadata list\fP -List metadata info. -.TP -.B \fBmdlog list\fP -List metadata log. -.TP -.B \fBmdlog trim\fP -Trim metadata log. -.TP -.B \fBbilog list\fP -List bucket index log. -.TP -.B \fBbilog trim\fP -Trim bucket index log (use start\-marker, end\-marker). -.TP -.B \fBdatalog list\fP -List data log. -.TP -.B \fBdatalog trim\fP -Trim data log. -.TP -.B \fBopstate list\fP -List stateful operations entries (use client_id, op_id, object). -.TP -.B \fBopstate set\fP -Set state on an entry (use client_id, op_id, object, state). -.TP -.B \fBopstate renew\fP -Renew state on an entry (use client_id, op_id, object). -.TP -.B \fBopstate rm\fP -Remove entry (use client_id, op_id, object). -.TP -.B \fBreplicalog get\fP -Get replica metadata log entry. -.TP -.B \fBreplicalog delete\fP -Delete replica metadata log entry. -.UNINDENT -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fBceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during -startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through ceph.conf). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-uid=uid -The radosgw user ID. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-subuser= -Name of the subuser. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-email=email -The e\-mail address of the user. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-display\-name=name -Configure the display name of the user. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-access\-key= -S3 access key. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gen\-access\-key -Generate random access key (for S3). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-secret=secret -The secret associated with a given key. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gen\-secret -Generate random secret key. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-key\-type= -key type, options are: swift, S3. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-temp\-url\-key[\-2]= -Temporary url key. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-system -Set the system flag on the user. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-bucket=bucket -Specify the bucket name. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-object=object -Specify the object name. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-date=yyyy\-mm\-dd -The date needed for some commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-start\-date=yyyy\-mm\-dd -The start date needed for some commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-end\-date=yyyy\-mm\-dd -The end date needed for some commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-shard\-id= -Optional for mdlog list. Required for \fBmdlog trim\fP, -\fBreplica mdlog get/delete\fP, \fBreplica datalog get/delete\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auth\-uid=auid -The librados auid. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-purge\-data -Remove user data before user removal. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-purge\-keys -When specified, subuser removal will also purge all the subuser keys. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-purge\-objects -Remove all objects before bucket removal. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-lazy\-remove -Defer removal of object tail. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-metadata\-key= -Key to retrieve metadata from with \fBmetadata get\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-rgw\-region= -Region in which radosgw is running. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-rgw\-zone= -Zone in which radosgw is running. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fix -Besides checking bucket index, will also fix it. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-check\-objects -bucket check: Rebuilds bucket index according to actual objects state. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-format= -Specify output format for certain operations: xml, json. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sync\-stats -Option to \(aquser stats\(aq, update user stats with current stats reported by -user\(aqs buckets indexes. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-show\-log\-entries= -Enable/disable dump of log entries on log show. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-show\-log\-sum= -Enable/disable dump of log summation on log show. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-skip\-zero\-entries -Log show only dumps entries that don\(aqt have zero value in one of the numeric -field. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-infile -Specify a file to read in when setting data. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-state= -Specify a state for the opstate set command. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-replica\-log\-type -Replica log type (metadata, data, bucket), required for replica log -operations. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-categories= -Comma separated list of categories, used in usage show. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-caps= -List of caps (e.g., "usage=read, write; user=read". -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-yes\-i\-really\-mean\-it -Required for certain operations. -.UNINDENT -.SH QUOTA OPTIONS -.INDENT 0.0 -.TP -.B \-\-bucket -Specified bucket for quota command. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-max\-objects -Specify max objects (negative value to disable). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-max\-size -Specify max size (in bytes, negative value to disable). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quota\-scope -Scope of quota (bucket, user). -.UNINDENT -.SH EXAMPLES -.sp -Generate a new user: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin user create \-\-display\-name="johnny rotten" \-\-uid=johnny -{ "user_id": "johnny", - "rados_uid": 0, - "display_name": "johnny rotten", - "email": "", - "suspended": 0, - "subusers": [], - "keys": [ - { "user": "johnny", - "access_key": "TCICW53D9BQ2VGC46I44", - "secret_key": "tfm9aHMI8X76L3UdgE+ZQaJag1vJQmE6HDb5Lbrz"}], - "swift_keys": []} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Remove a user: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin user rm \-\-uid=johnny -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Remove a user and all associated buckets with their contents: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin user rm \-\-uid=johnny \-\-purge\-data -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Remove a bucket: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin bucket unlink \-\-bucket=foo -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Show the logs of a bucket from April 1st, 2012: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin log show \-\-bucket=foo \-\-date=2012=04\-01 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Show usage information for user from March 1st to (but not including) April 1st, 2012: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin usage show \-\-uid=johnny \e - \-\-start\-date=2012\-03\-01 \-\-end\-date=2012\-04\-01 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Show only summary of usage information for all users: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin usage show \-\-show\-log\-entries=false -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Trim usage information for user until March 1st, 2012: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ radosgw\-admin usage trim \-\-uid=johnny \-\-end\-date=2012\-04\-01 -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBradosgw\-admin\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please -refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -\fBradosgw\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/radosgw.8 b/man/radosgw.8 deleted file mode 100644 index a9e4234d6a2c6..0000000000000 --- a/man/radosgw.8 +++ /dev/null @@ -1,380 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RADOSGW" "8" "January 20, 2015" "dev" "Ceph" -.SH NAME -radosgw \- rados REST gateway -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBradosgw\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBradosgw\fP is an HTTP REST gateway for the RADOS object store, a part -of the Ceph distributed storage system. It is implemented as a FastCGI -module using libfcgi, and can be used in conjunction with any FastCGI -capable web server. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use \fBceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through \fBceph.conf\fP). -.UNINDENT -.INDENT 0.0 -.TP -.B \-i ID, \-\-id ID -Set the ID portion of name for radosgw -.UNINDENT -.INDENT 0.0 -.TP -.B \-n TYPE.ID, \-\-name TYPE.ID -Set the rados user name for the gateway (eg. client.radosgw.gateway) -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cluster NAME -Set the cluster name (default: ceph) -.UNINDENT -.INDENT 0.0 -.TP -.B \-d -Run in foreground, log to stderr -.UNINDENT -.INDENT 0.0 -.TP -.B \-f -Run in foreground, log to usual location -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-rgw\-socket\-path=path -Specify a unix domain socket path. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-rgw\-region=region -The region where radosgw runs -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-rgw\-zone=zone -The zone where radosgw runs -.UNINDENT -.SH CONFIGURATION -.sp -Earlier RADOS Gateway had to be configured with \fBApache\fP and \fBmod_fastcgi\fP\&. -Now, \fBmod_proxy_fcgi\fP module is used instead of \fBmod_fastcgi\fP as the later -doesn\(aqt come under a free license. \fBmod_proxy_fcgi\fP works differently than a -traditional FastCGI module. This module requires the service of \fBmod_proxy\fP -which provides support for the FastCGI protocol. So, to be able to handle -FastCGI protocol, both \fBmod_proxy\fP and \fBmod_proxy_fcgi\fP have to be present -in the server. Unlike \fBmod_fastcgi\fP, \fBmod_proxy_fcgi\fP cannot start the -application process. Some platforms have \fBfcgistarter\fP for that purpose. -However, external launching of application or process management may be available -in the FastCGI application framework in use. -.sp -\fBApache\fP can be configured in a way that enables \fBmod_proxy_fcgi\fP to be used -with localhost tcp or through unix domain socket. \fBmod_proxy_fcgi\fP that doesn\(aqt -support unix domain socket such as the ones in Apache 2.2 and earlier versions of -Apache 2.4, needs to be configured for use with localhost tcp. -.INDENT 0.0 -.IP 1. 3 -Modify \fB/etc/ceph/ceph.conf\fP file to make radosgw use tcp instead of unix -domain socket. -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C -[client.radosgw.gateway] -host = gateway -keyring = /etc/ceph/keyring.radosgw.gateway - -; ******** -; tcp fastcgi - rgw socket path = "" - rgw frontends = fastcgi socket_port=9000 socket_host=0.0.0.0 -.ft P -.fi -.UNINDENT -.UNINDENT -.IP 2. 3 -Modify Apache\(aqs configuration file so that \fBmod_proxy_fcgi\fP can be used -with localhost tcp. -.sp -Debian/Ubuntu: -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C - -ServerName localhost -DocumentRoot /var/www/html - -ErrorLog /var/log/apache2/error.log -CustomLog /var/log/apache2/access.log combined - -LogLevel debug - - -RewriteEngine On - -RewriteRule .* \- [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] - -SetEnv proxy\-nokeepalive 1 - -ProxyPass / fcgi://127.0.01:9000/ - -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -CentOS/RHEL: -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C - -ServerName localhost -DocumentRoot /var/www/html - -ErrorLog /var/log/httpd/error.log -CustomLog /var/log/httpd/access.log combined - -LogLevel debug - - -RewriteEngine On - -RewriteRule .* \- [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] - -SetEnv proxy\-nokeepalive 1 - -ProxyPass / fcgi://127.0.01:9000/ - -.ft P -.fi -.UNINDENT -.UNINDENT -.IP 3. 3 -Modify Apache\(aqs configuration file so that \fBmod_proxy_fcgi\fP can be used -through unix domain socket. -.sp -Debian/Ubuntu: -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C - -ServerName localhost -DocumentRoot /var/www/html - -ErrorLog /var/log/apache2/error.log -CustomLog /var/log/apache2/access.log combined - -LogLevel debug - - -RewriteEngine On - -RewriteRule .* \- [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] - -ProxyPass / unix:///tmp/.radosgw.sock|fcgi://localhost:9000/ disablereuse=On - -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -CentOS/RHEL: -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C - -ServerName localhost -DocumentRoot /var/www/html - -ErrorLog /var/log/httpd/error.log -CustomLog /var/log/httpd/access.log combined - -LogLevel debug - - -RewriteEngine On - -RewriteRule .* \- [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] - -ProxyPass / unix:///tmp/.radosgw.sock|fcgi://localhost:9000/ disablereuse=On - -.ft P -.fi -.UNINDENT -.UNINDENT -.IP 4. 3 -Generate a key for radosgw to use for authentication with the cluster. -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph\-authtool \-C \-n client.radosgw.gateway \-\-gen\-key /etc/ceph/keyring.radosgw.gateway -ceph\-authtool \-n client.radosgw.gateway \-\-cap mon \(aqallow rw\(aq \-\-cap osd \(aqallow rwx\(aq /etc/ceph/keyring.radosgw.gateway -.ft P -.fi -.UNINDENT -.UNINDENT -.IP 5. 3 -Add the key to the auth entries. -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C -ceph auth add client.radosgw.gateway \-\-in\-file=keyring.radosgw.gateway -.ft P -.fi -.UNINDENT -.UNINDENT -.IP 6. 3 -Start Apache and radosgw. -.sp -Debian/Ubuntu: -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C -sudo /etc/init.d/apache2 start -sudo /etc/init.d/radosgw start -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -CentOS/RHEL: -.INDENT 3.0 -.INDENT 3.5 -.sp -.nf -.ft C -sudo apachectl start -sudo /etc/init.d/ceph\-radosgw start -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.SH USAGE LOGGING -.sp -\fBradosgw\fP maintains an asynchronous usage log. It accumulates -statistics about user operations and flushes it periodically. The -logs can be accessed and managed through \fBradosgw\-admin\fP\&. -.sp -The information that is being logged contains total data transfer, -total operations, and total successful operations. The data is being -accounted in an hourly resolution under the bucket owner, unless the -operation was done on the service (e.g., when listing a bucket) in -which case it is accounted under the operating user. -.sp -Following is an example configuration: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -[client.radosgw.gateway] - rgw enable usage log = true - rgw usage log tick interval = 30 - rgw usage log flush threshold = 1024 - rgw usage max shards = 32 - rgw usage max user shards = 1 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The total number of shards determines how many total objects hold the -usage log information. The per\-user number of shards specify how many -objects hold usage information for a single user. The tick interval -configures the number of seconds between log flushes, and the flush -threshold specify how many entries can be kept before resorting to -synchronous flush. -.SH AVAILABILITY -.sp -\fBradosgw\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer -to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more -information. -.SH SEE ALSO -.sp -\fBceph\fP(8) -\fBradosgw\-admin\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/rbd-fuse.8 b/man/rbd-fuse.8 deleted file mode 100644 index 8e23798d40ecc..0000000000000 --- a/man/rbd-fuse.8 +++ /dev/null @@ -1,110 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RBD-FUSE" "8" "January 12, 2014" "dev" "Ceph" -.SH NAME -rbd-fuse \- expose rbd images as files -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBrbd\-fuse\fP [ \-p pool ] [\-c conffile] \fImountpoint\fP [ \fIfuse options\fP ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBrbd\-fuse\fP is a FUSE (File system in USErspace) client for RADOS -block device (rbd) images. Given a pool containing rbd images, -it will mount a userspace filesystem allowing access to those images -as regular files at \fBmountpoint\fP\&. -.sp -The file system can be unmounted with: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -fusermount \-u mountpoint -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or by sending \fBSIGINT\fP to the \fBrbd\-fuse\fP process. -.SH OPTIONS -.sp -Any options not recognized by rbd\-fuse will be passed on to libfuse. -.INDENT 0.0 -.TP -.B \-c ceph.conf -Use \fIceph.conf\fP configuration file instead of the default -\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-p pool -Use \fIpool\fP as the pool to search for rbd images. Default is \fBrbd\fP\&. -.UNINDENT -.SH AVAILABILITY -.sp -\fBrbd\-fuse\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -fusermount(8), -\fBrbd\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/rbd-replay-many.8 b/man/rbd-replay-many.8 deleted file mode 100644 index 1d6c0bf9ac6d2..0000000000000 --- a/man/rbd-replay-many.8 +++ /dev/null @@ -1,134 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RBD-REPLAY-MANY" "8" "September 04, 2014" "dev" "Ceph" -.SH NAME -rbd-replay-many \- replay a rados block device (RBD) workload on several clients -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBrbd\-replay\-many\fP [ \fIoptions\fP ] \-\-original\-image \fIname\fP \fIhost1\fP [ \fIhost2\fP [ ... ] ] \-\- \fIrbd_replay_args\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBrbd\-replay\-many\fP is a utility for replaying a rados block device (RBD) workload on several clients. -Although all clients use the same workload, they replay against separate images. -This matches normal use of librbd, where each original client is a VM with its own image. -.sp -Configuration and replay files are not automatically copied to clients. -Replay images must already exist. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-original\-image name -Specifies the name (and snap) of the originally traced image. -Necessary for correct name mapping. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-image\-prefix prefix -Prefix of image names to replay against. -Specifying \-\-image\-prefix=foo results in clients replaying against foo\-0, foo\-1, etc. -Defaults to the original image name. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-exec program -Path to the rbd\-replay executable. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-delay seconds -Delay between starting each client. Defaults to 0. -.UNINDENT -.SH EXAMPLES -.sp -Typical usage: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd\-replay\-many host\-0 host\-1 \-\-original\-image=image \-\- \-c ceph.conf replay.bin -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -This results in the following commands being executed: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ssh host\-0 \(aqrbd\-replay\(aq \-\-map\-image \(aqimage=image\-0\(aq \-c ceph.conf replay.bin -ssh host\-1 \(aqrbd\-replay\(aq \-\-map\-image \(aqimage=image\-1\(aq \-c ceph.conf replay.bin -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBrbd\-replay\-many\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBrbd\-replay\fP(8), -\fBrbd\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/rbd-replay-prep.8 b/man/rbd-replay-prep.8 deleted file mode 100644 index 13ab33aaf62b1..0000000000000 --- a/man/rbd-replay-prep.8 +++ /dev/null @@ -1,103 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RBD-REPLAY-PREP" "8" "August 21, 2014" "dev" "Ceph" -.SH NAME -rbd-replay-prep \- prepare captured rados block device (RBD) workloads for replay -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBrbd\-replay\-prep\fP [ \-\-window \fIseconds\fP ] [ \-\-anonymize ] \fItrace_dir\fP \fIreplay_file\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBrbd\-replay\-prep\fP processes raw rados block device (RBD) traces to prepare them for \fBrbd\-replay\fP\&. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-window seconds -Requests further apart than \(aqseconds\(aq seconds are assumed to be independent. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-anonymize -Anonymizes image and snap names. -.UNINDENT -.SH EXAMPLES -.sp -To prepare workload1\-trace for replay: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd\-replay\-prep workload1\-trace/ust/uid/1000/64\-bit workload1 -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBrbd\-replay\-prep\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBrbd\-replay\fP(8), -\fBrbd\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/rbd-replay.8 b/man/rbd-replay.8 deleted file mode 100644 index cefb925bf53b2..0000000000000 --- a/man/rbd-replay.8 +++ /dev/null @@ -1,141 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RBD-REPLAY" "8" "September 10, 2014" "dev" "Ceph" -.SH NAME -rbd-replay \- replay rados block device (RBD) workloads -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBrbd\-replay\fP [ \fIoptions\fP ] \fIreplay_file\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBrbd\-replay\fP is a utility for replaying rados block device (RBD) workloads. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf ceph.conf -Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to -determine monitor addresses during startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-p pool, \-\-pool pool -Interact with the given pool. Defaults to \(aqrbd\(aq. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-latency\-multiplier -Multiplies inter\-request latencies. Default: 1. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-read\-only -Only replay non\-destructive requests. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-map\-image rule -Add a rule to map image names in the trace to image names in the replay cluster. -A rule of image1@snap1=image2@snap2 would map snap1 of image1 to snap2 of image2. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dump\-perf\-counters -\fBExperimental\fP -Dump performance counters to standard out before an image is closed. -Performance counters may be dumped multiple times if multiple images are closed, -or if the same image is opened and closed multiple times. -Performance counters and their meaning may change between versions. -.UNINDENT -.SH EXAMPLES -.sp -To replay workload1 as fast as possible: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd\-replay \-\-latency\-multiplier=0 workload1 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To replay workload1 but use test_image instead of prod_image: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd\-replay \-\-map\-image=prod_image=test_image workload1 -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBrbd\-replay\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBrbd\-replay\-prep\fP(8), -\fBrbd\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. diff --git a/man/rbd.8 b/man/rbd.8 deleted file mode 100644 index 1605785dce43d..0000000000000 --- a/man/rbd.8 +++ /dev/null @@ -1,667 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "RBD" "8" "March 12, 2015" "dev" "Ceph" -.SH NAME -rbd \- manage rados block device (RBD) images -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.nf -\fBrbd\fP [ \-c \fIceph.conf\fP ] [ \-m \fImonaddr\fP ] [ \-p | \-\-pool \fIpool\fP ] [ -\-\-size \fIsize\fP ] [ \-\-order \fIbits\fP ] [ \fIcommand\fP ... ] -.fi -.sp -.SH DESCRIPTION -.sp -\fBrbd\fP is a utility for manipulating rados block device (RBD) images, -used by the Linux rbd driver and the rbd storage driver for Qemu/KVM. -RBD images are simple block devices that are striped over objects and -stored in a RADOS object store. The size of the objects the image is -striped over must be a power of two. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf ceph.conf -Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to -determine monitor addresses during startup. -.UNINDENT -.INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through ceph.conf). -.UNINDENT -.INDENT 0.0 -.TP -.B \-p pool, \-\-pool pool -Interact with the given pool. Required by most commands. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-no\-progress -Do not output progress information (goes to standard error by -default for some commands). -.UNINDENT -.SH PARAMETERS -.INDENT 0.0 -.TP -.B \-\-image\-format format -Specifies which object layout to use. The default is 1. -.INDENT 7.0 -.IP \(bu 2 -format 1 \- Use the original format for a new rbd image. This format is -understood by all versions of librbd and the kernel rbd module, but -does not support newer features like cloning. -.IP \(bu 2 -format 2 \- Use the second rbd format, which is supported by -librbd and kernel since version 3.11 (except for striping). This adds -support for cloning and is more easily extensible to allow more -features in the future. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-size size\-in\-mb -Specifies the size (in megabytes) of the new rbd image. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-order bits -Specifies the object size expressed as a number of bits, such that -the object size is \fB1 << order\fP\&. The default is 22 (4 MB). -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-stripe\-unit size\-in\-bytes -Specifies the stripe unit size in bytes. See striping section (below) for more details. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-stripe\-count num -Specifies the number of objects to stripe over before looping back -to the first object. See striping section (below) for more details. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-snap snap -Specifies the snapshot name for the specific operation. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-id username -Specifies the username (without the \fBclient.\fP prefix) to use with the map command. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyfile filename -Specifies a file containing the secret to use with the map command. -If not specified, \fBclient.admin\fP will be used by default. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyring filename -Specifies a keyring file containing a secret for the specified user -to use with the map command. If not specified, the default keyring -locations will be searched. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-shared tag -Option for \fIlock add\fP that allows multiple clients to lock the -same image if they use the same tag. The tag is an arbitrary -string. This is useful for situations where an image must -be open from more than one client at once, like during -live migration of a virtual machine, or for use underneath -a clustered filesystem. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-format format -Specifies output formatting (default: plain, json, xml) -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-pretty\-format -Make json or xml formatted output more human\-readable. -.UNINDENT -.INDENT 0.0 -.TP -.B \-o map\-options, \-\-options map\-options -Specifies which options to use when mapping an image. map\-options is -a comma\-separated string of options (similar to mount(8) mount options). -See map options section below for more details. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-read\-only -Map the image read\-only. Equivalent to \-o ro. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-image\-features features -Specifies which RBD format 2 features are to be enabled when creating -an image. The numbers from the desired features below should be added -to compute the parameter value: -.sp -+1: layering support -+2: striping v2 support -+4: exclusive locking support -+8: object map support -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-image\-shared -Specifies that the image will be used concurrently by multiple clients. -This will disable features that are dependent upon exclusive ownership -of the image. -.UNINDENT -.SH COMMANDS -.INDENT 0.0 -.TP -.B \fBls\fP [\-l | \-\-long] [pool\-name] -Will list all rbd images listed in the rbd_directory object. With -\-l, also show snapshots, and use longer\-format output including -size, parent (if clone), format, etc. -.TP -.B \fBinfo\fP [\fIimage\-name\fP] -Will dump information (such as size and order) about a specific rbd image. -If image is a clone, information about its parent is also displayed. -If a snapshot is specified, whether it is protected is shown as well. -.TP -.B \fBcreate\fP [\fIimage\-name\fP] -Will create a new rbd image. You must also specify the size via \-\-size. The -\-\-stripe\-unit and \-\-stripe\-count arguments are optional, but must be used together. -.TP -.B \fBclone\fP [\fIparent\-snapname\fP] [\fIimage\-name\fP] -Will create a clone (copy\-on\-write child) of the parent snapshot. -Object order will be identical to that of the parent image unless -specified. Size will be the same as the parent snapshot. The \-\-stripe\-unit -and \-\-stripe\-count arguments are optional, but must be used together. -.sp -The parent snapshot must be protected (see \fIrbd snap protect\fP). -This requires image format 2. -.TP -.B \fBflatten\fP [\fIimage\-name\fP] -If image is a clone, copy all shared blocks from the parent snapshot and -make the child independent of the parent, severing the link between -parent snap and child. The parent snapshot can be unprotected and -deleted if it has no further dependent clones. -.sp -This requires image format 2. -.TP -.B \fBchildren\fP [\fIimage\-name\fP] -List the clones of the image at the given snapshot. This checks -every pool, and outputs the resulting poolname/imagename. -.sp -This requires image format 2. -.TP -.B \fBresize\fP [\fIimage\-name\fP] [\-\-allow\-shrink] -Resizes rbd image. The size parameter also needs to be specified. -The \-\-allow\-shrink option lets the size be reduced. -.TP -.B \fBrm\fP [\fIimage\-name\fP] -Deletes an rbd image (including all data blocks). If the image has -snapshots, this fails and nothing is deleted. -.TP -.B \fBexport\fP [\fIimage\-name\fP] [\fIdest\-path\fP] -Exports image to dest path (use \- for stdout). -.TP -.B \fBimport\fP [\fIpath\fP] [\fIdest\-image\fP] -Creates a new image and imports its data from path (use \- for -stdin). The import operation will try to create sparse rbd images -if possible. For import from stdin, the sparsification unit is -the data block size of the destination image (1 << order). -.sp -The \-\-stripe\-unit and \-\-stripe\-count arguments are optional, but must be -used together. -.TP -.B \fBexport\-diff\fP [\fIimage\-name\fP] [\fIdest\-path\fP] [\-\-from\-snap \fIsnapname\fP] -Exports an incremental diff for an image to dest path (use \- for stdout). If -an initial snapshot is specified, only changes since that snapshot are included; otherwise, -any regions of the image that contain data are included. The end snapshot is specified -using the standard \-\-snap option or @snap syntax (see below). The image diff format includes -metadata about image size changes, and the start and end snapshots. It efficiently represents -discarded or \(aqzero\(aq regions of the image. -.TP -.B \fBmerge\-diff\fP [\fIfirst\-diff\-path\fP] [\fIsecond\-diff\-path\fP] [\fImerged\-diff\-path\fP] -Merge two continuous incremental diffs of an image into one single diff. The -first diff\(aqs end snapshot must be equal with the second diff\(aqs start snapshot. -The first diff could be \- for stdin, and merged diff could be \- for stdout, which -enables multiple diff files to be merged using something like -\(aqrbd merge\-diff first second \- | rbd merge\-diff \- third result\(aq. Note this command -currently only support the source incremental diff with stripe_count == 1 -.TP -.B \fBimport\-diff\fP [\fIsrc\-path\fP] [\fIimage\-name\fP] -Imports an incremental diff of an image and applies it to the current image. If the diff -was generated relative to a start snapshot, we verify that snapshot already exists before -continuing. If there was an end snapshot we verify it does not already exist before -applying the changes, and create the snapshot when we are done. -.TP -.B \fBdiff\fP [\fIimage\-name\fP] [\-\-from\-snap \fIsnapname\fP] -Dump a list of byte extents in the image that have changed since the specified start -snapshot, or since the image was created. Each output line includes the starting offset -(in bytes), the length of the region (in bytes), and either \(aqzero\(aq or \(aqdata\(aq to indicate -whether the region is known to be zeros or may contain other data. -.TP -.B \fBcp\fP [\fIsrc\-image\fP] [\fIdest\-image\fP] -Copies the content of a src\-image into the newly created dest\-image. -dest\-image will have the same size, order, and image format as src\-image. -.TP -.B \fBmv\fP [\fIsrc\-image\fP] [\fIdest\-image\fP] -Renames an image. Note: rename across pools is not supported. -.TP -.B \fBimage-meta list\fP [\fIimage\-name\fP] -Show metadata held on the image. The first column is the key -and the second column is the value. -.TP -.B \fBimage-meta get\fP [\fIimage\-name\fP] [\fIkey\fP] -Get metadata value with the key. -.TP -.B \fBimage-meta set\fP [\fIimage\-name\fP] [\fIkey\fP] [\fIvalue\fP] -Set metadata key with the value. They will displayed in \fImetadata-list\fP -.TP -.B \fBimage-meta remove\fP [\fIimage\-name\fP] [\fIkey\fP] -Remove metadata key with the value. -.TP -.B \fBsnap\fP ls [\fIimage\-name\fP] -Dumps the list of snapshots inside a specific image. -.TP -.B \fBsnap\fP create [\fIimage\-name\fP] -Creates a new snapshot. Requires the snapshot name parameter specified. -.TP -.B \fBsnap\fP rollback [\fIimage\-name\fP] -Rollback image content to snapshot. This will iterate through the entire blocks -array and update the data head content to the snapshotted version. -.TP -.B \fBsnap\fP rm [\fIimage\-name\fP] -Removes the specified snapshot. -.TP -.B \fBsnap\fP purge [\fIimage\-name\fP] -Removes all snapshots from an image. -.TP -.B \fBsnap\fP protect [\fIimage\-name\fP] -Protect a snapshot from deletion, so that clones can be made of it -(see \fIrbd clone\fP). Snapshots must be protected before clones are made; -protection implies that there exist dependent cloned children that -refer to this snapshot. \fIrbd clone\fP will fail on a nonprotected -snapshot. -.sp -This requires image format 2. -.TP -.B \fBsnap\fP unprotect [\fIimage\-name\fP] -Unprotect a snapshot from deletion (undo \fIsnap protect\fP). If cloned -children remain, \fIsnap unprotect\fP fails. (Note that clones may exist -in different pools than the parent snapshot.) -.sp -This requires image format 2. -.TP -.B \fBmap\fP [\fIimage\-name\fP] [\-o | \-\-options \fImap\-options\fP ] [\-\-read\-only] -Maps the specified image to a block device via the rbd kernel module. -.TP -.B \fBunmap\fP [\fIdevice\-path\fP] -Unmaps the block device that was mapped via the rbd kernel module. -.TP -.B \fBshowmapped\fP -Show the rbd images that are mapped via the rbd kernel module. -.TP -.B \fBstatus\fP [\fIimage\-name\fP] -Show the status of the image, including which clients have it open. -.TP -.B \fBlock\fP list [\fIimage\-name\fP] -Show locks held on the image. The first column is the locker -to use with the \fIlock remove\fP command. -.TP -.B \fBlock\fP add [\fIimage\-name\fP] [\fIlock\-id\fP] -Lock an image. The lock\-id is an arbitrary name for the user\(aqs -convenience. By default, this is an exclusive lock, meaning it -will fail if the image is already locked. The \-\-shared option -changes this behavior. Note that locking does not affect -any operation other than adding a lock. It does not -protect an image from being deleted. -.TP -.B \fBlock\fP remove [\fIimage\-name\fP] [\fIlock\-id\fP] [\fIlocker\fP] -Release a lock on an image. The lock id and locker are -as output by lock ls. -.TP -.B \fBbench\-write\fP [\fIimage\-name\fP] \-\-io\-size [\fIio\-size\-in\-bytes\fP] \-\-io\-threads [\fInum\-ios\-in\-flight\fP] \-\-io\-total [\fItotal\-bytes\-to\-write\fP] -Generate a series of sequential writes to the image and measure the -write throughput and latency. Defaults are: \-\-io\-size 4096, \-\-io\-threads 16, -\-\-io\-total 1GB -.UNINDENT -.SH IMAGE NAME -.sp -In addition to using the \-\-pool and the \-\-snap options, the image name can include both -the pool name and the snapshot name. The image name format is as follows: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -[pool/]image\-name[@snap] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Thus an image name that contains a slash character (\(aq/\(aq) requires specifying the pool -name explicitly. -.SH STRIPING -.sp -RBD images are striped over many objects, which are then stored by the -Ceph distributed object store (RADOS). As a result, read and write -requests for the image are distributed across many nodes in the -cluster, generally preventing any single node from becoming a -bottleneck when individual images get large or busy. -.sp -The striping is controlled by three parameters: -.INDENT 0.0 -.TP -.B order -The size of objects we stripe over is a power of two, specifically 2^[\fIorder\fP] bytes. The default -is 22, or 4 MB. -.UNINDENT -.INDENT 0.0 -.TP -.B stripe_unit -Each [\fIstripe_unit\fP] contiguous bytes are stored adjacently in the same object, before we move on -to the next object. -.UNINDENT -.INDENT 0.0 -.TP -.B stripe_count -After we write [\fIstripe_unit\fP] bytes to [\fIstripe_count\fP] objects, we loop back to the initial object -and write another stripe, until the object reaches its maximum size (as specified by [\fIorder\fP]. At that -point, we move on to the next [\fIstripe_count\fP] objects. -.UNINDENT -.sp -By default, [\fIstripe_unit\fP] is the same as the object size and [\fIstripe_count\fP] is 1. Specifying a different -[\fIstripe_unit\fP] requires that the STRIPINGV2 feature be supported (added in Ceph v0.53) and format 2 images be -used. -.SH MAP OPTIONS -.sp -Most of these options are useful mainly for debugging and benchmarking. The -default values are set in the kernel and may therefore depend on the version of -the running kernel. -.INDENT 0.0 -.IP \(bu 2 -fsid=aaaaaaaa\-bbbb\-cccc\-dddd\-eeeeeeeeeeee \- FSID that should be assumed by -the client. -.IP \(bu 2 -ip=a.b.c.d[:p] \- IP and, optionally, port the client should use. -.IP \(bu 2 -share \- Enable sharing of client instances with other mappings (default). -.IP \(bu 2 -noshare \- Disable sharing of client instances with other mappings. -.IP \(bu 2 -crc \- Enable CRC32C checksumming for data writes (default). -.IP \(bu 2 -nocrc \- Disable CRC32C checksumming for data writes. -.IP \(bu 2 -cephx_require_signatures \- Require cephx message signing, i.e. MSG_AUTH -feature bit (since 3.19, default). -.IP \(bu 2 -nocephx_require_signatures \- Don\(aqt require cephx message signing (since -3.19). -.IP \(bu 2 -tcp_nodelay \- Disable Nagle\(aqs algorithm on client sockets (since 4.0, -default). -.IP \(bu 2 -notcp_nodelay \- Enable Nagle\(aqs algorithm on client sockets (since 4.0). -.IP \(bu 2 -osdkeepalive=x \- OSD keepalive timeout (default is 5 seconds). -.IP \(bu 2 -osd_idle_ttl=x \- OSD idle TTL (default is 60 seconds). -.IP \(bu 2 -rw \- Map the image read\-write (default). -.IP \(bu 2 -ro \- Map the image read\-only. Equivalent to \-\-read\-only. -.UNINDENT -.SH EXAMPLES -.sp -To create a new rbd image that is 100 GB: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd \-p mypool create myimage \-\-size 102400 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or alternatively: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd create mypool/myimage \-\-size 102400 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To use a non\-default object size (8 MB): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd create mypool/myimage \-\-size 102400 \-\-order 23 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To delete an rbd image (be careful!): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd rm mypool/myimage -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To create a new snapshot: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd snap create mypool/myimage@mysnap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To create a copy\-on\-write clone of a protected snapshot: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd clone mypool/myimage@mysnap otherpool/cloneimage -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To see which clones of a snapshot exist: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd children mypool/myimage@mysnap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To delete a snapshot: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd snap rm mypool/myimage@mysnap -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To map an image via the kernel with cephx enabled: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd map mypool/myimage \-\-id admin \-\-keyfile secretfile -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To unmap an image: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd unmap /dev/rbd0 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To create an image and a clone from it: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd import \-\-image\-format 2 image mypool/parent -rbd snap create \-\-snap snapname mypool/parent -rbd snap protect mypool/parent@snap -rbd clone mypool/parent@snap otherpool/child -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To create an image with a smaller stripe_unit (to better distribute small writes in some workloads): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd \-p mypool create myimage \-\-size 102400 \-\-stripe\-unit 65536 \-\-stripe\-count 16 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To change an image from one image format to another, export it and then -import it as the desired image format: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd export mypool/myimage@snap /tmp/img -rbd import \-\-image\-format 2 /tmp/img mypool/myimage2 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To lock an image for exclusive use: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd lock add mypool/myimage mylockid -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To release a lock: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rbd lock remove mypool/myimage mylockid client.2485 -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AVAILABILITY -.sp -\fBrbd\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to -the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. -.SH SEE ALSO -.sp -\fBceph\fP(8), -\fBrados\fP(8) -.SH COPYRIGHT -2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA -.\" Generated by docutils manpage writer. -. -- 2.39.5