Forge Home

rsync

Puppet module to install and configure rsync

910,334 downloads

17,393 latest version

2.0 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.

Version information

  • 1.2.0 (latest)
  • 1.1.3
  • 1.1.1
  • 1.1.0
  • 1.0.0
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.0
  • 0.1.0
released Jan 31st 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetlabs-rsync', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-rsync --version 0.2.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
Tags: rsync

Documentation

puppetlabs/rsync — version 0.2.0 Jan 31st 2014

puppetlabs-rsync

puppetlabs-rsync manages rsync clients, repositories, and servers as well as providing defines to easily grab data via rsync.

Definition: rsync::get

get files via rsync

Parameters:

$source   - source to copy from
$path     - path to copy to, defaults to $name
$user     - username on remote system
$purge    - if set, rsync will use '--delete'
$exlude   - string to be excluded
$keyfile  - ssh key used to connect to remote host
$timeout  - timeout in seconds, defaults to 900
$execuser - user to run the command (passed to exec)

Actions:

get files via rsync

Requires:

$source must be set

Sample Usage:

# get file 'foo' via rsync
rsync::get { '/foo':
  source  => "rsync://${rsyncServer}/repo/foo/",
  require => File['/foo'],
}

Definition: rsync::server::module

sets up a rsync server

Parameters:

$path           - path to data
$comment        - rsync comment
$motd           - file containing motd info
$read_only      - yes||no, defaults to yes
$write_only     - yes||no, defaults to no
$list           - yes||no, defaults to no
$uid            - uid of rsync server, defaults to 0
$gid            - gid of rsync server, defaults to 0
$incoming_chmod - incoming file mode, defaults to 644
$outgoing_chmod - outgoing file mode, defaults to 644

Actions:

sets up an rsync server

Requires:

$path must be set

Sample Usage:

# setup default rsync repository
rsync::server::module{ 'repo':
  path    => $base,
  require => File[$base],
}