Forge Home


UCARP management module


7,863 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.2.1 (latest)
  • 0.2.0
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Feb 3rd 2016
This version is compatible with:
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'thbe-ucarp', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add thbe-ucarp
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install thbe-ucarp --version 0.2.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



thbe/ucarp — version 0.2.1 Feb 3rd 2016


Build Status Puppet Forge Coverage Status

####Table of Contents

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


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.


###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':
  virtual_id => '001',
  virtual_ip => '',
  virtual_if => 'eth0',
  virtual_pw => 'Secret'


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'



  • 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.


The following parameters are available in the ucarp module

####virtual_id Set the virtual ID

####virtual_ip Set the virtual IP

####virtual_if Set the virtual Interface

####virtual_pw Set the ucarp password

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

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


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

The module has been tested on:

  • CentOS 6
  • CentOS 7

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.


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