puppet-herald gem

Overview

Herald is a puppet report processor. He provides a gateway for consuming puppet reports, a REST API and a simple Web app to display reports.

Puppet module

There is/will be a puppet module that handle installation and configuration of Herald and prerequisites. Check that out: https://github.com/wavesoftware/puppet-herald

Prerequisites

  • libpq-dev

On Ubuntu/Debian system install them with:

sudo apt-get install libpq-dev

Installation

Install Herald and all dependencies from http://rubygems.org:

sudo gem install puppet-herald

Configuration

If you like to use PostgreSQL database to hold reports, you will need to configure it. By default, Herald will use a sqlite file that he tries to create in your home directory. Check out puppet-herald --help for description.

Create a database

Just create a database for Herald (this is just a sample):

CREATE ROLE pherald LOGIN PASSWORD '<YOUR PASSWORD>' NOSUPERUSER INHERIT NOCREATEDB NOCREATEROLE NOREPLICATION;
CREATE DATABASE "pherald" WITH OWNER = pherald
  ENCODING = 'UTF8'
  TABLESPACE = pg_default;

Usage

$ puppet-herald --help

Example of running a server with using sqlite and binding to other host and port:

puppet-herald --dbconn sqlite:///var/lib/puppet/reports/pherald.db --bind master.cluster.vm --port 8081

Contributing

Contributions are welcome!

To contribute, follow the standard git flow of:

  1. Fork it
  2. Create your feature branch (git checkout -b feature/my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/my-new-feature)
  5. Create new Pull Request

Even if you can't contribute code, if you have an idea for an improvement please open an issue.