Puppet module: foo

# Written by Lab42 #
# http://www.Example42.com

Licence: Apache2

DESCRIPTION:
This module installs and manages foo.
It's based on Example42's module structure and features standard and
extended classes for automatic monitoring, backup and firewalling.

All the variables used in this module are defined in the foo::params class
(File: $MODULEPATH/foo/manifests/params.pp). Here you can:
- Set default settings and filtering module's specific Users variables
- Add selectors for internal variables to adapt the module to different OSes
- Review and eventually change default settings for variables that affect the
  Example42 extended classes.

Customizations for different projects and logic on how to populate configuration
files should be placed in the $my_project classes.


MODULE'S SPECIFIC USER VARIABLES:


USAGE:
# Standard Classes 
include foo              # Install and run foo 

include foo::disable     # Disable foo service.
include foo::disableboot # Disable foo service at boot time, but don't stop if is running.
include foo::absent      # Remove foo package.
include foo::debug       # Used for debugging purposes (not resource hungry)
                         # Automatically included if $debug=yes
                         # Requires Example42's puppet::params and puppet::debug

# Extended Classes
include foo::puppi       # Puppi extensions for the foo module
                         # Requires Example42's puppi module
include foo::monitor     # Monitor foo
                         # Automatically included if $monitor=yes
                         # Requires Example42's monitor module
include foo::backup      # Backup foo data
                         # Automatically included if $backup=yes
                         # Requires Example42's backup module
include foo::firewall    # Manages firewall rules for foo service
                         # Automatically included if $firewall=yes
                         # Requires Example42's firewall module

# Generic define to set parameters in the main configuration file. EXPERIMENTAL.
foo::conf { "ParameterName": value="YourValue"} # Generic 

# Module specific classes

# Module specific defines


EXAMPLE42 GENERAL VARIABLES:
Example42 modules collection uses some general variables that can influence the
behaviour of this module. You can happily live without considering or setting them,
but they can be useful to get many useful features out of the box.
$my_project - If set, permits you to alter and customize the module behaviour
  and files's deploy logic in custom project classes
  The custom class foo::$my_module autoloads from MODULEPATH/foo/manifests/$my_project.pp
  but you can place it in a separated module by explicitely importing it:
  "import $my_project" to have something like MODULEPATH/$my_project/manifests/foo.pp
$base_source - Lets you define an alternative source for static files:
  - $base_source not set -> Files are looked in puppet://$servername/ (the PuppetMaster)
  - $base_source set -> Files are in $base_source ( Ex: puppet://$servername/$my_module ) 
  Note that the module automatically manages the different paths for Puppet pre 0.25
$debug - If set to yes writes in /var/lib/puppet/debug/ useful debugging info

VARIABLES FOR EXTENDED MODULES:
$puppi - Set to "yes" to enable foo plugins for puppi
Check foo/manifests/puppi.pp for more info.

$monitor - Set to "yes" to enable auto monitoring classes 
$monitor_tool - Defines the monitor tools to activate (At leat one, can be an array)
Check foo/manifests/monitor.pp for more info on foo monitoring related variables.

$backup - Set to "yes" to enable auto backuping classes 
$backup_tool - Defines the backup tools to activate (At leat one, can be an array)
Check foo/manifests/backup.pp for more info on foo backuping related variables.

$firewall - Set to "yes" to enable auto firewalling classes
$firewall_tool - Defines the firewall tools to activate
Check foo/manifests/firewall.pp for more info on foo firewalling related variables.


DEPENDENCIES:
Standard classes generally don't need external modules.
Extended classes need the relevant external modules.
foo::conf generic infile configuration define needs the Example42 "common" module


OPERATING SYSTEMS SUPPORT (Planned, Development, Testing, Production):
RedHat/Centos 5 : Testing
RedHat/Centos 6 : Testing
Debian 5        : Testing
Debian 6        : Planned
Ubuntu 8.04     : Testing
Ubuntu 10.04    : Testing
SLES 10         : Planned
SLES 11         : Testing