Skip to content

Commit

Permalink
docs: added documentation about new event
Browse files Browse the repository at this point in the history
  • Loading branch information
Tbaile committed Mar 15, 2024
1 parent 0820eb6 commit adab15e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/core/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ Events fired by the `cluster` agent (i.e. channel is `cluster/event/<event name>
- `leader-changed`: a node was promoted to leader. The `node_id` attribute
indicates the new leader, and `endpoint` its public Wireguard VPN endpoint address

## Node events

Events fired by the `node` agent (i.e. channel is `node/<node id>/event/<event name>`):
- `fqdn-changed`: the node FQDN has changed. The `hostname` and `domain` attribute describe the new FQDN, while the `node` attribute contains the node ID that originated the event

## Signaling events

To signal an event, just [PUBLISH](https://redis.io/commands/PUBLISH) a message to the channel.
Expand Down

0 comments on commit adab15e

Please sign in to comment.