Version information
This version is compatible with:
- Puppet Enterprise >=3.7.0 < 2015.3.0
- Puppet >=3.3.0 <5.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'jaxxstorm-inspec', '0.1.1'Learn more about managing modules with a PuppetfileDocumentation
puppet-inspec
Table of Contents
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with puppet-inspec
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Module description
This module will download and install inspec by Chef, a compliance as code tool.
Setup
What puppet-inspec affects
puppet-inspec will simply download the package from the package url (or optionally from your own repo) and install it. That's it!
Beginning with puppet-inspec
Simply include the inspec module like so:
include ::inspec
You may want to use a class include if you wish to override parameters:
class { '::inspec' :
install_method => 'package'
}
Usage
I just want to install inspec, what's the minimum I need
include ::inspec
I want to install the package from a custom url
Specify the URL to download from. It's a good idea to make sure you also specify the version specifically, so Puppet knows about it
class { '::inspec' :
download_url => 'http://my_url/inspec-1.7.1-1.el6.x86_64.rpm'
version => '1.7.1-1'
}
Reference
Classes
Public Classes
inspec: Installs inspec in your environment.
Private Classes
- [
inspec::install]: Installs the required inspec package using the method you specify
inspec
Parameters
package_name [String]
Specifies the package to install for inspec
package_version [String]
Specifies the version of the inspec package to install (default: 1.7.1-1)
install_method [String]
Specifies the install method you wish to use. Possible values are: 'url' (default) : 'package' If package is specified, it's assumed the package is in an available repo
download_path [String]
Specifies the temporary path to download the inspec package to before installing it (default: /tmp/)
download_url_base [String]
Specifices the url base for the chef website to grab the package from (default: https://packages.chef.io/stable/)
download_url [String]
Specifies a custom download_url to grab the package from (default: undef)
os_arch [String]
Specifies the Operating System Architecture of the package you wish to download (default: platform dependant)
os_family [String]
Specifies the operating system family of the package you wish to download (default: platform dependant)
os_ver [String]
Specifies the major relase of the package you wish to download
package_suffix [String]
Specifies the suffix of the package you wish to download (default: platform dependant)
Limitations
The module only currently works on RedHat Enterprise Linux variants
Dependencies
- puppetlabs/stdlib (>=3.2.0 <5.0.0)
MIT License Copyright (c) 2016 Lee Briggs Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.