Skip to content

Latest commit

 

History

History
181 lines (125 loc) · 3.48 KB

README.md

File metadata and controls

181 lines (125 loc) · 3.48 KB
Raw

puppet-module-facter

===

Build Status

Puppet module to manage Facter. To use simply include ::facter.

===

Compatibility

This module is built for use with Puppet v3 (with and without the future parse), v4 and v5 and supports Ruby versions 1.8.7, 1.9.3, 2.0.0, 2.1.9 and 2.4.1 on all POSIX like platforms. See .travis.yml for an exact matrix of tested Ruby and Puppet versions.

===

Parameters

manage_package

Boolean to manage the package resource. Not honored with Puppet 4 where it will be false since facter is included in the puppet-agent package.

  • Default: true

package_name

String or Array of package(s) for facter.

  • Default: 'facter'

package_ensure

String for ensure parameter to facter package.

  • Default: present

manage_facts_d_dir

Boolean to manage the directory.

  • Default: true

purge_facts_d

Boolean to delete unmanaged fact files from the facts.d directory.

  • Default: false

facts_d_dir

Path to facts.d directory.

  • Default: /etc/facter/facts.d

facts_d_owner

Owner of facts.d directory.

  • Default: root

facts_d_group

Group of facts.d directory.

  • Default: root

facts_d_mode

Four digit mode of facts.d directory.

  • Default: 0755

path_to_facter

Path to facter to create symlink from. Required if ensure_facter_symlink is true.

  • Default: '/usr/bin/facter'

path_to_facter_symlink

Path to symlink for facter. Required if ensure_facter_symlink is true.

  • Default: '/usr/local/bin/facter'

ensure_facter_symlink

Boolean for ensuring a symlink for path_to_facter to symlink_facter_target. This is useful if you install facter in a non-standard location that is not in your $PATH.

  • Default: false

facts_hash

Hash of facts to be passed to facter::fact with create_resources().

  • Default: undef

facts_hash_hiera_merge

Boolean to control merges of all found instances of facter::facts_hash in Hiera. This is useful for specifying facts entries at different levels of the hierarchy and having them all included in the catalog.

  • Default: false

facts_file

Filename under facts_d_dir to place facts in

  • Default: facts.txt

facts_file_owner

Owner of facts_file.

  • Default: root

facts_file_group

Group of facts_file.

  • Default: root

facts_file_mode

Four digit mode of facts_file.

  • Default: 0644

===

Define facter::fact

Ensures a fact is present in the fact file with stdlib file_line() in fact=value format.

Usage

You can optionally specify a hash of external facts in Hiera.

---
facter::facts_hash:
  role:
    value: 'puppetmaster'
  location:
    value: 'RNB'
    file: 'location.txt'

The above configuration in Hiera would produce /etc/facter/facts.d/facts.txt with the following content.

role=puppetmaster

It would also produce /etc/facter/facts.d/location.txt with the following content.

location=RNB

value

Value for the fact

  • Required

fact

Name of the fact

  • Default: $name

file

File under facts_dir in which to place the fact.

  • Default: 'facts.txt'

facts_dir

Path to facts.d directory.

  • Default: '/etc/facter/facts.d'