- Description
- Setup - Installation and preparations
- Using pe_tech_check
- Development - Guide for contributing to the module
- Deprecations
This module collects Puppet Enterprise data for analysis as part of the PE Tech Check service offering. The majority of the data is collected by the Puppet Enterprise Support Script.
https://puppet.com/docs/pe/latest/getting_support_for_pe.html#pe-support-script
The preferred method of installation of pe_tech_check is via Code manager however should this not be possible other options are available
To manually install the pe_tech_check module, execute the following command on the Primary Server.
puppet module install puppetlabs-pe_tech_check --modulepath=/opt/puppetlabs/puppet/modulesDoing so will install this module into the base module path, making its tasks available without interfering with other modules.
If your Primary Server has environment caching enabled (which is true by default if Code Manager is being used), flush the environment cache to enable the tasks in this module by running the following command on the Primary Server:
/opt/puppetlabs/puppet/modules/pe_tech_check/scripts/flush_environment_cache.shBolt can be used either on the Primary Server or another machine with connectivity to the Primary Server. Firstly, follow the instruction for installing Bolt.
The following block of code will create a Bolt Project under the logged in user's home directory and set up the module:
mkdir -p ~/tech_check
cd ~/tech_check
cat >>Puppetfile <<EOF
mod 'puppetlabs-stdlib'
mod 'puppetlabs-pe_tech_check'
EOF
bolt project init
bolt module install --no-resolvePe_tech_check consumes Metric Provided by Puppet_Metrics_Collector Module, Puppet Enterprise >= 2019.8.8 and >= 2021.3 Come with Puppet Metrics Collector built in however for PE 2019.8.8 this feature must be enabled before proceeding.
To enable metrics collector in 2019.8.8 set the following parameters to true:
Hiera classification example
puppet_enterprise::enable_metrics_collection:: true
puppet_enterprise::enable_system_metrics_collection:: true
Alternativly these parameters can be set in the console, in a node group which covers your PE infrastructure nodes
If using a supported version of Puppet enterprise prior to 2019.8.8 or 2021.3 ensure you have Puppet Metrics Collector installed and enabled using the documentation from the Forge
Note: Allow at least one day after enabling
puppet_metrics_collectorto allow the module to collect metrics data before executing thepe_tech_check::collecttask.
Note: if running Bolt from the Primary Server the --targets parameter will accept
localhostas a destination which will not require authentication
bolt task run pe_tech_check::collect --targets <primary_fqdn>In the Console, run the pe_tech_check::collect task, targeting the Primary Server.
From the command line of the Primary Server, run:
puppet task run pe_tech_check::collect --nodes $(puppet config print certname)When finished, the pe_tech_check::collect task will output a list of files.
Upload those files from the Primary Server to Puppet for analysis.
This module is developed and maintained by the Puppet Enterprise Support and Technical Sales teams.
pe_tech_check::configure should be considered deprecated and should not be used in currently supported versions of Puppet Enterprise