rdiff-backup Cookbook

This cookbook configures backup using the rdiff-backup backup tool.

Requirements

ssh key

Put a ssh private key into files/default/#{node['rdiff-backup']['key']} and the
corresponding public one into files/default/#{node['rdiff-backup']['key']}.pub.

This key will be used for the rdiff-backup user that runs the backups.

Cookbooks:

• ssh_known_hosts
• sudo

Attributes

rdiff-backup::default

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['rdiff-backup']['backup_dir']</tt></td>
<td>String</td>
<td>where to put the backup files</td>
<td><tt>/backup</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['etc_dir']</tt></td>
<td>String</td>
<td>where to put the rdiff-backup config files</td>
<td><tt>/etc/rdiff-backup</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['user']</tt></td>
<td>Boolean</td>
<td>the user to run the backup task as</td>
<td><tt>rdiff-backup</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['key']</tt></td>
<td>String</td>
<td>the ssh key file name</td>
<td><tt>id_rsa</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['enable']</tt></td>
<td>Boolean</td>
<td>whether to setup a cron job for automated backups</td>
<td><tt>true</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['email']</tt></td>
<td>String</td>
<td>where to send summary emails</td>
<td><tt>nil</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['lockfile']</tt></td>
<td>String</td>
<td>where to write the cron job lockfile</td>
<td><tt>/tmp/rdiff-backup.lock</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['day']</tt></td>
<td>String</td>
<td>day component of the cron job definition</td>
<td><tt></tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['hour']</tt></td>
<td>String</td>
<td>hour component of the cron job definition</td>
<td><tt></tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['minute']</tt></td>
<td>String</td>
<td>minute component of the cron job definition</td>
<td><tt></tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['month']</tt></td>
<td>String</td>
<td>month component of the cron job definition</td>
<td><tt></tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['cron']['weekday']</tt></td>
<td>String</td>
<td>weekday component of the cron job definition</td>
<td><tt>*</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['autotrim']['enable']</tt></td>
<td>Boolean</td>
<td>whether to auto trim backups</td>
<td><tt>true</tt></td>
</tr>
<tr>
<td><tt>['rdiff-backup']['autotrim']['timespan']</tt></td>
<td>String</td>
<td>backup retention timespan (in rdiff-backup format)</td>
<td><tt>1y</tt></td>
</tr>
</table>

Definitions

backup_path

Adds a path to the backup directory list.

Usage

recipes

rdiff-backup::default

Used in the other recipes. Do not call directly.

rdiff-backup::client

Sets up the client (= host to be backed up) side.

rdiff-backup::server

Sets up the server (= host to save backups to) side.

This will do things: if enabled, a cron job is created that backs up all
configured rdiff-backup clients, and scripts to run on demand backups of each
single client.

definitions

backup_path

backup_path "/var/lib/mailman"

Adds the mailman home directory to be backed up.

pre and post backup scripts

You can put shell scripts into #{node['rdiff-backup']['etc_dir']}/pre.d and
#{node['rdiff-backup']['etc_dir']}/post.d folders to be run before and after
the backup itself respectively.

Contributing

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write you change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github

License and Authors

Authors: ka’imi kaimi@piratenfraktion-nrw.de