Skip to content

Commit

Permalink
(maint) Add notes about not installing bolt as a gem
Browse files Browse the repository at this point in the history
**What this changes** Add notes to readme and official docs recommending installing bolt as a package
**Why** Because users often install bolt as a gem and it doesn't work as they expect out of the box.
  • Loading branch information
lucywyman committed Sep 21, 2018
1 parent 60c8628 commit ee2fa6f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 33 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Additionally the Bolt project includes:
* [bolt-server](developer-documentation/bolt-server.md), an experimental HTTP API for executing tasks over SSH and WinRM.
* bolt-inventory-pdb, a command-line tool for generating an inventory file from a template containing PuppetDB queries.

> Installing bolt from a gem is not recommended since core modules will not be available. Please [install bolt](https://puppet.com/docs/bolt/latest/bolt_installing.md) as a package
## Supported platforms

* Linux, OSX, Windows
Expand Down
34 changes: 1 addition & 33 deletions pre-docs/bolt_installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,39 +170,7 @@ The Puppet repository for the YUM package management system is [http://yum.puppe

## Install Bolt as a gem

Install Ruby 2.3 or above and Bolt.

If Ruby is already included in your operating system, verify that it is version 2.3 or above. Run `ruby -v`.

1. To install the dependencies required to install Bolt, run the command that corresponds to your operating system.
- For Fedora 27

```
dnf install -y ruby rubygem-json rubygem-ffi rubygem-bigdecimal rubygem-io-console
```

- For Debian 9 or Ubuntu 16.04

```
apt-get install -y ruby ruby-ffi
```

- For Mac OS X 10.13 \(High Sierra\)

```
xcode-select --install
```

- For Windows, you can download Ruby from [https://rubyinstaller.org/](https://rubyinstaller.org/) or the Chocolatey Windows package manager. Run subsequent commands in a Windows PowerShell session.
2. To install Bolt, run `gem install bolt`
3. Run a Bolt command and get started.

```
bolt --help
```
4. Copy the contents of [bolt's Puppetfile](../Puppetfile) to `~/.puppetlabs/bolt/Puppetfile`
5. Run `bolt puppetfile install`
Installing bolt from a gem is not recommended since core modules will not be available.

## Analytics data collection

Expand Down

1 comment on commit ee2fa6f

@katelopresti
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated DITA source.

Please sign in to comment.