From b0a5cc2db2cb73c4776243d0d2869fd6cc0f4903 Mon Sep 17 00:00:00 2001 From: Yehuda Sadeh Date: Thu, 15 Jul 2010 14:07:52 -0700 Subject: [PATCH] rbd: update man page, other external tools --- debian/ceph.install | 4 +- man/Makefile.am | 2 +- man/rbd.8 | 102 ++++++++++++++++++++++++++++++++++++++++++++ man/rbdtool.8 | 60 -------------------------- 4 files changed, 105 insertions(+), 63 deletions(-) create mode 100644 man/rbd.8 delete mode 100644 man/rbdtool.8 diff --git a/debian/ceph.install b/debian/ceph.install index aa4b41ed94eb4..e0dcf894abd47 100644 --- a/debian/ceph.install +++ b/debian/ceph.install @@ -12,7 +12,7 @@ usr/bin/cmds usr/bin/cosd usr/bin/cauthtool usr/bin/rados -usr/bin/rbdtool +usr/bin/rbd sbin/mount.ceph usr/sbin/mkcephfs usr/lib/ceph/ceph_common.sh @@ -33,6 +33,6 @@ usr/share/man/man8/ceph.8 usr/share/man/man8/mount.ceph.8 usr/share/man/man8/cauthtool.8 usr/share/man/man8/rados.8 -usr/share/man/man8/rbdtool.8 +usr/share/man/man8/rbd.8 usr/share/man/man8/cclass.8 usr/share/man/man8/cclsinfo.8 diff --git a/man/Makefile.am b/man/Makefile.am index b9541d16c378f..1f367f9061166 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -18,6 +18,6 @@ dist_man_MANS = \ radosgw_admin.8 \ cauthtool.8 \ rados.8 \ - rbdtool.8 \ + rbd.8 \ cclass.8 \ cclsinfo.8 diff --git a/man/rbd.8 b/man/rbd.8 new file mode 100644 index 0000000000000..9a5e8e4dc4005 --- /dev/null +++ b/man/rbd.8 @@ -0,0 +1,102 @@ +.TH RBDTOOL 8 +.SH NAME +rbd \- manage rados block device (RBD) images +.SH SYNOPSIS +.B rbd +[ \fB\-c\fI ceph.conf\fR ] +[ \fB\-m\fI monaddr\fR ] +[ \fB\-p\fP | \fB\-\-pool\fI pool\fR ] +[ \fB\-\-size\fI size\fR ] +[ \fB\-\-order\fI bits\fR ] +[ \fIcommand ...\fR ] + +.SH DESCRIPTION +.B rbd +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 +.TP +\fB\-c\fI ceph.conf\fR, \fB\-\-conf \fIceph.conf\fR +Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP +to determine monitor addresses during startup. +.TP +\fB\-m\fI monaddress[:port]\fR +Connect to specified monitor (instead of looking through \fIceph.conf\fR). +.TP +\fB\-p\fI pool\fR, \fB\-\-pool \fIpool\fR +Interact with the given \fIpool\fP. Required by most commands. +.SH PARAMETERS +.TP +\fB\-\-size \fIsize-in-mb\fP +Specifies the size (in megabytes) of the new rbd image. +.TP +\fB\-\-order \fIbits\fP +Specifies the object size expressed as a number of bits, such that the object size is 1 << \fIorder\fR. The default is 22 (4 MB). +.TP +\fB\-\-snap \fIsnap\fP +Specifies the snapshot name for the specific operation. +.SH COMMANDS +.TP +\fBls\fP +Will list all rbd images listed in the \fIrbd_directory\fR object. +.TP +\fBinfo \fR[ \fIimage-name\fP ] +Will dump information (such as size and order) about a specific rbd image. +.TP +\fBcreate \fR[ \fIimage-name\fP ] +Will create a new rbd image. You must also specify the size via \fB\-\-size\fR. +.TP +\fBresize \fR[ \fIimage-name\fP ] +Resizes rbd image. The size parameter also needs to be specified. +.TP +\fBrm \fR[ \fIimage-name\fP ] +Deletes rbd image (including all data blocks) +.TP +\fBrm \fR[ \fIimage-name\fP ] +Deletes rbd image (including all data blocks) +.TP +\fBexport \fR[ \fIimage-name\fP ] \fR[ \fIdest-path\fP ] +Exports image to dest path. +.TP +\fBimport \fR[ \fI[path\fP ] \fR[ \fIdest-image\fP ] +Creates a new image and imports its data from path. +.TP +\fBcp \fR[ \fI[src-image\fP ] \fR[ \fIdest-image\fP ] +Copies the content of a src-image into the newly created dest-image. +.TP +\fBmv \fR[ \fI[src-image\fP ] \fR[ \fIdest-image\fP ] +Renames an image. +.TP +\fBsnap ls \fR[ \fI[image-name\fP ] +Dumps the list of snapshots inside a specific image. +.TP +\fBsnap create \fR[ \fI[image-name\fP ] +Creates a new snapshot. Requires the snapshot name parameter specified. +.TP +\fBsnap rollback \fR[ \fI[image-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. +.SH EXAMPLES +To create a new rbd image that is 100 GB: +.IP +rbd -p mypool create myimage --size 102400 +.PP +or alternatively +.IP +rbd create mypool/myimage --size 102400 +.PP +To use a non-default object size (8 MB): +.IP +rbd create mypool/myimage --size 102400 --order 23 +.PP +To delete an rbd image (be careful!): +.IP +rbd rm mypool/myimage +.PP +.SH AVAILABILITY +.B rbd +is part of the Ceph distributed file system. Please refer to the Ceph wiki at +http://ceph.newdream.net/wiki for more information. +.SH SEE ALSO +.BR ceph (8), rados (8) diff --git a/man/rbdtool.8 b/man/rbdtool.8 deleted file mode 100644 index a55b5d426c531..0000000000000 --- a/man/rbdtool.8 +++ /dev/null @@ -1,60 +0,0 @@ -.TH RBDTOOL 8 -.SH NAME -rbdtool \- manage rados block device (RBD) images -.SH SYNOPSIS -.B rbdtool -[ \fB\-m\fI monaddr\fR ] -[ \fB\-p\fP | \fB\-\-pool\fI pool\fR ] -[ \fB\-\-create\fI imgname\fR [ \fB\-s\fI sizeinmb\fR ] ] -[ \fB\-\-delete\fI imgname\fR ] -[ \fB\-\-list\fR ] - -.SH DESCRIPTION -.B rbdtool -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 -.TP -\fB\-p\fI pool\fR, \fB\-\-pool \fIpool\fR -Interact with the given \fIpool\fP. Required by most commands. -.TP -\fB\-\-list\fP -will list all rbd images listed in the \fIrbd_directory\fR object. -.TP -\fB\-\-create \fIimgname\fP -will create a new rbd image. You must also specify the size via \fB\-\-size\fR. -.TP -\fB\-\-size \fIsize_in_mb\fP -specifies the size (in megabytes) of the new rbd image. -.TP -\fB\-\-order \fIbits\fP -specifies the object size expressed as a number of bits, such that the object size is 1 << \fIorder\fR. The default is 22 (4 MB). -.TP -\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR -Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP -to determine monitor addresses during startup. -.TP -\fB\-m\fI monaddress[:port]\fR -Connect to specified monitor (instead of looking through \fIceph.conf\fR). -.SH EXAMPLES -To create a new rbd image that is 100 GB: -.IP -rbdtool -p mypool --create myimage --size 100000 -.PP -To use a non-default object size (8 MB): -.IP -rbdtool -p mypool --create myimage --size 100000 --order 23 -.PP -To delete an rbd image (be careful!): -.IP -rbdtool -p mypool --delete myimage -.PP -.SH AVAILABILITY -.B rbdtool -is part of the Ceph distributed file system. Please refer to the Ceph wiki at -http://ceph.newdream.net/wiki for more information. -.SH SEE ALSO -.BR ceph (8), rados (8) -src/ -- 2.39.5