rabbitmq (90) Versions 5.9.1 Follow154

Installs and configures RabbitMQ server

Policyfile

Berkshelf

Knife

cookbook 'rabbitmq', '~> 5.9.1', :supermarket

cookbook 'rabbitmq', '~> 5.9.1'

knife supermarket install rabbitmq

knife supermarket download rabbitmq

README

Dependencies

Changelog

Quality 33%

RabbitMQ Chef Cookbook

This is a cookbook for managing RabbitMQ with Chef.

Supported Chef Versions

This cookbook targets Chef 14.0 and later.

Supported RabbitMQ Versions

5.x release series targets RabbitMQ 3.8.x releases.

For any series used, a supported Erlang version must be provisioned.

Supported Distributions

The cookbook targets and is tested against

Ubuntu 18.04 through 20.04
Debian 10 (Buster) and 11 (Bullseye)
RHEL 7 and 8
CentOS 7 and 8
Fedora 32 or later
Amazon Linux 2
Scientific Linux 7

Those are the distributions currently used to run tests [with Kitchen](.kitchen.yml).

Newer Versions

Newer Debian, Ubuntu and RHEL/CentOS 8.x versions should work.

Older Versions

CentOS 6.x, Ubuntu 16.04 and Debian 9 (Stretch) are no longer supported
by modern RabbitMQ releases as they do not provide OpenSSL 1.1.

Dependencies

This cookbook depends on the Erlang cookbook
and assumes that the user can configure it to provision a supported Erlang/OTP version.

Two more recipes are provided by this cookbook:rabbitmq::erlang_package and rabbitmq::esl_erlang_package.
The latter is an alias to the erlang::esl recipe in the Erlang
cookbook.

The former uses Debian Erlang packages and zero dependency Erlang RPM package produced and published by Team RabbitMQ.
Those packages provide the latest patch releases of Erlang/OTP.

Both options are covered below.

Provisioning RabbitMQ 3.8.x

Ensure Your Cookbook Version is Compatible

To provision RabbitMQ 3.8.x, you must use version 5.8.5 of this cookbook or later.

Provision Erlang/OTP 23.2 or Later

Before provisioning a 3.8.x release, please learn about
the minimum required Erlang/OTP version
and Erlang/OTP version recommendations.

Most distributions provide older versions, so Erlang must be provisioned either
using RabbitMQ's zero dependency Erlang RPM,
Debian Erlang packages,
or from Erlang Solutions

Installing Erlang Using Packages by Team RabbitMQ

rabbitmq::erlang_package is a recipe that provisions latest Erlang packages from team RabbitMQ.
The packages support

Debian 9 and 10
Ubuntu 16.04 through 20.04
RHEL 7 and 8
CentOS 7 and 8
Fedora 32 or later
Scientific Linux 7
Amazon Linux 2

The packages are cannot be installed alongside with other Erlang packages, for example, those
from standard Debian repositories or Erlang Solutions.

To make sure that the Erlang cookbook is not used by rabbitmq::default, rabbitmq::cluster,
and other recipes, set node['rabbitmq']['erlang']['enabled'] to true:

node['rabbitmq']['erlang']['enabled'] = true

By default rabbitmq::erlang_package will install the latest Erlang version available.
To override package version, use node['rabbitmq']['erlang']['version']:

# Debian
node['rabbitmq']['erlang']['version'] = '1:23.3.4.4-1'

# RPM
node['rabbitmq']['erlang']['version'] = '23.3.1'

On Ubuntu and Debian the distribution will be picked from node attributes.

Most of the time there is no need to override other attributes. Below is a list of defaults
used on Ubuntu and Debian:

# RabbitMQ Erlang packages
deb_distro = value_for_platform(
  'debian' => {
    'default' => 'debian'
  },
  'ubuntu' => {
    'default' => 'ubuntu'
  }
)

