File concatenation system for Puppet
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
lionce 9a2cfd89d7
Merge pull request #582 from puppetlabs/release
14 hours ago
examples (FM-7340) - Add additional example 5 months ago
lib/puppet/type (maint) fix typo 5 months ago
locales (L10n) Updating translations for locales/ja/puppetlabs-concat.po 4 months ago
manifests (maint) - Removing whitespace from manifests 3 months ago
readmes (L10n) Updating translations for readmes/README_ja_JP.md 4 months ago
spec (FM-8073) litmus block support 6 days ago
.fixtures.yml (FM-7606) enable litmus for concat 2 weeks ago
.gitattributes (FM-7339) - Add i18n implementation 5 months ago
.gitignore pdksync - (maint) Update pdk-template to f778803 1 month ago
.pdkignore pdksync - (maint) Update pdk-template to f778803 1 month ago
.project (MODULES-4098) Sync the rest of the files 2 years ago
.puppet-lint.rc pdksync - (maint) Update pdk-template to f778803 1 month ago
.rspec (FM-4049) Update to current msync configs [2c99161] 3 years ago
.rubocop.yml (FM-7339) - Add i18n implementation 5 months ago
.rubocop_todo.yml Fix rubocop offenses 3 months ago
.sync.yml (FM-7606) enable litmus for concat 2 weeks ago
.travis.yml (FM-7606) enable litmus for concat 2 weeks ago
.yardopts pdksync_heads/master-0-g85ca41b 1 year ago
CHANGELOG.md MODULES-9105 - release v6.0.0 20 hours ago
CONTRIBUTING.md (maint) modulesync 892c4cf 1 year ago
Gemfile (FM-7606) enable litmus for concat 2 weeks ago
HISTORY.md (MODULES-7706) - Release Prep for 5.0.0 9 months ago
LICENSE (FM-4046) Update to current msync configs [006831f] 3 years ago
MAINTAINERS.md (MODULES-4098) Sync the rest of the files 2 years ago
NOTICE (maint) modulesync 65530a4 Update Travis 1 year ago
README.md (FM-7606) enable litmus for concat 2 weeks ago
REFERENCE.md (FM-7341) - Added REFERENCE.md and updated documentation 5 months ago
Rakefile (FM-7606) enable litmus for concat 2 weeks ago
appveyor.yml (FM-7606) enable litmus for concat 2 weeks ago
distelli-manifest.yml (FM-7606) enable litmus for concat 2 weeks ago
metadata.json MODULES-9105 - release v6.0.0 20 hours ago
provision.yaml (FM-7606) enable litmus for concat 2 weeks ago

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

We are experimenting with a new tool for running acceptance tests. It’s name is puppet_litmus this replaces beaker as the test runner. To run the acceptance tests follow the instructions here.

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.