Forge Home

ccollect

Manage ccollect

14,235 downloads

7,164 latest version

4.6 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.2.1 (latest)
  • 1.2.0
  • 1.1.0
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Jan 8th 2017
This version is compatible with:
  • Debian, Ubuntu

Start using this module

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

Add this module to your Puppetfile:

mod 'saz-ccollect', '1.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add saz-ccollect
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install saz-ccollect --version 1.2.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

Documentation

saz/ccollect — version 1.2.1 Jan 8th 2017

puppet-ccollect

Manage ccollect via Puppet

How to use

Destination node

    class { 'ccollect':
        backup_dir = '/backup/ccollect/',
    }

    # Realize all collected nodes
    Ccollect::Backup <<| |>> {
        ensure => present,
    }

Source node(s)

    @@ccollect::backup {
        source_host       => $fqdn,
        ssh_user          => root,
        source            => '/',
        exclude           => 'puppet:///files/another/exclude/file',
        rsync_options     => '',
        delete_incomplete => 'y',
        pre_exec          => 'puppet:///files/path/to/pre/exec/script',
        post_exec         => 'puppet:///files/path/to/post/exec/script',
    }
  • source_host: Host to connect to, most of the time this should be set to $fqdn. Required

  • ssh_user: User to connect as to remote host Default: root

  • source: Start position of rsync Default: /

  • exclude: Exclude list to use Default: 'puppet:///modules/ccollect/exclude'

  • rsync_options: Additional rsync options Default: ''

  • delete_incomplete: Delete incomplete backups Default: y

  • pre_exec: Script to execute before backing up host Default: ''

  • post_exec: Script to execute after backing up host Default: ''