craigwatson / puppet-nixstats

Puppet module to manage NIXStats installation

puppet-nixstats

Table of Contents

1. Overview - What is the puppet-nixstats module?
2. Module Description - What does the module do?
3. Setup - The basics of getting started with puppet-nixstats
   • What puppet-nixstats affects
   • Setup requirements
   • Beginning with puppet-nixstats
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

This module manages the installation and configuration of the NIXStats server monitoring agent, which currently in BETA.

Puppet 3 Support

Please note that the master branch of this module does not support Puppet 3!

On 31st December 2016, support for Puppet 3.x was withdrawn. As such, this module no longer supports Puppet 3, and is actively being migrated to Puppet 4 syntax.

If you require Puppet 3 compatibility, please use version 1.0.4 from the Puppet Forge, or the puppet3 branch in Git.

Module Description

A rough Puppetisation of the install scripts available via nixstats.com, this module creates the directory structure, and all necessary files for the NIXStats agent to run.

Usage

The simplest way to use the module is to pass your user ID to the module. The module will then configure the directories and packages necessary to run the NIXstats agent.

Your user ID is a hexadecimal string displayed at the end of the command you are given to manually install the agent.

class { 'nixstats':
  user_id => '343249dab923d2389e9a1b',
}

To stop the module from installing any supporting packages (e.g. curl), just set the manage_packages parameter to false.

Reference

Classes

nixstats::cleanup

• Cleans up the old version of the install script

nixstats::config

• Creates the directory structure and deploys the user/server IDs

nixstats::user

• Creates a system user and group for the agent to run as.

nixstats::install

• Installs supporting system packages, followed by the nixstatsagent package via pip

nixstats::params

• O/S-specific and module configuration (e.g. paths to binaries and a boolean variable to control file deployment)

Limitations

Supported Operating Systems

• Ubuntu/Debian
• CentOS/RedHat (untested)
• Arch Linux (untested)

Development

• Copyright (C) 2013 to 2015 Craig Watson - [e-mail]
• Distributed under the terms of the Apache License v2.0 - see LICENSE file for details.
• Further contributions and testing reports are extremely welcome - please submit a pull request or issue on GitHub