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.