Metadata-Version: 2.1
Name: backwork-backup-files
Version: 0.1.3
Summary: Backwork plug-in for file backups.
Home-page: https://github.com/IBM/backwork-backup-files
Author: Leons Petrazickis
Author-email: leonsp@ca.ibm.com
License: Apache 2
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
Requires-Dist: backwork

# monsoon-backup-files

[![Build Status](https://travis.ibm.com/apset/monsoon-backup-files.svg?token=sEYcW68KU3tGRyi3z1eH&branch=master)](https://travis.ibm.com/apset/monsoon-backup-files)

Add support for file backups on [`monsoon`](https://github.ibm.com/apset/monsoon).

## Requirements
This plug-in is build on top of [`tar`](https://linux.die.net/man/1/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
```sh
$ pip install monsoon-backup-files
```

Alternatively, you can install it directly from GHE:
```sh
$ pip install git+ssh://git@github.ibm.com/apset/monsoon-backup-files
```

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

```sh
$ 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`:

```sh
$ 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
```


