pound

#pound

####Table of Contents

1. Module Description - What the module does and why it is useful
2. Setup - The basics of getting started with pound
   • What pound affects
   • Setup requirements
   • Beginning with pound
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
7. Todo
8. Thanks

##Module Description

Installs, configures and starts Pound.

##Setup

###What pound affects

• pound package
• pound configuration file
• pound service

###Beginning with pound

include '::pound' is enough to get you up and running. Or:

class { '::pound':
}

##Usage

All interaction with the pound module can do be done through the main pound class. This means you can simply toggle the options in the pound class to get at the full functionality.

###I just want Pound, what's the minimum I need?

include '::pound'

###I'd like to opt out of having the service controlled, we use another tool for that.

class { '::pound':
  manage_service => false,
}

###Looks great! But I'd like a different template, we need to do something unique here.

class { '::pound':
  manage_service  => false,
  config_template => 'different/module/custom.template.erb',
}

##Reference

###Classes

• pound: Main class, includes all the rest.
• pound::install: Handles the packages.
• pound::config: Handles the configuration file.
• pound::service: Handles the service.

###Parameters

The following parameters are available in the pound module

####config

This sets the file to write pound configuration into.

####config_template

This determines which template puppet should use for the pound configuration.

####package_ensure

This can be set to 'present' or 'latest' or a specific version to choose the pound package to be installed.

####package_name

This determines the name of the package to install.

####service_enable

This determines if the service should be enabled at boot.

####service_ensure

This determines if the service should be running or not.

####service_manage

This selects if puppet should manage the service in the first place.

####service_name

This selects the name of the pound service for puppet to manage.

####pound_user

Set what user to run the pound service as.

####pound_group

Set what group to run the pound service as.

####listen_http_address

Set what address to listen for http on.

####listen_http_port

Set what port to listen for http on.

####backend_servers

A hash of IP or servername and the port.

####log_level

Set what level of logging pound should do.

##Limitations

Currently there is no testing of the module.

The module has only been tested on:

• CentOS 6
• Ubuntu 12.04

Release notes

• 0.1.2 - Changed from backend_ports and backed_addresses to a hash in the variable backend_servers, and the pound.cfg template will loop through them

##TODO

• Testing should be brought in
• Support more operating systems
• Add ssl support

##Development

Please lodge issues and send pull requests to the github repository.

##Thanks

This module was based on the Puppetlabs NTP module.