default['rabbitmq']['erlang']['apt']['uri'] = "https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/deb/#{deb_distro}"
default['rabbitmq']['erlang']['apt']['lsb_codename'] = node['lsb']['codename']
default['rabbitmq']['erlang']['apt']['components'] = ["main"]
default['rabbitmq']['erlang']['apt']['key'] = 'https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/gpg.E495BB49CC4BBE5B.key'

default['rabbitmq']['erlang']['apt']['install_options'] = %w(--fix-missing)

On CentOS 8 and 7, base Yum repository URL will be picked based on distribution versions.
On Fedora, a suitable CentOS package will be used. Erlang package version is set the same way
as for Debian (see above).

Below are the defaults used by the Yum repository (assuming RHEL or CentOS 8):

# CentOS 8, RHEL 8, Fedora
default['rabbitmq']['erlang']['yum']['baseurl'] = 'https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/rpm/el/8/$basearch'
default['rabbitmq']['erlang']['yum']['gpgkey'] = 'https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/gpg.E495BB49CC4BBE5B.key'
default['rabbitmq']['erlang']['yum']['gpgcheck'] = true
default['rabbitmq']['erlang']['yum']['repo_gpgcheck'] = false

The CentOS 7 variant uses el/7 for distribution name in the baseurl:

# CentOS 7, RHEL 7
default['rabbitmq']['erlang']['yum']['baseurl'] = 'https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/rpm/el/7/$basearch'
default['rabbitmq']['erlang']['yum']['gpgkey'] = 'https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/gpg.E495BB49CC4BBE5B.key'
default['rabbitmq']['erlang']['yum']['gpgcheck'] = true
default['rabbitmq']['erlang']['yum']['repo_gpgcheck'] = false

Installing Erlang with the Erlang Cookbook

The Erlang cookbook will provision packages from Erlang Solutions
if node['erlang']['install_method'] is set to esl.
Note that Erlang Solutions repositories can be behind the latest Erlang/OTP patch releases.

# will install the latest release, please
# consult with https://www.rabbitmq.com/which-erlang.html first
node['erlang']['install_method'] = "esl"

to provision a specific version, e.g. 23.3.1:

node['erlang']['install_method'] = "esl"
# Ubuntu and Debian
# note the "1:" package epoch prefix
node['erlang']['esl']['version'] = "1:23.3.1"

node['erlang']['install_method'] = "esl"
# CentOS, RHEL, Fedora
node['erlang']['esl']['version'] = "23.3.1-1"

Seting RabbitMQ Version

Set node['rabbitmq']['version'] to specify a version:

node['rabbitmq']['version'] = "3.8.17"

If you have node['rabbitmq']['deb_package_url'] or node['rabbitmq']['rpm_package_url'] overridden
from earlier versions, consider omitting those attributes. Otherwise see a section on download
location customization below.

RabbitMQ packages will be downloaded from Cloudsmith.

Recipes

default

Installs rabbitmq-server via direct download (from Bintray or GitHub, depending on the version) of
the installation package or using the distribution version. Depending on your distribution,
the provided version may be quite old so direct download is the default option.

Clustering Essentials

Set the ['rabbitmq']['clustering']['enable'] attribute to true, ['rabbitmq']['clustering']['cluster_disk_nodes']
array of node@host strings that describe cluster members,
and a alphanumeric string for the erlang_cookie.

TLS

To enable TLS for client connections, set the ssl to true and set the paths to your cacert, cert and key files.

node['rabbitmq']['ssl'] = true
# path to the CA bundle file
node['rabbitmq']['ssl_cacert'] = '/path/to/cacert.pem'
# path to the server certificate (pubic key) PEM file
node['rabbitmq']['ssl_cert'] = '/path/to/cert.pem'
# path to the server private key file
node['rabbitmq']['ssl_key'] = '/path/to/key.pem'

Client Connection Listeners

TCP connection listeners may be limited to a specific interface
using the node['rabbitmq']['tcp_listen_interface'] attribute.

Its TLS connection listener counterpart is node['rabbitmq']['ssl_listen_interface'].

Custom Package Download Locations

