OpenBolt 9
OpenBolt is an open source orchestration tool that automates the manual work it takes to maintain your infrastructure. Use it for one-off changes, such as patching systems, troubleshooting servers, or restarting services, or as part of a larger orchestration workflow. OpenBolt runs on your workstation and connects directly to remote targets, so you don’t need to install agent software on them.
How it works
OpenBolt usually connects to targets over SSH (the default) or WinRM, authenticates as a specified user, and runs work on the target. Other transports cover Docker and Podman containers, the local machine, network devices through a proxy target, and Choria. There is no persistent agent or daemon: each run connects, executes, and disconnects.
Work is expressed at several levels:
- Commands: run a shell command directly on targets.
- Scripts: upload and run a script file on targets.
- Tasks: reusable units of automation with defined parameters, written in any language.
- Plans: Puppet language or YAML programs that combine tasks, commands, and scripts across multiple targets with conditional logic.
Tasks, plans, modules, and inventory files you already have work unchanged.
Get started
- Install OpenBolt on Linux, macOS, or Windows.
- Work through Getting started with OpenBolt, then try the longer guides.
Make one-time changes to your targets
Automate your workflow with tasks and plans
- Running tasks
- Running plans
- Writing tasks
- Writing plans in YAML
- Writing plans in the Puppet language
- Applying Puppet code
Related documentation
- OpenVox: the agent, server, and the Puppet language that manifest blocks are written in.
- OpenVoxDB: the database that the
puppetdbplugin and plan functions query. - PDK: tooling for creating and testing modules.
Get help and contribute
- OpenBolt on GitHub: source code, issues, and pull requests.
- OpenVox community Slack: ask questions and share what you’ve built.
- Vox Pupuli: the community that OpenVox grew out of, which maintains many of the modules you can use with OpenBolt.
- Puppet Forge: find modules with tasks and plans, and publish your own.