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.
lib
manifests
spec
.gitignore
.travis.sh
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENCE
Modulefile
Puppetfile
Puppetfile.lock
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:

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:

  • sshd_config for setting configuration entries in OpenSSH's sshd_config
  • sshd_config_subsystem for setting subsystem entries in OpenSSH's sshd_config

Requirements

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

See Puppet/Augeas pre-requisites.

Planned

The following builtin types have Augeas-based providers planned:

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

Issues

Please file any issues or suggestions on Github: https://github.com/domcleal/augeasproviders/issues

Something went wrong with that request. Please try again.