Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

augeasproviders_apache

Augeas-based apache types and providers for Puppet
Project URLRSS FeedReport issues

1,904 downloads

1,146 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.

Version information

  • 5.0.0 (latest)
  • 4.0.0
  • 3.2.0
released Jun 22nd 2023
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-augeasproviders_apache', '5.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-augeasproviders_apache
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-augeasproviders_apache --version 5.0.0

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

Documentation

puppet/augeasproviders_apache — version 5.0.0 Jun 22nd 2023

Build Status Release Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores puppetmodule.info docs Coverage Status Apache-2 License

apache: types/providers for apache files for Puppet

This module provides new types/providers for Puppet to read and modify apache config files using the Augeas configuration library.

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.

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

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 herculesteam/augeasproviders_apache

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 `apache_directive` 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.

Compatibility

Puppet versions

Minimum of Puppet 2.7.

Augeas versions

Augeas Versions 0.10.0 1.0.0 1.1.0 1.2.0
FEATURES
case-insensitive keys no yes yes yes
PROVIDERS
apache_directive yes yes yes yes
apache_setenv yes yes yes yes

Documentation and examples

Type documentation can be generated with puppet doc -r type or viewed on the Puppet Forge page.

apache_directive provider

manage simple entry

apache_directive { "StartServers":
  args   => 4,
  ensure => present,
}

delete entry

apache_directive { "ServerName":
  args   => "foo.example.com",
  ensure => absent,
}

manage entry in another config location

apache_directive { "SetEnv":
  args        => ["SPECIAL_PATH", "/foo/bin"],
  args_params => 1,
  ensure      => present,
  target      => "/etc/httpd/conf.d/app.conf",
}

The SetEnv directive is not unique per scope: the first arg identifies the entry we want to update, and needs to be taken into account. For this reason, we set args_params to 1.

set a value in a given context

apache_directive { 'StartServers for mpm_prefork_module':
  ensure      => present,
  name        => 'StartServers',
  context     => 'IfModule[arg="mpm_prefork_module"]',
  args        => 4,
}

The directive is nested in the context of the mpm_prefork_module module, so we specify this with the context parameter.

The value of StartServers for the mpm_prefork_module module will be set/updated to 4. Note that the IfModule entry will not be created if it is missing.

apache_setenv provider

This is a custom type and provider supplied by augeasproviders.

manage simple entry

apache_setenv { "SPECIAL_PATH":
  ensure => present,
  value  => "/foo/bin",
}

manage entry with no value

apache_setenv { "ENABLE_FOO":
  ensure  => present,
}

delete entry

apache_setenv { "SPECIAL_PATH":
  ensure => absent,
}

manage entry in another config location

apache_setenv { "SPECIAL_PATH":
  ensure => present,
  value  => "/foo/bin",
  target => "/etc/httpd/conf.d/app.conf",
}

Issues

Please file any issues or suggestions on GitHub.