Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

rabbitmq

RabbitMQ Puppet Module (for company internal usage)
Project URLRSS FeedReport issues

9,958 downloads

9,492 latest version

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

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.3 (latest)
  • 0.0.2
  • 0.0.1
released Aug 7th 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'prachetasp-rabbitmq', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add prachetasp-rabbitmq
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install prachetasp-rabbitmq --version 0.0.3

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.

Download

Documentation

prachetasp/rabbitmq — version 0.0.3 Aug 7th 2014

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

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

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

##Setup

###What rabbitmq affects

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

###Beginning with rabbitmq

include '::rabbitmq'

##Usage

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

Environment Variables

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

class { 'rabbitmq':
  port              => '5672',
  environment_variables   => {
    'RABBITMQ_NODENAME'     => 'node01',
    'RABBITMQ_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,
  }
}

Clustering

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',
}

##Reference

##Classes

  • 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 yum repo for Redhat systems.

###Parameters

####admin_enable

If enabled sets up the management interface/plugin for RabbitMQ.

####cluster_disk_nodes

DEPRECATED AND REPLACED BY CLUSTER_NODES.

####cluster_node_type

Choose between disk and ram nodes.

####cluster_nodes

An array of nodes for clustering.

####config

The file to use as the rabbitmq.config template.

####config_cluster

Boolean to enable or disable clustering support.

####config_mirrored_queues

DEPRECATED

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

####config_path

The path to write the RabbitMQ configuration file to.

####config_stomp

Boolean to enable or disable stomp.

####delete_guest_user

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

####env_config

The template file to use for rabbitmq_env.config.

####env_config_path

The path to write the rabbitmq_env.config file to.

####erlang_cookie

The erlang cookie to use for clustering - must be the same between all nodes.

####config_variables

To set config variables in rabbitmq.config

####node_ip_address

The value of RABBITMQ_NODE_IP_ADDRESS in rabbitmq_env.config

####environment_variables

RabbitMQ Environment Variables in rabbitmq_env.config

####package_ensure

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

####package_name

The name of the package to install.

####package_provider

What provider to use to install the package.

####package_source

Where should the package be installed from?

####plugin_dir

Location of RabbitMQ plugins.

####port

The RabbitMQ port.

####management_port

The port for the RabbitMQ management interface.

####service_ensure

The state of the service.

####service_manage

Determines if the service is managed.

####service_name

The name of the service to manage.

####ssl

Configures the service for using SSL.

####ssl_only

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

####stomp_port

The port to use for Stomp.

####stomp_ensure

Boolean to install the stomp plugin.

####wipe_db_on_cookie_change

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

####version

Sets the version to install.

##Native Types

rabbitmq_user

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'],
}

rabbitmq_vhost

query all current vhosts: $ puppet resource rabbitmq_vhost

rabbitmq_vhost { 'myhost':
  ensure => present,
}

rabbitmq_exchange

rabbitmq_exchange { 'myexchange@myhost':
  user     => 'dan',
  password => 'bar',
  type     => 'topic',
  ensure   => present,
}

rabbitmq_user_permissions

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

rabbitmq_plugin

query all currently enabled plugins $ puppet resource rabbitmq_plugin

rabbitmq_plugin {'rabbitmq_stomp':
  ensure => present,
}

rabbitmq_federation_upstream

uris and vhost are required. uris must be a non-empty array of uri's that use the amqp or amqps protocol and contain no spaces. Other parameters default to the values shown in the example if not provided.

rabbitmq_federation_upstream { 'myupstream':
  uris            => ['amqp://dan:bar@localhost/myhost', 'amqps://dan:bar@localhost/myhost'],
  vhost           => 'myhost',
  ack_mode        => 'on-confirm',
  expires         => 1000,  # defaults to forever if not provided
  max_hops        => 1,
  message_ttl     => 1000,  # defaults to forever if not provided
  prefetch_count  => 1000,
  reconnect_delay => 1,
  trust_user_id   => false,
}

###rabbitmq_federation_upstreamset

vhost is required. Do not provide upstreams to set to 'all'.

NOTE: It is an error to provide 'all' in the upstreams array.

rabbitmq_federation_upstreamset { 'myupstreamset':
  vhost     => 'myhost',
  upstreams => ['myupstream', 'myupstream1'],
}

###rabbitmq_policy

vhost, definition and pattern are required. definition must be a non-empty Hash. Other parameters default to the values shown in the example if not provided.

rabbitmq_policy { 'mypolicy':
  vhost      => 'myhost',
  definition => {'federation-upstream' => 'myfederationupstream'},
  pattern    => '^.*$',
  apply_to   => 'all',
  priority   => 0,
}

###rabbitmq_parameter

The resource title is parsed as 'vhost component name'. All three are required. value is also required and must be a non-empty Hash.

NOTE: Federation components (federation upstreams and federation upstream sets) cannot be managed with this type. Instead use the rabbitmq_federation_upstream and rabbitmq_federation_upstreamset types.

rabbitmq_parameter { 'myvhost shovel myparameter':
   value => {'src-uri'             => 'amqp://dan:bar@localhost/',
             'src-exchange'        => '/',
             'src-exchange-key'    => 'mykey',
             'dest-uri'            => 'amqp://dan:bar@localhost/',
             'dest-exchange'       => '/',
             'dest-exchange-key'   => 'mykey1',
             'add-forward-headers' => false,
             'ack-mode'            => 'on-confirm',
             'delete-after'        => 'never'},
}

##Limitations

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

The module has been tested on:

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

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

Module dependencies

To have a suitable erlang version installed on RedHat and Debian systems, you have to install another puppet module from http://forge.puppetlabs.com/garethr/erlang 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',
}

##Development

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.

Authors