IBM Support

How to install RabbitMQ

How To


Summary

RabbitMQ is an enterprise-ready alternative to MemoryMq. While MemoryMq is sufficient for basic and prototyping installations, RabbitMQ is the preferred messaging framework when you need greater reliability and clustering.

Objective

RabbitMQ is a robust message queuing software package that Secret Server uses to communicate with its distributed engines. For detailed information about RabbitMQ go to https://www.rabbitmq.com/

Environment

Important: IBM Security Secret Server supports RabbitMQ that is installed on Windows operating systems only.

Steps

What you should know about RabbitMQ and Encryption

All data sent from or read by Secret Server from RabbitMQ is encrypted. If you would like to add SSL despite the data already being encrypted, follow the "Advanced installation of RabbitMq with TLS" use case. 


Prerequisites:

  • Windows Server 2008 or higher with PowerShell v3 support
  • Nodes hosting RabbitMQ requires at least 128MB of memory available at all times. A minimum of 2GB RAM.
  • Disk space is not an issue, but it must  not go below 50MB (default value) especially if you host RabbitMQ on the same server as Secret Server
  • Minimum 2 vCPUs
  • Ports 5672 (non-SSL) or 5671 (SSL) opened on the machine/firewall
  • SSL certificate (optional). You will need:
  • A server certificate PFX type and a root Certificate Authority certificate CER type.
  • The PFX certificate should have:
    1. A name that matches the RabbitMQ Fully Qualified Machine Name
    2. If you plan on making a RabbitMQ cluster then please add DNS names (SANs) to your certificate
    3. Your certificate needs to be an RSA certificate. CNG isn't supported and installation will fail
  • If you do not have an internal PKI and prefer not to use a public certificate, you can use a self-signed certificate. IBM does not assist with creating or troubleshooting self-signed certificates.


Installation:

In Secret Server:

  1. Navigate to AdminDistributed Engine, and click Manage Site Connectors. Select New Site Connector.
  2. Select Rabbit MQ for the Queue Type
  3. Enter a Name for your new Site Connector, and mark it as Active.
  4. Enter the Host Name of the machine where you plan on installing RabbitMQ. Note that the Engines need to be able to resolve this host name or the connection will fail. Also, inbound firewall rules must be created on the machine that is hosting the connector
  5. Port 5672 is the default port for non-SSL installation.
  6. After the Site Connector is created, you can retrieve the automatically generated cred­­­­­entials by viewing the connector and clicking the View Credentials.
  7. Copy both the User Name and Password to a notepad for use in later steps


On the RabbitMQ Host:

  1. Download the RabbitMQ helper.
  2. Install the helper by running the downloaded MSI.
  3. Review the supported installation use cases here.
  4. Run the helper and run the snip-it(s) from the use case(s) that apply to your need.
  5. After installation completes, the helper will open a web browser to the RabbitMQ management console. There is no need to interact with the site at this time so you can minimize or close the page for now.
  6. Go to your Site Connector page in Secret Server and click Validate Connectivity.
  7. If everything has been set up correctly you will see "Validation Succeeded". If you see "Validation Failed", do the following steps:
    • Ensure the RabbitMQ Windows service is running.
    • Check the logs found under C:\Program Files\Thycotic Software Ltd\RabbitMq Site Connector\log.
    • Check the Secret Server System Log for a full error report.

Troubleshooting

For installation errors, refer to https://thycotic.github.io/rabbitmq-helper/troubleshooting.html

Document Location

Worldwide

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSWHLP","label":"IBM Security Secret Server"},"Component":"","Platform":[{"code":"PF004","label":"Appliance"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB24","label":"Security Software"}}]

Document Information

Modified date:
09 April 2019

UID

ibm10880037