History

JimMoen 5e100f52b8 style: erlfmt all `rebar.config` files and `bin/nodetool`		2023-12-29 09:08:03 +08:00
..
etc	chore: remove unused conf comments	2023-05-22 14:01:49 +08:00
src	fix(dialyzer): fix some dialyzer issues found on otp 26	2023-12-06 20:32:49 +01:00
test	test: replace 'slave' and 'ct_slave' with 'peer'	2023-12-01 08:07:09 +01:00
BSL.txt	chore(rebalance): move apps from lib-ee, add READMEs	2023-05-09 20:51:24 +05:00
README.md	chore(rebalance): move apps from lib-ee, add READMEs	2023-05-09 20:51:24 +05:00
rebar.config	style: erlfmt all `rebar.config` files and `bin/nodetool`	2023-12-29 09:08:03 +08:00

README.md

EMQX Eviction Agent

emqx_eviction_agent is a part of the node evacuation/node rebalance feature in EMQX. It is a low-level application that encapsulates working with actual MQTT connections.

Application Responsibilities

emqx_eviction_agent application:

Blocks incoming connection to the node it is running on.
Serves as a facade for connection/session eviction operations.
Reports blocking status via HTTP API.

The emqx_eviction_agent is relatively passive and has no eviction/rebalancing logic. It allows emqx_node_rebalance to perform eviction/rebalancing operations using high-level API, without having to deal with MQTT connections directly.

EMQX Integration

emqx_eviction_agent interacts with the following EMQX components:

emqx_cm - to get the list of active MQTT connections;
emqx_hooks subsystem - to block/unblock incoming connections;
emqx_channel and the corresponding connection modules to perform the eviction.

User Facing API

The application provided a very simple API (CLI and HTTP) to inspect the current blocking status.

Documentation

The rebalancing concept is described in the corresponding EIP.

Contributing

Please see our contributing.md.