Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Upstream has MOVED to hercules-team/augeasproviders
Ruby CSS Puppet

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
augeas @ e483962
docs
lib
manifests
spec
.gitignore
.gitmodules
.travis.sh
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENCE
Modulefile
Puppetfile
Puppetfile.lock
README.html
README.md
Rakefile
metadata.json

README.md

augeasproviders: alternative Augeas-based providers for Puppet

This module provides alternative providers for core Puppet types such as host and mailalias using the Augeas configuration library. It also adds some of its own types for new functionality.

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.

These providers will hide all of the Augeas commands etc., you don't need to know anything about Augeas to make use of it.

If you want to make changes to config files in your own way, you should use the augeas type directly. For more information about Augeas, see the web site or the Puppet/Augeas wiki page.

Using augeasproviders

For builtin types, change the provider on individual resources to augeas:

host { "example.com":
  ensure   => present,
  ip       => "10.1.2.3",
  provider => "augeas",
}

Or change the resource defaults globally or in a single scope for the types needed from the list below:

Host {
  provider => "augeas",
}

New types provided by augeasproviders can be used out of the box. See the list below and puppet doc -r type output.

Types and providers

The following builtin types have an Augeas-based provider implemented:

  • host
  • mailalias

The following other types have a provider implemented:

The module adds the following new types:

  • kernel_parameter for adding kernel parameters to GRUB Legacy or GRUB 2 configs
  • nrpe_command for setting command entries in Nagios NRPE's nrpe.cfg
  • sshd_config for setting configuration entries in OpenSSH's sshd_config
  • sshd_config_subsystem for setting subsystem entries in OpenSSH's sshd_config
  • sysctl for entries inside Linux's sysctl.conf
  • syslog for entries inside syslog.conf

Requirements

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

See Puppet/Augeas pre-requisites.

Installing

On Puppet 2.7.14+, the module can be installed easily (documentation):

puppet module install domcleal/augeasproviders

You may see an error similar to this on Puppet 2.x (#13858):

Error 400 on SERVER: Puppet::Parser::AST::Resource failed with error ArgumentError: Invalid resource type `kernel_parameter` at ...

Ensure the module is present in your puppetmaster's own environment (it doesn't have to use it) and that the master has pluginsync enabled. Run the agent on the puppetmaster to cause the custom types to be synced to its local libdir (puppet master --configprint libdir) and then restart the puppetmaster so it loads them.

Planned

The following builtin types have Augeas-based providers planned:

  • ssh_authorized_key
  • port, once #5660 is done
  • yumrepo, once #8758 is done

Other ideas for new types are:

  • /etc/system types

Issues

Please file any issues or suggestions on GitHub.

Something went wrong with that request. Please try again.