Skip to content
A repository to collect task modules
Shell Ruby Puppet Pascal
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
site
.gitignore
CODEOWNERS
LICENSE
Puppetfile
README.md

README.md

Task Modules

This repository provides a control repo with a collection of task modules for getting started with Puppet tasks. The tasks in this module can be used both with bolt task run on the command line and in Puppet Plans. This repository also contains a few utility functions for use in plans.

Installation and usage

Configure this repository or a fork as your r10k control repo or clone and run r10k puppetfile install command. If using with bolt set the --modulepath $INSTALL_LOCATION/site:$INSTALL_LOCATION/modules to add these module to the modulepath.

Usage

The examples below give some hints on how to use the contents of this repo. All examples assume that the repo shell variable is set to the toplevel directory of the checkout of this repository, and that nodes contains a comma-separated list of the nodes on which a task or a plan should be run.

Tasks

Each of these tasks can be run with bolt --modules $repo --nodes $nodes task run <task_name>. You can find out more information about the parameters to pass to the tasks from the init.json file in each task's directory.

Name Purpose Requirements on the target nodes
install_puppet Install the open-source Puppet agent RedHat- or Debian-derived Linux distro
package Manipulate packages Puppet must be installed
resource Retrieve the state of resources Puppet must be installed
service Manipulate services Puppet must be installed
facter_task fetch a fact value Facter must be installed
minifact Retrieve basic node facts Bash must be installed

Plans

minifact

The minifact module also contains a plan that lists basic node information. It is not necessary to have Puppet installed on target nodes for this. You can run the plan with

bolt --modules $repo plan run minifact::info nodes=$nodes

canary

The canary module contains a plan for running a task on canary nodes and then continuing on all nodes if it succeeds.

bolt --modules $repo plan run canary::random nodes=$nodes task=install_puppet canary_size=3

aggregate

The aggregate module contains two plans to run a task and aggregrate the results

aggregate::count : This returns a hash that for each key in the results counts how many times each value occurs.

aggregate::nodes : This returns a hash that for each key makes a list of nodes that have a given value.

bolt --modules $repo plan run aggregate::count nodes=$nodes task=install_puppet params=<must be passed as json>

Functions

The following functions are available for use in your plans:

Function Purpose
aggregate::count(ExecutionResult $result) This returns a hash that for each key in the results counts how many times each value occurs.
aggregate::nodes(ExecutionResult $result) This returns a hash that for each key makes a list of nodes that have a given value.
canary::merge(ExecutionResult $first, ExecutionReuslt $secon) Merge to execution results prefering nodes from the second.
util::print(String $message) Print a message on the console
util::exit(Integer $exitcode = 0) Exit bolt immediately
util::error(String $message, Integer $exitcode = 1) Print the message and exit with the given exitcode
You can’t perform that action at this time.