Skip to content

Latest commit

 

History

History
443 lines (345 loc) · 14.5 KB

bolt_installing.md

File metadata and controls

443 lines (345 loc) · 14.5 KB

Installing Bolt

Packaged versions of Bolt are available for many modern Linux distributions, as well as macOS and Windows.

What about Puppet? You don't need to install Puppet to use Bolt. If you have Puppet installed on your machine, Bolt uses its internal version of Puppet and does not conflict with the Puppet version you have installed.

Note: 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 Analytics data collection

Have questions? Get in touch. We're in #bolt on the Puppet community Slack.

Installing Bolt on Windows

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

Install Bolt with Windows Installer (MSI) 

Use the MSI installer package to install Bolt on Windows:

  1. Download the Bolt installer package.
  2. Double-click the MSI file and run the installer.
  3. Open PowerShell and run a Bolt command. 
    bolt --help

If you see an error message instead of the expected output, you probably need to follow one or both of the additional steps below. See Add the Bolt module to PowerShell and Change execution policy restrictions.

Upgrading Bolt with the MSI

If you installed Bolt using the MSI, download the MSI again and repeat the installation steps to install the latest version.

Uninstalling Bolt with the MSI

If you installed Bolt using the MSI, you can uninstall it from Windows Apps & Features:

  1. Press Windows+X, F to open Apps & Features.
  2. Search for Puppet Bolt, select it, and click Uninstall.

Install Bolt with Chocolatey

You must have the Chocolatey package manager installed.

  1. Download and install the bolt package: 
    choco install puppet-bolt
  2. Run a Bolt command and get started: 
    bolt --help

If you see an error message instead of the expected output, you probably need to follow one or both of the additional steps below. See Add the Bolt module to PowerShell and Change execution policy restrictions.

Upgrading Bolt with Chocolatey

Use the following command to upgrade Bolt:

choco upgrade puppet-bolt

Uninstalling Bolt with Chocolatey

Use the following command to uninstall Bolt:

choco uninstall puppet-bolt

Add the Bolt module to PowerShell

PowerShell versions 2.0 and 3.0 cannot automatically discover and load the Bolt module, so you'll need to add it manually. Unless your system dates from 2013 or earlier, this situation probably does not apply to you. To confirm your version run $PSVersionTable in PowerShell.

To allow PowerShell to load Bolt, add the correct module to your PowerShell profile.

  1. Update your PowerShell profile. 
    'Import-Module -Name ${Env:ProgramFiles}\WindowsPowerShell\Modules\PuppetBolt' | Out-File -Append $PROFILE
  2. Load the module in your current PowerShell window. 
    . $PROFILE

Change execution policy restrictions

Some Windows installations have security restrictions that do not allow Bolt to run. These restrictions are easy to change, but check with your security team first.

If you see this or a similar error when trying to run Bolt, you probably need to change your script execution policy restrictions, as described here.

bolt : The 'bolt' command was found in the module 'PuppetBolt', but the module could not be loaded. 
For more information, run 'Import-Module PuppetBolt'.
                At line:1 char:1
                + bolt --help
                + ~~~~
                + CategoryInfo          : ObjectNotFound: (bolt:String) [], CommandNotFoundExceptio
                n
                + FullyQualifiedErrorId : CouldNotAutoloadMatchingModule
  1. Press Windows+X, A to run PowerShell as an administrator.
  2. Set your script execution policy to at least RemoteSigned: 
    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
    For more information about PowerShell execution policies, see Microsoft's documentation about execution policies and how to set them.

Installing Bolt on macOS

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

Install Bolt with Homebrew

You must have the command line tools for macOS and the Homebrew package manager installed.

Download and install the Bolt package:

brew cask install puppetlabs/puppet/puppet-bolt

Upgrading Bolt with Homebrew

To upgrade Bolt, use the following command:

brew cask upgrade puppet-bolt

Uninstalling Bolt with Homebrew

To uninstall Bolt with homebrew, use the following command:

brew cask uninstall puppet-bolt

Install Bolt with macOS installer 

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

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

    🔩 Tip To find the macOS version number on your Mac, go to the Apple () menu in the corner of your screen and choose About This Mac.

  2. Double-click the puppet-bolt-latest.dmg file to mount it and then double-click puppet-bolt-[version]-installer.pkg to run the installer.

  3. Open Terminal and run a Bolt command and get started.

    bolt --help

Note: If you get a "Command not found error" when you try to run Bolt, make sure you've added the opt/puppetlabs/bin PATH to ~/.bashrc or the relevant profile for the shell you're using.

Upgrading Bolt with macOS installer

If you installed Bolt using the macOS installer, download the DMG again and repeat the installation steps to install the latest version.

Installing Bolt on *nix

