Ruby Puppet HTML
Latest commit 3bb2d87 Feb 17, 2017 @eputnam eputnam committed on GitHub Merge pull request #464 from mpolenchuk/cleanup_tcp_opts
Cleanup void tcp options
Failed to load latest commit information.
examples Designate former tests files as examples Dec 1, 2016
files Add RabbitMQ Plugin Support Mar 22, 2011
lib Merge pull request #491 from wyardley/rabbitmqadmin-sourcename-empty Sep 1, 2016
manifests Merge branch 'master' into cleanup_tcp_opts Feb 16, 2017
spec (maint) parallel_spec maintenance: spec_helper Feb 17, 2017
templates Merge branch 'master' into cleanup_tcp_opts Feb 16, 2017
.fixtures.yml (maint) Update dependencies. Mar 21, 2016
.gitattributes (FM-4046) Update to current msync configs [006831f] Feb 16, 2016
.gitignore (MODULES-4098) Sync the rest of the files Jan 20, 2017
.nodeset.yml Add framework for rspec-system tests. Jul 16, 2013
.project (MODULES-4098) Sync the rest of the files Jan 20, 2017
.rspec (FM-4049) Update to current msync configs [2c99161] Jan 27, 2016
.rubocop.yml Update modulesync_config [a3fe424] Aug 26, 2016
.sync.yml (MODULES-4098) Sync the rest of the files Jan 20, 2017
.travis.yml (MODULES-4097) Sync travis.yml Jan 10, 2017 Release prep for unsupported release 5.6.0 Oct 25, 2016 (MODULES-4098) Sync the rest of the files Jan 20, 2017
Gemfile (MODULES-4098) Sync the rest of the files Jan 20, 2017
LICENSE (FM-4046) Update to current msync configs [006831f] Feb 16, 2016 (MODULES-4098) Sync the rest of the files Jan 20, 2017
NOTICE (MODULES-4098) Sync the rest of the files Jan 20, 2017 Merge pull request #498 from tampakrap/management_hostname Sep 2, 2016
Rakefile (MODULES-4098) Sync the rest of the files Jan 20, 2017
metadata.json Release prep for unsupported release 5.6.0 Oct 25, 2016


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


