mickeprag/puppet-ejabberd

Configure and manage ejabberd

-- mode: markdown; mode: visual-line; --

Ejabberd Puppet Module

Configure and manage ejabberd

  Copyright (c) 2015 UL HPC Management Team <hpc-sysadmins@uni.lu>

• Online Project Page -- Sources -- Issues

Synopsis

Configure and manage ejabberd.

This module implements the following elements:

• Puppet classes:

  • ejabberd
  • ejabberd::common
  • ejabberd::common::debian
  • ejabberd::params

• Puppet definitions:

All these components are configured through a set of variables you will find in manifests/params.pp.

Note: the various operations that can be conducted from this repository are piloted from a Rakefile and assumes you have a running Ruby installation. See doc/contributing.md for more details on the steps you shall follow to have this Rakefile working properly.

Dependencies

See metadata.json. In particular, this module depends on

• puppetlabs/stdlib

Overview and Usage

Class ejabberd

This is the main class defined in this module. It accepts the following parameters:

• $ensure: default to 'present', can be 'absent'

Use is as follows:

 include ' ejabberd'

See also tests/init.pp

Class ejabberd::common

See tests/common.pp

Class ejabberd::common::debian

See tests/common/debian.pp

Class ejabberd::params

See tests/params.pp

Librarian-Puppet / R10K Setup

You can of course configure the ejabberd module in your Puppetfile to make it available with Librarian puppet or r10k by adding the following entry:

 # Modules from the Puppet Forge
 mod "ULHPC-ejabberd"

or, if you prefer to work on the git version:

 mod "ULHPC-ejabberd", 
     :git => https://github.com/ULHPC/puppet-ejabberd,
     :ref => production 

Issues / Feature request

You can submit bug / issues / feature request using the ULHPC-ejabberd Puppet Module Tracker.

Developments / Contributing to the code

If you want to contribute to the code, you shall be aware of the way this module is organized. These elements are detailed on doc/contributing.md

You are more than welcome to contribute to its development by sending a pull request.

Puppet modules tests within a Vagrant box

The best way to test this module in a non-intrusive way is to rely on Vagrant. The Vagrantfile at the root of the repository pilot the provisioning various vagrant boxes available on Vagrant cloud you can use to test this module.

See doc/vagrant.md for more details.