Skip to content

Latest commit

 

History

History
453 lines (304 loc) · 10.7 KB

bolt_installing.md

File metadata and controls

453 lines (304 loc) · 10.7 KB
Raw

Installing Bolt

Bolt automatically collects data about how you use it. If you want to opt out of providing this data, you can do so. For more information, see Opt out of data collection.

Packaged versions of Bolt are available for several Linux distributions, macOS, and Microsoft Windows.

Operating system Versions
Debian 9, 10, 11
Fedora 34
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

Note: Windows packages are automatically tested on the versions listed above, but might be installable on other versions.

Install Bolt on Debian

Install Bolt

To install Bolt, run the appropriate command for the version of Debian you have installed:

  • Debian 9

    wget https://apt.puppet.com/puppet-tools-release-stretch.deb
sudo dpkg -i puppet-tools-release-stretch.deb
sudo apt-get update
sudo apt-get install puppet-bolt

  • Debian 10

    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

    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:

sudo apt-get update
sudo apt install puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo apt remove puppet-bolt

Install Bolt on Fedora

Install Bolt

To install Bolt, run the appropriate command for the version of Fedora you have installed:

  • Fedora 34

    sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-34.noarch.rpm
sudo dnf install puppet-bolt

Upgrade Bolt

To upgrade Bolt to the latest version, run the following command:

sudo dnf upgrade puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo dnf remove puppet-bolt

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 installed.

  1. Tap the Puppet formula repository:

    brew tap puppetlabs/puppet

  2. Install Bolt:

    brew install --cask puppet-bolt

Upgrade Bolt

To upgrade Bolt to the latest version, run the following command:

brew upgrade --cask puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

brew uninstall --cask puppet-bolt

macOS installer (DMG)

Install Bolt

Use the Apple Disk Image (DMG) to install Bolt on macOS:

  1. Download the Bolt installer package for your macOS version.

  2. 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.
  2. From the General tab, click the lock icon to allow changes to your security settings and enter your macOS password.
  3. 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".
  4. 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:

sudo rm -rf /opt/puppetlabs/bolt /opt/puppetlabs/bin/bolt

Install Bolt on Microsoft Windows

Use one of the supported Windows installation methods to install Bolt.

Chocolatey

Install Bolt

To install Bolt with Chocolatey, you must have the Chocolatey package manager installed.

  1. Download and install the bolt package:

    choco install puppet-bolt

  2. Refresh the environment:

    refreshenv

  3. Install the PuppetBolt PowerShell module.

  4. Run a Bolt cmdlet. If you see an error message instead of the expected output, you might need to add the Bolt module to PowerShell or change execution policy restrictions.

Upgrade Bolt

To upgrade Bolt to the latest version, run the following command:

choco upgrade puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

choco uninstall puppet-bolt

Windows installer (MSI)

Install Bolt

Use the Windows installer (MSI) package to install Bolt on Windows:

  1. Download the Bolt installer package.

  2. Double-click the MSI file and run the installer.

  3. Install the PuppetBolt PowerShell module.

  4. Open a new PowerShell window and run a Bolt cmdlet. If you see an error message instead of the expected output, you might need to add the Bolt module to PowerShell or change execution policy restrictions.

Upgrade Bolt

To upgrade Bolt to the latest version, download the MSI again and repeat the installation steps.

Uninstall Bolt

You can uninstall Bolt from Windows Apps & Features:

  1. Press Windows + X + F to open Apps & Features.

  2. Search for Puppet Bolt, select it, and click Uninstall.

PuppetBolt PowerShell module

The PuppetBolt PowerShell module is available on the PowerShell Gallery and includes help documents and PowerShell cmdlets 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:

Install-Module PuppetBolt

Update PuppetBolt

To update the PuppetBolt PowerShell module, run the following command in PowerShell:

Update-Module PuppetBolt

Uninstall PuppetBolt

To uninstall the PuppetBolt PowerShell module, run the following command in 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

    sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-6.noarch.rpm
sudo yum install puppet-bolt

  • RHEL 7

    sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-7.noarch.rpm
sudo yum install puppet-bolt

  • RHEL 8

    sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-el-8.noarch.rpm
sudo yum install puppet-bolt

  • RHEL 9

    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:

sudo yum update puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

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

    sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-sles-12.noarch.rpm
sudo zypper install puppet-bolt

  • SLES 15

    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:

sudo zypper update puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

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

    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

    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

Upgrade Bolt

To upgrade Bolt to the latest version, run the following command:

sudo apt-get update
sudo apt install puppet-bolt

Uninstall Bolt

To uninstall Bolt, run the following command:

sudo apt remove puppet-bolt

Install Bolt as a gem

To install Bolt reliably and with all dependencies, use one of the Bolt installation packages instead of a gem. Gem installations do not include core modules which are required for common Bolt actions.

To install Bolt as a gem:

gem install bolt

Install gems in Bolt's Ruby environment

Bolt packages include their own copy of Ruby.

When you install gems for use with Bolt, 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 operating system:

  • On Windows with the default install location: 
    "C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <GEM>
  • On other platforms: 
    /opt/puppetlabs/bolt/bin/gem install --user-install <GEM>