isabella232 / pe_tech_check

A repo containing tasks and scripts for the PE Tech Check service

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

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

Using Bolt

Bolt is the preferred installation and execution method and can be used either on the master or another machine with connectivity to the master. Firstly, follow the instruction for installing Bolt. Users are strongly encouraged to follow the note about directly installing the package if installing on a PE node.

The following block of code will create a Boltdir under the logged in user's home directory and set up the module:

mkdir -p ~/Boltdir
cd ~/Boltdir

cat >>Puppetfile <<EOF
mod 'puppetlabs-stdlib'
mod 'puppetlabs-pe_tech_check'
mod 'tkishel-pe_tune',
  :git => 'https://github.com/tkishel/pe_tune.git',
  :branch => 'master'
EOF

bolt puppetfile install

Manually

To manually install the pe_tech_check module, execute the following command on the Primary Master.

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 Master 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 Master:

/opt/puppetlabs/puppet/modules/pe_tech_check/scripts/flush_environment_cache.sh

Usage

Run the pe_tech_check::configure task

Via Bolt

bolt task run pe_tech_check::configure --nodes <master_fqdn>

Via the Console

In the Console, run the pe_tech_check::configure task, targeting the Primary Master.

Via Puppet Task

From the command line of the Primary Master, run:

puppet task run pe_tech_check::configure --nodes $(puppet config print certname)

Task parameters

install_pe_metrics (Boolean, default: true)

Temporarily install and configure the puppet_metrics_collector module, if it is not already installed.

https://forge.puppet.com/puppetlabs/puppet_metrics_collector

install_pe_tune (Boolean, default: true)

Temporarily install the puppet pe tune subcommand via the pe_tune module. The pe_tune module is the upstream version of the puppet infrastructure tune subcommand.

https://github.com/tkishel/pe_tune

Note: Allow at least one day after executing the pe_tech_check::configure task for the puppet_metrics_collector module to collect metrics data before executing the pe_tech_check::collect task.

Run the pe_tech_check::collect task

Via Bolt

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

Via the Console

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

Via Puppet Task

From the command line of the Primary Master, run:

puppet task run pe_tech_check::collect --targets $(puppet config print certname)

When finished, the pe_tech_check::collect task will output a list of files. Upload those files from the Primary Master to Puppet for analysis.

Development

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