Description

This is a small utility I've made for the purpose of automating backups with rsync & tar.

WARNING: This package is not yet stable. Use at own peril.

Why?

I needed something that I could run from cron and manually, log stuff, and that could be also easily configurable through tools like Ansible. Since the configuration is just a YAML file I can generate it with a trivial template file:

{{ rbackup_config | to_nice_yaml }}

Installation

Not available in PyPi yet so you have to install from GitHub:

pip install git+https://github.com/PonderingGrower/rbackup

Or clone it, and build it by hand:

git clone https://github.com/PonderingGrower/rbackup
cd rbackup
./setup.py sdist
pip install dist/rbackup-0.1.tar.gz

Usage

Define configuration in YAML format, usually in /etc/rbackup.yaml:

config:
    log: /tmp/rbackup.log
    pid: /tmp/rbackup.pid
    debug: false
assets:
  - id: example
    type: rsync
    src: /tmp/example
    dest: example
    target: remote_backup
    exclude: [ something, another_thing ]
targets:
  - id: remote_backup
    dest: /mnt/backup
    host: bkp.example.com
    user: userx

Now simply run the backup:

$ rbackup save example
INFO: Starting rsync: /tmp/example -> userx@bkp.example.com:/mnt/backup/example
INFO: Finished in: 6.22s
INFO: sent 20.36K bytes  received 15 bytes  3.13K bytes/sec
INFO: total size is 20.21M  speedup is 991.80

Or restore:

$ rbackup restore example
WARNING: Enabled RESTORE mode!
INFO: Starting rsync: userx@bkp.example.com:/mnt/backup/example -> /tmp/example
INFO: Finished in: 10.72s
INFO: sent 8.41K bytes  received 20.25M bytes  1.76M bytes/sec
INFO: total size is 20.21M  speedup is 1.00

Help

RBackup ver 0.1

This script backups directories configred as 'assets' in the YAML config file.

Usage:
  rbackup (save | restore) <asset>... [-c PATH] [-T SECS] [-t TYPE] [-p PATH]
                                      [-l PATH] [-D] [-s] [-b] [-f] [-d]
  rbackup config
  rbackup -h | --help
  rbackup --version

Options:
  -c PATH --config PATH   Location of YAML config file.
                          [default: ~/rbackup.yaml,/etc/rbackup.yaml]
  -T SECS --timeout SECS  Time after which rsync command will be stopped.
  -p PATH --pid PATH      Path of PID file to check for other running instances.
  -l PATH --log PATH      Path of the log file.
  -t TYPE --type TYPE     Type of backup to execute: rsync / tar
  -D --dryrun             Run the code without executing the backup command.
  -d --debug              Enable debug logging.
  -s --stdin              Get configuration from STDIN as well.
  -b --battery-check      Enable checking for battery power before running.
  -f --force              When used things like running on battery are ignored.

Config: 
  It's a YAML file with a format that includes 2 mandatory keys and 1 optional:
  
  * config - Same as CLI arguments you can provide.
  * assets - Defined assets to backup.
  * targets - Defines destinatoins for the backups.
  
  Configuration can be also provided through standard input using --stdin flag.
  The first found config is merged with the one read from the file.

To Do

• Functional tests
• More sane restore mode
• More types of backups
• More custom options for tar and rsync