node['rabbitmq']['deb_package_url'] and node['rabbitmq']['rpm_package_url'] can be used
to override the package download location. They configure a prefix without a version.
Set them to a download location without a version if you want to provision from a custom
endpoint such as a local mirror.

The default recipe will append a version suffix that matches RabbitMQ tag naming scheme.
For 3.7.x or later, it is just the version (the value is used as is).

Lastly, a package name will be appended to form a full download URL. They rarely need
changing but can also be overridden using the node['rabbitmq']['deb_package']
and node['rabbitmq']['rpm_package'] attributes.

Attributes

A full list of attributes related to TLS in RabbitMQ
can be found in [attributes/default.rb](attributes/default.rb).

Default values and usage information of important attributes are shown below. More attributes are documented in metadata.rb.

Username and Password

The default username and password are guest/guest, with access limited to localhost connections:

['rabbitmq']['default_user'] = 'guest'
['rabbitmq']['default_pass'] = 'guest'

It is highly recommended that a different
default user name is used with a reasonably long (say, 30-40 characters) generated password.

Loopback Users

By default, the guest user can only connect from localhost.
This prevents remote access for installations that use the well-known default credentials.
It is highly recommended that remote access for the default user is not enabled
but if security is of absolutely no importance in a certain environment, this can be done:

['rabbitmq']['loopback_users'] = []

Learn more in the RabbitMQ Access Control guide.

Definitions Import

It is possible to to load a definitions (schema) file on node boot.
Consult RabbitMQ's Definitions
and Backup doc guides to learn more.

To configure definition loading, set the following attribute:

['rabbitmq']['management']['load_definitions'] = true

By default, the node will be configured to load a JSON at /etc/rabbitmq/load_definitions.json;
however, you can define another path if you'd prefer using the following attribute:

['rabbitmq']['management']['definitions_file'] = '/path/to/your/definitions.json'

In order to use this functionality, you will need to provision a file referenced by the above attribute
before you execute any recipes in the RabbitMQ cookbook (in other words, before the node starts). For example, this can be done
using a remote file resource.

management_ui

Installs the RabbitMQ management plugin.

To enable HTTPS for the management UI and HTTP API, set ['rabbitmq']['web_console_ssl'] attribute to true.
The HTTPS port for the management UI can be configured by setting attribute ['rabbitmq']['web_console_ssl_port'],
whose default value is 15671.

plugins

Enables any plugins listed in the node['rabbitmq']['enabled_plugins'] and disables any listed
in node['rabbitmq']['disabled_plugins'] attributes.

LDAP Configuration

To enable the LDAP plugin, a few attributes have to be used
in combination:

Set node['rabbitmq']['ldap']['enabled'] = true
Enable auth_backends: node['rabbitmq']['auth_backends'] = 'rabbit_auth_backend_internal,rabbit_auth_backend_ldap'
Enable the rabbitmq_auth_backend_ldap plugin
Configure LDAP servers and queries via the node['rabbitmq']['ldap']['conf'] variable

Example configuration

# this is just an example
node['rabbitmq']['ldap']['conf'] = {
  :servers => ["ldap-host1", "ldap-host2"],
  :user_bind_pattern => "${username}@<domain>",
  :dn_lookup_attribute => "sAMAccountName",
  :dn_lookup_base => "DC=<CHANGEME>,DC=<CHANGEME>",
  :port => <CHANGEME (number)>,
  :log => <CHANGEME (boolean)>,
  :vhost_access_query => '{constant, true}',
  :topic_access_query => '{constant, true}',
  :resource_access_query => '{constant, true}',
  :tag_queries => "[{administrator, {constant, false}}]"
  }

users

Enables any RabbitMQ users listed in the node['rabbitmq']['enabled_users'] and disables any listed in node['rabbitmq']['disabled_users'] attributes.
You can provide user credentials, the vhosts that they need to have access to and the permissions that should be allocated to each user.

