Forge Home

bolt

configures bolt and provides hacks to execute it via systemd services

661 downloads

18 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.5.0 (latest)
  • 1.4.0
  • 1.3.0
  • 1.2.2
  • 1.2.0
  • 1.1.1
  • 1.1.0
  • 1.0.0
  • 0.3.0
  • 0.2.0
  • 0.1.0
released Nov 26th 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
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-bolt', '1.5.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install puppet-bolt --version 1.5.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

puppet/bolt — version 1.5.0 Nov 26th 2024

Bolt Puppet Module

Build Status Release Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores puppetmodule.info docs AGPL v3 License

Table of contents

Usage

The idea of this module is to configure bolt. The default is to install the puppet-tools-release package from yum.puppet.com. The source is configureable via the base_url parameter. Examples and all parameters are documented in the REFERENCE.md

Running plans

This module provides a way to run bolt plans in a complicated way. There's a defined resource that creates a bolt project, bolt::project. It's also documented in the REFERENCE.md.

The defined resource will create its own directory and user. It will also create a multi-instance systemd unit like $project@%i.service. You can start the unit with any plan name and systemd will run the plan in the background.

This is useful if you need to start plans via the PE orchestrator that manipulate the orchestrator itself. That usually deadlocks or restarts the orchestrator which in turn kills the plan.

Now you can:

  • Use PE Orchestrator API to start a task
  • the service task will start the systemd unit
  • systemd will start bolt in the background
  • consecutive service tasks can check for the state of the bolt systemd unit

Limitations

This module is only written for RedHat-like systems at the moment. For an update list of operating systems we test on please check the metadata.json.

Contributions

Contribution is fairly easy:

  • Fork the module into your namespace
  • Create a new branch
  • Commit your bugfix or enhancement
  • Write a test for it (maybe start with the test first)
  • Create a pull request

Detailed instructions are in the CONTRIBUTING.md file.

License and Author

This module was originally written by Tim Meusel. It's licensed with AGPL version 3.