rabbitmq

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 rabbitmq
   • What rabbitmq affects
   • Setup requirements
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.
   • RedHat module dependencies
7. Development - Guide for contributing to the module

Overview

This module manages RabbitMQ (www.rabbitmq.com)

Module Description

The rabbitmq module sets up rabbitmq and has a number of providers to manage everything from vhosts to exchanges after setup.

Setup

What rabbitmq affects

• rabbitmq repository files.
• rabbitmq package.
• rabbitmq configuration file.
• rabbitmq service.

Usage

All options and configuration can be done through interacting with the parameters on the main rabbitmq class. These are now documented via Puppet Strings

You can view example usage in REFERENCE.

puppet/epel is a soft dependency. If you're on CentOS 7 and don't want to require it, set $require_epel to false

Version v13.2.0 and older also added an erlang repository on CentOS 7. That isn't used and can be safely removed.

Migrating from puppet-rabbitmq <= 15.x

Module versions greater than 15.x drop support for RabbitMQ < 3.7.0. Please upgrade to a newer RabbitMQ version before upgrading the module.

Module versions greater than 15.x switch to the new ini-style config file As of RabbitMQ 3.7.0 instead of a Erlang-style rabbitmq.config file, there are two configuration files, rabbitmq.conf (sysctl style) and advanced.config. puppet-rabbitmq >= 16.x uses these two files - using the same parameters should have the same result, but users are strongly advised to test upgrade in a dev environment.

If the new files contain all the desired settings, use the purge_legacy_config_files parameter to ensure legacy-format configuration files are removed.

Reference

See REFERENCE.

Limitations

Supported OSes and dependencies are given into metadata.json file.

This module is tested with the last RabbitMQ 3.x release (3.13) and 3.x release from CentOS Messaging SIG (3.8). It may work with other releases >= 3.7.0 but it is not tested against them. It definitely does not support anymore RabbitMQ < 3.7.0 because of the new INI-style/sysctl configuration file.

Development

This module is maintained by Vox Pupuli. Voxpupuli welcomes new contributions to this module, especially those that include documentation and rspec tests. We are happy to provide guidance if necessary.

Please see CONTRIBUTING for more details.

Authors

• Jeff McCune jeff@puppetlabs.com
• Dan Bode dan@puppetlabs.com
• RPM/RHEL packages by Vincent Janelle randomfrequency@gmail.com
• Puppetlabs Module Team
• Voxpupuli Team