node['rabbitmq']['enabled_users'] = [
    {
        :name => 'kitten',
        :password => 'kitten',
        :tag => 'leader',
        :rights => [
            {
                :vhost => 'nova',
                :conf => '.*',
                :write => '.*',
                :read => '.*'
            }
        ]
    }
]

Note that with this approach user credentials will be stored in the attribute file.
Using encrypted data bags is therefore highly recommended.

Alternatively definitions export and import (see above) can be used.
Definition files contain password hashes since clear text values are not stored.

vhosts

Enables any virtual hosts listed in the node['rabbitmq']['virtualhosts']
and disables any listed in node['rabbitmq']['disabled_virtualhosts'] attributes.

cluster

Forms a cluster RabbitMQ of nodes.

It supports two clustering modes: auto or manual.

Auto clustering: lists cluster members in the RabbitMQ config file. Those are taken from lists the nodes node['rabbitmq']['clustering']['cluster_nodes'].
Manual clustering : joins cluter members using rabbitmqctl join_cluster.

Attributes

node['rabbitmq']['clustering']['enable'] : Default decision flag of clustering
node['rabbitmq']['erlang_cookie'] : Same erlang cookie is required for the cluster
node['rabbitmq']['clustering']['use_auto_clustering'] : Default is false. (manual clustering is default)
node['rabbitmq']['clustering']['cluster_name'] : Name of cluster. default value is nil. In case of nil or '' is set for cluster_name, first node name in node['rabbitmq']['clustering']['cluster_nodes'] attribute will be set for manual clustering. for the auto clustering, one of the node name will be set.
node['rabbitmq']['clustering']['cluster_nodes'] : List of cluster nodes. it required node name and cluster node type. please refer to example in below.

Example

node['rabbitmq']['clustering']['enable'] = true
node['rabbitmq']['erlang_cookie'] = 'AnyAlphaNumericStringWillDo'
node['rabbitmq']['clustering']['cluster_partition_handling'] = 'pause_minority'
node['rabbitmq']['clustering']['use_auto_clustering'] = false
node['rabbitmq']['clustering']['cluster_name'] = 'qa_env'
node['rabbitmq']['clustering']['cluster_nodes'] = [
    {
        :name => 'rabbit@rabbit1'
    },
    {
        :name => 'rabbit@rabbit2'
    },
    {
        :name => 'rabbit@rabbit3'
    }
]

policies

Enables any policies listed in the node['rabbitmq']['policies'] and disables any listed in node['rabbitmq']['disabled_policies'] attributes.

See examples in attributes file.

community_plugins

Downloads, installs and enables pre-built community plugins binaries.

To specify a plugin, set the attribute node['rabbitmq']['community_plugins']['PLUGIN_NAME'] to '{DOWNLOAD_URL}'.

Available Resources/Providers

There are several LWRPs for interacting with RabbitMQ and a few setting up Erlang repositories
and package.

erlang_apt_repository_on_cloudsmith

erlang_apt_repository_on_cloudsmith sets up a Debian package repository from Cloudsmith.
It is a wrapper around the standard apt_repository resource provider.

rabbitmq_erlang_apt_repository_on_cloudsmith 'rabbitmq_erlang_repo_on_cloudsmith' do
  distribution node['lsb']['codename'] unless node['lsb'].nil?

  action :add
end

erlang_yum_repository_on_cloudsmith

erlang_apt_repository_on_cloudsmith sets up an RPM package repository from Bintray.
It is a wrapper around the standard apt_repository resource provider.

rabbitmq_erlang_yum_repository_on_cloudsmith 'rabbitmq_erlang' do
  # for RHEL/CentOS 8+, Fedora. See https://www.rabbitmq.com/install-rpm.html.
  baseurl 'https://dl.cloudsmith.io/public/rabbitmq/rabbitmq-erlang/rpm/el/8/$basearch'

  action :add
end

erlang_package_from_cloudsmith

Install the package. Here's an example for Debian-based systems:

