File concatenation system for Puppet
david22swan Merge pull request #548 from puppetlabs/pdksync_pdksync_heads/master-…
…0-gbf720df

pdksync - pdksync_heads/master-0-gbf720df
Latest commit 45d98c0 Dec 17, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples (FM-7340) - Add additional example Dec 6, 2018
lib/puppet/type (maint) fix typo Dec 14, 2018
locales (FM-7339) - Add i18n implementation Dec 3, 2018
manifests (FM-7339) - Add i18n implementation Dec 3, 2018
spec (FM-7581) - Fix CI failures for Windows 2016 and 10 Enterprise Dec 4, 2018
.fixtures.yml (FM-7339) - Add i18n implementation Dec 3, 2018
.gitattributes (FM-7339) - Add i18n implementation Dec 3, 2018
.gitignore (maint) - Run pdk update Aug 9, 2018
.pdkignore pdksync_heads/master-0-gbf720df Dec 17, 2018
.project (MODULES-4098) Sync the rest of the files Jan 20, 2017
.puppet-lint.rc pdksync_heads/master-0-gbf720df Dec 17, 2018
.rspec (FM-4049) Update to current msync configs [2c99161] Jan 27, 2016
.rubocop.yml (FM-7339) - Add i18n implementation Dec 3, 2018
.rubocop_todo.yml (FM-7339) - Add i18n implementation Dec 3, 2018
.sync.yml (FM-7339) - Add i18n implementation Dec 3, 2018
.travis.yml pdksync_heads/master-0-gbf720df Dec 17, 2018
.yardopts pdksync_heads/master-0-g85ca41b May 18, 2018
CHANGELOG.md (MODULES-8341) - Release Prep 5.2.0 Dec 7, 2018
CONTRIBUTING.md (maint) modulesync 892c4cf Sep 18, 2017
Gemfile (FM-7339) - Add i18n implementation Dec 3, 2018
HISTORY.md (MODULES-7706) - Release Prep for 5.0.0 Aug 24, 2018
LICENSE (FM-4046) Update to current msync configs [006831f] Feb 16, 2016
MAINTAINERS.md (MODULES-4098) Sync the rest of the files Jan 20, 2017
NOTICE (maint) modulesync 65530a4 Update Travis Jan 3, 2018
README.md (maint) Add HTML anchor tag Dec 10, 2018
REFERENCE.md (FM-7341) - Added REFERENCE.md and updated documentation Nov 29, 2018
Rakefile (FM-7339) - Add i18n implementation Dec 3, 2018
appveyor.yml pdksync_heads/master-0-gabccfb1 Nov 7, 2018
metadata.json pdksync_heads/master-0-gbf720df Dec 17, 2018

README.md

concat

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Overview

The concat module lets you construct files from multiple ordered fragments of text.

Module Description

The concat module lets you gather concat::fragment resources from your other modules and order them into a coherent file through a single concat resource.

Beginning with concat

To start using concat you need to create:

  • A concat{} resource for the final file.
  • One or more concat::fragment{}s.

A minimal example might be:

concat { '/tmp/file':
  ensure => present,
}

concat::fragment { 'tmpfile':
  target  => '/tmp/file',
  content => 'test contents',
  order   => '01'
}

Usage

Maintain a list of the major modules on a node

To maintain an motd file that lists the modules on one of your nodes, first create a class to frame up the file:

class motd {
  $motd = '/etc/motd'

  concat { $motd:
    owner => 'root',
    group => 'root',
    mode  => '0644'
  }

  concat::fragment{ 'motd_header':
    target  => $motd,
    content => "\nPuppet modules on this server:\n\n",
    order   => '01'
  }

  # let local users add to the motd by creating a file called
  # /etc/motd.local
  concat::fragment{ 'motd_local':
    target => $motd,
    source => '/etc/motd.local',
    order  => '15'
  }
}

# let other modules register themselves in the motd
define motd::register($content="", $order='10') {
  if $content == "" {
    $body = $name
  } else {
    $body = $content
  }

  concat::fragment{ "motd_fragment_$name":
    target  => '/etc/motd',
    order   => $order,
    content => "    -- $body\n"
  }
}

Then, in the declarations for each module on the node, add motd::register{ 'Apache': } to register the module in the motd.

class apache {
  include apache::install, apache::config, apache::service

  motd::register{ 'Apache': }
}

These two steps populate the /etc/motd file with a list of the installed and registered modules, which stays updated even if you just remove the registered modules' include lines. System administrators can append text to the list by writing to /etc/motd.local.

When you're finished, the motd file will look something like this:

  Puppet modules on this server:

    -- Apache
    -- MySQL

  <contents of /etc/motd.local>

Reference

See REFERENCE.md

Removed functionality

The following functionality existed in previous versions of the concat module, but was removed in version 2.0.0:

Parameters removed from concat::fragment:

  • gnu
  • backup
  • group
  • mode
  • owner

The concat::setup class has also been removed.

Prior to concat version 2.0.0, if you set the warn parameter to a string value of true, false, 'yes', 'no', 'on', or 'off', the module translated the string to the corresponding boolean value. In concat version 2.0.0 and newer, the warn_header parameter treats those values the same as other strings and uses them as the content of your header message. To avoid that, pass the true and false values as booleans instead of strings.

Limitations

This module has been tested on all PE-supported platforms, and no issues have been identified.

For an extensive list of supported operating systems, see metadata.json

Development

Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.

Contributors

Richard Pijnenburg (@Richardp82)

Joshua Hoblitt (@jhoblitt)

More contributors.