Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

deploy

Module containing tasks and a plan for deploying a puppet environment with R10k
Project URLRSS FeedReport issues

2,560 downloads

2,086 latest version

5.0 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

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
  • , , , , ,
Tasks:
  • cache
  • generate_types
  • r10k
Plans:
  • 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.

Download

Documentation

suchpuppet/deploy — version 0.1.1 Oct 7th 2019

deploy

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

Description

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.

Setup

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

Usage

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

Limitations

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

Development

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.

Contributors:

  • Scott Brimhall