rabbitmq_erlang_package_from_cloudsmith 'rabbitmq_erlang' do
  # This package version assumes a Debian-based distribution.
  version '1:23.3.4.4-1'

  action :install
end

Here's another one for RPM-based ones:

rabbitmq_erlang_package_from_cloudsmith 'rabbitmq_erlang' do
  version '23.3.4.4'

  action :install
end

plugin

Enables or disables a rabbitmq plugin. Plugins are not supported for releases prior to 2.7.0.

:enable enables a plugin
:disable disables a plugin

Examples

rabbitmq_plugin "rabbitmq_stomp" do
  action :enable
end

rabbitmq_plugin "rabbitmq_shovel" do
  action :disable
end

policy

Sets or clears a RabbitMQ policy.

:set sets a policy
:clear clears a policy
:list lists policys

Examples

rabbitmq_policy "queue-length-limit" do
  pattern "^limited\\.*"
  parameters ({"max-length" => "3000"})
  priority 1
  action :set
end

user

Adds and deletes users:

:add adds a user with a password
:delete deletes a user
:set_permissions sets the permissions for a user, vhost is optional
:clear_permissions clears the permissions for a user
:set_tags set the tags on a user
:clear_tags clear any tags on a user
:change_password set the password for a user

Examples

rabbitmq_user "guest" do
  action :delete
end

rabbitmq_user "nova" do
  password "sekret"
  action :add
end

rabbitmq_user "nova" do
  vhost "/nova"
  permissions ".* .* .*"
  action :set_permissions
end

rabbitmq_user "rmq" do
  vhost ["/", "/rmq", "/nova"]
  permissions ".* .* .*"
  action :set_permissions
end

rabbitmq_user "joe" do
  tag "admin,lead"
  action :set_tags
end

vhost

Adds and deletes virtual hosts.

:add adds a vhost
:delete deletes a vhost

Examples

rabbitmq_vhost "/nova" do
  action :add
end

cluster

Forms a cluster and controls cluster name.
This is an imperative version of classic config peer discovery in
modern RabbitMQ versions.

:join join in cluster as a manual clustering. node will join in first node of json string data.
- cluster nodes as JSON: all cluster nodes should be listed.

 [
     {
         "name" : "rabbit@rabbit1",
         "type" : "disc"
     },
     {
         "name" : "rabbit@rabbit2",
         "type":  "disc"
     },
     {
         "name" "rabbit@rabbit3",
         "type" : "disc"
     }
]

:set_cluster_name set the cluster name

Examples

rabbitmq_cluster '[{"name":"rabbit@rabbit1", "type":"disc"},{"name":"rabbit@rabbit2", "type":"disc"},{"name":"rabbit@rabbit3", "type":"disc"}]' do
  action :join
end

rabbitmq_cluster '[{"name":"rabbit@rabbit1","type":"disc"},{"name":"rabbit@rabbit2", ,"type":"disc"},{"name":"rabbit@rabbit3","type":"disc"}]' do
  cluster_name 'seoul_tokyo_newyork'
  action :set_cluster_name
end

rabbitmq_cluster '[{"name":"rabbit@rabbit1","type":"disc"},{"name":"rabbit@rabbit2", ,"type":"disc"},{"name":"rabbit@rabbit3","type":"disc"}]' do
  action :change_cluster_node_type
end

Removing Nodes from an Existing Cluster

This cookbook provides the primitives to remove a node from a cluster via helper functions but do not include these in any recipes. This is something that is potentially very dangerous and different deployments will have different needs and IF you decide you need this it should be implemented in your wrapper with EXTREME caution. There are 2 helper methods for 2 different scenario:
- removing self from cluster. This should likely only be considered for machines on a normal decommission. This is accomplished by using the helper fucntion reset_current_node.
- removing another node from cluster. This should only be done once you are sure the machine is gone and won't come back. This can be accomplished via remove_remote_node_from_cluster.

Limitations

For an already running cluster, these actions still require manual intervention:

changing the shared cluster secret using the :erlang_cookie attribute
disabling clutering entirely by setting :cluster from true to false

