-.TH "CEPH-AUTHTOOL" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-AUTHTOOL" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-authtool \- ceph keyring manipulation tool
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
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.
+\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,
.SH CAPABILITIES
.sp
The subsystem is the name of a Ceph subsystem: \fBmon\fP, \fBmds\fP, or
-\fBosd\fP.
+\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
superuser permissions for the given subsystem.
.sp
For example:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
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
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
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
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
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
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
.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 mount 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 the Ceph distributed file system. Please
+\fBceph\-authtool\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "CEPH-CLSINFO" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-CLSINFO" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-clsinfo \- show class object information
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-clsinfo\fP is part of the Ceph distributed file system. Please
+\fBceph\-clsinfo\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "CEPH-CONF" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-CONF" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-conf \- ceph conf file tool
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
.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 the Ceph distributed file system. Please refer
+\fBceph\-conf\fP is part of the Ceph distributed storage system. Please refer
to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "CEPH-DEBUGPACK" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-DEBUGPACK" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-debugpack \- ceph debug packer utility
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-debugpack\fP is part of the Ceph distributed file system. Please
+\fBceph\-debugpack\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "CEPH-DENCODER" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-DENCODER" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-dencoder \- ceph encoder/decoder utility
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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...]
.INDENT 0.0
.TP
.B list_types
-List the data types known to this build of \fBceph\-dencoder\fP.
+List the data types known to this build of \fBceph\-dencoder\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.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
+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 <f>
-Set the feature bits provided to \fBencode\fP to \fIf\fP. This allows
+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:
+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
"watchers": {}}
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-dencoder\fP is part of the Ceph distributed file system. Please
+\fBceph\-dencoder\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "CEPH-FUSE" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-FUSE" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-fuse \- FUSE-based client for ceph
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
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
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-fuse\fP is part of the Ceph distributed file system. Please refer to
+\fBceph\-fuse\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPH-MDS" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-MDS" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-mds \- ceph metadata server daemon
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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]]
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-mds\fP is part of the Ceph distributed file system. Please refer to the Ceph documentation at
+\fBceph\-mon\fP is part of the Ceph distributed storage system. Please refer to the Ceph documentation at
\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPH-MON" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-MON" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-mon \- ceph monitor daemon
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
.INDENT 7.0
.IP \(bu 2
The cluster fsid. This can come from a monmap (\fB\-\-monmap <path>\fP) or
-explicitly via \fB\-\-fsid <uuid>\fP.
+explicitly via \fB\-\-fsid <uuid>\fP\&.
.IP \(bu 2
A list of monitors and their addresses. This list of monitors
can come from a monmap (\fB\-\-monmap <path>\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
+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 <path>\fP.
+The monitor secret key \fBmon.\fP\&. This must be included in the
+keyring provided via \fB\-\-keyring <path>\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-keyring
-Specify a keyring for use with \fB\-\-mkfs\fP.
+Specify a keyring for use with \fB\-\-mkfs\fP\&.
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-mon\fP is part of the Ceph distributed file system. Please refer
+\fBceph\-mon\fP is part of the Ceph distributed storage system. Please refer
to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "CEPH-OSD" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-OSD" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-osd \- ceph object storage daemon
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
.INDENT 0.0
.TP
.B \-\-osd\-data osddata
-Use object store at \fIosddata\fP.
+Use object store at \fIosddata\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-osd\-journal journal
-Journal updates to \fIjournal\fP.
+Journal updates to \fIjournal\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-osd\fP is part of the Ceph distributed file system. Please refer to
+\fBceph\-osd\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPH-POST-FILE" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-POST-FILE" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-post-file \- post files for ceph developers
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ...
.INDENT 0.0
.TP
.B \-u *user*
-Set the user metadata for the upload. This defaults to \fIwhoami\(ga@\(gahostname \-f\fP.
+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 the Ceph distributed file system. Please refer to
+\fBceph\-post\-file\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPH-RBDNAMER" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-RBDNAMER" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-rbdnamer \- udev helper to name RBD devices
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
\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 the Ceph distributed file system. Please
+\fBceph\-rbdnamer\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "CEPH-REST-API" "8" "July 26, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-REST-API" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-rest-api \- ceph RESTlike administration server
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
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.
+send a PUT request to \fBosd/rm?ids=2&ids=3\fP\&.
.SH DISCOVERY
.sp
Human\-readable discovery of supported commands and parameters, along
of all known commands. The command set is very similar to the commands
supported by the \fBceph\fP tool. One notable exception is that the
\fBceph pg <pgid> <command>\fP style of commands is supported here
-as \fBtell/<pgid>/command?args\fP.
+as \fBtell/<pgid>/command?args\fP\&.
.SH DEPLOYMENT AS WSGI APPLICATION
.sp
When deploying as WSGI application (say, with Apache/mod_wsgi,
see those messages in case of problem.
.SH AVAILABILITY
.sp
-\fBceph\-rest\-api\fP is part of the Ceph distributed file system. Please refer to the Ceph documentation at
+\fBceph\-rest\-api\fP is part of the Ceph distributed storage system. Please refer to the Ceph documentation at
\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPH-RUN" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-RUN" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-run \- restart daemon on core dump
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ...
None
.SH AVAILABILITY
.sp
-\fBceph\-run\fP is part of the Ceph distributed file system. Please refer to
+\fBceph\-run\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPH-SYN" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH-SYN" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph-syn \- ceph synthetic workload generator
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
+\fBceph\-syn\fP [ \-m \fImonaddr\fP:\fIport\fP ] \-\-syn \fIcommand\fP \fI\&...\fP
.fi
.sp
.SH DESCRIPTION
.INDENT 0.0
.TP
.B \fBmknap\fP \fIpath\fP \fIsnapname\fP
-Create a snapshot called \fIsnapname\fP on \fIpath\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.
+Delete snapshot called \fIsnapname\fP on \fIpath\fP\&.
.TP
.B \fBrmfile\fP \fIpath\fP
-Delete/unlink \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
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\-syn\fP is part of the Ceph distributed file system. Please refer to
+\fBceph\-syn\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPH" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPH" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
ceph \- ceph file system control utility
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 [ \-m \fImonaddr\fP ] [ \-w | \fIcommand\fP ... ]
.SH DESCRIPTION
.sp
\fBceph\fP is a control utility for communicating with the monitor
-cluster of a running Ceph distributed file system.
+cluster of a running Ceph distributed storage system.
.sp
There are three basic modes of operation.
.SS Interactive mode
.SS Watch mode
.sp
Watch mode shows cluster state changes as they occur. For example:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
ceph \-w
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SS Command line mode
.sp
Finally, to send a single instruction to the monitor cluster (and wait
.SH EXAMPLES
.sp
To grab a copy of the current OSD map:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
ceph \-m 1.2.3.4:6789 osd getmap \-o osdmap
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
To get a dump of placement group (PG) state:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
ceph pg dump \-o pg.txt
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH MONITOR COMMANDS
.sp
A more complete summary of commands understood by the monitor cluster can be found in the
.UNINDENT
.SH AVAILABILITY
.sp
-\fBceph\fP is part of the Ceph distributed file system. Please refer to the Ceph documentation at
+\fBceph\fP is part of the Ceph distributed storage system. Please refer to the Ceph documentation at
\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "CEPHFS" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "CEPHFS" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
cephfs \- ceph file system options utility
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
.SH DESCRIPTION
.sp
\fBcephfs\fP is a control utility for accessing and manipulating file
-layout and location data in the Ceph distributed file system.
+layout and location data in the Ceph distributed storage system.
.sp
Choose one of the following three commands:
.INDENT 0.0
in modern versions of the Ceph servers; do not use it.
.SH AVAILABILITY
.sp
-\fBcephfs\fP is part of the Ceph distributed file system. Please refer
+\fBcephfs\fP is part of the Ceph distributed storage system. Please refer
to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
.UNINDENT
.SH AVAILABILITY
.sp
-\fBcrushtool\fP is part of the Ceph distributed file system. Please
+\fBcrushtool\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "LIBRADOS-CONFIG" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "LIBRADOS-CONFIG" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
librados-config \- display information about librados
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
.INDENT 0.0
.TP
.B \fBlibrados\-config\fP is a utility that displays information about the
-installed \fBlibrados\fP.
+installed \fBlibrados\fP\&.
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.UNINDENT
.SH AVAILABILITY
.sp
-\fBlibrados\-config\fP is part of the Ceph distributed file system.
+\fBlibrados\-config\fP is part of the Ceph distributed storage system.
Please refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for
more information.
.SH SEE ALSO
-.TH "MONMAPTOOL" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "MONMAPTOOL" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
monmaptool \- ceph monitor cluster map manipulation tool
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
+[ \-\-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 file system. The monitor map
+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.
.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
\-\-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 the Ceph distributed file system. Please
+\fBmonmaptool\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "MOUNT.CEPH" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "MOUNT.CEPH" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
mount.ceph \- mount a ceph file system
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 [
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.
.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 the Ceph distributed file system. Please
+\fBmount.ceph\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "OSDMAPTOOL" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "OSDMAPTOOL" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
osdmaptool \- ceph osd cluster map manipulation tool
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
.SH DESCRIPTION
.sp
\fBosdmaptool\fP is a utility that lets you create, view, and manipulate
-OSD cluster maps from the Ceph distributed file system. Notably, it
+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
.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 the Ceph distributed file system. Please
+\fBosdmaptool\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "RADOS" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "RADOS" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
rados \- rados object storage utility
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
.SH DESCRIPTION
.sp
\fBrados\fP is a utility for interacting with a Ceph object storage
-cluster (RADOS), part of the Ceph distributed file system.
+cluster (RADOS), part of the Ceph distributed storage system.
.SH OPTIONS
.INDENT 0.0
.TP
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.
+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.
+Create pool snapshot named \fIfoo\fP\&.
.TP
.B \fBrmsnap\fP \fIfoo\fP
-Remove pool snapshot named \fIfoo\fP.
+Remove pool snapshot named \fIfoo\fP\&.
.TP
.B \fBbench\fP \fIseconds\fP \fImode\fP [ \-b \fIobjsize\fP ] [ \-t \fIthreads\fP ]
Benchmark for seconds. The mode can be write or read. The default
.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 the Ceph distributed file system. Please refer to
+\fBrados\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "RADOSGW-ADMIN" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "RADOSGW-ADMIN" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
radosgw-admin \- rados REST gateway user administration utility
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
+\fBradosgw\-admin\fP \fIcommand\fP [ \fIoptions\fP \fI\&...\fP ]
.fi
.sp
.SH DESCRIPTION
.SH EXAMPLES
.sp
Generate a new user:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
"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
\-\-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 the Ceph distributed file system. Please
+\fBradosgw\-admin\fP is part of the Ceph distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "RADOSGW" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "RADOSGW" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
radosgw \- rados REST gateway
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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
.SH CONFIGURATION
.sp
Currently it\(aqs the easiest to use the RADOS Gateway with Apache and mod_fastcgi:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
</VirtualHost>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
And the corresponding radosgw script (/var/www/s3gw.fcgi):
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
exec /usr/bin/radosgw \-c /etc/ceph/ceph.conf \-n client.radosgw.gateway
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
The radosgw daemon is a standalone process which needs a configuration
section in the ceph.conf The section name should start with
\(aqclient.radosgw.\(aq as specified in /etc/init.d/radosgw:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
rgw socket path = /tmp/radosgw.sock
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
You will also have to generate a key for the radosgw to use for
authentication with the cluster:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
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
.sp
And add the key to the auth entries:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
ceph auth add client.radosgw.gateway \-\-in\-file=keyring.radosgw.gateway
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
Now you can start Apache and the radosgw daemon:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
/etc/init.d/radosgw start
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH USAGE LOGGING
.sp
The \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.
+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
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
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
synchronous flush.
.SH AVAILABILITY
.sp
-\fBradosgw\fP is part of the Ceph distributed file system. Please refer
+\fBradosgw\fP is part of the Ceph distributed storage system. Please refer
to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
-.TH "RBD-FUSE" "8" "April 29, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "RBD-FUSE" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
rbd-fuse \- expose rbd images as files
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ]
\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.
+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
.INDENT 0.0
.TP
.B \-p pool
-Use \fIpool\fP as the pool to search for rbd images. Default is \fBrbd\fP.
+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 the Ceph distributed file system. Please refer to
+\fBrbd\-fuse\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
-.TH "RBD" "8" "November 18, 2013" "dev" "Ceph"
+.\" Man page generated from reStructuredText.
+.
+.TH "RBD" "8" "December 09, 2013" "dev" "Ceph"
.SH NAME
rbd \- manage rados block device (RBD) images
.
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructuredText.
.
+.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 ] [
.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).
+the object size is \fB1 << order\fP\&. The default is 22 (4 MB).
.UNINDENT
.INDENT 0.0
.TP
.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 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 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 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 the Ceph distributed file system. Please refer to
+\fBrbd\fP is part of the Ceph distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp