Forge Home

stdlib9_readiness_checker

Detect stdlib 9 removed functions within a Puppet Environment

174 downloads

44 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

  • 1.0.0 (latest)
  • 0.2.0
  • 0.1.0
released Oct 29th 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
  • Puppet >= 7.24 < 9.0.0
  • , , ,
Tasks:
  • stdlib9_readiness_checker
Plans:
  • stdlib9_readiness_checker

Start using this module

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

Add this module to your Puppetfile:

mod 'benjaminrobertson-stdlib9_readiness_checker', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add benjaminrobertson-stdlib9_readiness_checker
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install benjaminrobertson-stdlib9_readiness_checker --version 1.0.0

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

benjaminrobertson/stdlib9_readiness_checker — version 1.0.0 Oct 29th 2024

stdlib9_readiness_checker

A module containing a task and plan to scan entire code environments for stdlib 9 removed functions.

Table of Contents

  1. Description
  2. Setup - The basics of getting started with stdlib9_readiness_checker
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

Puppet 8 requires upgrade to stdlib 9. Stdlib 9 has removed many deprecated functions, if these functions are still in use, Puppet code will fail to compile after upgrading to stdlib 9.

Stdlib should be be upgraded to stdlib 9.x> prior to upgrading to Puppet 8. Stdlib 9 is supported on Puppet 7.

Setup

Beginning with stdlib9_readiness_checker

Add stdlib9 readiness checker to your Puppetfile and deploy code to your Puppet primary.

Stdlib readiness checker task and plan accepts 1 parameter.

Environment: Required: Name of the environment you wish to scan. This could be production, development etc. Note: the plan limits environment names to valid environment names.

check_deprecated: Optional: Whether to check for deprecated functions in stdlib9.

The plan stdlib9_readiness_checker will automatically locate your Puppet primary server. To manually target a Puppet server use the task stdlib9_readiness_checker and select the desired target.

This task should also function when run by Puppet Bolt.

Usage

From within the Puppet Enterprise console, goto plans or tasks and select stdlib9_readiness_checker. Fill in required values then run the task/plan.

Depending on the size of your Puppet code environment, it may take a while to return the results.

Limitations

stdlib9_readiness_checker can be used to help prepare for the migration to stdlib 9. However it should not be solely relied upon to catch all issues. Running your code on stdlib 9 within your test environment is vital before performing production upgrades.

Development

If you find any issues with this module, please log them in the issues register of the GitHub project. Issues

PR's glady accepted.