License & Authors

Author:: Benjamin Black
Author:: Daniel DeLeo
Author:: Matt Ray
Author:: Seth Thomas
Author:: JJ Asghar
Author:: Team RabbitMQ

Copyright (c) 2009-2018, Chef Software, Inc.
Copyright (c) 2018-2021, VMware, Inc. or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

erlang >= 0.0.0

yum-epel >= 0.0.0

yum-erlang_solutions >= 0.0.0

dpkg_autostart >= 0.0.0

logrotate >= 0.0.0

Contingent cookbooks

Change Log

v5.9.2 (in development)

No changes yet.

v5.9.1 (2021-06-25)

unified_mode is now used only if provided by the Chef client.
This restores compatibility with Chef 14.

GitHub issue: #577
Change log corrections

v5.9.0 (2021-06-23)

This release introduces potentially breaking changes due to a number of significant changes in the RabbitMQ ecosystem
and beyond.

Switch from Bintray to Cloudsmith for package provisioning. Bintray has been permanently shut down.

GitHub issue: #574

RabbitMQ 3.7.x has been entirely out of support since September 2020. The package now provisions 3.8.17 by default instead of an unsupported version. 3.8.x series also address several CVEs.

GitHub issue: #574

This cookbook now can provision Erlang 24 from Cloudsmith.

GitHub issue: #574

Support for Ubuntu versions prior to 16.04, Fedora prior to 31, Debian prior to Stretch has been dropped as modern RabbitMQ and Erlang versions no longer support them and assume OpenSSL 1.1 to be available.

Instead, integration tests now focus on more modern distributions such as Ubuntu 20.04 and 21.04,
CentOS Stream, Fedora 34, Debian 10 and 11.

GitHub issue: #574

v5.8.5 (2020-07-25)

Idempotency w.r.t. Ohai package state reloading.

Contributed by @Wing924 and @ramereth.

GitHub issue: #554, #562

Chef 16 compatibility and cookbook style fixes.

Contributed by @tas50 and @ramereth.

GitHub issues: #541, #542, #561

Cluster status output parser failed with the new RabbitMQ 3.8-specific output format

Contributed by @DecoyJoe.

GitHub issue: #560

User tags are now set unconditionally by the users recipe.

Contributed by @tophercullen.

GitHub issue: #538

Compression enabled for logrotate.

Contributed by @drewhammond.

GitHub issue: #557

File is scoped explicitly to disambiguate.

Contributed by @tas50.

GitHub issue: #542

v5.8.4 (2019-08-26)

