diff --git a/docs/_openbolt_5x/bolt_installing.md b/docs/_openbolt_5x/bolt_installing.md index afb2a1193..4c7df3ba8 100644 --- a/docs/_openbolt_5x/bolt_installing.md +++ b/docs/_openbolt_5x/bolt_installing.md @@ -1,449 +1,163 @@ --- layout: default -title: Installing Bolt +title: Installing OpenBolt --- -# Installing Bolt +# Installing OpenBolt -Packaged versions of Bolt are available for several Linux distributions, macOS, +Packaged versions of OpenBolt are available for several Linux distributions, macOS, and Microsoft Windows. | Operating system | Versions | | ------------------------- | ------------------- | -| Debian | 10, 11 | -| Fedora | 36 | -| macOS | 11, 12 | -| Microsoft Windows* | 10 Enterprise | -| Microsoft Windows Server* | 2012R2, 2019 | -| RHEL | 6, 7, 8, 9 | -| SLES | 12, 15 | -| Ubuntu | 18.04, 20.04, 22.04 | +| Amazon Linux | 2, 23 | +| Debian | 12, 13 | +| Enterprise Linux | 8, 9, 10 | +| Fedora | 43, 44 | +| macOS | 13, 14, 15 | +| Microsoft Windows | 11 | +| Microsoft Windows Server* | 2019, 2022, 2025 | +| SLES | 15, 16 | +| Ubuntu | 22.04, 24.04, 26.04 | -> **Note:** Windows packages are automatically tested on the versions listed -> above, but might be installable on other versions. +## Install OpenBolt on Linux -## Install Bolt on Debian +### Debian/Ubuntu -### Install Bolt +Download and install the appropriate file for the OS you have -To install Bolt, run the appropriate command for the version of Debian you -have installed: - -- _Debian 10_ - - ```console - wget https://apt.puppet.com/puppet-tools-release-buster.deb - sudo dpkg -i puppet-tools-release-buster.deb - sudo apt-get update - sudo apt-get install puppet-bolt - ``` - -- _Debian 11_ - - ```console - wget https://apt.puppet.com/puppet-tools-release-bullseye.deb - sudo dpkg -i puppet-tools-release-bullseye.deb - sudo apt-get update - sudo apt-get install puppet-bolt - ``` - -### Upgrade Bolt - -To upgrade Bolt to the latest version, run the following command: - -```console -sudo apt-get update -sudo apt install puppet-bolt +```shell +source /etc/os-release +wget "https://apt.voxpupuli.org/openvox8-release-${ID}${VERSION_ID}.deb" +apt install ./openvox8-release*.deb ``` -### Uninstall Bolt +Then install OpenBolt: -To uninstall Bolt, run the following command: - -```console -sudo apt remove puppet-bolt +```shell +sudo apt-get update +sudo apt-get install openbolt ``` -## Install Bolt on Fedora - -### Install Bolt - -To install Bolt, run the appropriate command for the version of Fedora you -have installed: - -- _Fedora 36_ - - ```console - sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-36.noarch.rpm - sudo dnf install puppet-bolt - ``` - -### Upgrade Bolt - -To upgrade Bolt to the latest version, run the following command: +To upgrade OpenBolt: -```console -sudo dnf upgrade puppet-bolt +```shell +sudo apt-get update +sudo apt-get --only-upgrade install openbolt ``` -### Uninstall Bolt - -To uninstall Bolt, run the following command: +To remove OpenBolt: -```console -sudo dnf remove puppet-bolt +```shell +sudo apt purge openbolt ``` -## Install Bolt on macOS - -You can install Bolt packages for macOS using either Homebrew or the -macOS installer. - -### Homebrew - -#### Install Bolt - -To install Bolt with Homebrew, you must have the [Homebrew package -manager](https://brew.sh/) installed. - -1. Tap the Puppet formula repository: +### Enterprise Linux family - ```console - brew tap puppetlabs/puppet - ``` +Download and install the appropriate file for the OS you have -1. Install Bolt: - - ```console - brew install --cask puppet-bolt - ``` - -#### Upgrade Bolt - -To upgrade Bolt to the latest version, run the following command: - -```console -brew upgrade --cask puppet-bolt +```shell +# Amazon Linux 2 +sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-amazon-2.noarch.rpm +# Amazon Linux 2023 +sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-amazon-2023.noarch.rpm +# EL8 +sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-el-8.noarch.rpm +# EL9 +sudo dnf install https://yum.voxpupuli.org/openvox8-release-el-9.noarch.rpm +# EL10 +sudo dnf install https://yum.voxpupuli.org/openvox8-release-el-10.noarch.rpm +# Fedora 43 +sudo dnf install https://yum.voxpupuli.org/openvox8-release-fedora-43.noarch.rpm +# Fedora 44 +sudo dnf install https://yum.voxpupuli.org/openvox8-release-fedora-44.noarch.rpm +# SLES 15 +sudo zypper install https://yum.voxpupuli.org/openvox8-release-sles-15.noarch.rpm +# SLES 16 +sudo zypper install https://yum.voxpupuli.org/openvox8-release-sles-16.noarch.rpm ``` -#### Uninstall Bolt - -To uninstall Bolt, run the following command: +Then install OpenBolt: -```console -brew uninstall --cask puppet-bolt +```shell +# Amazon/EL/Fedora +sudo dnf install openbolt +# SLES +sudo zypper install openbolt ``` -### macOS installer (DMG) - -#### Install Bolt +To upgrade OpenBolt: -Use the Apple Disk Image (DMG) to install Bolt on macOS: - -1. Download the Bolt installer package for your macOS version. - - - [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) - -1. Double-click the `puppet-bolt-latest.dmg` file to mount the installer and - then double-click `puppet-bolt-[version]-installer.pkg` to run the installer. - -If you get a message that the installer "can't be opened because Apple cannot check it for malicious software:" - -1. Click **** > **System Preferences** > **Security & Privacy**. -1. From the **General** tab, click the lock icon to allow changes to your security settings and enter your macOS password. -1. Look for a message that says the Bolt installer "was blocked from use because it is not from an identified developer" and click "Open Anyway". -1. Click the lock icon again to lock your security settings. - -#### Upgrade Bolt - -To upgrade Bolt to the latest version, download the DMG again and repeat the -installation steps. - -#### Uninstall Bolt - -To uninstall Bolt, remove Bolt's files and executable: - -```console -sudo rm -rf /opt/puppetlabs/bolt /opt/puppetlabs/bin/bolt +```shell +# Amazon/EL/Fedora +sudo dnf upgrade --refresh openbolt +# SLES +sudo zypper up openbolt ``` -## Install Bolt on Microsoft Windows - -Use one of the supported Windows installation methods to install Bolt. - -### Chocolatey +To remove OpenBolt: -#### Install Bolt - -To install Bolt with Chocolatey, you must have the [Chocolatey package -manager](https://chocolatey.org/docs/installation) installed. - -1. Download and install the bolt package: - - ```powershell - choco install puppet-bolt - ``` - -1. Refresh the environment: - - ```powershell - refreshenv - ``` - -1. Install the [PuppetBolt PowerShell module](#puppetbolt-powershell-module). - -1. Run a [Bolt cmdlet](bolt_cmdlet_reference.html). If you see an error message - instead of the expected output, you might need to [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). - -#### Upgrade Bolt - -To upgrade Bolt to the latest version, run the following command: - -```powershell -choco upgrade puppet-bolt +```shell +# Amazon/EL/Fedora +sudo dnf remove openbolt +# SLES +sudo zypper remove openbolt ``` -#### Uninstall Bolt - -To uninstall Bolt, run the following command: - -```powershell -choco uninstall puppet-bolt -``` +## Install OpenBolt on macOS -### Windows installer (MSI) +Use the Apple Disk Image (DMG) to install OpenBolt on macOS: -#### Install Bolt +1. Download the OpenBolt installer package for your macOS version from `https://downloads.voxpupuli.org/mac`. +2. Double-click the `openbolt-[version].dmg` file to mount the installer and + then double-click `openbolt-[version]-installer.pkg` to run the installer. -Use the Windows installer (MSI) package to install Bolt on Windows: +**Upgrade OpenBolt** -1. Download the [Bolt installer - package](https://downloads.puppet.com/windows/puppet-tools/puppet-bolt-x64-latest.msi). +To upgrade OpenBolt to the latest version, download the DMG again and repeat the +installation steps. -1. Double-click the MSI file and run the installer. +## Install OpenBolt on Microsoft Windows -1. Install the [PuppetBolt PowerShell module](#puppetbolt-powershell-module). +Use the Windows installer (MSI) package to install OpenBolt on Windows: -1. Open a new PowerShell window and run a [Bolt cmdlet](bolt_cmdlet_reference.html). - If you see an error message instead of the expected output, you might need to - [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). +1. Download the [more recent OpenBolt installer package](https://downloads.voxpupuli.org/windows/openvox8/). -#### Upgrade Bolt +2. Double-click the MSI file and run the installer. -To upgrade Bolt to the latest version, download the MSI again and repeat the +To upgrade OpenBolt to the latest version, download the MSI again and repeat the installation steps. -#### Uninstall Bolt +#### Uninstall OpenBolt -You can uninstall Bolt from Windows **Apps & Features**: +You can uninstall OpenBolt from Windows **Apps & Features**: 1. Press **Windows** + **X** + **F** to open **Apps & Features**. -1. Search for **Puppet Bolt**, select it, and click **Uninstall**. - -### PuppetBolt PowerShell module - -The PuppetBolt PowerShell module is available on the [PowerShell -Gallery](https://www.powershellgallery.com/packages/PuppetBolt) and includes -help documents and [PowerShell cmdlets](bolt_cmdlet_reference.html) for running -each of Bolt's commands. New versions of the PuppetBolt module are shipped at the -same time as a new Bolt release. - -#### Install PuppetBolt - -To install the PuppetBolt PowerShell module, run the following command in -PowerShell: - -```powershell -Install-Module PuppetBolt -``` - -#### Update PuppetBolt - -To update the PuppetBolt PowerShell module, run the following command in -PowerShell: - -```powershell -Update-Module PuppetBolt -``` - -#### Uninstall PuppetBolt - -To uninstall the PuppetBolt PowerShell module, run the following command in -PowerShell: - -```powershell -Remove-Module PuppetBolt -``` - -## Install Bolt on RHEL - -### Install Bolt - -To install Bolt, run the appropriate command for the version of RHEL you -have installed: - -- _RHEL 6_ - - ```console - sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-6.noarch.rpm - sudo yum install puppet-bolt - ``` - -- _RHEL 7_ - - ```console - sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-7.noarch.rpm - sudo yum install puppet-bolt - ``` - -- _RHEL 8_ - - ```console - sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-8.noarch.rpm - sudo yum install puppet-bolt - ``` - -- _RHEL 9_ - - ```console - sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-9.noarch.rpm - sudo yum install puppet-bolt - ``` - -### Upgrade Bolt - -To upgrade Bolt to the latest version, run the following command: - -```console -sudo yum update puppet-bolt -``` - -### Uninstall Bolt - -To uninstall Bolt, run the following command: - -```console -sudo yum remove puppet-bolt -``` - -## Install Bolt on SLES - -### Install Bolt - -To install Bolt, run the appropriate command for the version of SLES you -have installed: - -- _SLES 12_ - - ```console - sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-sles-12.noarch.rpm - sudo zypper install puppet-bolt - ``` - -- _SLES 15_ - - ```console - sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-sles-15.noarch.rpm - sudo zypper install puppet-bolt - ``` - -### Upgrade Bolt - -To upgrade Bolt to the latest version, run the following command: - -```console -sudo zypper update puppet-bolt -``` - -### Uninstall Bolt - -To uninstall Bolt, run the following command: - -```console -sudo zypper remove puppet-bolt -``` - -## Install Bolt on Ubuntu - -### Install Bolt - -To install Bolt, run the appropriate command for the version of Ubuntu you -have installed: - -- _Ubuntu 18.04_ - - ```console - wget https://apt.puppet.com/puppet-tools-release-bionic.deb - sudo dpkg -i puppet-tools-release-bionic.deb - sudo apt-get update - sudo apt-get install puppet-bolt - ``` - -- _Ubuntu 20.04_ - - ```console - wget https://apt.puppet.com/puppet-tools-release-focal.deb - sudo dpkg -i puppet-tools-release-focal.deb - sudo apt-get update - sudo apt-get install puppet-bolt - ``` - -- _Ubuntu 22.04_ - - ```console - wget https://apt.puppet.com/puppet-tools-release-jammy.deb - sudo dpkg -i puppet-tools-release-jammy.deb - sudo apt-get update - sudo apt-get install puppet-bolt - ``` - -### Upgrade Bolt - -To upgrade Bolt to the latest version, run the following command: - -```console -sudo apt-get update -sudo apt install puppet-bolt -``` - -### Uninstall Bolt - -To uninstall Bolt, run the following command: - -```console -sudo apt remove puppet-bolt -``` +2. Search for **OpenBolt**, select it, and click **Uninstall**. -## Install Bolt as a gem +## Install OpenBolt as a gem -To install Bolt reliably and with all dependencies, use one of the Bolt +To install OpenBolt reliably and with all dependencies, use one of the OpenBolt installation packages instead of a gem. Gem installations do not include core -modules which are required for common Bolt actions. +modules which are required for common OpenBolt actions. -To install Bolt as a gem: +To install OpenBolt as a gem: ```console -gem install bolt +gem install openbolt ``` -## Install gems in Bolt's Ruby environment +## Install gems in OpenBolt's Ruby environment -Bolt packages include their own copy of Ruby. +OpenBolt packages include their own copy of Ruby. -When you install gems for use with Bolt, use the `--user-install` command-line +When you install gems for use with OpenBolt, use the `--user-install` command-line option to avoid requiring privileged access for installation. This option also enables sharing gem content with Puppet installations — such as when running `apply` on `localhost` — that use the same Ruby version. -To install a gem for use with Bolt, use the command appropriate to your +To install a gem for use with OpenBolt, use the command appropriate to your operating system: - On Windows with the default install location: