RabbitMQ for PCF v1.5.28

RabbitMQ for Pivotal Cloud Foundry® Documentation

RabbitMQ is a fast and dependable open-source message server that supports a wide range of use cases including reliable integration, content based routing and global data delivery, and high volume monitoring and data ingestion.

Emerging as the de facto standard for cloud messaging, RabbitMQ is used for efficient communication between servers, applications and devices, and creates lasting value by enabling rapid development of modern decentralized application and data architectures that can scale with your business needs. The Pivotal Cloud Foundry® (PCF) installer enables cloud operators to deploy a RabbitMQ service in PCF. You can deploy the service as a single node or a cluster.

Product snapshot

Current RabbitMQ for PCF Details
Version: 1.5.28
Release Date: 27th April 2017
Software component version: RabbitMQ OSS 3.5.8
Compatible Ops Manager Version(s): 1.7.x, 1.6.x, 1.5.x, 1.4.x
Compatible Elastic Runtime Version(s): 1.7.x, 1.6.x, 1.5.x, 1.4.x
vSphere support? Yes
AWS support? Yes
OpenStack support? Yes
IPsec support? No

Upgrading to the Latest Version

Consider the following compatibility information before upgrading RabbitMQ for Pivotal Cloud Foundry®.

Note: Customers looking to upgrade to v1.6.19 should not install this version (1.5.28), but should upgrade directly from their existing version

Note: Before you upgrade to Ops Manager 1.4.x, you must first upgrade RabbitMQ for PCF to at least 1.3.4. This allows RabbitMQ for PCF upgrades after you install Ops Manager 1.4.x.

Note: Only version 1.5.9 and above are certified to work in new installations of Ops Manager 1.7.x.

For more information, refer to the full Product Compatibility Matrix.

Ops Manager Version Supported Upgrades from Imported RabbitMQ Installation
1.6.x, 1.5.x and 1.4.x
  • From 1.4.0 through to 1.5.28
  • From 1.5.9 through to 1.5.28


  • Provision an instance of the RabbitMQ service, which corresponds to a unique RabbitMQ vhost (virtual host)
  • Bind applications to an instance of the plan, providing unique credentials for each binding
  • Management dashboard access to PCF Operators and application developers
  • Deployment across multiple availability zones, with nodes striped across the AZs automatically
  • Enable SSL (Secure Sockets Layer) for the AMQP, MQTT, STOMP protocols
  • 2 node RabbitMQ cluster in a default deployment
  • HAProxy load balancer across all nodes to balance connections
  • Plugin configuration can be easily changed at any time and the cluster redeployed and updated
  • The cluster topology can be changed and easily scaled out
  • Default configurable policy applied to all new instances to mirror queues on two nodes
  • Automated upgrades of RabbitMQ for major, minor and patch releases.

Install via Pivotal Ops Manager

To install RabbitMQ for PCF, follow the procedure for installing Pivotal Ops Manager tiles:

  1. Download the product file from Pivotal Network.
  2. Upload the product file to your Ops Manager installation.
  3. Click Add next to the uploaded product description in the Ops Manager Available Products view to add this product to your staging area.
  4. Click the newly added tile to review any configurable options.
  5. Click Apply Changes to install the service.

This product requires Ops Manager version 1.4.0 or greater.

Using RabbitMQ in your application

RabbitMQ is shown in the services marketplace, either in the Apps Manager or through cf marketplace on the CLI.

Application developers can create an instance of the application with cf create-service p-rabbitmq standard <your name>. For this service an instance equals a Vhost on the RabbitMQ cluster.

Creating a binding gives the user permissions to access this Vhost and associated management dashboard.

Current Limitations

Limitations with the current RabbitMQ for PCF product include:

  • Availability Zone configuration cannot be changed once deployed.

We hope to address all of these limitations in future releases.

Known Issues

  • In versions 1.4.1 and 1.4.2, the manage button for your RabbitMQ instance in Apps Manager will not automatically log you into the RabbitMQ Dashboard. You need to press logout and then login with your username and password which can be obtained from inspecting the environment variables for your instance.
  • In versions 1.5.0 and 1.5.1, when performing a fresh installation or upgrade, if the Elastic Runtime system and application domains are different then the Broker Registrar errand will fail. To resolve this disable the errand and redeploy, then register the broker manually using the system domain route pivotal-rabbitmq-broker.system.domain. For more information on registering brokers see the CloudFoundry documentation.
  • In the 1.5.0, 1.5.1, 1.5.2, 1.5.3 releases, when performing a fresh installation or upgrade, if you have the rabbitmq_jsonrpc_channel or rabbitmq_jsonrpc_channel_examples plugins selected then the RabbitMQ nodes will fail to start. The plugins are no longer distributed with RabbitMQ and plugin validation was introduced in RabbitMQ 3.5.7, causing the nodes to fail to start. To resolve this issue you should install/upgrade to version 1.5.4 or above of the tile.
  • In the 1.4.x and 1.5.x tiles it not possible to install the RabbitMQ tile in multiAZ with multi-subnet networks.
  • It is not possible to upgrade directly from the latest v.1.5.x patch version to the latest v1.6.x patch version. You can only upgrade to a tile which has a higher stemcell version than the one which you have installed.


Please provide any bugs, feature requests, or questions to the Pivotal Cloud Foundry® Feedback list.

Create a pull request or raise an issue on the source for this page in GitHub