-- mode: markdown; mode: visual-line; --
Configure and manage BackupPC server and clients
Copyright (c) 2017 Hyacinthe Cartiaux <[email protected]>
| Project Page | Sources | Documentation | Issues |
Configure and manage BackupPC server and clients.
This module implements the following elements:
-
Puppet classes:
-
Puppet definitions:
All these components are configured through a set of variables you will find in
manifests/params.pp
.
Note: the various operations that can be conducted from this repository are piloted from a Rakefile
and assumes you have a running Ruby installation.
See docs/contributing.md
for more details on the steps you shall follow to have this Rakefile
working properly.
See metadata.json
. In particular, this module depends on
This is the main class defined in this module. It accepts the following parameters:
$ensure
: default to 'present', can be 'absent'
Use it as follows:
include ' backuppc'
See also tests/init.pp
You can of course configure the backuppc module in your Puppetfile
to make it available with Librarian puppet or
r10k by adding the following entry:
# Modules from the Puppet Forge
mod "ULHPC/backuppc"
or, if you prefer to work on the git version:
mod "ULHPC/backuppc",
:git => 'https://github.com/ULHPC/puppet-backuppc',
:ref => 'production'
You can submit bug / issues / feature request using the ULHPC/backuppc Puppet Module Tracker.
If you want to contribute to the code, you shall be aware of the way this module is organized.
These elements are detailed on docs/contributing.md
.
You are more than welcome to contribute to its development by sending a pull request.
The best way to test this module in a non-intrusive way is to rely on Vagrant.
The Vagrantfile
at the root of the repository pilot the provisioning various vagrant boxes available on Vagrant cloud you can use to test this module.
See docs/vagrant.md
for more details.
Read the Docs aka RTFD hosts documentation for the open source community and the ULHPC/backuppc puppet module has its documentation (see the docs/
directly) hosted on readthedocs.
See docs/rtfd.md
for more details.
This project and the sources proposed within this repository are released under the terms of the Apache-2.0 licence.