Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

rsnapshot

Rsnapshot master and node configuration with auto generated and distributed ssh keys.
Project URLRSS FeedReport issues

11,304 downloads

9,325 latest version

2.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.3.1 (latest)
  • 0.3.0
  • 0.2.0
  • 0.1.0
  • 0.0.2
  • 0.0.1
released Apr 2nd 2015
This version is compatible with:
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'ivaldi-rsnapshot', '0.3.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ivaldi-rsnapshot
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ivaldi-rsnapshot --version 0.3.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: ssh, rsnapshot, keys, backups

Documentation

ivaldi/rsnapshot — version 0.3.1 Apr 2nd 2015

#rsnapshot

##Overview The rsnapshot module allows you to setup an rsnapshot backup master and rsnapshot backup nodes. Each node is automatically added to the master and backuped using a cronjob on the master.

##Setup ###Installing a rsnapshot master server To setup a rsnapshot master server with location name dc1, add the following lines to its puppet configuration.

class { 'rsnapshot::master':
  location_name => 'dc1',
  exclusions    => ['var/spool'],
}

This will install rsnapshot, generate a ssh key pair and setup cronjobs to run rsnapshot as root.

###Adding rsnapshot nodes For every server that needs to be backed up to the previously configures rsnapshot master, add the following lines.

class { 'rsnapshot::node':
  to_location => 'dc1',
}

This will add the ssh public key of the rsnapshot master with location_name dc1 to the authorized_keys file of root, allowing rsnapshot to login from the master server. On the rsnapshot master, this will add a line to /etc/rsnapshot.conf to backup this node.

###Increasing security Optionally you might want to use a special backup user so you can disable root to login via ssh, this can be done by using the following syntax.

class { 'rsnapshot::node':
  to_location => 'dc1',
  user        => 'rsnapshot',
}

This will create the user rsnapshot on the node, give it permission to run sudo rsync and add the public key of the rsnapshot master with location_name dc1 to the authorized_keys file of root, allowing rsnapshot to login from the master server as this new rsnapshot user.