Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simp/pupmod-simp-rsync

The SIMP rsync Puppet Module
https://github.com/simp/pupmod-simp-rsync

puppet rsync simp

Last synced: about 2 months ago
JSON representation

The SIMP rsync Puppet Module

Awesome Lists containing this project

README

        

[![License](https://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/73/badge)](https://bestpractices.coreinfrastructure.org/projects/73)
[![Puppet Forge](https://img.shields.io/puppetforge/v/simp/rsync.svg)](https://forge.puppetlabs.com/simp/rsync)
[![Puppet Forge Downloads](https://img.shields.io/puppetforge/dt/simp/rsync.svg)](https://forge.puppetlabs.com/simp/rsync)
[![Build Status](https://travis-ci.org/simp/pupmod-simp-rsync.svg)](https://travis-ci.org/simp/pupmod-simp-rsync)

## This is a SIMP module

This module is a component of the [System Integrity Management Platform](https://simp-project.com),
a compliance-management framework built on Puppet.

If you find any issues, they can be submitted to our [JIRA](https://simp-project.atlassian.net/).

Please read our [Contribution Guide](https://simp.readthedocs.io/en/stable/contributors_guide/index.html).

## 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:
-
-
```

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](./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](./metadata.json) for the most up-to-date list of
supported operating systems, Puppet versions, and module dependencies.

## Development

Please read our [Contribution Guide](https://simp.readthedocs.io/en/stable/contributors_guide/index.html).

Visit the project homepage on [GitHub](https://simp-project.com),
and look at our issues on [JIRA](https://simp-project.atlassian.net/).