← Back to branch summary

~ubuntu-branches/ubuntu/quantal/ceph/quantal

« back to all changes in this revision

Viewing changes to doc/man/1/obsync.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2012-07-16 09:56:24 UTC
  • mfrom: (0.3.11)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: package-import@ubuntu.com-20120716095624-azr2w4hbhei1rxmx
Tags: upstream-0.48
Import upstream version 0.48

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/1/obsync.rst
 
1
========================================
 
2
 obsync -- The object synchronizer tool
 
3
========================================
 
4
 
 
5
.. program:: obsync
 
6
 
 
7
Synopsis
 
8
========
 
9
 
 
10
| **obsync** [ *options* ] *source-url* *destination-url*
 
11
 
 
12
 
 
13
Description
 
14
===========
 
15
 
 
16
**obsync** is an object syncrhonizer tool designed to transfer objects
 
17
between different object storage systems. Similar to rsync, you
 
18
specify a source and a destination, and it will transfer objects
 
19
between them until the destination has all the objects in the
 
20
source. Obsync will never modify the source -- only the destination.
 
21
 
 
22
By default, obsync does not delete anything. However, by specifying
 
23
``--delete-after`` or ``--delete-before``, you can ask it to delete
 
24
objects from the destination that are not in the source.
 
25
 
 
26
 
 
27
Target types
 
28
============
 
29
 
 
30
Obsync supports S3 via ``libboto``. To use the s3 target, your URL
 
31
should look like this: ``s3://host-name/bucket-name``
 
32
 
 
33
Obsync supports storing files locally via the ``file://`` target. To
 
34
use the file target, your URL should look like this:
 
35
``file://directory-name``
 
36
 
 
37
Alternately, give no prefix, like this: ``./directory-name``
 
38
 
 
39
Obsync supports storing files in a RADOS Gateway backend via the
 
40
``librados`` Python bindings. To use the ``rgw` target, your URL
 
41
should look like this: ``rgw:ceph-configuration-path:rgw-bucket-name``
 
42
 
 
43
 
 
44
Options
 
45
=======
 
46
 
 
47
.. option:: -h, --help
 
48
 
 
49
   Display a help message
 
50
 
 
51
.. option:: -n, --dry-run
 
52
 
 
53
   Show what would be done, but do not modify the destination.
 
54
 
 
55
.. option:: -c, --create-dest
 
56
 
 
57
   Create the destination if it does not exist.
 
58
 
 
59
.. option:: --delete-before
 
60
 
 
61
   Before copying any files, delete objects in the destination that
 
62
   are not in the source.
 
63
 
 
64
.. option:: -L, --follow-symlinks
 
65
 
 
66
   Follow symlinks when dealing with ``file://`` targets.
 
67
 
 
68
.. option:: --no-preserve-acls
 
69
 
 
70
   Don't preserve ACLs when copying objects.
 
71
 
 
72
.. option:: -v, --verbose
 
73
 
 
74
   Be verbose.
 
75
 
 
76
.. option:: -V, --more-verbose
 
77
 
 
78
   Be really, really verbose (developer mode)
 
79
 
 
80
.. option:: -x SRC=DST, --xuser SRC=DST
 
81
 
 
82
   Set up a user translation. You can specify multiple user
 
83
   translations with multiple ``--xuser`` arguments.
 
84
 
 
85
.. option:: --force
 
86
 
 
87
   Overwrite all destination objects, even if they appear to be the
 
88
   same as the source objects.
 
89
 
 
90
 
 
91
Environment variables
 
92
=====================
 
93
 
 
94
.. envvar:: SRC_AKEY
 
95
 
 
96
   Access key for the source URL
 
97
 
 
98
.. envvar:: SRC_SKEY
 
99
 
 
100
   Secret access key for the source URL
 
101
 
 
102
.. envvar:: DST_AKEY
 
103
 
 
104
   Access key for the destination URL
 
105
 
 
106
.. envvar:: DST_SKEY
 
107
 
 
108
   Secret access key for the destination URL
 
109
 
 
110
.. envvar:: AKEY
 
111
 
 
112
   Access key for both source and dest
 
113
 
 
114
.. envvar:: SKEY
 
115
 
 
116
   Secret access key for both source and dest
 
117
 
 
118
.. envvar:: DST_CONSISTENCY
 
119
 
 
120
   Set to 'eventual' if the destination is eventually consistent. If the destination
 
121
   is eventually consistent, we may have to retry certain operations multiple times.
 
122
 
 
123
 
 
124
Examples
 
125
========
 
126
 
 
127
::
 
128
 
 
129
        AKEY=... SKEY=... obsync -c -d -v ./backup-directory s3://myhost1/mybucket1
 
130
 
 
131
Copy objects from backup-directory to mybucket1 on myhost1::
 
132
 
 
133
        SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync -c -d -v s3://myhost1/mybucket1 s3://myhost1/mybucket2
 
134
 
 
135
Copy objects from mybucket1 to mybucket2
 
136
 
 
137
 
 
138
Availability
 
139
============
 
140
 
 
141
**obsync** is part of the Ceph distributed file system. Please refer
 
142
to the Ceph wiki at http://ceph.newdream.net/wiki for more
 
143
information.