Forge Home

etckeeper

Puppet Module for managing etckeeper

21,168 downloads

2,886 latest version

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

  • 2.0.0 (latest)
  • 1.2.3
  • 1.2.2
  • 1.2.1
  • 1.2.0
  • 1.1.0
  • 1.0.0
released Jun 8th 2021
This version is compatible with:
  • Puppet Enterprise 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, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >=5.5.10 <8.0.0
  • , , , , , , , Archlinux

Start using this module

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

Add this module to your Puppetfile:

mod 'bodgit-etckeeper', '2.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bodgit-etckeeper
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bodgit-etckeeper --version 2.0.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: etckeeper

Documentation

bodgit/etckeeper — version 2.0.0 Jun 8th 2021

etckeeper

Build Status Codecov Puppet Forge version Puppet Forge downloads Puppet Forge - PDK version

Table of Contents

  1. Description
  2. Setup - The basics of getting started with etckeeper
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module ensures that etckeeper is set up and configured to keep the /etc directory under version control.

RHEL/CentOS, Ubuntu, Debian, SLES and Arch Linux are supported using Puppet 5 or later.

Setup

What etckeeper affects

This module will remove any VCS state directories under /etc for any supported VCS except the one chosen to be used. So for example, if you're using git, any directories matching /etc/.bzr, /etc/.hg and /etc/_darcs will be removed. This also means that if you change VCS you will lose any previous commits.

Setup Requirements

On RHEL/CentOS platforms you will need to have access to the EPEL repository by using puppet/epel or by other means.

Beginning with etckeeper

In the very simplest case, you can just include the following:

include etckeeper

Usage

For example to configure etckeeper to use a specific VCS instead of going with the default:

class { 'etckeeper':
  vcs => 'bzr',
}

Reference

The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-etckeeper/ and available also in the REFERENCE.md.

Limitations

This module has been built on and tested against Puppet 5 and higher.

The module has been tested on:

  • Red Hat/CentOS Enterprise Linux 6/7
  • Ubuntu 14.04/16.04
  • Debian 7/8

It should also work on SLES 11 & 12 and Arch Linux.

Development

The module relies on PDK and has both rspec-puppet and beaker-rspec tests. Run them with:

$ bundle exec rake spec
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:<nodeset>

Please log issues or pull requests at github.