augeasproviders_puppet
Version information
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
Add this module to your Puppetfile:
mod 'herculesteam-augeasproviders_puppet', '2.2.1'
Learn more about managing modules with a PuppetfileDocumentation
puppet: types/providers for Puppet files for Puppet
This module provides a new type/provider for Puppet to read and modify Puppet 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_puppet
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 `puppet_auth` 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 |
---|---|---|---|---|
PROVIDERS | ||||
puppet_auth | yes | yes | yes | yes |
Documentation and examples
Type documentation can be generated with puppet doc -r type
or viewed on the
Puppet Forge page.
puppet_auth provider
This is a custom type and provider supplied by augeasproviders
.
It requires the Puppet_Auth.lns
lens, which is provided with versions of Augeas strictly greater than 0.10.0.
manage simple entry
puppet_auth { 'Deny /facts':
ensure => present,
path => '/facts',
authenticated => 'any',
}
manage regex entry
puppet_auth { 'Deny ~ ^/facts/([^/]+)$':
ensure => present,
path => '^/facts/([^/]+)$',
path_regex => true,
authenticated => 'any',
}
add multiple environments
puppet_auth { 'Allow /facts for prod and dev environments from same client':
ensure => present,
path => '/facts',
authenticated => 'any',
allow => '$1',
environments => ['prod', 'dev'],
}
ensure an entry is before a given path
ins_after
provides the opposite functionality, so an entry is created after a
given path.
puppet_auth { 'Allow /facts before first denied rule':
ensure => present,
path => '/facts',
authenticated => 'any',
allow => '*',
ins_before => 'first deny',
}
delete entry
puppet_auth { 'Remove /facts':
ensure => absent,
path => '/facts',
}
Issues
Please file any issues or suggestions on GitHub.
Types in this module release
Changelog
2.2.1
- Fix puppet requirement to < 7.0.0
2.2.0
- add support for Puppet 5 & 6
- deprecate support for Puppet < 5
- update supported OSes in metadata.json
2.1.1
- Upped supported Puppet versions to include Puppet 5
2.1.0
- Use $confdir instead of static path
2.0.2
- Add requirements in metadata.json
2.0.1
- Convert specs to rspec3 syntax
- Fix metadata.json
2.0.0
- First release of split module.
Dependencies
- herculesteam/augeasproviders_core (>=2.4.0 <3.0.0)
augeasproviders: alternative Augeas-based providers for Puppet Copyright (c) 2012-2016 Dominic Cleal and Raphaël Pinson 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.