REFERENCE.md

Reference

Table of Contents

Classes

• etckeeper: Installs etckeeper.
• etckeeper::config
• etckeeper::install

Defined types

• etckeeper::ignore: Add a glob pattern for the chosen VCS to ignore.

Data types

• Etckeeper::PackageManager::HighLevel
• Etckeeper::PackageManager::LowLevel
• Etckeeper::VCS

Classes

etckeeper

Installs etckeeper.

• Since 1.0.0

• See also

  • puppet_defined_types::etckeeper::ignore
    • etckeeper::ignore

Examples

Declaring the class

include etckeeper

Choosing a specific VCS instead of the default

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

Forcing the user name & email for commits

class { 'etckeeper':
  vcs            => 'git',
  vcs_user_name  => 'Alice',
  vcs_user_email => 'alice@example.com',
}

Parameters

The following parameters are available in the etckeeper class:

• avoid_commit_before_install
• avoid_daily_autocommits
• avoid_special_file_warning
• bzr_commit_options
• conf_dir
• darcs_commit_options
• git_commit_options
• hg_commit_options
• highlevel_package_manager
• lowlevel_package_manager
• manage_vcs_package
• package_name
• push_remotes
• vcs
• vcs_packages
• vcs_user_email
• vcs_user_name

avoid_commit_before_install

Data type: Optional[Boolean]

avoid_daily_autocommits

Data type: Optional[Boolean]

avoid_special_file_warning

Data type: Optional[Boolean]

bzr_commit_options

Data type: Optional[String]

conf_dir

Data type: Stdlib::Absolutepath

Top-level configuration directory, usually /etc/etckeeper.

darcs_commit_options

Data type: Optional[String]

git_commit_options

Data type: Optional[String]

hg_commit_options

Data type: Optional[String]

highlevel_package_manager

Data type: Etckeeper::PackageManager::HighLevel

lowlevel_package_manager

Data type: Etckeeper::PackageManager::LowLevel

manage_vcs_package

Data type: Boolean

package_name

Data type: String

The name of the package.

push_remotes

Data type: Optional[Array[String, 1]]

vcs

Data type: Etckeeper::VCS

vcs_packages

Data type: Hash[Etckeeper::VCS, String]

Hash of VCS to the package that provides it.

vcs_user_email

Data type: Optional[String[1]]

vcs_user_name

Data type: Optional[String[1]]

etckeeper::config

The etckeeper::config class.

etckeeper::install

The etckeeper::install class.

Defined types

etckeeper::ignore

Add a glob pattern for the chosen VCS to ignore.

• Since 1.2.0

• See also

  • puppet_classes::etckeeper
    • etckeeper

Examples

Ignoring an example pattern

etckeeper::ignore { '*.foo':
  ensure => present,
}

Parameters

The following parameters are available in the etckeeper::ignore defined type:

• ensure
• glob

ensure

Data type: Enum['present', 'absent']

Default value: 'present'

glob

Data type: String[1]

The pattern to ignore.

Default value: $title

Data types

Etckeeper::PackageManager::HighLevel

The Etckeeper::PackageManager::HighLevel data type.

• Since 1.0.0

Alias of

Enum['apt', 'yum', 'zypper', 'pacman']

Etckeeper::PackageManager::LowLevel

The Etckeeper::PackageManager::LowLevel data type.

• Since 1.0.0

Alias of

Enum['dpkg', 'rpm', 'pacman']

Etckeeper::VCS

The Etckeeper::VCS data type.

• Since 1.0.0

Alias of

Enum['bzr', 'darcs', 'git', 'hg']