[note]This is a temporary repository to work on the charm events graph while Mermaid support for charmhub lingers in the pipeline. The reference document is https://discourse.charmhub.io/t/a-charms-life/5938; that takes precedence whenever discrepancies may arise.[/note]

This document is about the lifecycle of a charm, specifically the juju events that are used to keep track of it. These events, or 'hooks' to use some old terminology, are relayed to charm code by the Operator Framework in specific sequences depending on what's going on in the juju model.

It is common wisdom that event ordering should not be generally relied upon when coding a charm, to ensure resilience. It can be however useful to understand the logic behind the timing of events, so as to avoid common mistakes and have a better picture of what is happening in your charm. In this document we'll learn how:

• A charm's lifecycle can be seen to consist of three phases, each one with characteristic events and sequences thereof. The fuzziest of the three being the Operation phase, where pretty much anything can happen short of setup events.
• Not all events can be reliably be assumed to occur in specific temporal orders, but some can.

In this document we will not learn:

• What each event means or is typically used to represent about a workload status. For that see the sdk docs.
• What event cascades are triggered by a human administrator running commands through the juju cli. For that see this other doc.

The Graph

flowchart TD
    subgraph Setup
        storage_attached["[*]-storage-attached"]:::optStorageEvent --> install
        install --> relation_created["[*]-relation-created"]:::optRelationEvent
        relation_created --> |leader unit|leader_elected[leader-elected]:::optLeaderEvent
        relation_created --> |non-leader unit|leader_settings_changed[leader-settings-changed]:::optLeaderEvent
        leader_settings_changed --> config_changed[config-changed]
        leader_elected --> config_changed[config-changed]
        config_changed --> start
    end

    subgraph Operation
        workload_events_mant(["`[workload events] 
            (k8s only)`"]):::kubernetesEvent ~~~
        pre_series_upgrade_mant[["`pre-series-upgrade 
            (lxd only)`"]]:::lxdEvent --> 
        post_series_upgrade_mant[["`post-series-upgrade 
            (lxd only)`"]]:::lxdEvent


        update_status[update-status] ~~~
        upgrade_charm[upgrade-charm] --> config_changed_mant[config-changed]

        collect_metrics[collect-metrics] ~~~
        leader_elected_mant[leader-elected]:::leaderEvent ~~~ 
        leader_settings_changed_mant[leader-settings-changed]:::leaderEvent

        relation_joined_mant["[*]-relation-joined"]:::relationEvent -.- relation_departed_mant["[*]-relation-departed"]:::relationEvent
        relation_joined_mant --> relation_changed_mant["[*]-relation-changed"]:::relationEvent 

        relation_created_mant["[*]-relation-created"]:::relationEvent -.- relation_broken_mant["[*]-relation-broken"]:::relationEvent ~~~
        storage_attached_mant["[*]-storage-attached"]:::storageEvent -.- storage_detached_mant["[*]-storage-detached"]:::storageEvent
        
        secret_changed["secret-changed"]:::secretEvent ~~~
        secret_rotate["secret-rotate"]:::secretEvent ~~~
        secret_expire["secret-expire"]:::secretEvent ~~~
        secret_removed["secret-removed"]:::secretEvent 
    end
    
    subgraph Teardown
        relation_broken_teard["[*]-relation-broken"]:::optRelationEvent -->
        storage_detached["[*]-storage-detached"]:::optStorageEvent -->
        stop -->
        remove
    end
    
    Start["(start)"]:::meta --> 
    Setup --> 
    Operation --> 
    Teardown --> 
    End["(end)"]:::meta

classDef relationEvent fill:#f9f5;
classDef secretEvent fill:#f588;
classDef storageEvent fill:#f995;
classDef leaderEvent fill:#5f55;
classDef workloadEvent fill:#faa1,stroke-dasharray: 5 5;
classDef meta fill:#1112,stroke-width:3px;

classDef optRelationEvent fill:#f9f5,stroke-dasharray: 5 5;
classDef optStorageEvent fill:#f995,stroke-dasharray: 5 5;
classDef optLeaderEvent fill:#5f55,stroke-dasharray: 5 5;

classDef kubernetesEvent fill:#77f5;
classDef lxdEvent fill:#2965;

Legend

• (start) and (end) are 'meta' nodes and represent the beginning and end of the lifecycle of a Charm/juju unit. All other nodes represent hooks (events) that can occur during said lifecycle.
• Hard arrows represent strict temporal ordering which is enforced by the juju state machine and respected by the Operator Framework, which mediates between the juju controller and the Charm code.
• Dotted arrows represent a 1:1 relationship between relation events, explained in more detail down in the Operation section.
• The large yellow boxes represent broad phases in the lifecycle. You can read the graph as follows: when you fire up a unit, there is first a setup phase, when that is done the unit enters a operation phase, and when the unit goes there will be a sequence of teardown events. Generally speaking, this guarantees some sort of ordering of the events: events that are unique to the teardown phase can be guaranteed not to be fired during the setup phase. So a stop will never be fired before a start.
• The colors of the event nodes represent a logical but practically meaningless grouping of the events.
  • green for leadership events
  • red for storage events
  • purple for relation events
  • blue for generic lifecycle events

Workload events

Note the [workload events] (k8s only) node in the operation phase. That reprsents all events meant to communicate information about the workload container on kubernetes charms. At the time of writing the only such events are:

• *-pebble-ready
• [pebble-custom-notice]

Both can fire at any time whatsoever during the lifecycle of a charm.

Similarly, the [pre/post]-series-upgrade (lxd only) events can only occur on machine charms at any time during the operation phase.

Notes on the Setup phase

• The only events that are guaranteed to always occur during Setup are start, config-changed and install. The other events only happen if the charm happens to have (peer) relations at install time (e.g. if a charm that already is related to another gets scaled up) or it has storage. Same goes for leadership events. For that reason they are styled with dashed borders.
• config-changed occurs between start and install regardless of whether any leadership (or relation) event fires.
• Any *-relation-created event can occur at Setup time, but if X is a peer relation, then X-relation-created can only occur at Setup, while for non-peer relations, they can occur also during Operation. The reason for this is that a peer relation cannot be created or destroyed 'manually' at arbitrary times, they either exist or not, and if they do exist, then we know it from the start.

Notes on the Operation phase

• update-status is fired automatically and periodically, at a configurable regular interval (default is 5m) which can be configured by juju model-config update-status-hook-interval.
• collect-metrics is fired automatically and periodically in older juju versions, at a regular interval of 5m, AND whenever the user runs juju collect-metrics.
• leader-elected and leader-settings-changed only fire on the leader unit and the non-leader unit(s) respectively.
• There is a square of symmetries between the *-relation-[joined/departed/created/broken] events:
  • Temporal ordering: a X-relation-joined cannot follow a X-relation-departed for the same X. Same goes for *-relation-created and *-relation-broken, as well as *-relation-created and *-relation-changed.
  • Ownership: joined/departed are unit-level events: they fire when an application has a (peer) relation and a new unit joins or leaves. All units (including the newly created or leaving unit), will receive the event. created/broken are relation-level events, in that they fire when two applications become related or a relation is removed (e.g. via juju remove-relation or because an application is destroyed).
  • Number: there is a 1:1 relationship between joined/departed and created/broken: when a unit joins a relation with X other units, X *-relation-joined events will be fired. When a unit leaves, all units will receive a *-relation-departed event (so X of them are fired). Same goes for created/broken when two applications are related or a relationship is broken. Find in appendix 1 a somewhat more elaborate example.
• Technically speaking all events in this box are optional, but I did not style them with dashed borders to avoid clutter. If the charm shuts down immediately after start, it could happen that no operation event is fired.
• A X-relation-joined event is always followed up (immediately after) by a X-relation-changed event. But any number of *-relation-changed events can be fired at any time during operation, and they need not be preceded by a *-relation-joined event.
• There are more temporal orderings than the one displayed here; event chains can be initiated by human operation as detailed in the sdk docs and the leadership docs. For example, it is guaranteed that a leader-elected is always followed by a [settings-changed], and that if you remove the leader unit, you should get *-relation-departed and a leader-settings-changed on the remaining units (although no specific ordering can be guaranteed cfr this bug...).
• Secret events can only occur if your charm uses secrets and the juju controller they're managed by is recent enough.

Notes on the Teardown phase

• Both relation and storage events are guaranteed to fire before stop/remove if they will fire at all. They are optional, in that a departing unit (or application) might have no storage or relations.
• *-relation-broken events in the Teardown phase are fired in case an application is being torn down. These events can also occur at Operation time, if the relation is removed by e.g. a charm or a controller.

Caveats

• Events can be deferred by charm code by calling Event.defer(). That means that the event is put in a queue of deferred events which will get flushed by the operator framework as soon as the next event comes in, and before firing that new event in turn. See Appendix 2 for a visual representation. What this means in practice is that deferring an event can break the temporal ordering of the events as outlined in this graph; defer()ring an event twice will break the ordering guarantees we outlined here. Cf. the appendix for an UML-y representation. Cfr this document on defer for more.
• The events in the Operation phase can interleave in arbitrary ways. For this reason it's essential that hook handlers make no assumptions about each other -- each handler should check its preconditions independently and operate under the assumption that the relative ordering is totally arbitrary -- except relation events, which have some partial ordering as explained above.

Deprecation notices

• collect-metrics is no longer being fired in recent juju versions.
• leader-settings-changed is being deprecated; in a future release it will be gone.
• leader-deposed is a juju hook that was planned but never actually implemented. You may see a WARNING mentioning it in the juju debug-log but you can ignore it.

Event semantics and data

This document is only about the timing of the events; for the 'meaning' of the events, other sources are more appropriate; e.g. juju-events. For the data attached to an event, one should refer to the docstrings in the ops.charm.HookEvent subclass that the event you're expecting in your handler inherits from.

Appendices

Appendix 1: scenario example

This is a representation of the relation events a deployment will receive in a simple scenario that goes as follows:

• We start with two unrelated applications, applicationA and applicationB, with one unit each.
• applicationA and applicationB become related via a relation called R.
• applicationA is scaled up to 2 units.
• applicationA is scaled down to 1 unit.
• applicationA touches the R databag (e.g. during an update-status hook, or as a result of a config-changed, an action, a custom event...).
• The relation R is removed.

Note that many event sequences are marked as 'par' for parallel, which means that the events can be dispatched to the units arbitrarily interleaved.

sequenceDiagram
    participant Juju
    participant applicationA/0
    participant applicationB/0
    participant applicationA/1 
    # find way to add applicationA/1 later...?
    note right of applicationA/1: applicationA does not exist yet

    rect rgb(191, 223, 255)
        note right of Juju: juju relate applicationA:R applicationB:R
        par 
            Juju->>+applicationA/0: R-relation-created
            Juju->>+applicationA/0: R-relation-joined
            Juju->>+applicationA/0: R-relation-changed
        and
            Juju->>+applicationB/0: R-relation-created
            Juju->>+applicationB/0: R-relation-joined
            Juju->>+applicationB/0: R-relation-changed
        end
    end
    rect rgb(150,40,150,.2)
        note right of Juju: juju add-unit applicationA -n1
        note right of applicationA/1: applicationA is created now
        par
            Juju->>+applicationA/1: R-relation-created
            Juju->>+applicationA/1: R-relation-joined
            Juju->>+applicationA/1: R-relation-changed
        and
            Juju->>+applicationB/0: R-relation-joined
            Juju->>+applicationB/0: R-relation-changed
        and
            Juju->>+applicationA/0: R-relation-joined
            Juju->>+applicationA/0: R-relation-changed
        end
    end
    rect rgb(50,200,50,.2)
        note right of Juju: juju remove-unit applicationA -n1
        Juju->>+applicationA/1: R-relation-departed
        Juju->>+applicationA/1: R-relation-broken
        par
            Juju->>+applicationB/0: R-relation-departed
        and
            Juju->>+applicationA/0: R-relation-departed
        end
    end
    note right of applicationA/1: applicationA/1 does not exist anymore
    rect rgb(50,20,50,.2)
        note right of applicationA/0: applicationA/0 charm touches the R databag
        applicationA/0 -->> Juju: [new data]
        par
            Juju->>+applicationA/0: R-relation-changed
        and 
            Juju->>+applicationB/0: R-relation-changed
        end
    end
        rect rgb(250,220,100,.2)
        note right of Juju: juju remove-relation applicationA:R applicationB:R
        par
            Juju->>+applicationA/0: R-relation-departed
            Juju->>+applicationA/0: R-relation-broken
        and
            Juju->>+applicationB/0: R-relation-departed
            Juju->>+applicationB/0: R-relation-broken
        end
    end

Appendix 2: deferring an event

This is the 'normal' way of using defer(): an event event1 comes in but we are not ready to process it; we defer() it; when event2 comes in, the OF will first flush the queue and fire event1, then fire event2. The ordering is preserved: event1 is consumed before event2 by the charm.

sequenceDiagram
    Juju->>Operator Framework: event1
    note right of Operator Framework: event queue = []
    Operator Framework->>+Charm: event1
    Charm->>-Operator Framework: event1.defer()
    note right of Operator Framework: event queue = [event1] 
    Juju->>Operator Framework: event2
    Operator Framework->>+Charm: event1
    note right of Operator Framework: event queue = []
    note right of Charm: consume event1
    Operator Framework->>+Charm: event2
    note right of Charm: consume event2

Suppose now that the charm defers event1 again; then event2 will be processed by the charm before event1 is. event1 will only be fired again once another event, event3, comes in in turn. The result is that the events are consumed in the order: 2-1-3. Beware.

sequenceDiagram
    Juju->>Operator Framework: event1
    note right of Operator Framework: event queue = []
    Operator Framework->>+Charm: event1
    Charm->>-Operator Framework: event1.defer()
    note right of Operator Framework: event queue = [event 1] 
    Juju->>Operator Framework: event2
    Operator Framework->>+Charm: event1
    note right of Operator Framework: event queue = []
    Charm->>-Operator Framework: event1.defer()
    note right of Operator Framework: event queue = [event 1] 
    Operator Framework->>+Charm: event2 
    note right of Charm: consume event2
    Juju->>Operator Framework: event3
    Operator Framework->>+Charm: event1
    note right of Operator Framework: event queue = []
    note right of Charm: consume event1
    Operator Framework->>+Charm: event3 
    note right of Charm: consume event3

LINKS PER EVENT: more information <--!> DISCOURSE POSTS: specific documentation <--!>