Skip to content

voxpupuli/puppet-augeasproviders

augeasproviders: alternative Augeas-based providers for Puppet

License Puppet Forge Version Puppet Forge Downloads Build Status Donated by Herculesteam

Features

This module provides is a meta module which gathers all official augeasproviders modules as dependencies. Augeasproviders modules provide alternative Augeas-based providers for Puppet providers around config files, using the Augeas configuration library to read and modify them.

The advantage of using Augeas over the default Puppet parsedfile implementations is that Augeas will go to great lengths to preserve file formatting and comments, while also failing safely when needed.

Requirements

Ensure both Augeas and ruby-augeas 0.3.0+ bindings are installed and working as normal.

See Puppet/Augeas pre-requisites.

Classes

augeasproviders::instances

This class allows the types provided by this module to be defined using the classes' parameters or top-scope variables.

NOTE: The classes' parameters take presedence over the top-scope variables.

Set the sysctl entry net.ipv4.ip_forward to 1:

class { 'augeasproviders::instances':
  sysctl_hash => { 'net.ipv4.ip_forward' => { 'value' => '1' } },
}

The following example is the same as above but using a top-scope variable.

node 'foo.example.com' {
  $augeasproviders_sysctl_hash = {
    'net.ipv4.ip_forward' => { 'value' => '1' },
  }
  
  include augeasproviders::instances
}

Parameters

#####TYPE_hash

All types have a TYPE_hash parameter, where TYPE is the resource type. These parameters accept a Hash to define that type's resources.

#####resource_defaults

A Hash that contains the default values used to create each resource. See manifests/params.pp for the format used.

Variables

#####augeasproviders_TYPE_hash

All types have a augeasproviders_TYPE_hash variable, where TYPE is the resource type. These variables accept a Hash to define that type's resources.

Development documentation

See docs/ (run make) or augeasproviders.com.

Issues

Please file any issues or suggestions on GitHub.

Supported OS

See metadata.json for supported OS versions.

Dependencies

See metadata.json for dependencies.

Puppet

The supported Puppet versions are listed in the metadata.json

REFERENCES

Please see REFERENCE.md for more details.

Contributing

Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint to follow the recommended Puppet style guidelines from the Puppet Labs style guide.

Transfer Notice

This plugin was originally authored by Hercules Team. The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance. Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Hercules Team.