Rdiff-image-s3
NAME
rdiff-image-s3 - transfer backups to Amazon S3
SYNOPSIS
rdiff-images-s3
[options]
bucket
[log-file
[QTYxAGE[,...]
backup...]]
DESCRIPTION
rdiff-image-s3
transfers and manages backups on Amazon's S3 service.
Usually this program is not used directly
but rather invoked via a wrapper script
rdiff-image-cron(1).
ARGUMENTS
- bucket
-
Identifies the buckets to use on S3.
It is used as a prefix. The two bucket names generated from it are:
bucket_base and bucket_secret.
- log-file
-
The name of a file to append usage statistics to.
If not present or
-
no log entries are recorded.
The log contains lines of the following format
(split into two lines for readability):
-
-
time,bucket,action,key,size,bytes_up,\\\\
bytes_down,bytes_in_bucket,status,message
where:
-
- time
-
the time this entry was made, UTC, format: yyyy-mm-ddThh:mm:ss.
- bucket
-
name of the bucket being used.
- action
-
is
open
for opening a connection,
send
for sending a backup, and
delete
for deleting a backup.
- key
-
the key used in S3, as it appeared on the command line.
- size
-
size of the backup being acted upon, in bytes.
- bytes_down
-
bytes received over the TCP stream.
- bytes_up
-
bytes send over the TCP stream.
- bytes_in_bucket
-
total bytes in the bucket after the operation completed.
- status
-
if an error occurred, the status code returned by Amazon.
- message
-
message associated with the status.
Commas
(,)
have been replaced with semicolons
(;).
- QTYxAGE[,...]
-
Determines what backups are kept on S3.
QTY
is the number of backups to keep of a particular age.
AGE
is a number followed by the unit, which is one of
hour,
day,
week,
month,
year.
An example: 24x1hour,7x1day,4x1week,6xmonth
would keep 24 hourly backups, 7 daily backups,
4 weekly backups and 6 monthly backups.
A backup is also kept if any kept a backup depends on it.
This option can appear at most once.
If not present or
-
no backups are purged from S3.
- backup
-
The backups to send to S3. The format of each backup is:
-
-
backup-date_[depends-date]_[backup-name]_path-to-backup
where:
-
- backup-date
-
is the date-time the backup was made in the format yyyymmdd-hhmmss.
- depends-date
-
The
- backup-name
-
of a backup this depends on.
Blank if it doesn't depend on another backup.
The usual reason one backup depends on another is it just a set of differences.
- path-to-backup
-
The file to send to S3.
OPTIONS
- -c filename,--check=filename
-
Record the backups on S3 at completion into
filename,
and when supplied on subsequent
runs print an error message if S3 has changed between the runs.
If an error message is printed the program
will exit with an exit status of 3 after its normal tasks have completed.
AUTHOR
Russell Stuart <russell-rdiffimage@stuart.id.au>
SEE ALSO
rdiff-image.conf(5),
rdiff-image-backup(1),
rdiff-image-boot(1),
rdiff-image-cron(1),
rdiff-image-get(1),
rdiff-image-tarutil(1).
The
README.txt
that comes with the rdiff-image package.