History

Michal Kuratczyk 4a4b8bea60 Don't meck rabbit_log		2025-07-18 08:43:04 +02:00
..
examples/compose_consul_haproxy	…
include	Bump (c) line year	2025-01-01 17:54:10 -05:00
priv/schema	Bump (c) line year	2025-01-01 17:54:10 -05:00
src	[skip ci] Simplify logging around peer discovery	2025-07-18 08:43:03 +02:00
test	Don't meck rabbit_log	2025-07-18 08:43:04 +02:00
.gitignore	Cleanup .gitignore files for the monorepo	2024-06-28 12:00:52 +02:00
CODE_OF_CONDUCT.md	…
CONTRIBUTING.md	…
LICENSE	Replace @rabbitmq.com addresses with rabbitmq-core@groups.vmware.com	2023-06-20 15:40:13 +04:00
LICENSE-MPL-RabbitMQ	…
Makefile	Use Erlang.mk's native Elixir support for CLI	2025-03-18 10:02:49 +01:00
README.md	More missed license header updates #9969	2024-02-05 12:26:25 -05:00

README.md

RabbitMQ Peer Discovery Consul

This is a Consul-based implementation of RabbitMQ peer discovery interface (new in 3.7.0, previously available in the rabbitmq-autocluster plugin by Gavin Roy).

This plugin only performs peer discovery and most basic node health monitoring using Consul as a data source. Please get familiar with RabbitMQ clustering fundamentals before attempting to use it.

While it may seem at times that this is a RabbitMQ cluster management solution, it is not. Cluster provisioning and most of Day 2 operations such as proper monitoring are not in scope for this plugin.

Supported RabbitMQ Versions

This plugin requires RabbitMQ 3.7.0 or later.

For a Consul-based peer discovery and cluster formation mechanism that supports 3.6.x, see rabbitmq-autocluster.

Installation

This plugin ships with supported RabbitMQ versions. There is no need to install it separately.

As with any plugin, it must be enabled before it can be used. For peer discovery plugins it means they must be enabled or preconfigured before first node boot:

rabbitmq-plugins --offline enable rabbitmq_peer_discovery_consul

Documentation

See RabbitMQ Cluster Formation guide.

Contributing

See CONTRIBUTING.md and our development process overview.

License

Licensed under the MPL, same as RabbitMQ server.