Forge Home

apply_helpers

Helper libraries for Bolt Apply functionality

33,344 downloads

10,589 latest version

4.8 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

  • 0.3.0 (latest)
  • 0.2.1
  • 0.1.0
released Jun 28th 2021
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, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 7.0.0
  • , , , , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-apply_helpers', '0.3.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-apply_helpers
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-apply_helpers --version 0.3.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/apply_helpers — version 0.3.0 Jun 28th 2021

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.