HiveMQ Logo

Etcd Cluster Discovery Extension

HiveMQ Extension

Category: Cluster Discovery
Version: 0.1   |   License: Apache
Provider: MaibornWolff    |   Verified: no

Product Resources
Please use the following links to download and try the extension, read the installation guide, learn more about features, or find out how we can help.


This HiveMQ extension allows your HiveMQ cluster nodes to discover each other dynamically by regularly exchanging their information via etcd.

HiveMQ instances are added at runtime as soon as they become available by placing their information, on how to connect to them, to the configured key. The extension will regularly check the configured etcd key for files from other HiveMQ nodes. Additionally every broker updates its own entry on a regular basis to prevent the entry from expiring.

How to install


The information each node writes into etcd consists of an ip-address and a port. The ip-address and port are taken from the external-address and external-port which is configured in the cluster transport (config.xml). If they are not set, the bind-address and bind-port will be used.

The can be reloaded during runtime.

Configuration from will always take precedent over environment variables.

General Configuration

Config name Environment Required Description
key HIVEMQ_ETCD_KEY Key to store discovery entries at
etcd-endpoint HIVEMQ_ETCD_ENDPOINT x The region in which this S3 bucket resides.
etcd-port HIVEMQ_ETCD_PORT etcd port to connect at
expiration HIVEMQ_ETCD_EXPIRATION Time in seconds after which an entry in etcd is considered expired
update-interval HIVEMQ_ETCD_UPDATE_INTERVAL Time in seconds after which an entry in etcd is refreshed (Must be smaller than file-expiration)
use-tls HIVEMQ_ETCD_USE_TLS Use TLS for connection to etcd
ca-path HIVEMQ_ETCD_CA_PATH Certificate authority to use for validating tls connection to etcd - if not set, system certificates will be used

Default Configuration


Need Help?

We're always happy to answer any questions you may have during installation. The best place to get in contact is our community forum.

Contact Sales

If you have any questions about this product or any others, please contact our sales team here.

Back to marketplace