ucarp

####Table of Contents

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with ucarp
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

##Overview

The ucarp module provides the installation procedure for UCARP including the setup of the virtual IP.

##Module Description

The UCARP module provides a virtual IP that can be used in a cluster.

##Setup

###What ucarp affects

ucarp package.
ucarp configuration file.
ucarp alternative service configuration.

###Beginning with ucarp

include '::ucarp' is enough to get you up and running if the parameters point to proper values. If you wish to pass in parameters like which servers to use then you can use:

class { '::ucarp':
  vId => '001',
  vIp => '192.168.0.222',
  vIf => 'eth0',
  vPw => 'Secret'
}

##Usage

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

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

include '::ucarp'

##Reference

###Classes

ucarp: Main class, includes all the rest.
ucarp::install: Handles the packages.
ucarp::config: Handles the configuration file.
ucarp::service: Handles the alternative service link.

###Parameters

The following parameters are available in the ucarp module

####vId Set the virtual ID

####vIp Set the virtual IP

####vIf Set the virtual Interface

####vPw Set the ucarp password

####upscript Include a custom template for the ucarp upscript. See the included template for ideas.

####downscript Include a custom template for the ucarp downscript. See the included template for ideas.

##Limitations

This module has been built on and tested against Puppet 3.2 and higher.

The module has been tested on:

RedHat Enterprise Linux 6
Scientific Linux 6

Testing on other platforms has been light and cannot be guaranteed.

Currently only eth0 is supported, using other interfaces result in a rewrite of the common template.

##Development

If you like to add or improve this module, feel free to fork the module and send me a merge request with the modification.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

jon-proulx/puppet-ucarp

ucarp