augeasng

Next generation Puppet-Augeas integration

Module Stats

10,690 downloads

10,690 latest version

3.8 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Dec 4th 2011

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'domcleal-augeasng', '0.0.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add domcleal-augeasng

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install domcleal-augeasng --version 0.0.1

Tags: development, augeas, experimental, provider

Documentation

domcleal/augeasng — version 0.0.1 Dec 4th 2011

puppet-augeas-ng: next generation Puppet-Augeas integration

This module is a development ground for the Augeas provider in Puppet. It will also bring changes being merged into master (i.e. the next Puppet release) to existing versions of Puppet.

Using puppet-augeas-ng

A new resource type will be provided, identical to the existing augeas type but will add new features via providers.

Change existing resource types from augeas to augeasng to take advantage of the new providers. The type parameters are all backwards-compatible, no more changes are required.

Requirements

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

See the providers section below for specific requirements. Generally use the latest version possible to get the most out of this module and enable all features.

On RHEL 4, 5 and derivatives, use EPEL versions of Augeas and ruby-augeas
On RHEL 6 and derivatives, use Augeas from main and optional channels, ruby-augeas from EPEL. This may not be the latest version, do check beta channels too (e.g. RHEL 6.2).
On Fedora, use Augeas and ruby-augeas from main updates repo. Consider checking updates-testing.
On Debian, use Augeas and libaugeas-ruby* from main repo, or backports if available. Ensure you use the correct libaugeas-ruby1.8, 1.9 or 1.9.1 package for your version of Ruby.
On Ubuntu, as with Debian. Also see raphink's PPA repo for fresh Augeas packages.

Merged changes

The following changes are already merged in development or new versions of Puppet and are included here too:

#6494: New commands, defvar, defnode, mv and setm (in 2.7.0)
#2728: Add diff output for changes made by Augeas provider (in 2.7.3)
#2744: Display file diffs through the Puppet log system (in 2.7.8)
#7285: Use Augeas NO_LOAD/incl to optimise loading based on context (in 2.8)
#5606: Print Augeas' /augeas//error info to debug on save failure (in 2.8)

Providers

The following providers are planned along with their dependencies. Some deps will be very new or unreleased versions.

augparse provider, legacy parsing of commands and direct use of ruby-augeas API.
- augeas: any version
- ruby-augeas: any version
augsrun provider, using aug_srun for commands
- augeas: 0.10.0 or higher
- ruby-augeas: development
augcond provider, using aug_srun for commands and parsing for onlyif support
- augeas: 0.10.0 or higher
- ruby-augeas: development

Issues

Please file any issues or suggestions on Github: https://github.com/domcleal/puppet-augeas-ng/issues

Types in this module release

augeasng

Apply a change or an array of changes to the filesystem using the augeas tool.

Requires:

- [Augeas](http://www.augeas.net)
- The ruby-augeas bindings

Sample usage with a string:

    augeas{"test1" :
      context => "/files/etc/sysconfig/firstboot",
      changes => "set RUN_FIRSTBOOT YES",
      onlyif  => "match other_value size > 0",
    }

Sample usage with an array and custom lenses:

    augeas{"jboss_conf":
      context   => "/files",
      changes   => [
          "set etc/jbossas/jbossas.conf/JBOSS_IP $ipaddress",
          "set etc/jbossas/jbossas.conf/JAVA_HOME /usr",
        ],
      load_path => "$/usr/share/jbossas/lenses",
    }

Parameters
changes	The changes which should be applied to the filesystem. This can be a command or an array of commands. The following commands are supported: `set <PATH> <VALUE>` : Sets the value `VALUE` at loction `PATH` `setm <PATH> <SUB> <VALUE>` : Sets multiple nodes (matching `SUB` relative to `PATH`) to `VALUE` `rm <PATH>` : Removes the node at location `PATH` `remove <PATH>` : Synonym for `rm` `clear <PATH>` : Sets the node at `PATH` to `NULL`, creating it if needed `ins <LABEL> (before\|after) <PATH>` : Inserts an empty node `LABEL` either before or after `PATH`. `insert <LABEL> <WHERE> <PATH>` : Synonym for `ins` `mv <PATH> <OTHER PATH>` : Moves a node at `PATH` to the new location `OTHER PATH` `move <PATH> <OTHER PATH>` : Synonym for `mv` `defvar <NAME> <PATH>` : Sets Augeas variable `$NAME` to `PATH` `defnode <NAME> <PATH> <VALUE>` : Sets Augeas variable `$NAME` to `PATH`, creating it with `VALUE` if needed If the `context` parameter is set, that value is prepended to any relative `PATH`s.
context	Optional context path. This value is prepended to the paths of all changes if the path is relative. If the `incl` parameter is set, defaults to `/files + incl`; otherwise, defaults to the empty string.
force	Optional command to force the augeas type to execute even if it thinks changes will not be made. This does not overide the `onlyif` parameter.
incl	Load only a specific file, e.g. `/etc/hosts`. This can greatly speed up the execution the resource. When this parameter is set, you must also set the `lens` parameter to indicate which lens to use.
lens	Use a specific lens, e.g. `Hosts.lns`. When this parameter is set, you must also set the `incl` parameter to indicate which file to load.
load_path	Optional colon-separated list of directories; these directories are searched for schema definitions.
name	The name of this task. Used for uniqueness.
onlyif	Optional augeas command and comparisons to control the execution of this type. Supported onlyif syntax: * `get <AUGEAS_PATH> <COMPARATOR> <STRING>` * `match <MATCH_PATH> size <COMPARATOR> <INT>` * `match <MATCH_PATH> include <STRING>` * `match <MATCH_PATH> not_include <STRING>` * `match <MATCH_PATH> == <AN_ARRAY>` * `match <MATCH_PATH> != <AN_ARRAY>` where: * `AUGEAS_PATH` is a valid path scoped by the context * `MATCH_PATH` is a valid match synatx scoped by the context * `COMPARATOR` is one of `>, >=, !=, ==, <=,` or `<` * `STRING` is a string * `INT` is a number * `AN_ARRAY` is in the form `['a string', 'another']`
provider
root	A file system path; all files loaded by Augeas are loaded underneath `root`.
type_check	Whether augeas should perform typechecking. Defaults to false.

Properties
returns	The expected return code from the augeas command. Should not be set.

Providers
augparse

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

augeasng

Contributions Requested

Support the Puppet Community by contributing to this module

Version information

Start using this module

Documentation

puppet-augeas-ng: next generation Puppet-Augeas integration

Using puppet-augeas-ng

Requirements

Merged changes

Providers

Issues

Types in this module release

augeasng