backwork-backup-files 0.1.3

Backwork plug-in for file backups.

monsoon-backup-files

Add support for file backups on monsoon.

Requirements

This plug-in is build on top of tar.

Installing

You can use pip to install this plug-in from Artifactory.

First you will need to configure your pip client by creating or editing the ~/.pip/pip.conf file to look like the example below.

Note: Remember to change @ into %40 in your username!

[global]
index-url = https://pypi.python.org/simple
extra-index-url = https://<USERNAME>:<API KEY>@na.artifactory.swg-devops.com/artifactory/api/pypi/apset-pypi-local/simple

After that you should be able to run

$ pip install monsoon-backup-files

Alternatively, you can install it directly from GHE:

$ pip install git+ssh://[e-mail]/apset/monsoon-backup-files

Using

After installing the plug-in you will be able to use the backup files command on monsoon.

$ monsoon backup files -h
usage: monsoon backup files [-h] -f FILE

Back up one or more files. It uses `tar -cz` which gzips the output. You can
use any of the arguments supported by `tar`. Add a list of files and
directories you want backed up as the last thing in the line. Use `tar --help`
for more information.

optional arguments:
  -h, --help            show this help message and exit
  -o FILE, --output FILE  output gzipped file path

You can pass any option that you would normally use on mysqldump:

$ monsoon backup files -o foo.tgz --verbose /tmp /var/log

As shown in the --help message, there is one required arguments you must use in your backup process.

-o FILE or --output FILE will save the output of tar into a file.

Important: There is a conflict with the -h argument since it is reserved for the help/usage message. Use --dereference to follow symlinks.

Building and Publishing

Travis will publish builds for you. To build, push a tag to the repo:

git tag -a v0.1.2 -m 'v0.1.2'
git push --tags