4.1.5 kick_intent() ¶

-type kick_intent() :: {join,
                        #{node := node(),
                          cluster := cluster_id(),
                          join_intent := join_intent()}} |
                       kicked |
                       autoclean |
                       term().

Kick intent is an arbitrary term passed to classy:pre_kick/2, classy:on_kick_decided/2 and classy:on_leave/2 hooks. pre_kick may use intent to make a decision leaving the cluster in certain cases, while to on_leave this value is merely informational.

Classy itself uses the following intents:

• {join, #{node => node(), cluster => cluster_id(), ...}}: Site is leaving the cluster to immediately join a different one.
• kicked: Site detects that it got kicked from the cluster by a third party.
• autoclean: Site is kicked by the autoclean logic.