Install PE lab instances with bolt plans

Jarret Lavallee



1,530 latest version

5.0 quality score

Version information

  • 0.2.0 (latest)
  • 0.1.0
released Feb 28th 2020
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
  • download_file
  • install_pe
  • nightly
  • pin_node_group
  • run_agent
  • decom_agent
  • provision_agent
  • provision_compiler
  • provision_master

Start using this module


jarretlavallee/deploy_pe — version 0.2.0 Feb 28th 2020


A module of Bolt plans and tasks to facilitate a lab based installation of a monolithic PE stack.

Table of Contents

  1. Description
  2. Setup - The basics of getting started with deploy_pe
  3. Usage - Examples
  4. Limitations
  5. Development


A module of Bolt plans and tasks to facilitate the installation of a monolithic PE stack. This module is designed to be used with the Puppet Debugging Kit to install a lab based PE stack.

Currently the module provides the following plans.

  • Install a PE master
  • Install an agent and sign the certificate on the master
  • Install and configure a compiler


Setup Requirements

This module has only been tested on Linux and MacOS operating systems. The plans and tasks will likely not work from windows workstations. Please use the current version of Bolt to run these tasks and plans

The plans assume that there are no puppet components installed on the target machines. Only 2018.1+ versions of PE have been tested.

Beginning with deploy_pe


To use this module, install it in the boltdir and leverage the plans in the section below. The examples below will install a PE master, compiler, and agent.

Install a 2019.1.1 PE master with the admin password set to puppetlabs.

bolt plan run 'deploy_pe::provision_master' --run-as 'root' --params '{"version":"2019.1.1","pe_settings":{"password":"puppetlabs"}}' --targets 'pe-master'

The plan above will download the 2019.1.1 PE installer package, create a pe.conf with the password setting, and run the installer script to install PE.

Install an agent from the PE master.

bolt plan run 'deploy_pe::provision_agent' --run-as 'root' --params '{"master":"pe-master"}' --targets 'pe-agent'

The plan above will install the agent using the installer script from the master after ensuring that the agent packages are available on the master. It will then sign the agent's certificate on the master.

Install a compiler

bolt plan run 'deploy_pe::provision_compiler' --run-as 'root' --params '{"master":"pe-master"}' --targets 'pe-compiler'

The plan above will install the agent using the installer script from the master, pin the node to the PE Master node group, and then run the agent until there are no changes.

Purge a node from the master

bolt plan run 'deploy_pe::decom_agent' --run-as 'root' --params '{"master":"pe-master"}' --targets 'pe-agent'

The plan above will purge the node from the master. If the node is already offline it will try to guess the node name.

See the for additional parameters.


This is only meant for lab based installations and not production installations. It is meant to be run with vagrant-bolt and using the Puppet Debugging Kit


PRs and issues are welcome.


Thank you @m0dular for the continued help on this module.