Forge Home

commission

Commission / decommission Puppet nodes easily

324 downloads

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

Version information

  • 1.1.0 (latest)
  • 1.0.0
released Sep 16th 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • ,
Tasks:
  • add_custom_facts
  • deactivate_nodes
  • get_certificate_request
  • revoke_certificates
  • set_puppet_config
  • sign_certificate_requests
Plans:
  • commission
  • decommission

Start using this module

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

Add this module to your Puppetfile:

mod 'opuscodium-commission', '1.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add opuscodium-commission
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install opuscodium-commission --version 1.1.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

opuscodium/commission — version 1.1.0 Sep 16th 2024

puppet-commission

Build Status Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores License

Commission / decommission Puppet nodes easily.

This module provides Bolt plans to commission / decommission Puppet nodes.

Getting started

Use this module to setup commissioning / decommissioning plans tailored to your site. We ship two sample plans with the module: commission::commission and commission::decommission. These plans are site-agnostic and not too much opiniated to be used in any infrastructure. Use them to give a try to the module and as a template for your site-specific plans.

To setup site-specific plan for your ACME organization, start with your Bolt project:

romain@marvin % mkdir acme
romain@marvin % cd acme
romain@marvin ~/acme % bolt project init --modules opuscodium-commission acme
Installing project modules

  → Resolving module dependencies, this might take a moment

  → Writing Puppetfile at ~/acme/Puppetfile

  → Syncing modules from ~/acme/Puppetfile to ~/acme/.modules

  → Generating type references

Successfully synced modules from ~/acme/Puppetfile to ~/acme/.modules
romain@marvin ~/acme % mkdir -p plans
romain@marvin ~/acme % sed -e 's/commission::commission/acme::commission/' -e '/@api private/,+1d' < .modules/commission/plans/commission.pp > plans/commission.pp
romain@marvin ~/acme % bolt plan show
Plans
  acme::commission       Commission a node and connect it to the Puppet infrastructure
[...]

Edit the plans/commission.pp plan to fit your site policies, requirements, etc. Feel free to hardcode the puppet server name, fetch data from PuppetDB, prompt the user for inputs, and so on… When done, setup a decommissioning plan in a similar fashion.

Commissioning nodes

romain@marvin ~/acme % bolt plan run acme::commission -t node1.example.com,node2.example.com

Decommissioning nodes

romain@marvin ~/acme % bolt plan run acme::decommission -t node1.example.com,node2.example.com