Module puppetlabs/stdlib
| Download |
|
Module description
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.
Versions
This module follows semver.org (v1.0.0) versioning guidelines. The standard library module is released as part of Puppet Enterprise and as a result older versions of Puppet Enterprise that Puppet Labs still supports will have bugfix maintenance branches periodically “merged up” into master. The current list of integration branches are:
- v2.1.x (v2.1.1 released in PE 1.2, 1.2.1, 1.2.3, 1.2.4)
- v2.2.x (Never released as part of PE, only to the Forge)
- v2.3.x (Scheduled for next PE feature release)
- master (mainline development branch)
The first Puppet Enterprise version including the stdlib module is Puppet Enterprise 1.2.
Compatibility
stdlib v2.1.x, v2.2.x
v2.1.x and v2.2.x of this module are designed to work with Puppet versions 2.6.x and 2.7.x. There are currently no plans for a Puppet 0.25 standard library module.
stdlib v2.3.x
While not yet released, the standard library may only work with Puppet 2.7.x.
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
Release notes for version 2.3.2
2.3.2
2012-05-10 - Puppet Labs support@puppetlabs.com
- Make file_line default to ensure => present (1373e70)
- Memoize file_line spec instance variables (20aacc5)
- Fix spec tests using the new spec_helper (1ebfa5d)
- (#13595) initialize_everything_for_tests couples modules Puppet ver (3222f35)
- (#13439) Fix MRI 1.9 issue with spec_helper (15c5fd1)
- (#13439) Fix test failures with Puppet 2.6.x (665610b)
- (#13439) refactor spec helper for compatibility with both puppet 2.7 and master (82194ca)
- (#13494) Specify the behavior of zero padded strings (61891bb)
Types
anchor
Description
A simple resource type intended to be used as an anchor in a composite class.
In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly with the pattern of composing complex modules from smaller classes, as it makes it impossible for end users to specify order relationships between the exterior class and other modules.
The anchor type lets you work around this. By sandwiching any interior classes between two no-op resources that _are_ contained by the exterior class, you can ensure that all resources in the module are contained.
class ntp { # These classes will have the correct order relationship with each # other. However, without anchors, they won't have any order # relationship to Class['ntp']. class { 'ntp::package': } -> class { 'ntp::config': } -> class { 'ntp::service': }
# These two resources "anchor" the composed classes within the ntp # class. anchor { 'ntp::begin': } -> Class['ntp::package'] Class['ntp::service'] -> anchor { 'ntp::end': } }
This allows the end user of the ntp module to establish require and before relationships with Class['ntp']:
class { 'ntp': } -> class { 'mcollective': } class { 'mcollective': } -> class { 'ntp': }
Parameters
- name
The name of the anchor resource.
file_line
Description
Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet will add the line to ensure the desired state. Multiple resources may be declared to manage multiple lines in the same file.
Example:
file_line { 'sudo_rule': path => '/etc/sudoers', line => '%sudo ALL=(ALL) ALL', } file_line { 'sudo_rule_nopw': path => '/etc/sudoers', line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', }
In this example, Puppet will ensure both of the specified lines are contained in the file /etc/sudoers.
Parameters
- name
An arbitrary name used as the identity of the resource.
- line
The line to be appended to the file located by the path parameter.
- path
The file Puppet will ensure contains the line specified by the line parameter.
Properties
- ensure
Providers
- ruby