-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"name": "rdiff-backup", | ||
"description": "Installs/Configures rdiff-backup", | ||
"long_description": "rdiff-backup Cookbook\n=====================\n\nThis cookbook configures backup using the [rdiff-backup backup tool](http://rdiff-backup.nongnu.org/ \"rdiff-backup home page\").\n\nRequirements\n------------\n\n### ssh key\n\nPut a ssh private key into `files/default/#{node['rdiff-backup']['key']}` and the \ncorresponding public one into `files/default/#{node['rdiff-backup']['key']}.pub`.\n\nThis key will be used for the `rdiff-backup` user that runs the backups.\n\n### Cookbooks:\n\n* ssh\\_known\\_hosts\n* sudo\n\nAttributes\n----------\n\n### rdiff-backup::default\n\n<table>\n <tr>\n <th>Key</th>\n <th>Type</th>\n <th>Description</th>\n <th>Default</th>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['backup_dir']</tt></td>\n <td>String</td>\n <td>where to put the backup files</td>\n <td><tt>/backup</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['etc_dir']</tt></td>\n <td>String</td>\n <td>where to put the rdiff-backup config files</td>\n <td><tt>/etc/rdiff-backup</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['user']</tt></td>\n <td>Boolean</td>\n <td>the user to run the backup task as</td>\n <td><tt>rdiff-backup</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['key']</tt></td>\n <td>String</td>\n <td>the ssh key file name</td>\n <td><tt>id_rsa</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['enable']</tt></td>\n <td>Boolean</td>\n <td>whether to setup a cron job for automated backups</td>\n <td><tt>true</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['email']</tt></td>\n <td>String</td>\n <td>where to send summary emails</td>\n <td><tt>nil</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['lockfile']</tt></td>\n <td>String</td>\n <td>where to write the cron job lockfile</td>\n <td><tt>/tmp/rdiff-backup.lock</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['day']</tt></td>\n <td>String</td>\n <td>`day` component of the cron job definition</td>\n <td><tt>*</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['hour']</tt></td>\n <td>String</td>\n <td>`hour` component of the cron job definition</td>\n <td><tt>*</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['minute']</tt></td>\n <td>String</td>\n <td>`minute` component of the cron job definition</td>\n <td><tt>*</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['month']</tt></td>\n <td>String</td>\n <td>`month` component of the cron job definition</td>\n <td><tt>*</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['cron']['weekday']</tt></td>\n <td>String</td>\n <td>`weekday` component of the cron job definition</td>\n <td><tt>*</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['autotrim']['enable']</tt></td>\n <td>Boolean</td>\n <td>whether to auto trim backups</td>\n <td><tt>true</tt></td>\n </tr>\n <tr>\n <td><tt>['rdiff-backup']['autotrim']['timespan']</tt></td>\n <td>String</td>\n <td>backup retention timespan (in rdiff-backup format)</td>\n <td><tt>1y</tt></td>\n </tr>\n</table>\n\nDefinitions\n-----------\n\n### backup\\_path\n\nAdds a path to the backup directory list.\n\n\nUsage\n-----\n\n### recipes\n\n#### rdiff-backup::default\n\nUsed in the other recipes. Do not call directly.\n\n#### rdiff-backup::client\n\nSets up the client (= host to be backed up) side.\n\n#### rdiff-backup::server\n\nSets up the server (= host to save backups to) side.\n\nThis will do things: if enabled, a cron job is created that backs up all \nconfigured rdiff-backup clients, and scripts to run on demand backups of each \nsingle client.\n\n###definitions\n\n#### backup\\_path\n`backup_path \"/var/lib/mailman\"`\n\nAdds the mailman home directory to be backed up.\n\n### pre and post backup scripts\n\nYou can put shell scripts into `#{node['rdiff-backup']['etc_dir']}/pre.d` and \n`#{node['rdiff-backup']['etc_dir']}/post.d` folders to be run before and after \nthe backup itself respectively.\n\nContributing\n------------\n\n1. Fork the repository on Github\n2. Create a named feature branch (like `add_component_x`)\n3. Write you change\n4. Write tests for your change (if applicable)\n5. Run the tests, ensuring they all pass\n6. Submit a Pull Request using Github\n\nLicense and Authors\n-------------------\nAuthors: ka’imi <[email protected]>\n", | ||
"maintainer": "Piratenfraktion NRW", | ||
"maintainer_email": "[email protected]", | ||
"license": "GPLv3", | ||
"platforms": { | ||
}, | ||
"dependencies": { | ||
"ssh_known_hosts": ">= 0.0.0", | ||
"sudo": ">= 0.0.0" | ||
}, | ||
"recommendations": { | ||
}, | ||
"suggestions": { | ||
}, | ||
"conflicting": { | ||
}, | ||
"providing": { | ||
}, | ||
"replacing": { | ||
}, | ||
"attributes": { | ||
}, | ||
"groupings": { | ||
}, | ||
"recipes": { | ||
}, | ||
"version": "1.0.0" | ||
} |