Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

augeasproviders

Alternative Augeas-based providers for Puppet
Project URLRSS FeedReport issues

1,287,790 downloads

226,194 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

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:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. 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

  • 2.4.1 (latest)
  • 2.2.1
  • 2.2.0
  • 2.1.3
  • 2.1.2
  • 2.1.1
  • 2.1.0
  • 2.0.0
released Jun 26th 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
  • Puppet >= 5.0.0 < 7.0.0
  • , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'herculesteam-augeasproviders', '2.4.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add herculesteam-augeasproviders
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install herculesteam-augeasproviders --version 2.4.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: utilities, augeas, providers, types, augeasproviders

Documentation

herculesteam/augeasproviders — version 2.4.1 Jun 26th 2019

Puppet Forge Build Status Coverage Status

augeasproviders: alternative Augeas-based providers for Puppet

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.