Event 'leader-elected'

Event > List of events > Lifecycle events > leader-elected

Source: ops.LeaderElectedEvent
See also: Leader, How to implement leadership

The leader-elected event is emitted for a unit that is elected as leader. Together with leader-settings-changed, it is one of two “leadership events”. A unit receiving this event can be guaranteed that it will have leadership for approximately 30 seconds (from the moment the event is received). After that time, juju might have elected a different leader. The same holds if the unit checks leadership by Unit.is_leader(): if the result is True, then the unit can be ensured that it has leadership for the next 30s.

Leadership can change while a hook is running. (you could start a hook on unit/0 who is the leader, and while that hook is processing, you lose network connectivity for a long time [more than 30s], and then by the time the hook notices, juju has already moved on to another leader.)

Juju doesn’t guarantee that a leader will see every event: if the leader unit is overloaded long enough for the lease to expire (>30s), then juju will elect a different leader. Events that fired in between would be received units that are not leader yet or not leader anymore.

Contents:

Emission sequence

  • leader-elected is always emitted after peer-relation-created during the Startup phase. However, by the time relation-created runs, juju may already have a leader. This means that, in peer-relation-created handlers, it might already be the case that self.unit.is_leader() returns True even though the unit did not receive a leadership event yet. If the starting unit is not leader, it will receive a leader-settings-changed instead.
Scenario Example Command Resulting Events
Start new unit juju deploy foo
juju add-unit foo
(new leader) install -> (*peer)-relation-created -> leader-elected
  • During the Operation phase, leadership changes can in principle occur at any time, for example if the leader unit is unresponsive for some time. When a leader loses leadership it will only receive a leader-settings-changed event, just like all the other non-leader units. The new leader will receive leader-elected.

It is not possible to select a specific unit and ‘promote’ that unit to leader, or ‘demote’ an existing leader unit. Juju has control over which unit will become leader after the current leader is gone.

However, you can cause leadership change by destroying the leader unit or killing the jujud-machine service in operator charms.
\

  • non-k8s models: juju remove-unit <leader_unit>\
  • operator charms: juju ssh -m <id> -- systemctl stop jujud-machine-<id>\
  • sidecar charms: ssh into the charm container, source the /etc/profile.d/juju-introspection.sh script, and then get access to a few cli tools, including juju_stop_unit.

    That will cause the lease to expire within 60s, and another unit of the same application will be elected leader and receive leader-elected.
  • If the leader unit is removed, then one of the remaining units will be elected as leader and see the leader-elected event; all the other remaining units will see leader-settings-changed. If the leader unit was not removed, no leadership events will be fired on any units.

Note that unless there’s only one unit left, it is impossible to predict or control which one of the remaining units will be elected as the new leader.

Scenario Example Command Resulting Events
Current leader loses leadership juju remove-unit foo (new leader): leader-elected
(all other foo units): leader-settings-changed

Observing this event in Ops

In ops, you can observe this event like you would any other:

# in MyCharm.__init__
self.framework.observe(self.on.leader_elected, self._on_leader_elected)

The leader-elected event object does not expose any specific attributes.

You can test for leadership at any time with Charm.unit.is_leader(). This is an instant check, whose result is never cached by ops. See this for more.

When writing unit tests with the OF harness, leadership is set with self.harness.set_leader(True) (ops.testing.Harness.set_leader).

Behind the scenes, OF uses the hook-tools is-leader, leader-set and leader-get to interact with juju regarding leadership.

Last updated 8 months ago. Help improve this document in the forum.