Forge Home

redhat_tidy

Tidy up and lock down little RedHat niggles

5,570 downloads

5,570 latest version

1.9 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.2.15 (latest)
released Apr 29th 2018

Start using this module

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

Add this module to your Puppetfile:

mod 'geoffwilliams-redhat_tidy', '0.2.15'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install geoffwilliams-redhat_tidy --version 0.2.15

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/redhat_tidy — version 0.2.15 Apr 29th 2018

Build Status

redhat_tidy

Table of Contents

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

Description

Apply miscellaneous "tidying up" settings to RHEL (6/7 - where applicable)

Setup

What redhat_tidy affects

The module necessarily touches many parts of the system in order to perform the required changes. Consult the module source code in order to understand what is going on under the hood.

Since redhat_tidy locks down critical security settings, its vital that user's understand how and why it works to prevent lockout or misconfiguration scenarios.

Usage

Most classes will need to be loaded using the class resource syntax in order to pass the appropriate class defaults, eg:

class { "foo:bar":
  param1 => "value1",
  param2 => "value2",
}

Parameters, where available, are documented inside the individual classes. See Reference section.

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

  • RHEL 6/7 only

Development

PRs accepted :)

Testing

This module supports testing using PDQTest.

Test can be executed with:

bundle install
bundle exec pdqtest all

See .travis.yml for a working CI example