RabbitMQ cluster formation - Commands & Configuration

Introduction

When you run multiple RabbitMQ servers, you can connect them to work together as a cluster. This helps share the load and keep messages safe if one server stops working.

When you want to handle more messages than a single RabbitMQ server can manage.

When you need your messaging system to keep working even if one server crashes.

When you want to spread message queues across several servers for better performance.

When you want to add or remove RabbitMQ servers without stopping the whole system.

When you want to manage RabbitMQ servers as a single group instead of individually.

Config File - rabbitmq.conf

rabbitmq.conf

cluster_formation.peer_discovery_backend = classic_config
cluster_formation.classic_config.nodes.1 = rabbit@rabbit1
cluster_formation.classic_config.nodes.2 = rabbit@rabbit2
cluster_formation.classic_config.nodes.3 = rabbit@rabbit3

# Enable the management plugin for monitoring
management.load_definitions = /etc/rabbitmq/definitions.json

# Set node name for each server (example for rabbit1)
# This line should be set in each node's environment or advanced.config
# node.name = rabbit@rabbit1

This configuration file tells RabbitMQ how to find other nodes to form a cluster using the classic config method. It lists the nodes by their names so they can connect.

The management plugin is enabled for monitoring the cluster status.

Each node must have its own name set in its environment or advanced config to identify itself in the cluster.

Commands

Stop the RabbitMQ application on the node to prepare it for clustering commands.

Terminal

rabbitmqctl stop_app

Expected Output

Stopping rabbit application ...

Reset the node to clear any previous cluster data and prepare it to join a new cluster.

Terminal

rabbitmqctl reset

Expected Output

Resetting node ...

Join this node to the cluster where rabbit@rabbit1 is the main node already running the cluster.

Terminal

rabbitmqctl join_cluster rabbit@rabbit1

Expected Output

Clustering node with rabbit@rabbit1 ...

Start the RabbitMQ application again so the node can run as part of the cluster.

Terminal

rabbitmqctl start_app

Expected Output

Starting rabbit application ...

Check the current status of the cluster to verify all nodes are connected.

Terminal

rabbitmqctl cluster_status

Expected Output

Cluster status of node rabbit@rabbit2 ...



[{nodes,[{disc,[rabbit@rabbit1,rabbit@rabbit2]}]}]

Key Concept

If you remember nothing else from this pattern, remember: you must stop the RabbitMQ app, reset the node, join the cluster, then start the app again to form a cluster.

Common Mistakes

Trying to join a cluster without stopping the RabbitMQ application first.

The node will reject the join request because it is still running and has old data.

Always run 'rabbitmqctl stop_app' before 'rabbitmqctl join_cluster'.

Not resetting the node before joining the cluster.

Old cluster data can cause conflicts and prevent the node from joining properly.

Run 'rabbitmqctl reset' after stopping the app and before joining the cluster.

Using incorrect node names or forgetting to set the node name in the environment.

Nodes won't recognize each other and fail to form a cluster.

Ensure each node has a unique name like 'rabbit@rabbit1' set properly before clustering.

Summary

Stop the RabbitMQ app on the node before making cluster changes.

Reset the node to clear old cluster data.

Join the node to the cluster using the main node's name.

Start the RabbitMQ app again to run the node in the cluster.

Check cluster status to confirm all nodes are connected.

Practice

1. What is the main purpose of forming a RabbitMQ cluster?

easy

A. To create multiple independent RabbitMQ servers

B. To backup messages to a single server

C. To connect multiple RabbitMQ servers to work as one system

D. To run RabbitMQ only on one server

Solution

1. Step 1: Understand RabbitMQ clustering

   RabbitMQ clustering connects multiple servers to act as a single messaging system.

2. Step 2: Identify the purpose

   This improves reliability and scalability by sharing workload across servers.

3. Final Answer:

   To connect multiple RabbitMQ servers to work as one system -> Option C

4. Quick Check:

   Cluster = Multiple servers working as one [OK]

Hint: Clusters combine servers for reliability and scale [OK]

Common Mistakes:

• Thinking clusters create independent servers
• Confusing clustering with backup
• Assuming clustering limits to one server

2. Which command sequence correctly joins a RabbitMQ node to an existing cluster?

easy

A. rabbitmqctl start_app; rabbitmqctl stop_app; rabbitmqctl join_cluster rabbit@node1

