Version information
This module has been deprecated by its author since Oct 27th 2017.
The author has suggested herculesteam-augeasproviders as its replacement.
Start using this module
Documentation
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.
Types and providers
The following builtin types have an Augeas-based provider implemented:
host
mailalias
The following other types have a provider implemented:
mounttab
from puppetlabs-mount_providers
The module adds the following new types:
apache_setenv
for updating SetEnv entries in Apache HTTP Server configskernel_parameter
for adding kernel parameters to GRUB Legacy or GRUB 2 configsnrpe_command
for setting command entries in Nagios NRPE'snrpe.cfg
puppet_auth
for authentication rules in Puppet'sauth.conf
shellvar
for shell variables in/etc/sysconfig
or/etc/default
etc.sshd_config
for setting configuration entries in OpenSSH'ssshd_config
sshd_config_subsystem
for setting subsystem entries in OpenSSH'ssshd_config
sysctl
for entries inside Linux's sysctl.confsyslog
for entries inside syslog.conf
Lots of examples are provided in the accompanying documentation (see
docs/examples.html
) and are also published on the web site.
If this is a git checkout, you will need to run make
in docs/ to generate the
HTML pages.
Type documentation can be generated with puppet doc -r type
or viewed on the
Puppet Forge page.
For builtin types and mounttab, the default provider will automatically become
the augeas
provider once the module is installed. This can be changed back
to parsed
where necessary.
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:
Other ideas for new types are:
/etc/system
types
Issues
Please file any issues or suggestions on GitHub.
Types in this module release
augeasproviders: alternative Augeas-based providers for Puppet Copyright (c) 2012 Dominic Cleal 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.