Forge Home


Module containing tasks and a plan for deploying a puppet environment with R10k


1,970 latest version

5.0 quality score

Version information

  • 0.1.1 (latest)
  • 0.1.0
released Oct 7th 2019
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
  • , , , , ,
  • cache
  • generate_types
  • r10k
  • r10k

Start using this module

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

Add this module to your Puppetfile:

mod 'suchpuppet-deploy', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add suchpuppet-deploy
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install suchpuppet-deploy --version 0.1.1

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.



suchpuppet/deploy — version 0.1.1 Oct 7th 2019


Table of Contents

  1. Description
  2. Setup - The basics of getting started with deploy
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module


This module contains tasks for deploying Puppet environments, including R10k deploy, clearing environment cache, and generating types for a desired environment. The module also contains a plan for doing all 3 of the above in order.


What deploy affects

The tasks in this module are intended for a system running puppetserver >= 5.0.0 with R10k installed.

This module does not:

  • Install puppet or puppetserver packages
  • Install or configure r10k

Setup Requirements

To use this module you must already have:

  • puppetserver installed and the service running
  • r10k installed and configured to be able to access your control repo
  • puppet-agent package installed

Beginning with deploy

To use the tasks in this module, simply include this module in your Boltdir/Puppetfile and install the module:

bolt puppetfile install


To deploy environment production: bolt plan run deploy::r10k environment=production --nodes <nodes> --run-as root


In the Limitations section, list any incompatibilities, known issues, or other warnings.


In the Development section, tell other users the ground rules for contributing to your project and how they should submit their work.

Release Notes/Contributors/Etc.


  • Scott Brimhall