11---
22layout : default
3- title : OpenBolt 5
3+ title : Welcome to OpenBolt 5
44---
55
6- OpenBolt is a community implementation of [ Puppet Bolt] ( https://github.com/puppetlabs/bolt ) — an open
7- source orchestration tool that automates infrastructure management over SSH and WinRM without requiring
8- agents. Use OpenBolt to run commands, scripts, and tasks across remote targets, or to orchestrate
9- complex workflows using plans.
6+ OpenBolt is an open source community implementation of [ Puppet Bolt] ( https://github.com/puppetlabs/bolt )
7+ — an orchestration tool that automates infrastructure management over SSH and WinRM without requiring
8+ product-specific agents. Use OpenBolt to run commands, scripts, and tasks across
9+ remote targets, or to orchestrate complex workflows using plans.
1010
1111OpenBolt is downstream-compatible with Puppet Bolt — existing tasks, plans, modules, and inventory files work unchanged.
1212
@@ -20,12 +20,57 @@ Work is expressed at several levels:
2020
2121- ** Commands** — run a shell command directly on targets
2222- ** Scripts** — upload and execute a script file on targets
23- - ** Tasks** — self-contained, reusable units of automation with defined parameters; written in any language
24- - ** Plans** — Puppet or YAML programs that sequence tasks, commands, and scripts across multiple targets with conditional logic
23+ - ** [ Tasks] ( tasks.html ) ** — self-contained, reusable units of automation with defined parameters; written in any language
24+ - ** [ Plans] ( plans.html ) ** — Puppet or YAML programs that sequence tasks, commands, and scripts across multiple targets with conditional logic
2525
26- ## Getting started
26+ ## Helpful OpenBolt docs links
2727
28+ ### Install OpenBolt
29+
30+ - [ Installing OpenBolt] ( bolt_installing.html ) - Follow the installation instructions for your operating system: \* nix, macOS, or Windows.
31+ ### Make one-time changes to your remote targets
32+
33+ - [ Run a command] ( running_bolt_commands.html#run-a-command )
34+ - [ Run a script] ( running_bolt_commands.html#run-a-script )
35+ - [ Upload files] ( running_bolt_commands.html#upload-a-file-or-directory )
36+
37+ ### Automate your workflow with existing tasks and plans
38+
39+ - [ Running tasks] ( bolt_running_tasks.html )
40+ - [ Running plans] ( bolt_running_plans.html )
41+
42+ ### Create your own tasks and plans
2843- [ Installing OpenBolt] ( bolt_installing.html )
2944- [ Getting started with Bolt] ( getting_started_with_bolt.html )
3045- [ Writing tasks] ( writing_tasks.html )
3146- [ Writing plans] ( writing_plans.html )
47+ - [ Writing plans in YAML] ( writing_yaml_plans.html )
48+ - [ Example plans] ( writing_plans.html )
49+ - [ Applying manifest blocks] ( applying_manifest_blocks.html )
50+
51+ ## Other useful places
52+
53+ ### Learn the basics
54+
55+ - [ Getting started with OpenBolt] ( getting_started_with_bolt.html )
56+ - [ OpenBolt examples] ( bolt_examples.html ) - Guided examples of how OpenBolt can help you automate common tasks.
57+
58+ ### Watch OpenBolt development
59+
60+ - [ OpenBolt project on GitHub] ( https://github.com/OpenVoxProject/openbolt )
61+
62+ ### Docs for related OpenVox products
63+
64+ - [ OpenVox] ( /openvox/latest/ ) – open source, community-maintained implementation of Puppet
65+ - [ OpenVox Server] ( /openvox-server/latest/ )
66+ - [ OpenVoxDB] ( /openvoxdb/latest/ )
67+
68+
69+ ### Share and contribute
70+
71+ - [ Join us on Slack] ( https://voxpupuli.slack.com/ ) - Join the #bolt channel.
72+ - Follow us on [ Bluesky] ( https://bsky.app/profile/voxpupuli.bsky.social/ ) or [ Mastodon] ( https://fosstodon.org/@voxpupuli/ )
73+ - [ Connect with the OpenVox/VoxPupuli Community] ( https://voxpupuli.org/connect/ )
74+ - [ OpenVox on GitHub] ( https://github.com/openvox/ )
75+ - [ Open source projects from VoxPupuli on GitHub] ( https://github.com/voxpupuli/ )
76+ - [ Puppet Forge] ( https://forge.puppet.com ) - Find modules you can use, and contribute modules you've made to the community.
0 commit comments