Forge Home

rsync

UNKNOWN

10,253 downloads

10,019 latest version

1.9 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

  • 1.1.0 (latest)
  • 1.0.0
released Sep 13th 2013

Start using this module

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

Add this module to your Puppetfile:

mod 'proudsourcing-rsync', '1.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add proudsourcing-rsync
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install proudsourcing-rsync --version 1.1.0

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

Documentation

proudsourcing/rsync — version 1.1.0 Sep 13th 2013

proudsourcing-rsyncbackup

Puppet module to create backups using tar and transfer backups using rsync.

Usage

class { 'ps_rsyncbackup':   }

Configuration

Create backups

ps_rsyncbackup::backup { 'myname':
    backup_source_dir   => "/var/www/",
    backup_target_dir   => "/backups/www/",
    backup_rotate       => 14,
    backup_time_hour    => 3,
    backup_time_min     => 0,
}

Default values:

$backup_source_dir      = $ps_rsyncbackup::params::backup_source_dir,   # backup source directory
$backup_target_dir      = $ps_rsyncbackup::params::backup_target_dir,   # backup target directory

$backup_rotate          = 7,                # number ob backups to keep
$backup_time_hour       = 3,                # cronjob hour
$backup_time_min        = 0,                # cronjob minute
$backup_time_day        = "*",              # cronjob weekday
$backup_user            = "root",           # user file/cron
$backup_group           = "root",           # group file/cron
$backup_ensure          = "present",        # create or remove
$backup_name            = $name,            # name of backup
$backup_comment         = "",               # only a comment for you

Transfer backups

ps_rsyncbackup::transfer { 'myname':
    backup_source_dir   => "/var/www/",
    backup_target_dir   => "/backups/www/",
    backup_rotate       => 14,
    backup_time_hour    => 3,
    backup_time_min     => 0,
}

Default values:

$backup_source_dir      = $ps_rsyncbackup::params::backup_source_dir,   # transfer source directory
$backup_target_dir      = $ps_rsyncbackup::params::backup_target_dir,   # transfer target directory

$backup_exclude_dir     = ""                # exclude directories (array)
$backup_source_host     = "",               # source host ip/name
$backup_time_hour       = 3,                # cronjob hour
$backup_time_min        = 0,                # cronjob minute
$backup_time_day        = "*",              # cronjob weekday
$backup_user            = "root",           # user file/cron
$backup_group           = "root",           # group file/cron
$backup_ensure          = "present",        # create or remove
$backup_name            = $name,            # name of transfer
$backup_comment         = "",               # only a comment for you
$backup_mail            = true,             # send logs per mail
$backup_mail_address    = ""                # mail-adress for sending logs

Changelog

1.0.0   13.09.2013      Release
1.1.0   13.09.2013      add backup_exlude_dir array for transfers

License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Copyright

Proud Sourcing GmbH 2013
www.proudsourcing.de / www.proudcommerce.com