Update OpenBolt install instructions for most OSes#385
Conversation
|
I tested the instructions for EL, SLES, Debian, and Ubuntu, but I don't have any Windows or MacOS machines to test on (feedback welcome) I got rid of apparently moribund documentation, like homebrew, chocolatey, and the PowerShell Gallery, where even Puppet Bolt is no longer available or has not been updated for several major versions. |
This patch updates Bolt to OpenBolt, corrects the table of supported OSes based on the packages in the repos, and updates the installation instructions to use openbolt/voxpupuli packages and repos instead of the old puppet servers and packages. Signed-off-by: Chris Tessmer <chris.tessmer@onyxpoint.com>
Signed-off-by: Chris Tessmer <chris.tessmer@onyxpoint.com>
Signed-off-by: Chris Tessmer <chris.tessmer@onyxpoint.com>
c94c5d4 to
48dbbf0
Compare
|
|
||
| ```powershell | ||
| "C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <GEM> | ||
| "C:/Program Files/Puppet Labs/OpenBolt/bin/gem.bat" install --user-install <GEM> |
There was a problem hiding this comment.
This path is a guess (and maybe a better guess would be just keeping it 'Bolt', like the *nix AIOs do). I don't have access to Windows atm―can anyone confirm what the actual path is on a real Windows OpenBolt installation?
There was a problem hiding this comment.
Confirmed on a Windows 11 VM with openbolt-5.6.0-x64.msi: the installer's directory picker defaults to C:\Program Files\Puppet Labs\Bolt, and after install it's the only child of Puppet Labs — so your instinct was right, it's still Bolt like the *nix AIOs:
| "C:/Program Files/Puppet Labs/OpenBolt/bin/gem.bat" install --user-install <GEM> | |
| "C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <GEM> |
(For the same reason, the Apps & Features entry is OpenBolt, not "Puppet OpenBolt" — separate comment on that line.)
| [add the Bolt module to | ||
| PowerShell](troubleshooting.html#powershell-does-not-recognize-bolt-cmdlets) or [change | ||
| execution policy | ||
| restrictions](troubleshooting.html#powershell-could-not-load-the-bolt-powershell-module). |
There was a problem hiding this comment.
I'm not 100% certain it's correct to remove this section (no way to check atm)―but the module referenced here is currently a stale version (3.27.1) of Puppetlabs' Bolt in the PowerShell Gallery, without an OpenBolt equivalent.
Does anyone know if this step is necessary to get get OpenBolt to work on Windows, and if the PowerShell Gallery module is necessary or if there's a recommended alternative?
|
2 Errors from Link checker. See https://github.com/OpenVoxProject/openvox-docs/actions/runs/28607644025/job/84971270344?pr=385 |
There was a problem hiding this comment.
Built and link-checked against the live voxpupuli repos, and tested the MSI on a Windows 11 VM. A handful of install commands point at artifacts that don't exist (Fedora still on yum.puppet.com, EL9/EL10 release RPM names, Ubuntu 20.04, the FIPS row), plus some rebrand leftovers, suggestions inline for everything with a clean one-click fix.
| - _Fedora 44_ | ||
|
|
||
| ```console | ||
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-36.noarch.rpm | ||
| sudo dnf install puppet-bolt | ||
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-44.noarch.rpm | ||
| sudo dnf install openbolt | ||
| ``` | ||
|
|
||
| ### Upgrade Bolt | ||
|
|
||
| To upgrade Bolt to the latest version, run the following command: | ||
|
|
||
| ```console | ||
| sudo dnf upgrade puppet-bolt | ||
| ``` | ||
|
|
||
| ### Uninstall Bolt | ||
| - _Fedora 43_ | ||
|
|
||
| To uninstall Bolt, run the following command: | ||
|
|
||
| ```console | ||
| sudo dnf remove puppet-bolt | ||
| ``` | ||
|
|
||
| ## Install Bolt on macOS | ||
|
|
||
| You can install Bolt packages for macOS using either Homebrew or the | ||
| macOS installer. | ||
|
|
||
| ### Homebrew | ||
| ```console | ||
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-43.noarch.rpm | ||
| sudo dnf install openbolt | ||
| ``` | ||
|
|
||
| #### Install Bolt | ||
| - _Fedora 42_ | ||
|
|
||
| To install Bolt with Homebrew, you must have the [Homebrew package | ||
| manager](https://brew.sh/) installed. | ||
| ```console | ||
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-42.noarch.rpm | ||
| sudo dnf install openbolt | ||
| ``` |
There was a problem hiding this comment.
The Fedora blocks still point at the old Puppet repo — all three yum.puppet.com/puppet-tools-release-fedora-*.rpm URLs return 404, so the install can't succeed. The voxpupuli equivalents exist (all verified 200, and openbolt-5.6.0 is in the openvox8 Fedora repos):
| - _Fedora 44_ | |
| ```console | |
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-36.noarch.rpm | |
| sudo dnf install puppet-bolt | |
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-44.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| ### Upgrade Bolt | |
| To upgrade Bolt to the latest version, run the following command: | |
| ```console | |
| sudo dnf upgrade puppet-bolt | |
| ``` | |
| ### Uninstall Bolt | |
| - _Fedora 43_ | |
| To uninstall Bolt, run the following command: | |
| ```console | |
| sudo dnf remove puppet-bolt | |
| ``` | |
| ## Install Bolt on macOS | |
| You can install Bolt packages for macOS using either Homebrew or the | |
| macOS installer. | |
| ### Homebrew | |
| ```console | |
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-43.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| #### Install Bolt | |
| - _Fedora 42_ | |
| To install Bolt with Homebrew, you must have the [Homebrew package | |
| manager](https://brew.sh/) installed. | |
| ```console | |
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-42.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _Fedora 44_ | |
| ```console | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-fedora-44.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _Fedora 43_ | |
| ```console | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-fedora-43.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _Fedora 42_ | |
| ```console | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-fedora-42.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` |
| - _RHEL 10, RockyLinux 10, AlmaLinux 10, and clones | ||
|
|
||
| ```console | ||
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-6.noarch.rpm | ||
| sudo yum install puppet-bolt | ||
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox10-release-el-10.noarch.rpm | ||
| sudo dnf install openbolt | ||
| ``` | ||
|
|
||
| - _RHEL 7_ | ||
| - _RHEL 9, RockyLinux 9, AlmaLinux 9, and clones | ||
|
|
||
| ```console | ||
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-7.noarch.rpm | ||
| sudo yum install puppet-bolt | ||
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox9-release-el-9.noarch.rpm | ||
| sudo dnf install openbolt | ||
| ``` | ||
|
|
||
| - _RHEL 8_ | ||
| - _RHEL 8, RockyLinux 8, AlmaLinux 8, and clones | ||
|
|
||
| ```console | ||
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-el-8.noarch.rpm | ||
| sudo dnf install openbolt | ||
| ``` |
There was a problem hiding this comment.
openvox10-release-el-10 and openvox9-release-el-9 both 404 — the openvoxN prefix is the OpenVox collection version, not the OS major, so all three EL versions use openvox8-release-el-N (the RHEL 8 block already has it right; openvox8-release-el-9/-el-10 both verified 200). This also closes the italic markers on the three labels, which are missing their trailing _:
| - _RHEL 10, RockyLinux 10, AlmaLinux 10, and clones | |
| ```console | |
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-6.noarch.rpm | |
| sudo yum install puppet-bolt | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox10-release-el-10.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _RHEL 7_ | |
| - _RHEL 9, RockyLinux 9, AlmaLinux 9, and clones | |
| ```console | |
| sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-7.noarch.rpm | |
| sudo yum install puppet-bolt | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox9-release-el-9.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _RHEL 8_ | |
| - _RHEL 8, RockyLinux 8, AlmaLinux 8, and clones | |
| ```console | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-el-8.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _RHEL 10, RockyLinux 10, AlmaLinux 10, and clones_ | |
| ```console | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-el-10.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _RHEL 9, RockyLinux 9, AlmaLinux 9, and clones_ | |
| ```console | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-el-9.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` | |
| - _RHEL 8, RockyLinux 8, AlmaLinux 8, and clones_ | |
| ```console | |
| sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-el-8.noarch.rpm | |
| sudo dnf install openbolt | |
| ``` |
| - _Ubuntu 20.04_ | ||
|
|
||
| ```console | ||
| wget https://apt.voxpupuli.org/openvox8-release-ubuntu20.04.deb | ||
| sudo dpkg -i openvox8-release-ubuntu20.04.deb | ||
| sudo apt-get update | ||
| sudo apt-get install openbolt | ||
| ``` | ||
|
|
There was a problem hiding this comment.
No openbolt package (or openvox8-release-ubuntu20.04.deb) is published for 20.04, so these steps 404 at the first wget. Goes with dropping the 20.04 cell from the table above:
| - _Ubuntu 20.04_ | |
| ```console | |
| wget https://apt.voxpupuli.org/openvox8-release-ubuntu20.04.deb | |
| sudo dpkg -i openvox8-release-ubuntu20.04.deb | |
| sudo apt-get update | |
| sudo apt-get install openbolt | |
| ``` |
| 1. Search for **Puppet Bolt**, select it, and click **Uninstall**. | ||
|
|
||
| ### PuppetBolt PowerShell module | ||
| 1. Search for **Puppet OpenBolt**, select it, and click **Uninstall**. |
There was a problem hiding this comment.
| | Operating system | Versions | | ||
| | ------------------------- | -------------------------------- | | ||
| | AmazonLinux | 2, 2023 | | ||
| | Debian | 11, 12, 13 | | ||
| | Fedora | 42, 43, 44 | | ||
| | macOS | 11, 12 | | ||
| | Microsoft Windows* | 10 Enterprise, 11 | | ||
| | Microsoft Windows Server* | 2012R2, 2019 | | ||
| | RHEL | 8, 9, 10 | | ||
| | RHEL (FIPS-mode enabled) | 9, 10 | | ||
| | SLES | 15, 16 | | ||
| | Ubuntu | 20.04, 22.04, 24.04, 25.04 26.04 | |
There was a problem hiding this comment.
Two rows here don't match the published artifacts:
- Ubuntu 20.04: there's no openbolt deb for 20.04 —
apt.voxpupuli.org/pool/openvox8/o/openbolt/only has 22.04/24.04/25.04/26.04 (andopenvox8-release-ubuntu20.04.debdoesn't exist either). The cell is also missing a comma between25.04and26.04. - RHEL (FIPS-mode enabled): the redhatfips repos exist only for EL8/EL9 and contain no
openbolt-*.rpmat all, and the page has no FIPS install instructions — so the row promises something nothing backs.
| | Operating system | Versions | | |
| | ------------------------- | -------------------------------- | | |
| | AmazonLinux | 2, 2023 | | |
| | Debian | 11, 12, 13 | | |
| | Fedora | 42, 43, 44 | | |
| | macOS | 11, 12 | | |
| | Microsoft Windows* | 10 Enterprise, 11 | | |
| | Microsoft Windows Server* | 2012R2, 2019 | | |
| | RHEL | 8, 9, 10 | | |
| | RHEL (FIPS-mode enabled) | 9, 10 | | |
| | SLES | 15, 16 | | |
| | Ubuntu | 20.04, 22.04, 24.04, 25.04 26.04 | | |
| | Operating system | Versions | | |
| | ------------------------- | -------------------------------- | | |
| | AmazonLinux | 2, 2023 | | |
| | Debian | 11, 12, 13 | | |
| | Fedora | 42, 43, 44 | | |
| | macOS | 11, 12 | | |
| | Microsoft Windows* | 10 Enterprise, 11 | | |
| | Microsoft Windows Server* | 2012R2, 2019 | | |
| | RHEL | 8, 9, 10 | | |
| | SLES | 15, 16 | | |
| | Ubuntu | 22.04, 24.04, 25.04, 26.04 | |
Separate question, no change suggested: the macOS "11, 12" and the Windows/Server versions look carried over from the old Bolt docs — the DMG is version-agnostic (.all) and the MSI has no OS-version encoding, so it may be worth checking what's actually tested before shipping those cells.
|
|
||
| - [11 (Big Sur)](https://downloads.puppet.com/mac/puppet-tools/11/x86_64/puppet-bolt-latest.dmg) | ||
| - [12 (Monterey)](https://downloads.puppet.com/mac/puppet-tools/12/x86_64/puppet-bolt-latest.dmg) | ||
| - <https://downloads.voxpupuli.org/mac/openvox8/openbolt-5.6.0-1.macos.all.x86_64.dmg> |
There was a problem hiding this comment.
Not blocking, but flagging the trade-off: this DMG link and the MSI link below pin 5.6.0, so both need a hand edit every OpenBolt release (the old page used -latest aliases, which downloads.voxpupuli.org doesn't offer). Two in-repo precedents avoid the staleness:
- interpolate the version from the tracked data, e.g.
openbolt-{{ site.data.openbolt_release_contents[0].release }}-x64.msi(this data file is already consumed bycomponent_versions.md), or - link the versionless directory the way
docs/_openvox_8x/install_osx.md/install_windows.markdowndo ("Download the current package from https://downloads.voxpupuli.org/mac").
Related: downloads.voxpupuli.org/mac/openvox8/ also has an arm64 DMG, but only the x86_64 one is linked here — worth an Apple Silicon mention either way.
| ```powershell | ||
| choco uninstall puppet-bolt | ||
| ``` | ||
| Use one of the supported Windows installation methods to install OpenBolt. |
There was a problem hiding this comment.
A few small partial-rewrite leftovers, batched to keep the comment count down:
- Line 164: "Use one of the supported Windows installation methods" — only the MSI remains after the Chocolatey removal, so maybe "Use the Windows installer (MSI) to install OpenBolt." (Same pattern in the macOS section: single method, but still nested under a
### macOS installer (DMG)method heading.) - Line 156: "remove Bolt's files and executable" → "remove OpenBolt's files and executable" (the paths below correctly stay
/opt/puppetlabs/bolt). - Line 411: "use one of the Bolt installation packages" → "OpenBolt".
- Lines 309 and 316:
- _AmazonLinux 2023/- _AmazonLinux 2are missing the closing_, so the underscore renders literally instead of italicizing (the RHEL labels have the same issue — covered in the suggestion on that section).
| each of Bolt's commands. New versions of the PuppetBolt module are shipped at the | ||
| same time as a new Bolt release. | ||
|
|
||
| #### Install PuppetBolt |
There was a problem hiding this comment.
The ### PuppetBolt PowerShell module heading and its intro were deleted, which leaves these three #### subsections orphaned under "Windows installer (MSI)" — they read as MSI steps, but the module is a separate thing. It also breaks a cross-page link: getting_started_with_bolt.md (line 70) still points at bolt_installing.html#puppetbolt-powershell-module, which no longer resolves.
| #### Install PuppetBolt | |
| ### PuppetBolt PowerShell module | |
| The PuppetBolt PowerShell module provides PowerShell cmdlets for OpenBolt. | |
| #### Install PuppetBolt |
Also worth considering: the old MSI flow ended with "open a new PowerShell window and run a cmdlet, and if it errors see [troubleshooting]" — those two troubleshooting anchors still exist in troubleshooting.md but are no longer linked from anywhere in the install flow. A verification step pointing at them would save Windows users the most common post-install confusion.
|
|
||
| ```powershell | ||
| "C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <GEM> | ||
| "C:/Program Files/Puppet Labs/OpenBolt/bin/gem.bat" install --user-install <GEM> |
There was a problem hiding this comment.
Confirmed on a Windows 11 VM with openbolt-5.6.0-x64.msi: the installer's directory picker defaults to C:\Program Files\Puppet Labs\Bolt, and after install it's the only child of Puppet Labs — so your instinct was right, it's still Bolt like the *nix AIOs:
| "C:/Program Files/Puppet Labs/OpenBolt/bin/gem.bat" install --user-install <GEM> | |
| "C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <GEM> |
(For the same reason, the Apps & Features entry is OpenBolt, not "Puppet OpenBolt" — separate comment on that line.)

This patch updates "Bolt" to "OpenBolt", corrects the table of supported OSes based on the packages in the repos, and updates the installation instructions to use openbolt/voxpupuli repos and packages instead of the old puppet servers and packages.
Fixes #384
Short description
Checklist
I have:
Signed-off-byannotation to each of my commitsGenerated-byorAssisted-byannotations to each of my commits created with the help of an AI agent