Installation

There are two methods for installation: 1) From the non-existent tarball/installation script I intend to create, or 2) From source using git clone

Prerequisites:

1. Puppet infrastructure
2. Puppet master file bucket
3. MySQL server
4. HTTP server
5. On the server: PHP, PHP-CLI, PHP Pear, Pear Mail

Method 1: Installing from Tarball download
<to be="" added="" later=""></to>

Method 2: Installing from source using git clone

a. Clone the source - git clone git://git.code.sf.net/p/puppetreports/code puppetreports-code

This will provide two folders, web and puppet. We'll configure the web portion first.

b. Move the contents of web/ to your web server document root
c.* Create the database

 - mysqladmin create PuppetReports
 - mysql PuppetReports < puppetReports.sql

d. Configure document root/content/config.php

A few recommendations:

• You should create users in the MySQL database specifically for this access. The web GUI requires read-only access at the moment. The reporting script requires read/write access.
• You should put the web site on an https connection
• You should firewall protect the site to disallow external access. Authentication is not currently built in, though this may be added in the future.

Now to configure puppet.

This is mostly left up to you since everyone's environments are different. If you require help, post in the forums and I can provide further instruction.

The puppet directory contains a facts directory, a modules directory, and a site.pp. The facts directory has the file envreport.rb. If you have multiple environments configured and it's important to see this in the web interface, I recommend pushing this fact out.

The site.pp contains the minimum configuration required to get this reporting system working on clients. This needs to be merged with your site.pp.

The modules directory contains the module that needs to be added to your own modules directory.

Additional Configuration Items

In puppet/modules/PuppetReporting/files/alertcron.php:

• Line number 9, this needs to be modified to reflect your document root.
• Line number 77, this needs to be modified to reflect the location of the Puppet Reports scripts

In web/content/scripts:

• This files need to be moved to the location identified in line 77 of the previous configuration

I promise I'll make this easier eventually.

One last configuration note
Jobs/Alerts need to be managed manually right now and the concept isn't fully implemented. So, any alert you want to add will need to be done via an external script and updates to the database information needs to be done manually in table "alerts". Note that some jobs are configured by default, and you'll need to update the email address.

mysql> update alerts set emailTo="UserOrGroup@mydomain.loc";

Again, I'll make this easier eventually.