B. rabbitmqctl start_app; rabbitmqctl join_cluster rabbit@node1; rabbitmqctl stop_app

C. rabbitmqctl join_cluster rabbit@node1; rabbitmqctl stop_app; rabbitmqctl start_app

D. rabbitmqctl stop_app; rabbitmqctl join_cluster rabbit@node1; rabbitmqctl start_app

Solution

1. Step 1: Stop the RabbitMQ application on the joining node

   Use rabbitmqctl stop_app to safely stop the node before joining.

2. Step 2: Join the cluster and restart the application

   Run rabbitmqctl join_cluster rabbit@node1 then rabbitmqctl start_app to join and restart.

3. Final Answer:

   rabbitmqctl stop_app; rabbitmqctl join_cluster rabbit@node1; rabbitmqctl start_app -> Option D

4. Quick Check:

   Stop, join, then start = correct sequence [OK]

Hint: Stop app before join, then start after [OK]

Common Mistakes:

• Starting app before joining cluster
• Joining cluster before stopping app
• Not restarting app after join

3. Given the commands run on a new node:

rabbitmqctl stop_app
rabbitmqctl join_cluster rabbit@node1
rabbitmqctl start_app
rabbitmqctl cluster_status

What output should you expect from cluster_status?

medium

A. Shows the new node and rabbit@node1 as cluster members

B. Shows only rabbit@node1 as cluster member

C. Shows no cluster members

D. Returns an error about cluster status

Solution

1. Step 1: Understand cluster join effect

   After joining and starting, the new node becomes part of the cluster with existing nodes.

2. Step 2: Check cluster_status output

   The command lists all nodes in the cluster, including the new node and rabbit@node1.

3. Final Answer:

   Shows the new node and rabbit@node1 as cluster members -> Option A

4. Quick Check:

   Joined nodes appear in cluster_status [OK]

Hint: cluster_status lists all joined nodes [OK]

Common Mistakes:

• Expecting only original node listed
• Thinking cluster_status shows no nodes
• Assuming cluster_status errors after join

4. You ran these commands on a new node but it failed to join the cluster:

rabbitmqctl join_cluster rabbit@node1
rabbitmqctl stop_app
rabbitmqctl start_app

What is the main error?

medium

A. You must stop the app before joining the cluster

B. You must start the app before joining the cluster

C. The join_cluster command is misspelled

D. You cannot join a cluster without restarting the server

Solution

1. Step 1: Check command order for joining cluster

   The app must be stopped before running join_cluster to avoid errors.

2. Step 2: Identify the mistake in the sequence

   Here, join_cluster was run before stopping the app, causing failure.

3. Final Answer:

   You must stop the app before joining the cluster -> Option A

4. Quick Check:

   Stop app first, then join cluster [OK]

Hint: Always stop app before join_cluster command [OK]

Common Mistakes:

• Running join_cluster before stop_app
• Assuming join_cluster auto-stops app
• Ignoring command order importance

5. You want to form a RabbitMQ cluster with three nodes: rabbit@node1, rabbit@node2, and rabbit@node3. Which sequence of commands on rabbit@node3 correctly forms the cluster assuming rabbit@node1 is the main node?

hard

A. rabbitmqctl stop_app; rabbitmqctl join_cluster rabbit@node2; rabbitmqctl start_app

B. rabbitmqctl stop_app; rabbitmqctl join_cluster rabbit@node1; rabbitmqctl start_app

C. rabbitmqctl start_app; rabbitmqctl join_cluster rabbit@node1; rabbitmqctl stop_app

D. rabbitmqctl join_cluster rabbit@node1; rabbitmqctl stop_app; rabbitmqctl start_app

Solution

1. Step 1: Identify the main node for cluster join

   rabbit@node1 is the main node, so other nodes join it directly.

2. Step 2: Use correct command order on rabbit@node3

   Stop app, join cluster with rabbit@node1, then start app to form cluster properly.

3. Final Answer:

   rabbitmqctl stop_app; rabbitmqctl join_cluster rabbit@node1; rabbitmqctl start_app -> Option B

4. Quick Check:

   Join main node with stop, join, start sequence [OK]

Hint: Join new nodes to main node with stop, join, start [OK]

Common Mistakes:

• Joining to wrong node in cluster
• Starting app before joining
• Incorrect command order causing failure