REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• etckeeper: Manage etckeeper to keep /etc under git version control.

Private Classes

• etckeeper::config
• etckeeper::install

Classes

etckeeper

Manage etckeeper to keep /etc under git version control.

Examples

Basic usage

include etckeeper

Setting git user for commits

class { 'etckeeper':
  vcs_user_name  => 'root',
  vcs_user_email => 'root@example.com',
}

Adding custom gitignore entries

class { 'etckeeper':
  gitignore_entries => [
    '*.secret',
    'ssl/private/',
  ],
}

Parameters

The following parameters are available in the etckeeper class:

• package_name
• package_ensure
• git_package_name
• manage_git_package
• vcs_user_name
• vcs_user_email
• git_commit_options
• avoid_daily_autocommits
• avoid_special_file_warning
• avoid_commit_before_install
• push_remotes
• gitignore_entries
• conf_dir

package_name

Data type: String

Name of the etckeeper package.

package_ensure

Data type: String

Ensure value for the etckeeper package.

git_package_name

Data type: String

Name of the git package.

manage_git_package

Data type: Boolean

Whether to manage the git package.

vcs_user_name

Data type: Optional[String[1]]

Git user.name for commits in /etc.

vcs_user_email

Data type: Optional[String[1]]

Git user.email for commits in /etc.

git_commit_options

Data type: Optional[String]

Additional options passed to git commit.

avoid_daily_autocommits

Data type: Boolean

Disable daily autocommit cronjob.

avoid_special_file_warning

Data type: Boolean

Disable warnings about special files.

avoid_commit_before_install

Data type: Boolean

Disable auto-commit before package installs.

push_remotes

Data type: Array[String]

List of remotes to push to after commit.

gitignore_entries

Data type: Array[String]

Additional patterns to add to /etc/.gitignore.

conf_dir

Data type: Stdlib::Absolutepath

Path to the etckeeper configuration directory.