Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

rdiff-backup (2) Versions 1.0.1

Installs/Configures rdiff-backup

Berkshelf/Librarian
Policyfile
Knife
cookbook 'rdiff-backup', '~> 1.0.1'
cookbook 'rdiff-backup', '~> 1.0.1', :supermarket
knife cookbook site install rdiff-backup
knife cookbook site download rdiff-backup
README
Dependencies
Quality 33%

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

Dependent cookbooks

sudo >= 0.0.0
ssh_known_hosts >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric
            

1.0.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

1.0.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

1.0.1 failed this metric

FC039: Node method cannot be accessed with key: rdiff-backup/definitions/backup_path.rb:9
FC064: Ensure issues_url is set in metadata: rdiff-backup/metadata.rb:1
FC065: Ensure source_url is set in metadata: rdiff-backup/metadata.rb:1
FC066: Ensure chef_version is set in metadata: rdiff-backup/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: rdiff-backup/metadata.rb:1
FC069: Ensure standardized license defined in metadata: rdiff-backup/metadata.rb:1
Run with Foodcritic Version 12.2.1 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

1.0.1 failed this metric

rdiff-backup does not have a valid open source license.
Acceptable licenses include Apache-2.0, apachev2, Apache 2.0, MIT, mit, GPL-2.0, gplv2, GNU Public License 2.0, GPL-3.0, gplv3, GNU Public License 3.0.

No Binaries Metric
            

1.0.1 passed this metric

Publish Metric
            

1.0.1 passed this metric

Supported Platforms Metric
            

1.0.1 failed this metric

rdiff-backup should declare what platform(s) it supports.

Testing File Metric
            

1.0.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

1.0.1 passed this metric