Forge Home

shinken

This puppet module installs Shinken, an open source monitoring framework. Some basic Shinken modules are installed. Webui available

8,760 downloads

8,047 latest version

4.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.2 (latest)
  • 0.1.1
  • 0.1.0
released Nov 5th 2015
This version is compatible with:
  • , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'oloc-shinken', '0.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add oloc-shinken
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install oloc-shinken --version 0.1.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

oloc/shinken — version 0.1.2 Nov 5th 2015

Build Status

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
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  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

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.