/puppet-static_custom_facts

Primary LanguageRuby

puppet-static_custom_facts

Build Status

Table of Contents

  1. Description
  2. Setup - The basics of getting started with static_custom_facts
  3. Reference
  4. Development - Guide for contributing to the module

Description

The static_custom_facts module, other than having a long name, manages statically set custom facts for machines. It was originally written to put static (but not static enough to be in the certificate) contact information on servers while also exposing the information in PuppetDB.

Structured facts (hashes and arrays) are supported in addition to traditional facts (strings, numbers, and booleans).

static_custom_facts will only work in Puppet 4.

Setup

What static_custom_facts affects

Including static_custom_facts will ensure that the custom facts directory is created. By default, unmanaged files are left alone, but can be purged with the purge_unmanaged parameter.

Where facts are stored is based on the operating system.

On a Linux box, this module uses /opt/puppetlabs/facter/facts.d/. On Windows C:\ProgramData\PuppetLabs\facter\facts.d\ is used.

Reference

Public Classes

Class: static_custom_facts

Sets up the custom fact directory.

Parameters within static_custom_facts

  • parent_dirs: [Array] Parent directories of facts_path to create
  • facts_path: [String] The directory where custom facts should be stored. (defaults to an OS specific path)
  • facts_path_owner: [String] The owner of the directory created by facts_path (defaults to root on Linux)
  • facts_path_group: [String] The group owning the directory created by facts_path (defaults to root on Linux)
  • purge_unmanage: [Boolean] If set to true, facts managed outside of Puppet, but in the facts_path directory will be removed (default: false)
  • custom_facts: [Hash] A set of custom facts that should be automatically created. Commonly used with hiera/lookup.

Private Classes

Class: static_custom_facts::params

Sets the default parameters for static_custom_facts based on the operating system used.

Public Defines

Define: static_custom_facts::fact

Creates a fact with the same name as the resource being created.

Parameters for static_custom_facts::fact

  • ensure: The ensure parameter on the fact itself. (default: present)
  • value: The value of the fact itself. Can be a string, array, hash, number, or boolean. (required)

Development

Pull requests and bug reports are welcome. If you're sending a pull request, please consider writing tests if applicable.