Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 3.33 KB

README.markdown

File metadata and controls

96 lines (60 loc) · 3.33 KB
Raw

RRD

This is a Puppet Module for installing and configuring the Round Robin Database tools, cache, and bindings.

Build Status

Purpose

Why should there be a Puppet module for installing something as simple as RRD?

This module is mostly to cover dependencies when creating Puppet Modules for other tools or application that use RRD (e.g. Ganglia, Nagios, Cacti, etc). RRD is an application in it's own right and should be described independently.

The objective with this module is to provide a safe and consistently managed installation of RRD that can be depended on by other services and applications.

Dependencies

No dependencies on other Puppet Modules

Usage

Install RRD libraries

To only install the RRD libraries:

include rrd

Note: as the libraries are dependencies for the other RRD packages (rrdtool and rrdcached) the rrd class is not required by the other classes. It is simply for a lightweight RRD install.

Install the RRD tools

To install the RRD tools (a.k.a. rrdtool):

include rrd::tool

Default install the RRD cache daemon

For the default install of the RRD cache daemon (a.k.a. rrdcached):

include rrd::cache

Customised install of the RRD cache daemon

The rrd::cache class has the following parameters:

  • service: The enable parameter for the rrdcached service. Default is 'running'.
  • gid: the group ID that the rrdcached runs under. Default is undefined, which uses system default.
  • listen: the Unix socket that rrcached listens on. Defaults to 'unix:/var/run/rrdcached.sock'
  • journal_dir: The path where rrcached stores the cache journal. Defaults to '/var/lib/rrdcached/journal/'
  • timeout: Default is '1800'.
  • delay: Default is '1800'
  • write_threads: Default is '4'
  • jump_dir: Default is '/var/lib/rrdcached/db/'
  • always_flush: Default is true
  • enable_corefiles: Default is false
  • restrict_writes: Default is false
  • maxwait: Default is '30'
  • conf_file: The path to the rrdcached configuration file. Default is set approprately for operating system family.
  • service_name: The name of the rrdcached service. Default is set approprately for operating system family.

Install RRD language bindings

The module will install the RRD language bindings for Perl, PHP, Python, Ruby, and tcl. Install them in the following form, just replace the language name as appropriate:

include rrd::bindings::perl

References

This module uses the following modules for inspiration and reused code:

Attribution

This module is derived from the puppet-blank module by Aaron Hicks ([email protected])

This module has been developed for the use with Open Source Puppet (Apache 2.0 license) for automating server & service deployment.

Licensing

This file is part of the rrd Puppet module.

Licensed under the Apache License, Version 2.0