Merge pull request #68 from suckatrash/toml-rb_gem

document toml-rb gem requirement

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## 2019-7-11 - Release - 2.0.1
+
+### Bugfixes
+ - Document a requirement on the toml-rb rem
+
 ## 2019-7-11 - Release - 2.0.0
 
 ### Changes

README.md

@@ -4,6 +4,7 @@
 - [Setup](#Setup)
   - [Upgrade notes, breaking changes in v2](#Upgrade-notes-breaking-changes-in-v2)
   - [Determining where Telegraf runs](#Determining-where-Telegraf-runs)
+  - [Requirements](#requirements)
   - [Beginning with puppet_metrics_dashboard](#Beginning-with-puppet_metrics_dashboard)
     - [Minimal configuration](#Minimal-configuration)
 - [Usage](#Usage)
@@ -44,6 +45,8 @@ You have the option of collecting metrics using any or all of these methods:
 
 ### Upgrade notes, breaking changes in v2
 
+Version 2 and up now requires the toml-rb gem installed on the master
+
 The `puppet_metrics_dashboard::profile::postgres` class is now deprecated and you should use the `puppet_metrics_dashboard::profile::Master::postgres_access` class instead.
 
 Parameters `telegraf_agent_interval` and `http_response_timeout` were previously integers but are now strings.  The value should match a time interval, such as `5s`, `10m`, or `1h`.
@@ -63,6 +66,18 @@ Grafana runs on, use the `puppet_metrics_dashboard` class and the parameters: `m
 
 To configure Telegraf to run on each Puppet infrastructure node, use the corresponding profiles for those hosts.  See [Profile defined types](#profile-defined-types).  The `puppet_metrics_dashboard` class is still applied to a separate host to setup Grafana and InfluxDB and the profile classes configure Telegraf when applied to your Puppet infrastructure hosts.
 
+### Requirements
+
+This module **requires** the [toml-rb](https://github.com/eMancu/toml-rb) gem.  You can install the gem using puppet's native gem provider, [puppetserver_gem](https://forge.puppetlabs.com/puppetlabs/puppetserver_gem), [pe_gem](https://forge.puppetlabs.com/puppetlabs/pe_gem), [pe_puppetserver_gem](https://forge.puppetlabs.com/puppetlabs/pe_puppetserver_gem), or manually using one of the following methods:
+```
+  # apply on puppet-master
+  gem install toml-rb
+  # PE apply
+  /opt/puppetlabs/puppet/bin/gem install toml-rb
+  # AIO or PE puppetserver
+  /opt/puppet/bin/puppetserver gem install toml-rb
+```
+
 ### Beginning with puppet_metrics_dashboard
 
 #### Minimal configuration

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "puppetlabs-puppet_metrics_dashboard",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "author": "puppetlabs",
   "summary": "A module for managing the installation and configuration of metrics dashboards for Puppet Infrastructure.",
   "license": "Apache-2.0",