Puppet is IT automation software that enables system administrators to manage provisioning and configuration of their infrastructure. LogicMonitor’s Puppet module allows your Puppet infrastructure code to manage your LogicMonitor account as well.
- This module is only compatible with linux servers. Windows compatibility may be added in future releases.
LogicMonitor’s Puppet module defines 5 classes and 4 custom resource types:
- logicmonitor: Handles setting the credentials needed to interact with the LogicMonitor API
- logicmonitor::config: Provides the default credentials to the logicmonitor class
- logicmonitor::master: Collects the exported lm_host resources and lm_hostgroup resources. Communicates with the LogicMonitor API
- logicmonitor::collector: Handles LogicMonitor collector management for the device. Declares an instances of lm_collector and lm_installer resources
- logicmonitor:host: Declares an exported lm_host resource
- lm_hostgroup: Defines the behavior of the handling of LogicMonitor device groups. We recommend using exported resources
- lm_host: Defines the handling behavior of LogicMonitor devices. Used only within the logicmonitor::host class
- lm_collector: Defines the handling behavior of LogicMonitor collectors. Used only with the logicmonitor::collector class
- lm_installer: Defines the handling behavior of LogicMonitor collector binary installers. Used only within the logicmonitor::collector class
In order to use LogicMonitor’s Puppet Module, you’ll need to make sure you have the following:
- Ruby 1.8.7 or 1.9.3
- Puppet 3.X
- JSON Ruby gem (included by default in Ruby 1.9.3)
- Store Configs in Puppet
Store configs are required for the exported resources used by this module. To enable store configs, add storeconfigs = true to the [master] section of your puppet.conf file, like so:
Once enabled, Puppet will need a database to store the config info. Puppet recommends PuppetDB, although other database solutions are available.
4. Device Configuration
As with your other LogicMonitor devices, the collector will need to communicate with the device in order to gather data. Make sure the correct properties and authentication protocols are configured as part of the Puppet installation.
Installing the LogicMonitor Puppet Module
You can install LogicMonitor’s original Puppet Module via GitHub:
Once you’ve installed LogicMonitor’s Puppet Module, you can get started using the following sections:
Create a new user for Puppet
We recommend you create a new user with administrator privileges in your Logic Monitor account that you will use exclusively within your Puppet nodes to track changes made by Puppet in the audit log.
- Class: logicmonitor (modules/logicmonitor/manifests/init.pp)
This is the top level class for the LogicMonitor module. It’s purpose is to set the LogicMonitor credentials to be used by all the child classes. Explicit declaration of this class will override the default credentials set in the logicmonitor::config class. This class does not need to be explicitly declared.
- Class: logicmonitor::config (modules/logicmonitor/manifests/config.pp)
This class is used to set the default LogicMonitor account credentials for your Puppet environment. This class does not need to be explicitly declared.
- Class: logicmonitor::master (modules/logicmonitor/manifests/master.pp)
The master class enables communication between the LogicMonitor module and your LogicMonitor account for group and device management. This class acts as the collector for the lm_host and lm_hostgroup exported resources. This prevents conflicts and provides a single point of contact for communicating with the LogicMonitor API. This class must be explicitly declared on a single device. NOTE: All devices with the logicmonitor::collector and logicmonitor::master classes will need to be able to make outgoing http(s) requests.
- Class: logicmonitor::collector (modules/logicmonitor/manifests/collector.pp)
This class manages the creation, download and installation of a LogicMonitor collector on the specified node.
- The only absolute requirement for a collector node is that is is Linux and can make an outgoing SSL connection over port 443
- We suggest the collector system have at least 1G of RAM
- If the collector will be collecting data for more than 100 hosts, it is a good idea to dedicate a machine to it
To add collector to a node:
If you want to specify a specific location where you’d like to install a collector:
Class: logicmonitor::host (modules/logicmonitor/manifests/host.pp)
This class is used to add devices to your LogicMonitor account. Devices which are managed through Puppet will have any properties not specified in the device definition removed.
Adding a Device Group:
Type: Lm_hostgroup Device groups should be added using an exported resource to prevent conflits. It is recommend device groups are added from the same node where the logicmonitor::master class is included. Devices can be included in zero, one, or many device groups. Device groups are used to organize how your LogicMonitor Devices are displayed and managed and do not require a collector . Properties set at the device group level will be inherited by any devices added to the group.
To add and edit properties of device groups use lm_hostgroup, example below.
For more examples of the module in action, check out logicmonitor-puppet/README.md.