stdlib

pdk

supported

Puppet Module Standard Library

Project URL RSS Feed Report issues

Module Stats

120,101,899 downloads

36,523 latest version

3.8 quality score

Version information

released Nov 9th 2011

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-stdlib', '2.2.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-stdlib

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-stdlib --version 2.2.0

Tags: puppetlabs, library, stdlib, standard, stages

Documentation

puppetlabs/stdlib — version 2.2.0 Nov 9th 2011

Puppet Labs Standard Library

This module provides a "standard library" of resources for developing Puppet Modules. This modules will include the following additions to Puppet

Stages
Facts
Functions
Defined resource types
Types
Providers

This module is officially curated and provided by Puppet Labs. The modules Puppet Labs writes and distributes will make heavy use of this standard library.

Compatibility

This module is designed to work with Puppet version 2.6 and later. It may be forked if Puppet 2.7 specific features are added. There are currently no plans for a Puppet 0.25 standard library module.

Functions

Please see puppet doc -r function for documentation on each function. The current list of functions is:

getvar
has_key
loadyaml
merge.rb
validate_array
validate_bool
validate_hash
validate_re
validate_string

validate_hash

$somehash = { 'one' => 'two' }
validate\_hash($somehash)

getvar()

This function aims to look up variables in user-defined namespaces within puppet. Note, if the namespace is a class, it should already be evaluated before the function is used.

$namespace = 'site::data'
include "${namespace}"
$myvar = getvar("${namespace}::myvar")

Facts

Facts in /etc/facter/facts.d and /etc/puppetlabs/facter/facts.d are now loaded automatically. This is a direct copy of R.I. Pienaar's custom facter fact located at: https://github.com/ripienaar/facter-facts/tree/master/facts-dot-d

Types in this module release

anchor

A simple resource type intended to be used as an anchor in a composite class.

  class ntp {
    class { 'ntp::package': }
    -> class { 'ntp::config': }
    -> class { 'ntp::service': }

    # These two resources "anchor" the composed classes
    # such that the end user may use "require" and "before"
    # relationships with Class['ntp']
    anchor { 'ntp::begin': }   -> class  { 'ntp::package': }
    class  { 'ntp::service': } -> anchor { 'ntp::end': }
  }

This resource allows all of the classes in the ntp module to be contained within the ntp class from a dependency management point of view.

This allows the end user of the ntp module to establish require and before relationships easily:

  class { 'ntp': } -> class { 'mcollective': }
  class { 'mcollective': } -> class { 'ntp': }

Parameters
name	The name of the anchor resource.

file_line

Type that can append whole a line to a file if it does not already contain it.

Example:

file_line { 'sudo_rule': path => '/etc/sudoers', line => '%admin ALL=(ALL) ALL', }

Parameters
ensure
line	The line to be appended to the path.
name	arbitrary name used as identity
path	File to possibly append a line to.
provider

Providers
ruby

Copyright (C) 2011 Puppet Labs Inc

and some parts:

Copyright (C) 2011 Krzysztof Wilczynski

Puppet Labs can be contacted at: info@puppetlabs.com

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.