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
   • Beginning 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.

Reference

Table of Contents

Tasks

• init: Puppet task which scans entire code environments for removed functions in stdlib 9. Must be run against a Puppet Server with a full copy of t

Plans

• stdlib9_readiness_checker::stdlib9_readiness_checker: Puppet task which scans entire code environments for removed functions in stdlib 9.

Tasks

init

Puppet task which scans entire code environments for removed functions in stdlib 9. Must be run against a Puppet Server with a full copy of the Puppet environment you wish to scan. EG Primary, replica or compiler.

Supports noop? false

Parameters

environment

Data type: String[1]

Code environment to scan.

check_deprecated

Data type: Boolean

Check for deprecated functions

environment_path

Data type: Optional[String]

Path to Puppet environment, EG where Puppet code is deployed on primary.

Plans

stdlib9_readiness_checker::stdlib9_readiness_checker

lint:ignore:140chars lint:ignore:strict_indent Will automatically locate the Puppet primary and run task against it.

Parameters

The following parameters are available in the stdlib9_readiness_checker::stdlib9_readiness_checker plan:

• environment
• check_deprecated

environment

Data type: Pattern[/^[a-z0-9_]+/]

Code environment to scan.

check_deprecated

Data type: Boolean

Whether to check for deprecated functions in stdlib9.

Default value: false

Changelog

All notable changes to this project will be documented in this file.

Release 1.0.0

• Updated plan and task to work with lockless code deploys. Stdlib9_readiness_checker now dynamically locates environment directory using facts and configuration files. #2
• Bumped PDK version.

Release 0.2.0

Features

• Included a few missed removed functions
• Included removed types
• Included an option to scan for deprecated functions in stdlib9

Bugfixes

Known Issues

Release 0.1.0

Features

• First release to forge

Bugfixes

Known Issues