Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

mod_upgrade_check

This bolt plan assesses the complexity of modules installed on the Puppet master.
Project URLRSS FeedReport issues

2,518 downloads

1,450 latest version

5.0 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.3.1 (latest)
  • 0.3.0
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.0
released May 21st 2020
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, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • , , , , ,
Tasks:
  • get_code_environments
  • get_current_directory
  • get_module_complexity
  • get_modules_per_environment
  • get_roles_and_profiles
  • mkdir_p_file
Plans:
  • grab_module_info

Start using this module

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

Add this module to your Puppetfile:

mod 'liamjohnsexton-mod_upgrade_check', '0.3.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add liamjohnsexton-mod_upgrade_check
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install liamjohnsexton-mod_upgrade_check --version 0.3.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

liamjohnsexton/mod_upgrade_check — version 0.3.1 May 21st 2020

mod_upgrade_check

Table of Contents

  1. Description
  2. Setup - The basics of getting started with mod_upgrade_check
  3. Usage
  4. Limitations
  5. Development

Description

Knowing the complexity of the modules installed on your Puppet estate is essential to any successful Puppet migration. This provides information about the modules contained in each of your code environments.

Setup

What mod_upgrade_check affects

This module does not affect any of your Puppet estate. It simply reads the Puppet master and outputs its observations to CSV files.

Setup Requirements

Please ensure you have the credentials to log into the root of the Puppet master of your estate.

Beginning with mod_upgrade_check

The bolt plan: "grab_module_info" is the only item that needs to be run in order to obtain module complexity for each code environment. The CSV files that come from each task that is run are outputted to folders named after each code environment.

Usage

To run this module, run the following command from your local workstation, with the Puppet master being your target:

bolt plan run mod_upgrade_check::grab_module_info --targets <fqdn of PE_master> --user <username> --private-key <key> --run-as root

The CSV files produced are saved into folders for each code environment to your local workstation.

These folders are created in the the directory you have run the command from.

Limitations

As mentioned previously, the plan should only be run from your local workstation in order to obtain full value from the module.

Development

For any assistance in using or understanding this module, please contact: liam.sexton@puppet.com