arineng / arin-file_header

Grants the ability to easily manage and set a consistent header across multiple types for files managed via Puppet

file_header

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with file_header
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.

Overview

This module grants the ability to easily manage and set a consistent header across multiple types for files managed via Puppet

Module Description

This module grants the ability to set a file header from default parameter(s) set in the module, additionally you can set custom or overridge values in hiera.

Setup

puppet module install arineng-file_header -i /path/to/modules

Usage

This module can be used both with the default file type

define my_define {

    require file_header
    file {'/some/configuration/with/pound/comments':
        ensure => 'present',
        ...
        content => template("$file_header::pound_header", "other file contents")
    }
}

and with the PuppetLabs Concat module

define my_define {

  require file_header
  $concat_target_somefile_conf = "${somefile_destination}/conf/somefile.conf"

  concat { $concat_target_somefile_conf:
    ensure => present,
    owner  => 'root',
    group  => 'wheel',
    mode   => '0755',
  }

  include ::file_header
  concat::fragment { 'puppet_header':
    target  => $concat_target_somefile_conf,
    content => template("$::file_header::pound_header"),
    order   => '00',
  }

  concat::fragment { 'somefile.conf_main':
    target  => $concat_target_somefile_conf,
    content => template('somefile/somefile.conf.erb'),
    order   => '01',
  }

}

Reference

The inspiration for this module spawned from boundedinfinity/bi-puppet-banner, but without the need for the ripienaar/puppet-module-data dependency.

Limitations

This module was test with CentOS 6.x, currently no limitations that that should prevent it from being used with other versions or OS's.