Foreman

h1. Puppet Reports integration 

*Note* You need Foreman 0.1-1 or newer to support Puppet Reports.

h2. Overview

Foreman uses a custom puppet reports (similar to tagmail or store) which simply upload the puppet report to Foreman.

This enables you to see the reports through the web interface as soon as the client finish its run.

h2. Configuration

h3. client

Ensure that the puppet clients has the following option in their puppet.conf:

<pre>

report = true

</pre>

Without it, no reports will be sent.

h3. puppetmaster

# copy *extras/puppet/foreman/files/foreman-report.rb* to your report directory - e.g. /usr/lib/ruby/1.8/puppet/reports/foreman.rb

# open the new file with your favorite editor

# edit the URL (unless you have a DNS alias for foreman already) to point to foreman.

# add this report in your puppetmaster reports - e.g, in your master puppet.conf under the puppetmaster section add:

<pre>reports=log, foreman</pre>

and restart your puppetmaster

You should start seeing reports coming in under the reports link.

h2. Expire Reports automatically

You would probably want to delete your reports after some time, in order to do so, you would need to set a cronjob:

Available conditions:

* days => number of days to keep reports (defaults to 7)

* status => status of the report (defaults to 0 --> "reports with no errors")

Example:

# Expires all reports regardless of their status

<pre>

rake reports:expire days=7 RAILS_ENV="production"

</pre> 

# expires all non interesting reports after one day

<pre>

rake reports:expire days=1 status=0 RAILS_ENV="production"

</pre> 

h2. Todo:

# Associate Users with Hosts, this will allow to send notifications (e.g. email) to the right users

# -Send out a summary of all of yours hosts status per day- done see [[Summarized E-Mail Reports]]