isabella232 / puppetlabs-apply_helpers

Helper tasks for the Bolt `apply()` function

apply_helpers

Table of Contents

1. Description
2. Setup - The basics of getting started with apply_helpers
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how

Description

This module provides helper tasks that are used by the apply() functionality in Bolt. These tasks are not intended to be run on their own, but as part of a bolt plan that uses the apply keyword.

This module allows Bolt plans using apply() to be run on a Puppet Enterprise (PE) installation.

Setup

1. First you'll need to install the puppetlabs-puppet_agent module from the master branch on github. The easiest way to do this is to add the following to your Puppetfile:

   mod 'puppetlabs-puppet_agent'
   

   Or install using the puppet module command:

   puppet module install puppetlabs/puppet_agent
   

2. Install the apply_helpers module in PE. Add the following to your Puppetfile:

   mod 'puppetlabs-apply_helpers'
   

   Or install using the puppet module command:

   puppet module install puppetlabs/apply_helpers
   

3. Using PE RBAC, grant the ability to run the apply_helpers::custom_facts and apply_helpers::apply_catalog tasks to the users who intend to use this module.

Usage

Configure Bolt to work with PE Orchestrator and run Bolt commands or Tasks from the console.

Reference

This module includes tasks that are invoked automatically by Bolt: apply_helpers::custom_facts and apply_helpers::apply_catalog. These tasks should not be run on their own.