Git Product home page Git Product logo

puppet-augeasproviders_apache's Introduction

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.

puppet-augeasproviders_apache's People

Contributors

bastelfreak avatar domcleal avatar ekohl avatar igalic avatar maxadamo avatar raphink avatar smortex avatar trevor-vaughan avatar zilchms avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

puppet-augeasproviders_apache's Issues

Context with "

I want to change something in the <Directory "/var/www/html"> context, but the " are causing a 'problem', can't seem to select it. When the context is <Directory /var/www/html> it is working perfect:

apache_directive { "Options for html":
  name   => 'Options',
  args   => 'SymLinksIfOwnerMatch',
  ensure => present,
  context => 'Directory[arg="/var/www/html"]',
}

But trying to get the " in the context like this:

apache_directive { "Options for html":
  name   => 'Options',
  args   => 'SymLinksIfOwnerMatch',
  ensure => present,
  context => 'Directory[arg="\"/var/www/html\""]',
}

Makes Puppet change the context for the directory /

Context sensitive directives report duplicate resource definitions

Consider the following puppet code:

apache_directive { 'Disable autoindex in webroot':
  ensure      => present,
  name        => 'Options',
  context     => 'Directory[arg="/var/www/html"]',
  args        => 'FollowSymLinks',
}

apache_directive { 'Disable autoindex in icons':
  ensure      => present,
  name        => 'Options',
  context     => 'Directory[arg="/var/www/icons"]',
  args        => 'MultiViews FollowSymLinks',
}

When imported into a node these items report the following error:
Error: Puppet::Parser::AST::Resource failed with error ArgumentError: Cannot alias Apache_directive[Disable autoindex in icons] to ["Options"] at test.pp:19; resource ["Apache_directive", "Options"] already declared at test.pp:12 at test.pp:19 on node hostname.example.com

Can't add multiple Listen entries

We have a need to add multiple specific "Listen" directives in the httpd.conf file, but I don't seem to be able to.

The following code:

$profile::bind_addresses.each |Integer $index, Stdlib::IP::Address $ip_addr| {
  apache_directive { "set_apache_listen_address_${index}":
    ensure => 'present',
    name   => 'Listen',
    args   => "${ip_addr}:80"
  }   
}

simply results in:

Cannot alias Apache_directive[set_apache_listen_address_1] to [nil, "Listen", nil] at (file: /etc/puppetlabs/code/environments/rk_test/site/apache/manifests/init.pp, line: 56); resource ["Apache_directive", nil, "Listen", nil] already declared (file: /etc/puppetlabs/code/environments/rk_test/site/apache/manifests/init.pp, line: 56)

I know this is probably a small use case, but having multiple Listen directives is valid syntax in Apache, so I'm filing this issue report as I think this needs a fix.

Can not modify two different Listen directives

Hello,

In a default apache 2.4 ports.conf there is those directives:

Listen 80
<IfModule ssl_module>
    Listen 443
</IfModule>

As it's redefined elsewhere in our confs, I wanted to drop them both:

  apache_directive { 'Listen80':
    ensure => 'absent',
    name   => 'Listen',
    args   => '80',
    target => '/etc/apache2/ports.conf',
  }

  apache_directive { 'Listen443':
    ensure  => 'absent',
    name    => 'Listen',
    args    => '443',
    target  => '/etc/apache2/ports.conf',
    context => 'IfModule[arg="ssl_module"]',
  }

Unfortunately, with or without args, it gives an error on puppet execution:

Error: Could not retrieve catalog from remote server: Error 400 on SERVER: Evaluation Error: Error while evaluating a Resource Statement, Cannot alias Apache_directive[Listen443] to ["Listen"] at apache.pp:112; resource ["Apache_directive", "Listen"] already declared at apache.pp:105 at apache.pp:112:3 on node XXX

raphink on irc told me to open an issue, comment:
"probably not planned in the composite namevar"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.