shinken

Table of Contents

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

Overview

This puppet module installs Shinken, an open source monitoring framework.

Module Description

Shinken is a useful open source monitoring framework, and this module provides a simplified way of creating configurations to manage your infrastructure.

This module installs Shinken and helps you to configure it.

Setup

What shinken affects

• Configuration files and directories (created and written to)
• package/service/configuration files for Shinken
• Shinken modules

Setup Requirements

This module requires nothing extra before setting up.

Beginning with shinken

To install Shinken with the default parameters:

    class { 'shinken': }

The defaults are determined as below, and you can establish customized parameters.

    class { 'shinken':
      ensure      => present,
      user        => 'shinken',
      group       => 'shinken',
      modules     => [],
      conf_dir    => '/etc/shinken',
      modules_dir => '/etc/shinken/modules',
      daemons_dir => '/etc/shinken/daemons',
    }

Usage

This module modifies Shinken configuration files and directories and purges any configuration not managed by Puppet. Configuration of Shinken should be managed by Puppet, as non-Puppet configuration files can cause unexpected failures.

By default the webui is available:

• http://localhost:7767
• login: admin
• password: admin

Reference

Classes

• Public Classes

  • Class: shinken: Guides the basic setup of Shinken.

• Private Classes

  • Class: shinken::files: Guides the files setup of Shinken.
  • Class: shinken::install: Install Shinken package and Shinken modules.
  • Class: shinken::service: Manage the Shinken services.
  • Class: shinken::users: Manage the Shinken user/group.

• Private Defines

  • Define: shinken::file: Manage templated file.
  • Define: shinken::module: Manage Shinken module.
  • Define: shinken::undef_package: Install undefined package.

Public Classes

Class: shinken

The shinken module's primary class, shinken, guides the basic setup of Shinken on your system.

You can use hiera to set some parameters.

Parameters within shinken:

group

Changes the group that Shinken will answer requests as. The parent process will continue to be run as root, but resource accesses by child processes will be done under this group. This group is also the owner group of the shinken items. Default: shinken

user

Changes the user that Shinken will answer requests as. The parent process will continue to be run as root, but resource accesses by child processes will be done under this user. This user is also the owner of the shinken items. Default: shinken

modules

is an array of shinken modules (See the official list.).

Private Classes

Class: shinken::files

Class: shinken::install

Class: shinken::service

Class: shinken::users

Private Defines

Define: shinken::file

Define: shinken::module

Define: shinken::undef_package

Limitations

This module is CI tested on Centos 5 & 6, Ubuntu 12.04 & 14.04, Debian 6 & 7, and RHEL 6 & 7 platforms against the OSS version of Puppet.

Development

oloc modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. Do not hesitate to contribute by pull requests.

Changelog

This is a manually kept file, and may not entirely reflect reality

v0.1.2 - Alpha Yellow

Features

• Install Shinken.
• Install modules, especially webui.
• Uninstall improvement.
• Travis CI testing - Validate, Lint, Syntax, Template, spec.

v0.1.1 - Alpha Red

Features

• Install Shinken.
• Travis CI testing - Validate, Lint, Syntax, Template, spec.

v0.1.0 - Alpha

Features

• Install Shinken.