Forge Home

rsync

manage an rsync server, secured by stunnel

15,763 downloads

156 latest version

4.3 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

  • 6.9.1 (latest)
  • 6.8.0
  • 6.7.0
  • 6.6.1
  • 6.6.0
  • 6.5.0
  • 6.4.2
  • 6.4.1
  • 6.4.0
  • 6.3.0
  • 6.2.0
  • 6.1.1
  • 6.1.0
  • 6.0.6
  • 6.0.5
  • 6.0.4
  • 6.0.3
  • 6.0.2
  • 4.2.3
  • 4.2.2
released Jan 17th 2024
This version is compatible with:
  • Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'simp-rsync', '6.9.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install simp-rsync --version 6.9.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: rsync, stunnel, simp

Documentation

simp/rsync — version 6.9.1 Jan 17th 2024

License CII Best Practices Puppet Forge Puppet Forge Downloads Build Status

This is a SIMP module

This module is a component of the System Integrity Management Platform, a compliance-management framework built on Puppet.

If you find any issues, they can be submitted to our JIRA.

Please read our Contribution Guide.

Module Description

This module configures rsync for sharing large files that would be problematic to share using the native Puppet fileserving type.

Setup

Configuring Host as Server and Client

By default, in the 'simp' configuration scenario, an rsync server is configured on the primary Puppet server. In some configurations, it may be necessary to have supplemental rsync servers to sync files to clients (one example: PE MoM and Compile Master architecture).

To configure a Compile Master (or other node) to function as both a server and a client (of the primary server), setup hiera for the node:

rsync::server::global::port: 8873
rsync::server::trusted_nets:
  - <client_net>
  - <client_net>

This will configure an rsync server that utilizes stunnel for connections from the client_nets listed. To configure clients to utilize this new server, set their hieradata:

simp_options::rsync: 'fqdn.rsync.server'

to override the standard 'true' boolean value.

NOTE: If not using stunnel for the server/client connections, both values for rsync::server::trusted_nets and rsync::server::global::trusted_nets will need to match, as well as the trusted_nets values for any rsync::server::section resources. These all default to '127.0.0.1' for stunnel usage.

Reference

Please refer to the REFERENCE.md.

Limitations

SIMP Puppet modules are generally intended for use on Red Hat Enterprise Linux and compatible distributions, such as CentOS. Please see the metadata.json file for the most up-to-date list of supported operating systems, Puppet versions, and module dependencies.

Development

Please read our Contribution Guide.

Visit the project homepage on GitHub, and look at our issues on JIRA.