This module manages RabbitMQ (

Module Description

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

This module has been tested against 2.7.1 and is known to not support all features against earlier versions.


What rabbitmq affects

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

Beginning with rabbitmq

include '::rabbitmq'


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

rabbitmq class

To begin with the rabbitmq class controls the installation of rabbitmq. In here you can control many parameters relating to the package and service, such as disabling puppet support of the service:

class { '::rabbitmq':
  service_manage    => false,
  port              => '5672',
  delete_guest_user => true,

Or such as offline installation from intranet or local mirrors:

class { '::rabbitmq':
   key_content      => template('openstack/'),
   package_gpg_key  => '/tmp/',

And this one will use external package key source for any (apt/rpm) package provider:

class { '::rabbitmq':
   package_gpg_key  => 'http://www.some_site.some_domain/',

Environment Variables

To use RabbitMQ Environment Variables, use the parameters environment_variables e.g.:

class { 'rabbitmq':
  port              => '5672',
  environment_variables   => {
    'NODENAME'     => 'node01',
    'SERVICENAME'  => 'RabbitMQ'

Variables Configurable in rabbitmq.config

To change RabbitMQ Config Variables in rabbitmq.config, use the parameters config_variables e.g.:

class { 'rabbitmq':
  port              => '5672',
  config_variables   => {
    'hipe_compile'  => true,
    'frame_max'     => 131072,
    'log_levels'    => "[{connection, info}]"

To change Erlang Kernel Config Variables in rabbitmq.config, use the parameters config_kernel_variables e.g.:

class { 'rabbitmq':
  port              => '5672',
  config_kernel_variables  => {
    'inet_dist_listen_min' => 9100,
    'inet_dist_listen_max' => 9105,

To change Management Plugin Config Variables in rabbitmq.config, use the parameters config_management_variables e.g.:

class { 'rabbitmq':
  config_management_variables  => {
    'rates_mode' => 'basic',

Additional Variables Configurable in rabbitmq.config

To change Additional Config Variables in rabbitmq.config, use the parameter config_additional_variables e.g.:

class { 'rabbitmq':
  config_additional_variables => {
    'autocluster' => '[{consul_service, "rabbit"},{cluster_name, "rabbit"}]',
    'foo' => '[{bar, "baz"}]'

This will result in the following config appended to the config file:

% Additional config
  {autocluster, [{consul_service, "rabbit"},{cluster_name, "rabbit"}]},
  {foo, [{bar, "baz"}]}

(This is required for the autocluster plugin


To use RabbitMQ clustering facilities, use the rabbitmq parameters config_cluster, cluster_nodes, and cluster_node_type, e.g.:

class { 'rabbitmq':
  config_cluster           => true,
  cluster_nodes            => ['rabbit1', 'rabbit2'],
  cluster_node_type        => 'ram',
  erlang_cookie            => 'A_SECRET_COOKIE_STRING',
  wipe_db_on_cookie_change => true,



  • rabbitmq: Main class for installation and service management.
  • rabbitmq::config: Main class for rabbitmq configuration/management.
  • rabbitmq::install: Handles package installation.
  • rabbitmq::params: Different configuration data for different systems.
  • rabbitmq::service: Handles the rabbitmq service.
  • rabbitmq::repo::apt: Handles apt repo for Debian systems.
  • rabbitmq::repo::rhel: Handles rpm repo for Redhat systems.



Boolean, if enabled sets up the management interface/plugin for RabbitMQ.


An array specifying authorization/authentication backend to use. Syntax: single quotes should be placed around array entries, ex. ['{foo, baz}', 'baz'] Defaults to [rabbit_auth_backend_internal], and if using LDAP defaults to [rabbit_auth_backend_internal, rabbit_auth_backend_ldap].


Choose between disc and ram nodes.


An array of nodes for clustering.


Value to set for cluster_partition_handling RabbitMQ configuration variable.


Integer, set the collect_statistics_interval in rabbitmq.config


The file to use as the rabbitmq.config template.


String, dditional config variables in rabbitmq.config


Boolean to enable or disable clustering support.


Hash of Erlang kernel configuration variables to set (see Variables Configurable in rabbitmq.config).



Configuring queue mirroring should be done by setting the according policy for the queue. You can read more about it here


The path to write the RabbitMQ configuration file to.


Hash of configuration variables for the Management Plugin.


Boolean to enable or disable stomp.


Boolean to enable or disable shovel.


Hash of static shovel configurations


To set config variables in rabbitmq.config


Username to set for the default_user in rabbitmq.config.


Password to set for the default_user in rabbitmq.config.


Boolean to decide if we should delete the default guest user.


The template file to use for rabbitmq_env.config.


The path to write the rabbitmq_env.config file to.


RabbitMQ Environment Variables in rabbitmq_env.config


The erlang cookie to use for clustering - must be the same between all nodes. This value has no default and must be set explicitly if using clustering. If you run Pacemaker and you don't want to use RabbitMQ buildin cluster, you can set config_cluster to 'False' and set 'erlang_cookie'.


Set rabbitmq file ulimit. Defaults to 16384. Only available on systems with $::osfamily == 'Debian' or $::osfamily == 'RedHat'.


Set the heartbeat timeout interval, default is unset which uses the builtin server defaultsof 60 seconds. Setting this to 0 will disable heartbeats.


Uses content method for Debian OS family. Should be a template for apt::source class. Overrides package_gpg_key behavior, if enabled. Undefined by default.


Boolean, set to true to enable LDAP auth.


LDAP server to use for auth.


User DN pattern for LDAP auth.


How to bind to the LDAP server. Defaults to 'anon'.


Hash of other LDAP config variables.


Boolean, set to true to use SSL for the LDAP server.


Numeric port for LDAP server.


Boolean, set to true to log LDAP auth.


Boolean, whether or not to manage package repositories.


The hostname for the RabbitMQ management interface.


The port for the RabbitMQ management interface.


Enable/Disable SSL for the management port. Has an effect only if ssl => true. Default is true. Valid values are true or false.


The value of NODE_IP_ADDRESS in rabbitmq_env.config and of the rabbitmq_management server if it is enabled.


Determines the ensure state of the package. Set to installed by default, but could be changed to latest.


RPM package GPG key to import. Uses source method. Should be a URL for Debian/RedHat OS family, or a file name for RedHat OS family. Set to by default. Note, that key_content, if specified, would override this parameter for Debian OS family.


The name of the package to install.


What provider to use to install the package.


Where should the package be installed from?

On Debian- and Arch-based systems using the default package provider, this parameter is ignored and the package is installed from the rabbitmq repository, if enabled with manage_repo => true, or from the system repository otherwise. If you want to use dpkg as the package_provider, you must specify a local package_source.


Location of RabbitMQ plugins.


The RabbitMQ port.


The state of the service.


Determines if the service is managed.


The name of the service to manage.


Configures the service for using SSL.


Configures the service to only use SSL. No cleartext TCP listeners will be created. Requires that ssl => true and port => UNSET also


CA cert path to use for SSL.


Cert to use for SSL.


Key to use for SSL.


SSL management port.


SSL stomp port.


rabbitmq.config SSL verify setting.


rabbitmq.config fail_if_no_peer_cert setting.


Choose which SSL versions to enable. Example: ['tlsv1.2', 'tlsv1.1'].

Note that it is recommended to disable sslv3 and tlsv1 to prevent against POODLE and BEAST attacks. Please see the RabbitMQ SSL documentation for more information.


Support only a given list of SSL ciphers. Example: ['dhe_rsa,aes_256_cbc,sha','dhe_dss,aes_256_cbc,sha','ecdhe_rsa,aes_256_cbc,sha'].

Supported ciphers in your install can be listed with: rabbitmqctl eval 'ssl:cipher_suites().' Functionality can be tested with cipherscan or similar tool:


The port to use for Stomp.


Configures STOMP to only use SSL. No cleartext STOMP TCP listeners will be created. Requires setting ssl_stomp_port also.


Boolean to install the stomp plugin.


Integer, the size of the backlog on TCP connections.


Boolean to enable TCP connection keepalive for RabbitMQ service.


Integer, corresponds to recbuf in RabbitMQ tcp_listen_options


Integer, corresponds to sndbuf in RabbitMQ tcp_listen_options


Sets the version to install.

On Debian- and Arch-based operating systems, the version parameter is ignored and the latest version is installed from the rabbitmq repository, if enabled with manage_repo => true, or from the system repository otherwise.


Boolean to determine if we should DESTROY AND DELETE the RabbitMQ database.


String: OS dependent, default defined in param.pp. The system user the rabbitmq daemon runs as.


String: OS dependent, default defined in param.pp. The system group the rabbitmq daemon runs as.


String: OS dependent. default defined in param.pp. The home directory of the rabbitmq deamon.

Native Types


query all current users: $ puppet resource rabbitmq_user

rabbitmq_user { 'dan':
  admin    => true,
  password => 'bar',

Optional parameter tags will set further rabbitmq tags like monitoring, policymaker, etc. To set the administrator tag use admin-flag.

rabbitmq_user { 'dan':
  admin    => true,
  password => 'bar',
  tags     => ['monitoring', 'tag1'],


query all current vhosts: $ puppet resource rabbitmq_vhost

rabbitmq_vhost { 'myvhost':
  ensure => present,


rabbitmq_exchange { 'myexchange@myvhost':
  user     => 'dan',
  password => 'bar',
  type     => 'topic',
  ensure   => present,
  internal => false,
  auto_delete => false,
  durable => true,
  arguments => {
    hash-header => 'message-distribution-hash'


rabbitmq_queue { 'myqueue@myvhost':
  user        => 'dan',
  password    => 'bar',
  durable     => true,
  auto_delete => false,
  arguments   => {
    x-message-ttl => 123,
    x-dead-letter-exchange => 'other'
  ensure      => present,


rabbitmq_binding { 'myexchange@myqueue@myvhost':
  user             => 'dan',
  password         => 'bar',
  destination_type => 'queue',
  routing_key      => '#',
  arguments        => {},
  ensure           => present,


rabbitmq_user_permissions { 'dan@myvhost':
  configure_permission => '.*',
  read_permission      => '.*',
  write_permission     => '.*',


rabbitmq_policy { 'ha-all@myvhost':
  pattern    => '.*',
  priority   => 0,
  applyto    => 'all',
  definition => {
    'ha-mode'      => 'all',
    'ha-sync-mode' => 'automatic',


query all currently enabled plugins $ puppet resource rabbitmq_plugin

rabbitmq_plugin {'rabbitmq_stomp':
  ensure => present,


  rabbitmq_parameter { 'documentumShovel@/':
    component_name => '',
    value          => {
        'src-uri'    => 'amqp://',
        'src-queue'  => 'my-queue',
        'dest-uri'   => 'amqp://remote-server',
        'dest-queue' => 'another-queue',

  rabbitmq_parameter { 'documentumFed@/':
    component_name => 'federation-upstream',
    value          => {
        'uri'    => 'amqp://myserver',
        'expires' => '360000',


This is essentially a private type used by the rabbitmq::config class to manage the erlang cookie. It replaces the rabbitmq_erlang_cookie fact from earlier versions of this module. It manages the content of the cookie usually located at "${rabbitmq_home}/.erlang.cookie", which includes stopping the rabbitmq service and wiping out the database at "${rabbitmq_home}/mnesia" if the user agrees to it. We don't recommend using this type directly.


This module has been built on and tested against Puppet 3.x.

The module has been tested on:

  • RedHat Enterprise Linux 5/6
  • Debian 6/7
  • CentOS 5/6
  • Ubuntu 12.04/14.04

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

Apt module compatibility

While this module supports both 1.x and 2.x versions of the puppetlabs-apt module, it does not support puppetlabs-apt 2.0.0 or 2.0.1.

Module dependencies

If running CentOS/RHEL, and using the yum provider, ensure the epel repo is present.

To have a suitable erlang version installed on RedHat and Debian systems, you have to install another puppet module from with:

puppet module install garethr-erlang

This module handles the packages for erlang. To use the module, add the following snippet to your site.pp or an appropriate profile class:

For RedHat systems:

include 'erlang'
class { 'erlang': epel_enable => true}

For Debian systems:

include 'erlang'
package { 'erlang-base':
  ensure => 'latest',

This module also depends on the excellent puppet/staging module on the Forge:

puppet module install puppet-staging

Downgrade Issues

Be advised that there were configuration file syntax and other changes made between RabbitMQ versions 2 and 3. In order to downgrade from 3 to 2 (not that this is a terribly good idea) you will need to manually remove all RabbitMQ configuration files (/etc/rabbitmq) and the mnesia directory (usually /var/lib/rabbitmq/mnesia). The latter action will delete any and all messages stored to disk.

Failure to do this will result in RabbitMQ failing to start with a cryptic error message about "init terminating in do_boot", containing "rabbit_upgrade,maybe_upgrade_mnesia".


Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

You can read the complete module contribution guide on the Puppet Labs wiki.