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
- Puppet >= 5.3.2 < 7.0.0
This module has been deprecated by its author since Mar 20th 2019.
The reason given was: This module has now been deprecated in favor of the puppetlabs/healthcheck_lite
The author has suggested puppetlabs-healthcheck_lite as its replacement.
Start using this module
- Setup - Installation and preparations
- Using healthcheck_lite
- Development - Guide for contributing to the module
This module gathers data from the PE Infrastructure nodes for analysis as part of the HealthCheck Lite Service offering. It primarily does this by gathering data in the form of the Support Script, as well as an additional data capture script. It will also gather up the metrics from the puppetlabs/puppet_metrics_collector module if installed and enabled.
To install the
healthcheck_lite module execute this command on the Primary Master:
puppet module install puppetlabs-healthcheck_lite --modulepath=/opt/puppetlabs/puppet/modules
This will install the modules into the system module path, making the tasks and classes available without interfering with the normal code directory. Installing here is unlikely to survive a PE upgrade, but the same installation method can be used after an upgrade if required.
healthcheck_lite module has a dependency for the
puppetlabs/puppet_metrics_collector module. If the
puppetlabs/puppet_metrics_collector module was already installed and classified in the standard code directory, it will be re-installed in this alternate location, but this will not cause any issues.
If code manager is being used, you need to deploy the production environment to make sure the newly installed modules are available to Puppet Enterprise.
puppet code deploy production --wait
If puppet_metrics_collector is not already being used, enable the Puppet Metrics Collector by adding the class puppet_metrics_collector to the PE Infrastructure classification group. For more information on puppetlabs/puppet_metrics_collector please see the documentation for that module. https://forge.puppet.com/puppetlabs/puppet_metrics_collector/readme. Trigger a Puppet Run on the PE Infrastructure group or let the scheduled Puppet runs happen. Allow at least 24 hours of metrics collection to ensure as much pertinent information is captured as possible.
This task takes 2 input parameters, which are the username and password for a user account which has RBAC permissions to run Tasks on the infrastructure nodes. These are used to create a short lived Authentication Token which will be used to run the healthcheck-related tasks. After creating the token and writing it to a file,
healthcheck_lite::hcl1 task executes the PE Support Script (the healthcheck_lite::supportcapture task) on all infrastructure nodes (Primary Master/Compile Masters, PuppetDB and Console nodes if present).
Copy the resultant Support Script tarballs from all infrastructure nodes to the
/var/tmp/hcl_data directory on the Primary Master. The location of the tarball can be found in the output of the
healthcheck_lite::supportcapture task on each Infrastructure node.
This task will capture some additional data on the Primary Master, and then package all this data, including the Support Script tarballs copied to the Primary Master, up for forwarding to Puppet. It takes a single parameter which is an identifier (allowed characters are all alphanumeric characters plus underscore) which is to be agreed with Puppet during the Healthcheck Lite intake conversation. This task also cleans up after itself by deleting the working directory and the temporary Authentication Token.
This module is developed and maintained by the Puppet Support and Technical Sales teams.
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
This task captures additional information not included in the Support Script
This Task runs the support script on a single node, capturing only 1 day of logs. This Task is designed to be called by a wrapper task which executes this one on each infrastructure node.
- puppetlabs/puppet_metrics_collector (>= 4.0.0 < 6.0.0)