Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

pe_tech_check

Provides Tasks to capture data for PE Tech Check
Project URLRSS FeedReport issues

6,188 downloads

859 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

  • 2.0.0 (latest)
  • 1.0.0
released Nov 12th 2021
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.16.0 < 8.0.0
  • , , , , ,
This module has been deprecated by its author since Oct 11th 2022.

The author has suggested puppetlabs-pe_status_check as its replacement.

Tasks:
  • collect
  • configure

Start using this module

Documentation

puppetlabs/pe_tech_check — version 2.0.0 Nov 12th 2021

pe_tech_check

Table of Contents

  1. Description
  2. Setup - Installation and preparations
  3. Using pe_tech_check
  4. Development - Guide for contributing to the module
  5. Deprecations

Description

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

Setup

Install the pe_tech_check module

The preferred method of installation of pe_tech_check is via Code manager however should this not be possible other options are available

Manually

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/modules

Doing 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.sh

Using Bolt

Bolt 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-resolve

Usage

Pe_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_collector to allow the module to collect metrics data before executing the pe_tech_check::collect task.

Run the pe_tech_check::collect task

Via Bolt

Note: if running Bolt from the Primary Server the --targets parameter will accept localhost as a destination which will not require authentication

bolt task run pe_tech_check::collect --targets <primary_fqdn>

Via the Console

In the Console, run the pe_tech_check::collect task, targeting the Primary Server.

Via Puppet Task

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.

Development

This module is developed and maintained by the Puppet Enterprise Support and Technical Sales teams.

Deprecations

pe_tech_check::configure should be considered deprecated and should not be used in currently supported versions of Puppet Enterprise