bodgit/puppet-etckeeper

Puppet Module for managing etckeeper

etckeeper

Table of Contents

1. Description
2. Setup - The basics of getting started with etckeeper
   • What etckeeper affects
   • Setup requirements
   • Beginning 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.

puppet-etckeeper's Issues

Compatibility with puppetlabs-stdlib (v6.x)

It seems to work fine with newer puppetlabs-stdlib (v6.x) but I am not completely sure. Maybe the dependency changed and the version bumped?

Add config switch if vcs package should be installed

We have git package already defined in another puppet module.

Would be nice vcs package install is configurable

Convert to Litmus

Drop old Puppet versions

git user.email and user.name should be set on Debian/Ubuntu

If git is used the git configuration should be done for etckeeper.
After installing a new package onCentOS 7 i got:

etckeeper: post transaction commit

*** Please tell me who you are.

Run

  git config --global user.email "[email protected]"
  git config --global user.name "Your Name"

to set your account's default identity.
Omit --global to set the identity only in this repository.

fatal: unable to auto-detect email address (got 'root@centos.(none)')
warning: etckeeper failed to commit changes in /etc using git

Why is Ubuntu 14.04 configured to use bzr?

In https://github.com/bodgit/puppet-etckeeper/blob/master/manifests/params.pp vcs for Ubuntu 14.04 is set to bzr instead of git.

Why?

Compatibility with newer Debian and Ubuntu versions

It seems to work fine on Debian 9 and Debian 10 - not sure about Ubuntu. Maybe the compatibility should be adjusted and the version should be bumped.

Add option for yum plugin configuration

Should just be confined for $::osfamily = 'RedHat'

Evaluation Error: Unknown function: 'has_key' in install.pp

This module does no longer work with the current version of puppetlabs-stdlib.

In this MR the has_key function was removed.

puppetlabs/puppetlabs-stdlib#1319

Is this repository still managed? Would you accept a pull request? Or maybe this module can be transfered to voxpupuli team?

Is there any way to exclude files via the module?

We have a proxmox host which uses /etc/pve/.rrd to write rrd data :-/
Etckeeper constantly complains when installing new packages about uncommitted changes.

Preconfiguring packages ...
dpkg: warning: 'ldconfig' not found in PATH or not executable
dpkg: warning: 'start-stop-daemon' not found in PATH or not executable
dpkg: error: 2 expected programs not found in PATH or not executable
Note: root's PATH should usually contain /usr/local/sbin, /usr/sbin and /sbin
# On branch master
# Changes not staged for commit:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#       modified:   pve/local
#       modified:   pve/openvz
#       modified:   pve/qemu-server
#
no changes added to commit (use "git add" and/or "git commit -a")
E: Problem executing scripts DPkg::Post-Invoke 'if [ -x /usr/bin/etckeeper ]; then etckeeper post-install; fi'
E: Sub-process returned an error code
E: Sub-process /usr/bin/dpkg returned an error code (2)

Manual run via:

$ git add --all .;git commit -m "manual entry"
[master ae42962] manual entry
 1 file changed, 29 insertions(+), 29 deletions(-)
 rewrite pve/.rrd (81%)

Fixes it only until next run.

Convert to PDK

Drop old OS versions