2017-06-09 08:24:16 +08:00
# RabbitMQ Peer Discovery Etcd
2018-02-16 00:05:45 +08:00
This is an etcd-based implementation of RabbitMQ [peer discovery interface ](http://www.rabbitmq.com/blog/2018/02/12/peer-discovery-subsystem-in-rabbitmq-3-7/ )
2017-06-09 08:24:16 +08:00
(new in 3.7.0, previously available in the [rabbitmq-autocluster plugin ](https://github.com/rabbitmq/rabbitmq-autocluster )
by Gavin Roy).
2018-01-19 22:47:27 +08:00
This plugin only performs peer discovery and most basic node health monitoring
using [etcd ](https://coreos.com/etcd/ ) as a data source.
Please get familiar with [RabbitMQ clustering fundamentals ](https://rabbitmq.com/clustering.html ) 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 ](https://rabbitmq.com/monitoring.html )
are not in scope for this plugin.
2017-06-09 08:24:16 +08:00
## Supported RabbitMQ Versions
This plugin requires RabbitMQ 3.7.0 or later.
2018-07-19 22:25:41 +08:00
## Supported etcd Versions
2020-04-03 20:29:42 +08:00
The plugin supports etcd 3.4 or later and uses the current stable v3 gRPC API.
2017-06-09 08:24:16 +08:00
2018-02-16 00:05:45 +08:00
## Installation
2019-09-10 21:25:02 +08:00
This plugin ships with [supported RabbitMQ versions ](https://www.rabbitmq.com/versions.html ).
There is no need to install it separately.
As with any [plugin ](https://rabbitmq.com/plugins.html ), it must be enabled before it
can be used. For peer discovery plugins it means they must be [enabled ](https://rabbitmq.com//plugins.html#basics ) or [preconfigured ](https://rabbitmq.com//plugins.html#enabled-plugins-file )
before first node boot:
2018-02-16 00:05:45 +08:00
```
rabbitmq-plugins --offline enable rabbitmq_peer_discovery_etcd
```
2017-12-21 21:25:21 +08:00
## Documentation
2018-01-19 22:47:27 +08:00
See [RabbitMQ Cluster Formation guide ](https://www.rabbitmq.com/cluster-formation.html ).
2017-12-21 21:25:21 +08:00
2017-06-09 08:24:16 +08:00
## Contributing
See [CONTRIBUTING.md ](./CONTRIBUTING.md ) and our [development process overview ](http://www.rabbitmq.com/github.html ).
## License
[Licensed under the MPL ](LICENSE-MPL-RabbitMQ ), same as RabbitMQ server.
## Copyright
2024-02-06 01:26:25 +08:00
(c) 2007-2024 Broadcom. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
