puppet-etckeeper

Table of Contents

1. Overview
2. Module Description
3. Setup - The basics of getting started with etckeeper
   • What etckeeper affects
   • Setup requirements
   • Beginning with etckeeper
4. Usage - Configuration options and additional functionality
5. Reference
6. Limitations
7. Copyright and License

Overview

Manage etckeeper to keep /etc under git version control.

Module Description

This module installs and configures etckeeper with git as the version control backend. etckeeper automatically commits changes to /etc on package installations and provides a daily cronjob for uncommitted changes.

Setup

What etckeeper affects

• The etckeeper and git packages.
• The etckeeper configuration file at /etc/etckeeper/etckeeper.conf.
• Initializes a git repository in /etc via etckeeper init.
• Optionally configures git user name and email in /etc/.git/config.
• Optionally manages additional entries in /etc/.gitignore.

Setup requirements

Please review metadata.json for a list of requirements.

On RHEL-based systems, the EPEL repository is required as etckeeper is not available in the base repositories.

Beginning with etckeeper

include etckeeper is all you need to get it running.

Usage

All interaction with the etckeeper module can be done through the main etckeeper class. Parameters are configured via Hiera.

Basic

include etckeeper

Setting a git user for commits

etckeeper::vcs_user_name: 'root'
etckeeper::vcs_user_email: 'root@example.com'

Adding custom gitignore entries

etckeeper::gitignore_entries:
  - '*.secret'
  - 'ssl/private/'

Disabling daily autocommits

etckeeper::avoid_daily_autocommits: true

Pushing to a remote after each commit

etckeeper::push_remotes:
  - 'origin'

Passing additional options to git commit

etckeeper::git_commit_options: '--no-gpg-sign'

Reference

Reference documentation is generated using puppet-strings and available in REFERENCE.md.

Limitations

See metadata.json for supported and tested operating systems.

Copyright and License

This module is distributed under the MIT License.