Skip to content

RabbitMQ Configurations

RabbitMQ is used in HyWorks by multiple modules to send, receive, and manage messages to support multiple features, some of which are mentioned below:

  • DVM Push: Desktop agents push session events and heartbeats, and VM Scale Booster (Consumer service) pushes updates to the database, reducing overhead on the HyWorks Controller.

  • HA Notify: HyWorks Controllers push updates about the current HA status (e.g., the current primary server), so modules reading this can connect to the correct primary server.

  • Schedule Action and Notification: The Scheduler and Action Processor components use message queues to perform scheduled actions, then send notifications to agents in the sessions.

Understanding the importance of RabbitMQ in HyWorks deployments, this section will provide detailed information on RabbitMQ configurations(assuming installation is already completed):

RabbitMQ Server Configuration

RabbitMQ settings require modification after installation. A configuration script is provided and needed to execute the following necessary tasks:

  • Create a user in RabbitMQ: This user account will be configured in RabbitMQ to communicate with RabbitMQ from external hosts. A default user will not be allowed to connect from any host other than localhost.

  • Set the Erlang cookie so that the RabbitMQ command works correctly.

  • Configure some plugins and timestamp settings.

Steps to run RabbitMQ Configuration Script:

Follow the steps below to configure the RabbitMQ server for use with HyWorks components:

  1. Log in to the server using administrator-level user credentials.

  2. Make sure the exact versions of Erlang OTP (a prerequisite for RabbitMQ) and RabbitMQ are already installed on the server.

  3. Make sure that the RabbitMQ service is running after the installation is complete.

  4. Run the ConfigureRabbitMQ.bat with admin privileges. Refer to this download link for the Configuration Script for RabbitMQ v3.13.

    1. It will ask you to enter the username and password to configure RabbitMQ.

    2. Enter the username and password, and remember these details. Configure this information in the HyWorks components that use RabbitMQ.

  5. RabbitMQ is ready to be configured into the Accops HyWorks Controller and other components.

    1. This is a non-SSL configuration on port 5672.

    2. Refer to RabbitMQ Advanced Configurations to configure RabbitMQ for SSL communication.