From: Sage Weil Date: Thu, 19 Apr 2012 05:08:28 +0000 (-0700) Subject: obsync: section 8 -> 1 X-Git-Tag: v0.46~46 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=9cb796a03a7fd086dd92c32fcef03c5524aba392;p=ceph.git obsync: section 8 -> 1 Fixes: #2263 Signed-off-by: Sage Weil --- diff --git a/ceph.spec.in b/ceph.spec.in index 5b2f23309948a..32192097d56aa 100644 --- a/ceph.spec.in +++ b/ceph.spec.in @@ -341,7 +341,7 @@ fi %{_mandir}/man8/mount.ceph.8* %{_mandir}/man8/rados.8* %{_mandir}/man8/rbd.8* -%{_mandir}/man8/obsync.8* +%{_mandir}/man1/obsync.1* %{_mandir}/man8/ceph-rbdnamer.8* %{_mandir}/man8/ceph-authtool.8* %{_mandir}/man8/ceph-debugpack.8* diff --git a/debian/obsync.install b/debian/obsync.install index 5ac05ab12e9c4..04f485c5e50f1 100644 --- a/debian/obsync.install +++ b/debian/obsync.install @@ -1,2 +1,2 @@ usr/bin/obsync -usr/share/man/man8/obsync.8 +usr/share/man/man1/obsync.1 diff --git a/doc/man/1/obsync.rst b/doc/man/1/obsync.rst new file mode 100644 index 0000000000000..0963e8972c2dc --- /dev/null +++ b/doc/man/1/obsync.rst @@ -0,0 +1,143 @@ +======================================== + obsync -- The object synchronizer tool +======================================== + +.. program:: obsync + +Synopsis +======== + +| **obsync** [ *options* ] *source-url* *destination-url* + + +Description +=========== + +**obsync** is an object syncrhonizer tool designed to transfer objects +between different object storage systems. Similar to rsync, you +specify a source and a destination, and it will transfer objects +between them until the destination has all the objects in the +source. Obsync will never modify the source -- only the destination. + +By default, obsync does not delete anything. However, by specifying +``--delete-after`` or ``--delete-before``, you can ask it to delete +objects from the destination that are not in the source. + + +Target types +============ + +Obsync supports S3 via ``libboto``. To use the s3 target, your URL +should look like this: ``s3://host-name/bucket-name`` + +Obsync supports storing files locally via the ``file://`` target. To +use the file target, your URL should look like this: +``file://directory-name`` + +Alternately, give no prefix, like this: ``./directory-name`` + +Obsync supports storing files in a RADOS Gateway backend via the +``librados`` Python bindings. To use the ``rgw` target, your URL +should look like this: ``rgw:ceph-configuration-path:rgw-bucket-name`` + + +Options +======= + +.. option:: -h, --help + + Display a help message + +.. option:: -n, --dry-run + + Show what would be done, but do not modify the destination. + +.. option:: -c, --create-dest + + Create the destination if it does not exist. + +.. option:: --delete-before + + Before copying any files, delete objects in the destination that + are not in the source. + +.. option:: -L, --follow-symlinks + + Follow symlinks when dealing with ``file://`` targets. + +.. option:: --no-preserve-acls + + Don't preserve ACLs when copying objects. + +.. option:: -v, --verbose + + Be verbose. + +.. option:: -V, --more-verbose + + Be really, really verbose (developer mode) + +.. option:: -x SRC=DST, --xuser SRC=DST + + Set up a user translation. You can specify multiple user + translations with multiple ``--xuser`` arguments. + +.. option:: --force + + Overwrite all destination objects, even if they appear to be the + same as the source objects. + + +Environment variables +===================== + +.. envvar:: SRC_AKEY + + Access key for the source URL + +.. envvar:: SRC_SKEY + + Secret access key for the source URL + +.. envvar:: DST_AKEY + + Access key for the destination URL + +.. envvar:: DST_SKEY + + Secret access key for the destination URL + +.. envvar:: AKEY + + Access key for both source and dest + +.. envvar:: SKEY + + Secret access key for both source and dest + +.. envvar:: DST_CONSISTENCY + + Set to 'eventual' if the destination is eventually consistent. If the destination + is eventually consistent, we may have to retry certain operations multiple times. + + +Examples +======== + +:: + + AKEY=... SKEY=... obsync -c -d -v ./backup-directory s3://myhost1/mybucket1 + +Copy objects from backup-directory to mybucket1 on myhost1:: + + SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync -c -d -v s3://myhost1/mybucket1 s3://myhost1/mybucket2 + +Copy objects from mybucket1 to mybucket2 + + +Availability +============ + +**obsync** is part of the Ceph distributed file system. Please refer +to the Ceph wiki at http://ceph.newdream.net/wiki for more +information. diff --git a/doc/man/8/obsync.rst b/doc/man/8/obsync.rst deleted file mode 100644 index 0963e8972c2dc..0000000000000 --- a/doc/man/8/obsync.rst +++ /dev/null @@ -1,143 +0,0 @@ -======================================== - obsync -- The object synchronizer tool -======================================== - -.. program:: obsync - -Synopsis -======== - -| **obsync** [ *options* ] *source-url* *destination-url* - - -Description -=========== - -**obsync** is an object syncrhonizer tool designed to transfer objects -between different object storage systems. Similar to rsync, you -specify a source and a destination, and it will transfer objects -between them until the destination has all the objects in the -source. Obsync will never modify the source -- only the destination. - -By default, obsync does not delete anything. However, by specifying -``--delete-after`` or ``--delete-before``, you can ask it to delete -objects from the destination that are not in the source. - - -Target types -============ - -Obsync supports S3 via ``libboto``. To use the s3 target, your URL -should look like this: ``s3://host-name/bucket-name`` - -Obsync supports storing files locally via the ``file://`` target. To -use the file target, your URL should look like this: -``file://directory-name`` - -Alternately, give no prefix, like this: ``./directory-name`` - -Obsync supports storing files in a RADOS Gateway backend via the -``librados`` Python bindings. To use the ``rgw` target, your URL -should look like this: ``rgw:ceph-configuration-path:rgw-bucket-name`` - - -Options -======= - -.. option:: -h, --help - - Display a help message - -.. option:: -n, --dry-run - - Show what would be done, but do not modify the destination. - -.. option:: -c, --create-dest - - Create the destination if it does not exist. - -.. option:: --delete-before - - Before copying any files, delete objects in the destination that - are not in the source. - -.. option:: -L, --follow-symlinks - - Follow symlinks when dealing with ``file://`` targets. - -.. option:: --no-preserve-acls - - Don't preserve ACLs when copying objects. - -.. option:: -v, --verbose - - Be verbose. - -.. option:: -V, --more-verbose - - Be really, really verbose (developer mode) - -.. option:: -x SRC=DST, --xuser SRC=DST - - Set up a user translation. You can specify multiple user - translations with multiple ``--xuser`` arguments. - -.. option:: --force - - Overwrite all destination objects, even if they appear to be the - same as the source objects. - - -Environment variables -===================== - -.. envvar:: SRC_AKEY - - Access key for the source URL - -.. envvar:: SRC_SKEY - - Secret access key for the source URL - -.. envvar:: DST_AKEY - - Access key for the destination URL - -.. envvar:: DST_SKEY - - Secret access key for the destination URL - -.. envvar:: AKEY - - Access key for both source and dest - -.. envvar:: SKEY - - Secret access key for both source and dest - -.. envvar:: DST_CONSISTENCY - - Set to 'eventual' if the destination is eventually consistent. If the destination - is eventually consistent, we may have to retry certain operations multiple times. - - -Examples -======== - -:: - - AKEY=... SKEY=... obsync -c -d -v ./backup-directory s3://myhost1/mybucket1 - -Copy objects from backup-directory to mybucket1 on myhost1:: - - SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync -c -d -v s3://myhost1/mybucket1 s3://myhost1/mybucket2 - -Copy objects from mybucket1 to mybucket2 - - -Availability -============ - -**obsync** is part of the Ceph distributed file system. Please refer -to the Ceph wiki at http://ceph.newdream.net/wiki for more -information. diff --git a/man/Makefile.am b/man/Makefile.am index 9959eb8a2b4a3..fcc5487d4023e 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -25,4 +25,4 @@ dist_man_MANS = \ cephfs.8 \ ceph-dencoder.8 \ ceph-rbdnamer.8 \ - obsync.8 + obsync.1 diff --git a/man/obsync.1 b/man/obsync.1 new file mode 100644 index 0000000000000..dac18f8cc212a --- /dev/null +++ b/man/obsync.1 @@ -0,0 +1,180 @@ +.TH "OBSYNC" "1" "September 22, 2011" "dev" "Ceph" +.SH NAME +obsync \- The object synchronizer 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 +.. +.\" Man page generated from reStructeredText. +. +.SH SYNOPSIS +.nf +\fBobsync\fP [ \fIoptions\fP ] \fIsource\-url\fP \fIdestination\-url\fP +.fi +.sp +.SH DESCRIPTION +.sp +\fBobsync\fP is an object syncrhonizer tool designed to transfer objects +between different object storage systems. Similar to rsync, you +specify a source and a destination, and it will transfer objects +between them until the destination has all the objects in the +source. Obsync will never modify the source \-\- only the destination. +.sp +By default, obsync does not delete anything. However, by specifying +\fB\-\-delete\-after\fP or \fB\-\-delete\-before\fP, you can ask it to delete +objects from the destination that are not in the source. +.SH TARGET TYPES +.sp +Obsync supports S3 via \fBlibboto\fP. To use the s3 target, your URL +should look like this: \fBs3://host\-name/bucket\-name\fP +.sp +Obsync supports storing files locally via the \fBfile://\fP target. To +use the file target, your URL should look like this: +\fBfile://directory\-name\fP +.sp +Alternately, give no prefix, like this: \fB./directory\-name\fP +.sp +Obsync supports storing files in a RADOS Gateway backend via the +\fBlibrados\fP Python bindings. To use the \fBrgw\(ga target, your URL +should look like this: \(ga\(gargw:ceph\-configuration\-path:rgw\-bucket\-name\fP +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-h, \-\-help +Display a help message +.UNINDENT +.INDENT 0.0 +.TP +.B \-n, \-\-dry\-run +Show what would be done, but do not modify the destination. +.UNINDENT +.INDENT 0.0 +.TP +.B \-c, \-\-create\-dest +Create the destination if it does not exist. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-delete\-before +Before copying any files, delete objects in the destination that +are not in the source. +.UNINDENT +.INDENT 0.0 +.TP +.B \-L, \-\-follow\-symlinks +Follow symlinks when dealing with \fBfile://\fP targets. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-no\-preserve\-acls +Don\(aqt preserve ACLs when copying objects. +.UNINDENT +.INDENT 0.0 +.TP +.B \-v, \-\-verbose +Be verbose. +.UNINDENT +.INDENT 0.0 +.TP +.B \-V, \-\-more\-verbose +Be really, really verbose (developer mode) +.UNINDENT +.INDENT 0.0 +.TP +.B \-x SRC=DST, \-\-xuser SRC=DST +Set up a user translation. You can specify multiple user +translations with multiple \fB\-\-xuser\fP arguments. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-force +Overwrite all destination objects, even if they appear to be the +same as the source objects. +.UNINDENT +.SH ENVIRONMENT VARIABLES +.INDENT 0.0 +.TP +.B SRC_AKEY +Access key for the source URL +.UNINDENT +.INDENT 0.0 +.TP +.B SRC_SKEY +Secret access key for the source URL +.UNINDENT +.INDENT 0.0 +.TP +.B DST_AKEY +Access key for the destination URL +.UNINDENT +.INDENT 0.0 +.TP +.B DST_SKEY +Secret access key for the destination URL +.UNINDENT +.INDENT 0.0 +.TP +.B AKEY +Access key for both source and dest +.UNINDENT +.INDENT 0.0 +.TP +.B SKEY +Secret access key for both source and dest +.UNINDENT +.INDENT 0.0 +.TP +.B DST_CONSISTENCY +Set to \(aqeventual\(aq if the destination is eventually consistent. If the destination +is eventually consistent, we may have to retry certain operations multiple times. +.UNINDENT +.SH EXAMPLES +.sp +.nf +.ft C +AKEY=... SKEY=... obsync \-c \-d \-v ./backup\-directory s3://myhost1/mybucket1 +.ft P +.fi +.sp +Copy objects from backup\-directory to mybucket1 on myhost1: +.sp +.nf +.ft C +SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync \-c \-d \-v s3://myhost1/mybucket1 s3://myhost1/mybucket2 +.ft P +.fi +.sp +Copy objects from mybucket1 to mybucket2 +.SH AVAILABILITY +.sp +\fBobsync\fP is part of the Ceph distributed file system. Please refer +to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more +information. +.SH COPYRIGHT +2011, New Dream Network +.\" Generated by docutils manpage writer. +.\" +. diff --git a/man/obsync.8 b/man/obsync.8 deleted file mode 100644 index 57b44a0cb0539..0000000000000 --- a/man/obsync.8 +++ /dev/null @@ -1,180 +0,0 @@ -.TH "OBSYNC" "8" "September 22, 2011" "dev" "Ceph" -.SH NAME -obsync \- The object synchronizer 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 -.. -.\" Man page generated from reStructeredText. -. -.SH SYNOPSIS -.nf -\fBobsync\fP [ \fIoptions\fP ] \fIsource\-url\fP \fIdestination\-url\fP -.fi -.sp -.SH DESCRIPTION -.sp -\fBobsync\fP is an object syncrhonizer tool designed to transfer objects -between different object storage systems. Similar to rsync, you -specify a source and a destination, and it will transfer objects -between them until the destination has all the objects in the -source. Obsync will never modify the source \-\- only the destination. -.sp -By default, obsync does not delete anything. However, by specifying -\fB\-\-delete\-after\fP or \fB\-\-delete\-before\fP, you can ask it to delete -objects from the destination that are not in the source. -.SH TARGET TYPES -.sp -Obsync supports S3 via \fBlibboto\fP. To use the s3 target, your URL -should look like this: \fBs3://host\-name/bucket\-name\fP -.sp -Obsync supports storing files locally via the \fBfile://\fP target. To -use the file target, your URL should look like this: -\fBfile://directory\-name\fP -.sp -Alternately, give no prefix, like this: \fB./directory\-name\fP -.sp -Obsync supports storing files in a RADOS Gateway backend via the -\fBlibrados\fP Python bindings. To use the \fBrgw\(ga target, your URL -should look like this: \(ga\(gargw:ceph\-configuration\-path:rgw\-bucket\-name\fP -.SH OPTIONS -.INDENT 0.0 -.TP -.B \-h, \-\-help -Display a help message -.UNINDENT -.INDENT 0.0 -.TP -.B \-n, \-\-dry\-run -Show what would be done, but do not modify the destination. -.UNINDENT -.INDENT 0.0 -.TP -.B \-c, \-\-create\-dest -Create the destination if it does not exist. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-delete\-before -Before copying any files, delete objects in the destination that -are not in the source. -.UNINDENT -.INDENT 0.0 -.TP -.B \-L, \-\-follow\-symlinks -Follow symlinks when dealing with \fBfile://\fP targets. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-no\-preserve\-acls -Don\(aqt preserve ACLs when copying objects. -.UNINDENT -.INDENT 0.0 -.TP -.B \-v, \-\-verbose -Be verbose. -.UNINDENT -.INDENT 0.0 -.TP -.B \-V, \-\-more\-verbose -Be really, really verbose (developer mode) -.UNINDENT -.INDENT 0.0 -.TP -.B \-x SRC=DST, \-\-xuser SRC=DST -Set up a user translation. You can specify multiple user -translations with multiple \fB\-\-xuser\fP arguments. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-force -Overwrite all destination objects, even if they appear to be the -same as the source objects. -.UNINDENT -.SH ENVIRONMENT VARIABLES -.INDENT 0.0 -.TP -.B SRC_AKEY -Access key for the source URL -.UNINDENT -.INDENT 0.0 -.TP -.B SRC_SKEY -Secret access key for the source URL -.UNINDENT -.INDENT 0.0 -.TP -.B DST_AKEY -Access key for the destination URL -.UNINDENT -.INDENT 0.0 -.TP -.B DST_SKEY -Secret access key for the destination URL -.UNINDENT -.INDENT 0.0 -.TP -.B AKEY -Access key for both source and dest -.UNINDENT -.INDENT 0.0 -.TP -.B SKEY -Secret access key for both source and dest -.UNINDENT -.INDENT 0.0 -.TP -.B DST_CONSISTENCY -Set to \(aqeventual\(aq if the destination is eventually consistent. If the destination -is eventually consistent, we may have to retry certain operations multiple times. -.UNINDENT -.SH EXAMPLES -.sp -.nf -.ft C -AKEY=... SKEY=... obsync \-c \-d \-v ./backup\-directory s3://myhost1/mybucket1 -.ft P -.fi -.sp -Copy objects from backup\-directory to mybucket1 on myhost1: -.sp -.nf -.ft C -SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync \-c \-d \-v s3://myhost1/mybucket1 s3://myhost1/mybucket2 -.ft P -.fi -.sp -Copy objects from mybucket1 to mybucket2 -.SH AVAILABILITY -.sp -\fBobsync\fP is part of the Ceph distributed file system. Please refer -to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more -information. -.SH COPYRIGHT -2011, New Dream Network -.\" Generated by docutils manpage writer. -.\" -.