rabbitmq[erlang_package_from_bintray] now provisions Erlang 22 by default on RPM-based
distributions. Erlang 21.x can be provisioned by overriding the
`node['rabbitmq']['erlang']['yum']['baseurl'] attribute (see README for examples).
node['rabbitmq']['channel_max'] is a new attribute used to configure
the maximum number of channels allowed per connection.

Contributed by @rafaelyehuda.

GitHub issue: #533

v5.8.2 (2019-05-29)

Chef Compatibility

Restored compatibility with pre-Chef 13 apt_preference resource.

Contributed by Stefan Sundin.

GitHub issue: #527

Enhancements

Basic LDAP plugin configuration support (see documentation in the README).

Contributed by @refaelyehuda.

GitHub issue: #528

Bug Fixes

rabbitmq[user]'s :clear_permissions action unintentionally had no effect.

Contributed by Brandon Kneeld.

GitHub issue: #529

rabbitmq[erlang_package_from_bintray] now skips Erlang packages not available on Ubuntu 16.04 (Xenial).

Contributed by Stefan Sundin.

GitHub issue: #532

v5.8.1 (2019-05-01)

Bug Fixes

rabbitmq[erlang_package_from_bintray] could install different versions of Debian packages due to a two step installation proceess.

Contributed by Kevin Bonner.

GitHub issue: #525

rabbitmq[erlang_package_from_bintray] had a no-op :remove action block on non-Debian platforms.

Contributed by Kevin Bonner.

GitHub issue: #526

v5.8.0 (2019-04-22)

Chef Compatibility

Chef 13 is now the minimum required version. Chef 12 has been out of support since April 2018.

GitHub issue: #523

Enhancements

rabbitmq[erlang_package_from_bintray] now supports Debian 10 (Buster) starting with Erlang 21.3.6. More versions will be available as they come out and become available in the rabbitmq-erlang/debian Bintray repository.

v5.7.7 (2019-04-16)

Chef 12 Compatibility

rabbitmq[erlang_package_from_bintray] was adapted to support Chef 12 (which is no longer maintained).

GitHub issue: #522

v5.7.6 (2019-04-11)

Bug Fixes

rabbitmq[erlang_yum_repository_on_bintray] no longer performs a yum update which can result in unintended package updates.

GitHub issue: #521

On Debian, rabbitmq[erlang_package_from_bintray] will install all Erlang packages in
a single apt operation to avoid complications with interdependencies and order of installation.
Plugin operations now use inferred installed RabbitMQ version when deciding what switches
to use. This improves compatibility for distribution-provided versions.

Contributed by Jan Klare.

GitHub issue: #518

Enhancements

RabbitMQ 3.7.14 is now provisioned by default.

v5.7.5 (2019-03-25)

Enhancements

Amazon Linux 2 is now supported. Note that it requires Erlang to be provisioned via team RabbitMQ Erlang repositories.

GitHub issue: #515.

Bug Fixes

Scientific Linux lacked Kitchen integration tests.

GitHub issue: #516.

v5.7.4 (2019-03-20)

Enhancements

New LWRPs for provisioning team RabbitMQ's Erlang packages:

erlang_apt_repository_on_bintray and erlang_yum_repository_on_bintray for provisioning an appropriate package repository from Bintray. They are wrappers around the standard apt_repository and yum_repository resource providers:

  rabbitmq_erlang_apt_repository_on_bintray 'rabbitmq_erlang_repo_on_bintray' do
    distribution node['lsb']['codename'] unless node['lsb'].nil?
    # See https://www.rabbitmq.com/install-debian.html
    components ['erlang-22.x']

    action :add
  end

  rabbitmq_erlang_yum_repository_on_bintray 'rabbitmq_erlang' do
    # for RHEL/CentOS 7+, Fedora. See https://www.rabbitmq.com/install-rpm.html.
    baseurl 'https://dl.bintray.com/rabbitmq/rpm/rabbitmq-server/v3.7.x/el/7/'
    gpgkey 'https://dl.bintray.com/rabbitmq/Keys/rabbitmq-release-signing-key.asc'

    action :add
  end

erlang_package_from_bintray install the package:

  rabbitmq_erlang_package_from_bintray 'rabbitmq_erlang' do
    # This package version assumes a Debian-based distribution.
    # On RHEL/CentOS/Fedora it would be '22.3.4.4'
    version '1:22.3.4.4-1'

    action :install
  end

Bug Fixes

Actual installed RabbitMQ package version is now inferred using Ohai when deciding whether to use certain features, CLI tool arguments and so on.

Contributed by Jan Klare.

GitHub issue: #509

v5.7.3 (2019-03-15)

Follow-up to #508: more resources treat distro version as 3.6.x.

Note that node['rabbitmq']['use_distro_version'] will be dropped in the next major version of this cookbook.
Consider provisioning a supported RabbitMQ version (e.g. 3.7.13) instead of relying on node['rabbitmq']['use_distro_version'].

GitHub issue: #508

v5.7.2 (2019-03-13)

Bug Fixes

If node['rabbitmq']['use_distro_version'] is set to true, the version is considered to be a 3.6.x one. This is the case even with Ubuntu Cosmic (18.10) and Debian Stretch backports.

GitHub issue: #508

v5.7.1 (2019-03-11)

Bug Fixes

LSB attribute is no longer references on non-Debian platforms.

Contributed by Sten Spans.

GitHub issue: #507

Enhancements

Default provisioned RabbitMQ version is now 3.7.13.

v5.7.0 (2019-03-06)

Enhancements

rabbitmq::erlang_package and rabbitmq::esl_erlang_package are new recipes that
provision Erlang packages. The latter is an alias to the erlang::esl recipe in the Erlang
cookbook. The former uses Debian Erlang packages and zero dependency Erlang RPM package
produced by Team RabbitMQ.
Those packages provide the latest patch releases of Erlang/OTP.
Major integration test suite improvements

Bug Fixes

rabbitmq::cluster referenced an unitialized variable
socat package was not installed on CentOS 6

Diff

Full Diff

v5.6.3 (2019-03-04)

Enhancements

Generated CONFIG_FILE value will now use node['rabbitmq']['config'] value as is if no extension is provided. Note that RabbitMQ 3.6.x doesn't support config file paths with an extension, so an exception is made for those versions.

Contributed by James Morelli.

GitHub issue: #505

Bug Fixes

Plugin enablement detection did not work with latest RabbitMQ 3.7.x releases.
Socket options now force binary mode.

Contributed by Kevin Bonner.

GitHub issue: #492

Diff

Full Diff

v5.6.1 (2018-03-01)

Full Diff

Bug Fixes

Force a TCP socket option, binary, that's not necessary starting with 3.6.0 but implicitly required in earlier versions.

GitHub issue: #488

v5.6.0 (2018-02-23)

Full Diff

Enhancements:

More TLS socket options are configurable (e.g. cipher suite preference) #487
TCP socket buffer size is now configurable #486
TCP listener interface and port are now configuratble #485
Config root is now configurable #484

v5.5.0 (2018-02-14)

Full Diff

Enhancements:

RabbitMQ 3.7.x releases now can be provisioned

Closed issues:

Not honoring Version - always installs 3.6.8 #480
Github link seems to no longer be valid #479
Failing to create vhost and users #474

Merged pull requests:

fixed change cluster node type #477 (pauldmccann)
add the ability to load definitions on start #472 (esabelhaus)
Updated spec for upgrade_dpkg_package #471 (k-popov)
Ability to set interface to listen for SSL connections #470 (k-popov)

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

RabbitMQ Chef Cookbook

Supported Chef Versions

Supported RabbitMQ Versions

Supported Distributions

Newer Versions

Older Versions

Dependencies

Provisioning RabbitMQ 3.8.x

Ensure Your Cookbook Version is Compatible

Provision Erlang/OTP 23.2 or Later

Installing Erlang Using Packages by Team RabbitMQ

Installing Erlang with the Erlang Cookbook

Seting RabbitMQ Version

Recipes

default

Clustering Essentials

TLS

Client Connection Listeners

Custom Package Download Locations

Attributes

Username and Password

Loopback Users

Definitions Import

management_ui

plugins

LDAP Configuration

Example configuration

users

vhosts

cluster

Attributes

policies

community_plugins

Available Resources/Providers

erlang_apt_repository_on_cloudsmith

erlang_yum_repository_on_cloudsmith

erlang_package_from_cloudsmith

plugin

Examples

policy

Examples

user

Examples

vhost

Examples

cluster

Examples

Removing Nodes from an Existing Cluster

Limitations

License & Authors

Dependent cookbooks

Contingent cookbooks

Change Log

v5.9.2 (in development)

v5.9.1 (2021-06-25)

v5.9.0 (2021-06-23)

v5.8.5 (2020-07-25)

v5.8.4 (2019-08-26)

v5.8.2 (2019-05-29)

Chef Compatibility

Enhancements

Bug Fixes

v5.8.1 (2019-05-01)

Bug Fixes

v5.8.0 (2019-04-22)

Chef Compatibility

Enhancements

v5.7.7 (2019-04-16)

Chef 12 Compatibility

v5.7.6 (2019-04-11)

Bug Fixes

Enhancements

v5.7.5 (2019-03-25)

Enhancements