Use one of the supported *nix installation methods to install Bolt.

CAUTION: These instructions include enabling the Puppet Tools repository. While Bolt can also be installed from the Puppet 6 or 5 platform repositories, adding these repositories to a Puppet-managed target, especially a Puppet server, might result in an unsupported version of a package like puppet-agent being installed. This can cause downtime, especially on a Puppet server.

Install Bolt on Debian or Ubuntu

Packaged versions of Bolt are available for Debian 8-10 and Ubuntu 16.04 and 18.04.

The Puppet Tools repository for the APT package management system is https://apt.puppet.com. Packages are named using the convention puppet-tools-release-<VERSION CODE NAME>.deb. For example, the release package for Puppet Tools on Debian 8 “Jessie” is puppet-tools-release-jessie.deb.

  1. Download and install the software and its dependencies. Use the commands appropriate to your system:

    • Debian 8

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

    • 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

    • Ubuntu 16.04

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

    • 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

  2. Run a Bolt command and get started.

    bolt --help

Upgrading Bolt on Debian and Ubuntu

To upgrade Bolt on Debian and Ubuntu, use the following commands:

sudo apt-get update
sudo apt install puppet-bolt

Uninstalling Bolt on Debian and Ubuntu

To uninstall Bolt on Debian and Ubuntu, use the following command:

sudo apt remove puppet-bolt

Install Bolt on RHEL, SLES, or Fedora

Packaged versions of Bolt are available for Red Hat Enterprise Linux 6 and 7, SUSE Linux Enterprise Server 12, and Fedora 28-32.

The Puppet Tools repository for the YUM package management system is http://yum.puppet.com/puppet-tools/. Packages are named using the convention puppet-tools-release-<OS ABBREVIATION>-<OS VERSION>.noarch.rpm. For example, the release package for Puppet Tools on Linux 7 is puppet-tools-release-el-7.noarch.rpm.

  1. Download and install the software and its dependencies. Use the commands appropriate to your system.
    • 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
    • SUSE Linux Enterprise Server 12 
      sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-sles-12.noarch.rpm
sudo zypper install puppet-bolt
    • Fedora 30 
      sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-30.noarch.rpm
sudo dnf install puppet-bolt
    • Fedora 31 
      sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-31.noarch.rpm
sudo dnf install puppet-bolt
    • Fedora 32 
      sudo rpm -Uvh https://yum.puppet.com/puppet-tools-release-fedora-32.noarch.rpm
sudo dnf install puppet-bolt
  2. Run a Bolt command and get started. 
    bolt --help

Upgrading Bolt on RHEL, SLES, or Fedora

To upgrade Bolt on RHEL, use the following command:

sudo yum install puppet-bolt

To upgrade Bolt on SUSE Linux Enterprise Server 12, use the following command:

sudo zypper update puppet-bolt

To upgrade Bolt on Fedora, use the following command:

sudo dnf upgrade puppet-bolt

Uninstalling Bolt on RHEL, SLES, or Fedora

To uninstall Bolt on RHEL use the following command:

sudo yum remove puppet-bolt

To uninstall Bolt on SUSE Linux Enterprise Server 12, use the following command:

sudo zypper remove puppet-bolt

To uninstall Bolt on Fedora use the following command:

sudo dnf remove puppet-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>

Install Bolt as a gem

To install Bolt reliably and with all dependencies, use one of the Bolt installation packages instead of a gem.

Starting with Bolt 0.20.0, gem installations no longer include core task modules.

Analytics data collection

Bolt collects data about how you use it. You can opt out of providing this data.

What data does Bolt collect?

  • Version of Bolt
  • The Bolt command executed (for example, bolt task run or bolt plan show), excluding arguments
  • The functions called from a plan, excluding arguments
  • User locale
  • Operating system and version
  • Transports used (SSH, WinRM, PCP) and number of targets
  • The number of targets and groups defined in the Bolt inventory file
  • The number of targets targeted with a Bolt command
  • The output format selected (human-readable, JSON)
  • Whether the Bolt project directory was determined from the location of a bolt-project.yaml file or with the --project command-line option
  • The number of times Bolt tasks and plans are run (not including user-defined tasks or plans.)
  • The number of statements in a manifest block, and how many resources that produces for each target
  • The number of steps in a YAML plan
  • The return type (expression vs. value) of a YAML plan
  • Which bundled plugins Bolt is using (not including user-installed plugins)

This data is associated with a random, non-identifiable user UUID.

To see the data Bolt collects, add --log-level trace to a command.

Why does Bolt collect data?

Bolt collects data to help us understand how it's being used and make decisions about how to improve it.

How can I opt out of Bolt data collection?

To disable the collection of analytics data add the following line to ~/.puppetlabs/etc/bolt/analytics.yaml:

disabled: true