0Pricing
RabbitMQ Messaging & Async Systems · Lesson

Setting Up a Clustered Environment

Walk through the steps of setting up a multi-node RabbitMQ cluster. Configure nodes to work together and share state for increased availability.

Setting Up a Clustered Environment is a free RabbitMQ Messaging & Async Systems lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the RabbitMQ Messaging & Async Systems learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Ready to Cluster RabbitMQ?

In the previous lesson, we learned about RabbitMQ clustering concepts. Now, let's get practical! We'll walk through the essential steps to set up a multi-node RabbitMQ cluster.

Building a cluster helps your messaging system become more robust and highly available. This means less downtime and more reliable message delivery.

Erlang's Secret Handshake

RabbitMQ nodes are built on Erlang, and they communicate using a shared secret called the Erlang cookie. Think of it as a password that allows nodes to trust each other.

  • Each RabbitMQ node has its own cookie file (~/.erlang.cookie or /var/lib/rabbitmq/.erlang.cookie).
  • For nodes to form a cluster, they MUST have identical Erlang cookies.
  • If cookies don't match, nodes won't be able to communicate or cluster.

Syncing Your Cookies

To ensure nodes can cluster, you need to copy the Erlang cookie from one node to all other nodes in the cluster. Choose one node as the 'source' for the cookie.

Here's how you typically do it (replace node2 with your actual node name/IP):

# On Node 1 (source)
sudo cp /var/lib/rabbitmq/.erlang.cookie /tmp/erlang.cookie.bak
sudo chmod 400 /var/lib/rabbitmq/.erlang.cookie
sudo scp /var/lib/rabbitmq/.erlang.cookie node2:/var/lib/rabbitmq/.erlang.cookie

# On Node 2 (destination)
# Ensure permissions are correct
sudo chmod 400 /var/lib/rabbitmq/.erlang.cookie
sudo chown rabbitmq:rabbitmq /var/lib/rabbitmq/.erlang.cookie

Halt Before You Cluster

Before a node can join an existing cluster or form a new one, its RabbitMQ application must be stopped. This ensures a clean state for the clustering operation.

You'll use the rabbitmqctl stop_app command. This stops the RabbitMQ application but leaves the Erlang VM running.

# On Node 2 (the node joining the cluster)
sudo rabbitmqctl stop_app

Bringing Nodes Together

With the cookie synced and the app stopped, a node can now join the cluster. You'll specify the name of an existing node in the cluster to join.

Use the rabbitmqctl join_cluster <cluster_node_name> command. The cluster_node_name is usually in the format rabbit@hostname.

# On Node 2 (the node joining)
# Assuming Node 1 is 'rabbit@node1'
sudo rabbitmqctl join_cluster rabbit@node1

Restarting the Engines

After a node successfully joins the cluster, you need to start its RabbitMQ application again. It will now operate as part of the cluster.

Use the rabbitmqctl start_app command to bring the RabbitMQ application back online.

# On Node 2 (the node that joined)
sudo rabbitmqctl start_app

Check Your Cluster's Health

It's crucial to verify that all nodes have successfully joined the cluster. The rabbitmqctl cluster_status command shows you the current state of your cluster.

It lists all active nodes, their types (disk or RAM), and other important cluster information.

# On any node in the cluster
sudo rabbitmqctl cluster_status

Disk vs. RAM Nodes

When setting up a cluster, you might encounter disk nodes and RAM nodes. This refers to how a node stores its metadata (like queue definitions, exchange bindings, user data).

  • Disk nodes: Store metadata persistently on disk. At least one disk node is required in a cluster.
  • RAM nodes: Store metadata only in memory. They are faster but lose metadata on restart if not connected to a disk node.
  • Most production clusters use all disk nodes for simplicity and resilience.

Starting Fresh with Reset

Sometimes, a node might fail to join a cluster, or you might want to remove it and add it to a different cluster. In such cases, you can reset the node.

The rabbitmqctl reset command purges all data and state from a node, making it ready to be joined to a new or existing cluster.

# On the node to be reset
sudo rabbitmqctl stop_app
sudo rabbitmqctl reset
sudo rabbitmqctl start_app

Cluster Setup Check

You're setting up a RabbitMQ cluster. You've installed RabbitMQ on two servers, Node A and Node B. You've copied the Erlang cookie from Node A to Node B.

What is the next essential step on Node B before it can successfully join Node A's cluster?

Cluster Setup Summary

Great job! You've learned the practical steps to set up a RabbitMQ cluster. We covered:

  • The importance of the Erlang cookie for node authentication.
  • How to stop, join, and start RabbitMQ applications.
  • Using rabbitmqctl cluster_status to verify your cluster.
  • Briefly understanding disk and RAM nodes.
  • How to reset a node for a fresh start.

Next, we'll explore how to make your queues highly available using mirrored queues!

Frequently asked questions

Is the “Setting Up a Clustered Environment” lesson free?

Yes — the full text of “Setting Up a Clustered Environment” is free to read here on the web, and the RabbitMQ Messaging & Async Systems course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the RabbitMQ Messaging & Async Systems course, upgrade to CoddyKit PRO.

What will I learn in “Setting Up a Clustered Environment”?

Walk through the steps of setting up a multi-node RabbitMQ cluster. Configure nodes to work together and share state for increased availability. You practise RabbitMQ Messaging & Async Systems with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start RabbitMQ Messaging & Async Systems?

No prior experience is required. RabbitMQ Messaging & Async Systems on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Setting Up a Clustered Environment” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this RabbitMQ Messaging & Async Systems lesson?

Yes. Every RabbitMQ Messaging & Async Systems lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

  1. RabbitMQ Clustering Concepts
  2. Setting Up a Clustered Environment
  3. Mirrored Queues for HA
  4. Quorum Queues for Modern HA
← Back to RabbitMQ Messaging & Async Systems