mod_upgrade_check
Version information
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
- CentOS,OracleLinux,RedHat,Scientific,Debian,Ubuntu
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
Documentation
mod_upgrade_check
Table of Contents
- Description
- Setup - The basics of getting started with mod_upgrade_check
- Usage
- Limitations
- 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
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
What are plans?
Modules can contain plans that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Changelog
All notable changes to this project will be documented in this file.
Release 0.3.1
Features *Changed the name of one of the outputs produced.
Release 0.3.0
Features Bolt plan now creates folders and writes CSV files to a local workstation that plan is run from. Functionality changed to target Puppet master rather than be run from it.
Release 0.2.2
Features *Updated the overview and changelog documentation.
Release 0.2.1
Features *Full functionality is now available.
Bug fixes *Now able to run bolt plan properly.
Release 0.2.0
Features *Bolt plan renamed for simplicity.
Known Issues *Still issues surroding the execution of the bolt plan.
Release 0.1.0
Features *Initial release of this module. Sole functionality is obtaining module complexity information.
Known Issues *Issues with running the bolt plan properly.