Join the #bolt channel in the Puppet community Slack where Bolt developers and community members who use and contribute to Bolt discuss the tool. Another channel of interest is the #office-hours where once a week a Bolt developer leads a Q&A session about using Bolt.
Please submit new issues on the GitHub issue tracker: https://github.com/puppetlabs/bolt/issues
Choose the appropriate template depending on the kind of issue you're filing: feature request, bug report, or docs change.
The Bolt ecosystem is extensible via Puppet modules such as those hosted on the Forge. Many improvements to the Bolt plan ecosystem can be added there as new modules.
There are certain types of improvements that we believe make sense in Bolt itself:
- New Transports. Transports API is a work-in-progress, but is something we aim to stabilize. Currently these can't be extended via modules, although in the future they likely will be.
- Core functionality we believe makes Bolt a better tool, such as the
aggregateandcanaryplans included inmodules. - New functions
- New core functions that use Bolt internals such as the Executor, Applicator, or Inventory should live in bolt-modules/boltlib.
- Other directories under bolt-modules are used to categorize Bolt's standard library functions.
- New ways of interacting with plan progress and output, such as prompts to continue or output processors.
- New inventory sources. This is experimental right now, but we're working towards patterns for getting inventory into Bolt and how to refer to it from within a plan.
Pull requests are also welcome on GitHub: https://github.com/puppetlabs/bolt
As with other open-source projects managed by Puppet, you must digitally sign the Contributor License Agreement before we can accept your pull request: https://cla.puppet.com
If this is your first time submitting a PR:
- Fork the Bolt project (button in the top-right, next to 'star' and 'watch')
- Clone your fork of Bolt
- Add the puppetlabs repo as an upstream -
git remote add upstream [email protected]:puppetlabs/bolt - Make a new branch off of master -
git checkout -b mybranchname - Commit your changes and add a useful commit message, including what specifically you changed and why -
git commit - Push your changes to your branch on your fork -
git push origin mybranchname - Open a PR against master at https://github.com/puppetlabs/bolt
If it's not your first PR
- Update from upstream:
git fetch upstream && git checkout upstream/master && git checkout -b mybranchname - Commit your changes and add a useful commit message, including what specifically you changed and why -
git commit - Push your changes to your branch on your fork -
git push origin mybranchname - Open a PR against master at https://github.com/puppetlabs/bolt
If you are interested in trying bolt out or using in production we recommend installing from a system package detailed in installing bolt. The following installation instructions are focused on developers who wish to contribute to Bolt.
Depending on your development workflow, you can install Bolt one of three ways:
- From RubyGems
- From your Gemfile with Bundler
- From source
Bolt vendors a version of Puppet that supports executing tasks and plans, so you do not need to install Puppet. If you happen to already have Puppet installed, then the vendored version takes precedence and does not conflict with the already installed version.
To install from RubyGems, run:
gem install bolt
To use Bundler, add this to your Gemfile:
gem 'bolt'
Alternatively there are rake tasks defined in bundler that allow you to install your local Bolt with any changes you made for development and testing.
bundle exec rake install
bundle exec rake install:local
To run Bolt from source:
bundle install --path .bundle --without test
bundle exec bolt ...
To use rubocop, perform the bundle install with no exclusions
bundle install --path .bundle --with test
bundle exec rake rubocop
Some module content is included with the Bolt gem for out-of-the-box use. Some of those modules are included in this repository and others are managed with the Puppetfile included in this repository. All the bundled modules are installed in the modules directory.
To change external modules (to add a new module or bump the version), update the Puppetfile and then run bundle exec r10k puppetfile install.
Some tests require a Windows VM or Linux containers. For Linux tests (recommended, if you're not sure) run docker-compose -f spec/docker-compose.yml up -d --build from the project root directory. For windows tests, execute vagrant up from the root of the bolt repo to bring these up with the provided Vagrantfile. Any tests that require this are tagged with :winrm or :ssh in rspec.
Additional tests may run in a local environment and require certain shell capabilities. For example tests that require a Bash-like environment are tagged with :bash in rspec.
Some tests will also require that the bundled modules described above are installed. Ensure the modules are installed for testing with the following command:
bundle exec r10k puppetfile install .
To run all tests, run:
$ bundle exec rake test
To run specific versions of tagged tests, run the integration target with the tag appended, e.g.:
$ bundle exec rake integration:bash
To exclude tests that rely on Vagrant, run:
$ bundle exec rake unit
Windows includes additional tests that require a full Windows Server VM to run; we run them in AppVeyor. If you need to run the tests locally set APPVEYOR_AGENTS=true, re-run vagrant up to create a Windows Server 2016 Core VM, and run tests with
$ BOLT_WINRM_PORT=35985 BOLT_WINRM_SMB_PORT=3445 BOLT_WINRM_USER=vagrant BOLT_WINRM_PASSWORD=vagrant bundle exec rake integration:appveyor_agents
To use rubocop on Windows, you must install the ruby.devkit and the MSYS2 base package.
choco install ruby.devkit
refreshenv
ridk install # Choose the base install and complete the Wizard selections.