modolabs / puppet-chronograf

A module for managing and configuring InfluxDBs Chronograf service

puppet-chronograf

Table of Contents

1. Description
2. Setup - The basics of getting started with puppet-chronograf
   • What chronograf affects
   • Setup requirements
   • Beginning with chronograf
3. Usage - Configuration options and additional functionality
4. Reference
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

This module is intended as a means to configure and manage InfluxDB's Chronograf service. It is currently only tested to work on CentOS 7.

At the time of inital writing of this module, Chronograf was young and there were not existing puppet modules for it on the Forge, so I started writing this.

Setup

What chronograf affects

This module will likely touch the other aspects of the TICK stack (Telegraf, InfluxDB, and Kapacitor). While not strictly necessary to hook those up using the avaliable parameters, the main functionality is pretty much gone otherwise.

Note that InfluxDB and Kapacitor configurations can be setup directly through the app, rather than through this module. Setting them up through the module may make them immutable in the Chronograf UI.

A couple other things to note:

• The influxdb yum repo will be added so that packages can be grabbed from the appropriate source.
• Only Chronograf is installed via this module

Setup Requirements

If you would like authentication set up, you must provide a token_secret, and addition to the required keys.

Beginning with chronograf

include chronograf

Usage

The class parameters line-up almost perfectly with the options shown in the Chronograf documentation

To set up with authentication, see the Chronograf document regarding security, and apply the appropriate parameters when setting up the class.

The only class you need to include is the main class! Everything else is just a private class used by init.pp

Limitations

This module was developed for usage with RHEL/CentOS. It currently is only set to be compatible with those operating systems.

While the actual Chronograf configuration can support up quite a few Authentication methods, the only ones currently supported by this module are Github and Google. The rest will be added at a later point.

Release Notes/Contributors/Etc.

See CHANGELOG.md for the changelog.

puppet-chronograf's Issues

Bolt_path not actually being used due to issues with implementation

Trying to manually set the bolt_path led to some issues with chronograf and it not being able to start. I've commented out the section where it would be used for now, but this should be revisited at some point.

Write RSpec Test Suite for module

May be closed later and reopened as several separate tickets.

Support alternative means of authentication

Currently, the only authentication means supported in this module are Heroku, Github, and Google. According to the Chronograf documentation, it supports Generic OAuth2 and Auth0.