Forge Home

profile_guard

A module to guard named r_profile classes - for use in brownfield environments where rollouts must be controlled

8,967 downloads

8,967 latest version

4.1 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

  • 0.9.1 (latest)
released Feb 24th 2017

Start using this module

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

Add this module to your Puppetfile:

mod 'geoffwilliams-profile_guard', '0.9.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add geoffwilliams-profile_guard
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install geoffwilliams-profile_guard --version 0.9.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

Documentation

geoffwilliams/profile_guard — version 0.9.1 Feb 24th 2017

Build Status

profile_guard

Table of Contents

  1. Description
  2. Usage - Configuration options and additional functionality
  3. Reference - An under-the-hood peek at what the module is doing and how
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

Profile Guard wraps r_profile profiles with the trlinkin/noop module in order to placing all resources contained into noop mode.

Each profile_guard profile used will be in noop mode until deactivated, which is normally done by setting the appropriate value in Hiera.

Usage

See individual profile_guard classes for documentation. Classes are typically used by including them, for example:

include profile_guard::linux::ntp

Would activate r_profile::linux::ntp in noop mode. When ready for real deployment, ensuring the hiera lookup for: profile_guard::linux::ntp:noop_mode returns false would apply the profile in enforcing mode to apply changes:

profile_guard::linux::ntp:noop_mode: false

This pattern is used throughout the module

Reference

Reference documentation is generated directly from source code using puppet-strings. You may regenerate the documentation by running:

bundle exec puppet strings

Or you may view the current generated documentation.

The documentation is no substitute for reading and understanding the module source code, and all users should ensure they are familiar and comfortable with the operations this module performs before using it.

Limitations

  • Not supported by Puppet, Inc.
  • Depends entirely on the trlinkin/noop module for per-resource noop functionality

Development

PRs accepted :)

Testing

This module supports testing using PDQTest.

Test can be executed with:

bundle install
bundle exec pdqtest all