Welcome to The Operator Framework’s documentation!

ops package

The Charmed Operator Framework.

The Charmed Operator Framework allows the development of operators in a simple and straightforward way, using standard Python structures to allow for clean, maintainable, and reusable code.

A Kubernetes operator is a container that drives lifecycle management, configuration, integration and daily actions for an application. Operators simplify software management and operations. They capture reusable app domain knowledge from experts in a software component that can be shared.

The Charmed Operator Framework extends the “operator pattern” to enable Charmed Operators, packaged as and often referred to as “charms”. Charms are not just for Kubernetes but also operators for traditional Linux or Windows application management. Operators use an Operator Lifecycle Manager (OLM), like Juju, to coordinate their work in a cluster. The system uses Golang for concurrent event processing under the hood, but enables the operators to be written in Python.

Operators should do one thing and do it well. Each operator drives a single application or service and can be composed with other operators to deliver a complex application or service. An operator handles instantiation, scaling, configuration, optimisation, networking, service mesh, observability, and day-2 operations specific to that application.

Full developer documentation is available at https://juju.is/docs/sdk.

Submodules

ops.charm module

Base objects for the Charm, events and metadata.

class ops.charm.HookEvent(handle)

Bases: ops.framework.EventBase

Events raised by Juju to progress a charm’s lifecycle.

Hooks are callback methods of a charm class (a subclass of CharmBase) that are invoked in response to events raised by Juju. These callback methods are the means by which a charm governs the lifecycle of its application.

The HookEvent class is the base of a type hierarchy of events related to the charm’s lifecycle.

HookEvent subtypes are grouped into the following categories

• Core lifecycle events

• Relation events

• Storage events

• Metric events

Parameters

handle (ops.framework.Handle) –

class ops.charm.ActionEvent(handle)

Bases: ops.framework.EventBase

Events raised by Juju when an administrator invokes a Juju Action.

This class is the data type of events triggered when an administrator invokes a Juju Action. Callbacks bound to these events may be used for responding to the administrator’s Juju Action request.

To read the parameters for the action, see the instance variable params. To respond with the result of the action, call set_results(). To add progress messages that are visible as the action is progressing use log().

Parameters

handle (ops.framework.Handle) –

params

The parameters passed to the action.

defer()

Action events are not deferable like other events.

This is because an action runs synchronously and the administrator is waiting for the result.

restore(snapshot)

Used by the operator framework to record the action.

Not meant to be called directly by charm code.

Parameters

snapshot (dict) –

Return type

None

set_results(results)

Report the result of the action.

Parameters

results (Mapping) – The result of the action as a Dict

Return type

None

log(message)

Send a message that a user will see while the action is running.

Parameters

message (str) – The message for the user.

Return type

None

fail(message='')

Report that this action has failed.

Parameters

message (str) – Optional message to record why it has failed.

Return type

None

class ops.charm.InstallEvent(handle)

Bases: ops.charm.HookEvent

Event triggered when a charm is installed.

This event is triggered at the beginning of a charm’s lifecycle. Any associated callback method should be used to perform one-time setup operations, such as installing prerequisite software.

Parameters

handle (ops.framework.Handle) –

class ops.charm.StartEvent(handle)

Bases: ops.charm.HookEvent

Event triggered immediately after first configuration change.

This event is triggered immediately after the first ConfigChangedEvent. Callback methods bound to the event should be used to ensure that the charm’s software is in a running state. Note that the charm’s software should be configured so as to persist in this state through reboots without further intervention on Juju’s part.

Parameters

handle (ops.framework.Handle) –

class ops.charm.StopEvent(handle)

Bases: ops.charm.HookEvent

Event triggered when a charm is shut down.

This event is triggered when an application’s removal is requested by the client. The event fires immediately before the end of the unit’s destruction sequence. Callback methods bound to this event should be used to ensure that the charm’s software is not running, and that it will not start again on reboot.

Parameters

handle (ops.framework.Handle) –

class ops.charm.RemoveEvent(handle)

Bases: ops.charm.HookEvent

Event triggered when a unit is about to be terminated.

This event fires prior to Juju removing the charm and terminating its unit.

Parameters

handle (ops.framework.Handle) –

class ops.charm.ConfigChangedEvent(handle)

Bases: ops.charm.HookEvent

Event triggered when a configuration change is requested.

This event fires in several different situations.

• immediately after the install event.

• after a relation is created.

• after a leader is elected.

• after changing charm configuration using the GUI or command line interface

• when the charm starts.

• when a new unit joins a relation.

• when there is a change to an existing relation.

Any callback method bound to this event cannot assume that the software has already been started; it should not start stopped software, but should (if appropriate) restart running software to take configuration changes into account.

Parameters

handle (ops.framework.Handle) –

class ops.charm.UpdateStatusEvent(handle)

Bases: ops.charm.HookEvent

Event triggered by a status update request from Juju.

This event is periodically triggered by Juju so that it can provide constant feedback to the administrator about the status of the application the charm is modeling. Any callback method bound to this event should determine the “health” of the application and set the status appropriately.

The interval between update-status events can be configured model-wide, e.g. juju model-config update-status-hook-interval=1m.

Parameters

handle (ops.framework.Handle) –

class ops.charm.UpgradeCharmEvent(handle)

Bases: ops.charm.HookEvent

Event triggered by request to upgrade the charm.

This event will be triggered when an administrator executes juju upgrade-charm. The event fires after Juju has unpacked the upgraded charm code, and so this event will be handled by the callback method bound to the event in the new codebase. The associated callback method is invoked provided there is no existing error state. The callback method should be used to reconcile current state written by an older version of the charm into whatever form that is needed by the current charm version.

Parameters

handle (ops.framework.Handle) –

class ops.charm.PreSeriesUpgradeEvent(handle)

Bases: ops.charm.HookEvent

Event triggered to prepare a unit for series upgrade.

This event triggers when an administrator executes juju upgrade-series MACHINE prepare. The event will fire for each unit that is running on the specified machine. Any callback method bound to this event must prepare the charm for an upgrade to the series. This may include things like exporting database content to a version neutral format, or evacuating running instances to other machines.

It can be assumed that only after all units on a machine have executed the callback method associated with this event, the administrator will initiate steps to actually upgrade the series. After the upgrade has been completed, the PostSeriesUpgradeEvent will fire.

Parameters

handle (ops.framework.Handle) –

class ops.charm.PostSeriesUpgradeEvent(handle)

Bases: ops.charm.HookEvent

Event triggered after a series upgrade.

This event is triggered after the administrator has done a distribution upgrade (or rolled back and kept the same series). It is called in response to juju upgrade-series MACHINE complete. Associated charm callback methods are expected to do whatever steps are necessary to reconfigure their applications for the new series. This may include things like populating the upgraded version of a database. Note however charms are expected to check if the series has actually changed or whether it was rolled back to the original series.

Parameters

handle (ops.framework.Handle) –

class ops.charm.LeaderElectedEvent(handle)

Bases: ops.charm.HookEvent

Event triggered when a new leader has been elected.

Juju will trigger this event when a new leader unit is chosen for a given application.

This event fires at least once after Juju selects a leader unit. Callback methods bound to this event may take any action required for the elected unit to assert leadership. Note that only the elected leader unit will receive this event.

Parameters

handle (ops.framework.Handle) –

class ops.charm.LeaderSettingsChangedEvent(handle)

Bases: ops.charm.HookEvent

Event triggered when leader changes any settings.

DEPRECATED NOTICE

This event has been deprecated in favor of using a Peer relation, and having the leader set a value in the Application data bag for that peer relation. (see RelationChangedEvent).

Parameters

handle (ops.framework.Handle) –

class ops.charm.CollectMetricsEvent(handle)

Bases: ops.charm.HookEvent

Event triggered by Juju to collect metrics.

Juju fires this event every five minutes for the lifetime of the unit. Callback methods bound to this event may use the add_metrics() method of this class to send measurements to Juju.

Note that associated callback methods are currently sandboxed in how they can interact with Juju.

Parameters

handle (ops.framework.Handle) –

add_metrics(metrics, labels=None)

Record metrics that have been gathered by the charm for this unit.

Parameters

• metrics (Mapping) – A collection of {key: float} pairs that contains the metrics that have been gathered

• labels (Optional[Mapping]) – {key:value} strings that can be applied to the metrics that are being gathered

Return type

None

class ops.charm.RelationEvent(handle, relation, app=None, unit=None)

Bases: ops.charm.HookEvent

A base class representing the various relation lifecycle events.

Relation lifecycle events are generated when application units participate in relations. Units can only participate in relations after they have been “started”, and before they have been “stopped”. Within that time window, the unit may participate in several different relations at a time, including multiple relations with the same name.

relation

The Relation involved in this event

app

The remote Application that has triggered this event

unit

The remote Unit that has triggered this event. This may be None if the relation event was triggered as an Application level event

snapshot()

Used by the framework to serialize the event to disk.

Not meant to be called by charm code.

Return type

dict

restore(snapshot)

Used by the framework to deserialize the event from disk.

Not meant to be called by charm code.

Parameters

snapshot (dict) –

Return type

None

class ops.charm.RelationCreatedEvent(handle, relation, app=None, unit=None)

Bases: ops.charm.RelationEvent

Event triggered when a new relation is created.

This is triggered when a new relation to another app is added in Juju. This can occur before units for those applications have started. All existing relations should be established before start.

class ops.charm.RelationJoinedEvent(handle, relation, app=None, unit=None)

Bases: ops.charm.RelationEvent

Event triggered when a new unit joins a relation.

This event is triggered whenever a new unit of a related application joins the relation. The event fires only when that remote unit is first observed by the unit. Callback methods bound to this event may set any local unit settings that can be determined using no more than the name of the joining unit and the remote private-address setting, which is always available when the relation is created and is by convention not deleted.

class ops.charm.RelationChangedEvent(handle, relation, app=None, unit=None)

Bases: ops.charm.RelationEvent

Event triggered when relation data changes.

This event is triggered whenever there is a change to the data bucket for a related application or unit. Look at event.relation.data[event.unit/app] to see the new information, where event is the event object passed to the callback method bound to this event.

This event always fires once, after RelationJoinedEvent, and will subsequently fire whenever that remote unit changes its settings for the relation. Callback methods bound to this event should be the only ones that rely on remote relation settings. They should not error if the settings are incomplete, since it can be guaranteed that when the remote unit or application changes its settings, the event will fire again.

The settings that may be queried, or set, are determined by the relation’s interface.

class ops.charm.RelationDepartedEvent(handle, relation, app=None, unit=None, departing_unit_name=None)

Bases: ops.charm.RelationEvent

Event triggered when a unit leaves a relation.

This is the inverse of the RelationJoinedEvent, representing when a unit is leaving the relation (the unit is being removed, the app is being removed, the relation is being removed). For remaining units, this event is emitted once for each departing unit. For departing units, this event is emitted once for each remaining unit.

Callback methods bound to this event may be used to remove all references to the departing remote unit, because there’s no guarantee that it’s still part of the system; it’s perfectly probable (although not guaranteed) that the system running that unit has already shut down.

Once all callback methods bound to this event have been run for such a relation, the unit agent will fire the RelationBrokenEvent.

departing_unit

The Unit that is departing. This can facilitate determining e.g. whether you are the departing unit.

property departing_unit

The ops.model.Unit that is departing, if any.

snapshot()

Used by the framework to serialize the event to disk.

Not meant to be called by charm code.

Return type

dict

restore(snapshot)

Used by the framework to deserialize the event from disk.

Not meant to be called by charm code.

Parameters

snapshot (dict) –

Return type

None

class ops.charm.RelationBrokenEvent(handle, relation, app=None, unit=None)

Bases: ops.charm.RelationEvent

Event triggered when a relation is removed.

If a relation is being removed (juju remove-relation or juju remove-application), once all the units have been removed, this event will fire to signal that the relationship has been fully terminated.

The event indicates that the current relation is no longer valid, and that the charm’s software must be configured as though the relation had never existed. It will only be called after every callback method bound to RelationDepartedEvent has been run. If a callback method bound to this event is being executed, it is guaranteed that no remote units are currently known locally.

class ops.charm.StorageEvent(handle, storage)

Bases: ops.charm.HookEvent

Base class representing storage-related events.

Juju can provide a variety of storage types to a charms. The charms can define several different types of storage that are allocated from Juju. Changes in state of storage trigger sub-types of StorageEvent.

snapshot()

Used by the framework to serialize the event to disk.

Not meant to be called by charm code.

Return type

dict

restore(snapshot)

Used by the framework to deserialize the event from disk.

Not meant to be called by charm code.

Parameters

snapshot (dict) –

Return type

None

class ops.charm.StorageAttachedEvent(handle, storage)

Bases: ops.charm.StorageEvent

Event triggered when new storage becomes available.

This event is triggered when new storage is available for the charm to use.

Callback methods bound to this event allow the charm to run code when storage has been added. Such methods will be run before the InstallEvent fires, so that the installation routine may use the storage. The name prefix of this hook will depend on the storage key defined in the metadata.yaml file.

class ops.charm.StorageDetachingEvent(handle, storage)

Bases: ops.charm.StorageEvent

Event triggered prior to removal of storage.

This event is triggered when storage a charm has been using is going away.

Callback methods bound to this event allow the charm to run code before storage is removed. Such methods will be run before storage is detached, and always before the StopEvent fires, thereby allowing the charm to gracefully release resources before they are removed and before the unit terminates. The name prefix of the hook will depend on the storage key defined in the metadata.yaml file.

class ops.charm.WorkloadEvent(handle, workload)

Bases: ops.charm.HookEvent

Base class representing workload-related events.

Workload events are generated for all containers that the charm expects in metadata. Workload containers currently only trigger a PebbleReadyEvent.

workload

The Container involved in this event. Workload currently only can be a Container but in future may be other types that represent the specific workload type e.g. a Machine.

snapshot()

Used by the framework to serialize the event to disk.

Not meant to be called by charm code.

Return type

dict

restore(snapshot)

Used by the framework to deserialize the event from disk.

Not meant to be called by charm code.

Parameters

snapshot (dict) –

Return type

None

class ops.charm.PebbleReadyEvent(handle, workload)

Bases: ops.charm.WorkloadEvent

Event triggered when pebble is ready for a workload.

This event is triggered when the Pebble process for a workload/container starts up, allowing the charm to configure how services should be launched.

Callback methods bound to this event allow the charm to run code after a workload has started its Pebble instance and is ready to receive instructions regarding what services should be started. The name prefix of the hook will depend on the container key defined in the metadata.yaml file.

class ops.charm.CharmEvents(parent=None, key=None)

Bases: ops.framework.ObjectEvents

Events generated by Juju pertaining to application lifecycle.

This class is used to create an event descriptor (self.on) attribute for a charm class that inherits from CharmBase. The event descriptor may be used to set up event handlers for corresponding events.

By default the following events will be provided through CharmBase:

self.on.install
self.on.start
self.on.remove
self.on.update_status
self.on.config_changed
self.on.upgrade_charm
self.on.pre_series_upgrade
self.on.post_series_upgrade
self.on.leader_elected
self.on.collect_metrics

In addition to these, depending on the charm’s metadata (metadata.yaml), named relation and storage events may also be defined. These named events are created by CharmBase using charm metadata. The named events may be accessed as self.on[<name>].<relation_or_storage_event>

install

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

start

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

stop

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

remove

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

update_status

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

config_changed

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

upgrade_charm

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

pre_series_upgrade

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

post_series_upgrade

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

leader_elected

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

leader_settings_changed

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

collect_metrics

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

class ops.charm.CharmBase(framework, key=None)

Bases: ops.framework.Object

Base class that represents the charm overall.

CharmBase is used to create a charm. This is done by inheriting from CharmBase and customising the sub class as required. So to create your own charm, say MyCharm, define a charm class and set up the required event handlers (“hooks”) in its constructor:

import logging

from ops.charm import CharmBase
from ops.main import main

logger = logging.getLogger(__name__)

def MyCharm(CharmBase):
    def __init__(self, *args):
        logger.debug('Initializing Charm')

        super().__init__(*args)

        self.framework.observe(self.on.config_changed, self._on_config_changed)
        self.framework.observe(self.on.stop, self._on_stop)
        # ...

if __name__ == "__main__":
    main(MyCharm)

As shown in the example above, a charm class is instantiated by main() rather than charm authors directly instantiating a charm.

Parameters

• framework (ops.framework.Framework) – The framework responsible for managing the Model and events for this charm.

• key (Optional) – Ignored; will remove after deprecation period of the signature change.

on

Used to set up event handlers; see CharmEvents.

property app

Application that this unit is part of.

property unit

Unit that this execution is responsible for.

property meta

Metadata of this charm.

property charm_dir

Root directory of the charm as it is running.

property config

A mapping containing the charm’s config and current values.

class ops.charm.CharmMeta(raw=None, actions_raw=None)

Bases: object

Object containing the metadata for the charm.

This is read from metadata.yaml and/or actions.yaml. Generally charms will define this information, rather than reading it at runtime. This class is mostly for the framework to understand what the charm has defined.

The maintainers, tags, terms, series, and extra_bindings attributes are all lists of strings. The containers, requires, provides, peers, relations, storages, resources, and payloads attributes are all mappings of names to instances of the respective RelationMeta, StorageMeta, ResourceMeta, or PayloadMeta.

The relations attribute is a convenience accessor which includes all of the requires, provides, and peers RelationMeta items. If needed, the role of the relation definition can be obtained from its role attribute.

name

The name of this charm

summary

Short description of what this charm does

description

Long description for this charm

maintainers

A list of strings of the email addresses of the maintainers of this charm.

tags

Charm store tag metadata for categories associated with this charm.

terms

Charm store terms that should be agreed to before this charm can be deployed. (Used for things like licensing issues.)

series

The list of supported OS series that this charm can support. The first entry in the list is the default series that will be used by deploy if no other series is requested by the user.

subordinate

True/False whether this charm is intended to be used as a subordinate charm.

min_juju_version

If supplied, indicates this charm needs features that are not available in older versions of Juju.

containers

A dict of {name: ContainerMeta } for each of the ‘containers’ declared by this charm in the matadata.yaml file.

requires

A dict of {name: RelationMeta } for each ‘requires’ relation.

provides

A dict of {name: RelationMeta } for each ‘provides’ relation.

peers

A dict of {name: RelationMeta } for each ‘peer’ relation.

relations

A dict containing all RelationMeta attributes (merged from other sections)

storages

A dict of {name: StorageMeta} for each defined storage.

resources

A dict of {name: ResourceMeta} for each defined resource.

payloads

A dict of {name: PayloadMeta} for each defined payload.

extra_bindings

A dict of additional named bindings that a charm can use for network configuration.

actions

A dict of {name: ActionMeta} for actions that the charm has defined.

Parameters

• raw (dict) – a mapping containing the contents of metadata.yaml

• actions_raw (dict) – a mapping containing the contents of actions.yaml

classmethod from_yaml(metadata, actions=None)

Instantiate a CharmMeta from a YAML description of metadata.yaml.

Parameters

• metadata (Union[str, TextIO]) – A YAML description of charm metadata (name, relations, etc.) This can be a simple string, or a file-like object. (passed to yaml.safe_load).

• actions (Optional[Union[str, TextIO]]) – YAML description of Actions for this charm (eg actions.yaml)

class ops.charm.RelationRole(value)

Bases: enum.Enum

An annotation for a charm’s role in a relation.

For each relation a charm’s role may be

• A Peer

• A service consumer in the relation (‘requires’)

• A service provider in the relation (‘provides’)

peer = 'peer'

requires = 'requires'

provides = 'provides'

is_peer()

Return whether the current role is peer.

A convenience to avoid having to import charm.

Return type

bool

class ops.charm.RelationMeta(role, relation_name, raw)

Bases: object

Object containing metadata about a relation definition.

Should not be constructed directly by charm code. Is gotten from one of CharmMeta.peers, CharmMeta.requires, CharmMeta.provides, or CharmMeta.relations.

Parameters

• role (ops.charm.RelationRole) –

• relation_name (str) –

• raw (dict) –

role

This is RelationRole; one of peer/requires/provides

relation_name

Name of this relation from metadata.yaml

interface_name

Optional definition of the interface protocol.

limit

Optional definition of maximum number of connections to this relation endpoint.

scope

“global” (default) or “container” scope based on how the relation should be used.

VALID_SCOPES = ['global', 'container']

class ops.charm.StorageMeta(name, raw)

Bases: object

Object containing metadata about a storage definition.

storage_name

Name of storage

type

Storage type

description

A text description of the storage

read_only

Whether or not the storage is read only

minimum_size

Minimum size of storage

location

Mount point of storage

multiple_range

Range of numeric qualifiers when multiple storage units are used

class ops.charm.ResourceMeta(name, raw)

Bases: object

Object containing metadata about a resource definition.

resource_name

Name of resource

filename

Name of file

description

A text description of resource

class ops.charm.PayloadMeta(name, raw)

Bases: object

Object containing metadata about a payload definition.

payload_name

Name of payload

type

Payload type

class ops.charm.ActionMeta(name, raw=None)

Bases: object

Object containing metadata about an action’s definition.

class ops.charm.ContainerMeta(name, raw)

Bases: object

Metadata about an individual container.

NOTE: this is extremely lightweight right now, and just includes the fields we need for Pebble interaction.

name

Name of container (key in the YAML)

mounts

ContainerStorageMeta mounts available to the container

property mounts

An accessor for the mounts in a container.

Dict keys match key name in StorageMeta

Example:

storage:
  foo:
    type: filesystem
    location: /test
containers:
  bar:
    mounts:
      - storage: foo
      - location: /test/mount

class ops.charm.ContainerStorageMeta(storage, location)

Bases: object

Metadata about storage for an individual container.

storage

a name for the mountpoint, which should exist the keys for StorageMeta for the charm

location

the location storage is mounted at

locations

a list of mountpoints for the key

If multiple locations are specified for the same storage, such as Kubernetes subPath mounts, location will not be an accessible attribute, as it would not be possible to determine which mount point was desired, and locations should be iterated over.

add_location(location)

Add an additional mountpoint to a known storage.

property locations

An accessor for the list of locations for a mount.

ops.framework module

The Operator Framework infrastructure.

class ops.framework.Handle(parent, kind, key)

Bases: object

Handle defines a name for an object in the form of a hierarchical path.

The provided parent is the object (or that object’s handle) that this handle sits under, or None if the object identified by this handle stands by itself as the root of its own hierarchy.

The handle kind is a string that defines a namespace so objects with the same parent and kind will have unique keys.

The handle key is a string uniquely identifying the object. No other objects under the same parent and kind may have the same key.

Parameters

• parent (Optional[_ParentHandle]) –

• kind (str) –

• key (str) –

nest(kind, key)

Create a new handle as child of the current one.

Parameters

• kind (str) –

• key (str) –

property parent

Return own parent handle.

property kind

Return the handle’s kind.

property key

Return the handle’s key.

property path

Return the handle’s path.

classmethod from_path(path)

Build a handle from the indicated path.

class ops.framework.EventBase(handle)

Bases: object

The base for all the different Events.

Inherit this and override ‘snapshot’ and ‘restore’ methods to build a custom event.

Parameters

handle (ops.framework.Handle) –

framework = None

defer()

Defer the event to the future.

Deferring an event from a handler puts that handler into a queue, to be called again the next time the charm is invoked. This invocation may be the result of an action, or any event other than metric events. The queue of events will be dispatched before the new event is processed.

From the above you may deduce, but it’s important to point out:

• defer() does not interrupt the execution of the current event handler. In almost all cases, a call to defer() should be followed by an explicit return from the handler;

• the re-execution of the deferred event handler starts from the top of the handler method (not where defer was called);

• only the handlers that actually called defer() are called again (that is: despite talking about “deferring an event” it is actually the handler/event combination that is deferred); and

• any deferred events get processed before the event (or action) that caused the current invocation of the charm.

The general desire to call defer() happens when some precondition isn’t yet met. However, care should be exercised as to whether it is better to defer this event so that you see it again, or whether it is better to just wait for the event that indicates the precondition has been met.

For example, if config-changed is fired, and you are waiting for different config, there is no reason to defer the event because there will be a different config-changed event when the config actually changes, rather than checking to see if maybe config has changed prior to every other event that occurs.

Similarly, if you need 2 events to occur before you are ready to proceed (say event A and B). When you see event A, you could chose to defer() it because you haven’t seen B yet. However, that leads to:

1. event A fires, calls defer()

2. event B fires, event A handler is called first, still hasn’t seen B happen, so is deferred again. Then B happens, which progresses since it has seen A.

3. At some future time, event C happens, which also checks if A can proceed.

snapshot()

Return the snapshot data that should be persisted.

Subclasses must override to save any custom state.

Return type

dict

restore(snapshot)

Restore the value state from the given snapshot.

Subclasses must override to restore their custom state.

class ops.framework.EventSource(event_type)

Bases: object

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

class ops.framework.BoundEvent(emitter, event_type, event_kind)

Bases: object

Event bound to an Object.

Parameters

• emitter (_ObjectType) –

• event_type (_EventType) –

• event_kind (str) –

emit(*args, **kwargs)

Emit event to all registered observers.

The current storage state is committed before and after each observer is notified.

class ops.framework.HandleKind

Bases: object

Helper descriptor to define the Object.handle_kind field.

The handle_kind for an object defaults to its type name, but it may be explicitly overridden if desired.

class ops.framework.Object(parent, key)

Bases: object

Initialize an Object as a new leaf in Framework, identified by key.

Parameters

• parent – parent node in the tree.

• key – unique identifier for this object.

Every object belongs to exactly one framework.

Every object has a parent, which might be a framework.

We track a “path to object,” which is the path to the parent, plus the object’s unique identifier. Event handlers use this identity to track the destination of their events, and the Framework uses this id to track persisted state between event executions.

The Framework should raise an error if it ever detects that two objects with the same id have been created.

handle_kind

Helper descriptor to define the Object.handle_kind field.

The handle_kind for an object defaults to its type name, but it may be explicitly overridden if desired.

framework = None

handle = None

property model

Shortcut for more simple access the model.

class ops.framework.ObjectEvents(parent=None, key=None)

Bases: ops.framework.Object

Convenience type to allow defining .on attributes at class level.

handle_kind = 'on'

classmethod define_event(event_kind, event_type)

Define an event on this type at runtime.

cls: a type to define an event on.

event_kind: an attribute name that will be used to access the

event. Must be a valid python identifier, not be a keyword or an existing attribute.

event_type: a type of the event to define.

events()

Return a mapping of event_kinds to bound_events for all available events.

class ops.framework.PrefixedEvents(emitter, key)

Bases: object

Events to be found in all events using a specific prefix.

class ops.framework.PreCommitEvent(handle)

Bases: ops.framework.EventBase

Events that will be emitted first on commit.

Parameters

handle (ops.framework.Handle) –

class ops.framework.CommitEvent(handle)

Bases: ops.framework.EventBase

Events that will be emitted second on commit.

Parameters

handle (ops.framework.Handle) –

class ops.framework.FrameworkEvents(parent=None, key=None)

Bases: ops.framework.ObjectEvents

Manager of all framework events.

pre_commit

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

commit

EventSource wraps an event type with a descriptor to facilitate observing and emitting.

It is generally used as:

class SomethingHappened(EventBase):

pass

class SomeObject(Object):

something_happened = EventSource(SomethingHappened)

With that, instances of that type will offer the someobj.something_happened attribute which is a BoundEvent and may be used to emit and observe the event.

exception ops.framework.NoTypeError(handle_path)

Bases: Exception

No class to hold it was found when restoring an event.

class ops.framework.Framework(storage, charm_dir, meta, model)

Bases: ops.framework.Object

Main interface to from the Charm to the Operator Framework internals.

Parameters

• storage (ops.storage.SQLiteStorage) –

• charm_dir (Path) –

• meta (CharmMeta) –

• model (Model) –

on

Manager of all framework events.

charm_dir = None

meta = None

model = None

set_breakpointhook()

Hook into sys.breakpointhook so the builtin breakpoint() works as expected.

This method is called by main, and is not intended to be called by users of the framework itself outside of perhaps some testing scenarios.

It returns the old value of sys.excepthook.

The breakpoint function is a Python >= 3.7 feature.

This method was added in ops 1.0; before that, it was done as part of the Framework’s __init__.

close()

Close the underlying backends.

commit()

Save changes to the underlying backends.

register_type(cls, parent, kind=None)

Register a type to a handle.

Parameters

parent (Optional[_ParentHandle]) –

save_snapshot(value)

Save a persistent snapshot of the provided value.

Parameters

value (_Serializable) –

load_snapshot(handle)

Load a persistent snapshot.

Parameters

handle (ops.framework.Handle) –

Return type

_ObjectType

drop_snapshot(handle)

Discard a persistent snapshot.

Parameters

handle (ops.framework.Handle) –

observe(bound_event, observer)

Register observer to be called when bound_event is emitted.

The bound_event is generally provided as an attribute of the object that emits the event, and is created in this style:

class SomeObject:
    something_happened = Event(SomethingHappened)

That event may be observed as:

framework.observe(someobj.something_happened, self._on_something_happened)

Raises

RuntimeError – if bound_event or observer are the wrong type.

Parameters

• bound_event (ops.framework.BoundEvent) –

• observer (_ObserverCallback) –

reemit()

Reemit previously deferred events to the observers that deferred them.

Only the specific observers that have previously deferred the event will be notified again. Observers that asked to be notified about events after it’s been first emitted won’t be notified, as that would mean potentially observing events out of order.

breakpoint(name=None)

Add breakpoint, optionally named, at the place where this method is called.

For the breakpoint to be activated the JUJU_DEBUG_AT environment variable must be set to “all” or to the specific name parameter provided, if any. In every other situation calling this method does nothing.

The framework also provides a standard breakpoint named “hook”, that will stop execution when a hook event is about to be handled.

For those reasons, the “all” and “hook” breakpoint names are reserved.

remove_unreferenced_events()

Remove events from storage that are not referenced.

In older versions of the framework, events that had no observers would get recorded but never deleted. This makes a best effort to find these events and remove them from the database.

class ops.framework.StoredStateData(parent, attr_name)

Bases: ops.framework.Object

Manager of the stored data.

snapshot()

Return the current state.

restore(snapshot)

Restore current state to the given snapshot.

on_commit(event)

Save changes to the storage backend.

class ops.framework.BoundStoredState(parent, attr_name)

Bases: object

Stored state data bound to a specific Object.

set_default(**kwargs)

Set the value of any given key if it has not already been set.

class ops.framework.StoredState

Bases: object

A class used to store data the charm needs persisted across invocations.

Example:

class MyClass(Object):
    _stored = StoredState()

Instances of MyClass can transparently save state between invocations by setting attributes on _stored. Initial state should be set with set_default on the bound object, that is:

class MyClass(Object):
    _stored = StoredState()

def __init__(self, parent, key):
    super().__init__(parent, key)
    self._stored.set_default(seen=set())
    self.framework.observe(self.on.seen, self._on_seen)

def _on_seen(self, event):
    self._stored.seen.add(event.uuid)

class ops.framework.StoredDict(stored_data, under)

Bases: collections.abc.MutableMapping

A dict-like object that uses the StoredState as backend.

class ops.framework.StoredList(stored_data, under)

Bases: collections.abc.MutableSequence

A list-like object that uses the StoredState as backend.

insert(index, value)

Insert value before index.

append(value)

Append value to the end of the list.

class ops.framework.StoredSet(stored_data, under)

Bases: collections.abc.MutableSet

A set-like object that uses the StoredState as backend.

add(key)

Add a key to a set.

This has no effect if the key is already present.

discard(key)

Remove a key from a set if it is a member.

If the key is not a member, do nothing.

ops.jujuversion module

A helper to work with the Juju version.

class ops.jujuversion.JujuVersion(version)

Bases: object

Helper to work with the Juju version.

It knows how to parse the JUJU_VERSION environment variable, and exposes different capabilities according to the specific version, allowing also to compare with other versions.

PATTERN = '^\n    (?P<major>\\d{1,9})\\.(?P<minor>\\d{1,9})       # <major> and <minor> numbers are always there\n    ((?:\\.|-(?P<tag>[a-z]+))(?P<patch>\\d{1,9}))? # sometimes with .<patch> or -<tag><patch>\n    (\\.(?P<build>\\d{1,9}))?$                     # and sometimes with a <build> number.\n    '

classmethod from_environ()

Build a JujuVersion from JUJU_VERSION.

Return type

ops.jujuversion.JujuVersion

has_app_data()

Determine whether this juju version knows about app data.

Return type

bool

is_dispatch_aware()

Determine whether this juju version knows about dispatch.

Return type

bool

has_controller_storage()

Determine whether this juju version supports controller-side storage.

Return type

bool

ops.log module

Interface to emit messages to the Juju logging system.

class ops.log.JujuLogHandler(model_backend, level=10)

Bases: logging.Handler

A handler for sending logs to Juju via juju-log.

Initializes the instance - basically setting the formatter to None and the filter list to empty.

emit(record)

Send the specified logging record to the Juju backend.

This method is not used directly by the Operator Framework code, but by logging.Handler itself as part of the logging machinery.

ops.log.setup_root_logging(model_backend, debug=False)

Setup python logging to forward messages to juju-log.

By default, logging is set to DEBUG level, and messages will be filtered by Juju. Charmers can also set their own default log level with:

logging.getLogger().setLevel(logging.INFO)

Parameters

• model_backend – a ModelBackend to use for juju-log

• debug – if True, write logs to stderr as well as to juju-log.

ops.main module

Main entry point to the Operator Framework.

ops.main.main(charm_class, use_juju_for_storage=None)

Setup the charm and dispatch the observed event.

The event name is based on the way this executable was called (argv[0]).

Parameters

• charm_class (Type[ops.charm.CharmBase]) – your charm class.

• use_juju_for_storage (Optional[bool]) – whether to use controller-side storage. If not specified then kubernetes charms that haven’t previously used local storage and that are running on a new enough Juju default to controller-side storage, otherwise local storage is used.

ops.model module

Representations of Juju’s model, application, unit, and other entities.

class ops.model.Model(meta, backend)

Bases: object

Represents the Juju Model as seen from this unit.

This should not be instantiated directly by Charmers, but can be accessed as self.model from any class that derives from Object.

Parameters

• meta (ops.charm.CharmMeta) –

• backend (_ModelBackend) –

property unit

A Unit that represents the unit that is running this code (eg yourself).

property app

A Application that represents the application this unit is a part of.

property relations

Mapping of endpoint to list of Relation.

Answers the question “what am I currently related to”. See also get_relation().

property config

Return a mapping of config for the current application.

property resources

Access to resources for this charm.

Use model.resources.fetch(resource_name) to get the path on disk where the resource can be found.

property storages

Mapping of storage_name to Storage as defined in metadata.yaml.

property pod

Use model.pod.set_spec to set the container specification for Kubernetes charms.

property name

Return the name of the Model that this unit is running in.

This is read from the environment variable JUJU_MODEL_NAME.

property uuid

Return the identifier of the Model that this unit is running in.

This is read from the environment variable JUJU_MODEL_UUID.

get_unit(unit_name)

Get an arbitrary unit by name.

Internally this uses a cache, so asking for the same unit two times will return the same object.

Parameters

unit_name (str) –

Return type

ops.model.Unit

get_app(app_name)

Get an application by name.

Internally this uses a cache, so asking for the same application two times will return the same object.

Parameters

app_name (str) –

Return type

ops.model.Application

get_relation(relation_name, relation_id=None)

Get a specific Relation instance.

If relation_id is not given, this will return the Relation instance if the relation is established only once or None if it is not established. If this same relation is established multiple times the error TooManyRelatedAppsError is raised.

Parameters

• relation_name (str) – The name of the endpoint for this charm

• relation_id (Optional[int]) – An identifier for a specific relation. Used to disambiguate when a given application has more than one relation on a given endpoint.

Raises

TooManyRelatedAppsError – is raised if there is more than one relation to the supplied relation_name and no relation_id was supplied

Return type

ops.model.Relation

get_binding(binding_key)

Get a network space binding.

Parameters

binding_key (Union[str, ops.model.Relation]) – The relation name or instance to obtain bindings for.

Returns

If binding_key is a relation name, the method returns the default binding for that relation. If a relation instance is provided, the method first looks up a more specific binding for that specific relation ID, and if none is found falls back to the default binding for the relation name.

Return type

ops.model.Binding

class ops.model.Application(name, meta, backend, cache)

Bases: object

Represents a named application in the model.

This might be your application, or might be an application that you are related to. Charmers should not instantiate Application objects directly, but should use Model.get_app() if they need a reference to a given application.

Parameters

• name (str) –

• meta (ops.charm.CharmMeta) –

• backend (_ModelBackend) –

• cache (ops.model._ModelCache) –

name

The name of this application (eg, ‘mysql’). This name may differ from the name of the charm, if the user has deployed it to a different name.

property status

Used to report or read the status of the overall application.

Can only be read and set by the lead unit of the application.

The status of remote units is always Unknown.

Raises

• RuntimeError – if you try to set the status of another application, or if you try to set the status of this application as a unit that is not the leader.

• InvalidStatusError – if you try to set the status to something that is not a StatusBase

Example:

self.model.app.status = BlockedStatus('I need a human to come help me')

planned_units()

Get the number of units that Juju has “planned” for this application.

E.g., if an operator runs “juju deploy foo”, then “juju add-unit -n 2 foo”, the planned unit count for foo will be 3.

The data comes from the Juju agent, based on data it fetches from the controller. Pending units are included in the count, and scale down events may modify the count before some units have been fully torn down. The information in planned_units is up-to-date as of the start of the current hook invocation.

This method only returns data for this charm’s application – the Juju agent isn’t able to see planned unit counts for other applications in the model.

Return type

int

class ops.model.Unit(name, meta, backend, cache)

Bases: object

Represents a named unit in the model.

This might be your unit, another unit of your application, or a unit of another application that you are related to.

name

The name of the unit (eg, ‘mysql/0’)

app

The Application the unit is a part of.

property status

Used to report or read the status of a specific unit.

The status of any unit other than yourself is always Unknown.

Raises

• RuntimeError – if you try to set the status of a unit other than yourself.

• InvalidStatusError – if you try to set the status to something other than a StatusBase

Example:

self.model.unit.status = MaintenanceStatus('reconfiguring the frobnicators')

is_leader()

Return whether this unit is the leader of its application.

This can only be called for your own unit.

Returns

True if you are the leader, False otherwise

Raises

RuntimeError – if called for a unit that is not yourself

Return type

bool

set_workload_version(version)

Record the version of the software running as the workload.

This shouldn’t be confused with the revision of the charm. This is informative only; shown in the output of ‘juju status’.

Parameters

version (str) –

Return type

None

property containers

Return a mapping of containers indexed by name.

get_container(container_name)

Get a single container by name.

Raises

ModelError – if the named container doesn’t exist

Parameters

container_name (str) –

Return type

ops.model.Container

class ops.model.LazyMapping

Bases: collections.abc.Mapping, abc.ABC

Represents a dict that isn’t populated until it is accessed.

Charm authors should generally never need to use this directly, but it forms the basis for many of the dicts that the framework tracks.

class ops.model.RelationMapping(relations_meta, our_unit, backend, cache)

Bases: collections.abc.Mapping

Map of relation names to lists of Relation instances.

class ops.model.BindingMapping(backend)

Bases: object

Mapping of endpoints to network bindings.

Charm authors should not instantiate this directly, but access it via Model.get_binding()

get(binding_key)

Get a specific Binding for an endpoint/relation.

Not used directly by Charm authors. See Model.get_binding()

Parameters

binding_key (Union[str, ops.model.Relation]) –

Return type

ops.model.Binding

class ops.model.Binding(name, relation_id, backend)

Bases: object

Binding to a network space.

name

The name of the endpoint this binding represents (eg, ‘db’)

property network

The network information for this binding.

class ops.model.Network(network_info)

Bases: object

Network space details.

Charm authors should not instantiate this directly, but should get access to the Network definition from Model.get_binding() and its network attribute.

interfaces

A list of NetworkInterface details. This includes the information about how your application should be configured (eg, what IP addresses should you bind to.) Note that multiple addresses for a single interface are represented as multiple interfaces. (eg, [NetworkInfo('ens1', '10.1.1.1/32'), NetworkInfo('ens1', '10.1.2.1/32']))

ingress_addresses

A list of ipaddress.ip_address objects representing the IP addresses that other units should use to get in touch with you.

egress_subnets

A list of ipaddress.ip_network representing the subnets that other units will see you connecting from. Due to things like NAT it isn’t always possible to narrow it down to a single address, but when it is clear, the CIDRs will be constrained to a single address. (eg, 10.0.0.1/32)

Parameters

network_info (dict) – A dict of network information as returned by network-get.

property bind_address

A single address that your application should bind() to.

For the common case where there is a single answer. This represents a single address from interfaces that can be used to configure where your application should bind() and listen().

property ingress_address

The address other applications should use to connect to your unit.

Due to things like public/private addresses, NAT and tunneling, the address you bind() to is not always the address other people can use to connect() to you. This is just the first address from ingress_addresses.

class ops.model.NetworkInterface(name, address_info)

Bases: object

Represents a single network interface that the charm needs to know about.

Charmers should not instantiate this type directly. Instead use Model.get_binding() to get the network information for a given endpoint.

Parameters

• name (str) –

• address_info (dict) –

name

The name of the interface (eg. ‘eth0’, or ‘ens1’)

subnet

An ipaddress.ip_network representation of the IP for the network interface. This may be a single address (eg ‘10.0.1.2/32’)

class ops.model.Relation(relation_name, relation_id, is_peer, our_unit, backend, cache)

Bases: object

Represents an established relation between this application and another application.

This class should not be instantiated directly, instead use Model.get_relation() or ops.charm.RelationEvent.relation. This is principally used by ops.charm.RelationMeta to represent the relationships between charms.

Parameters

• relation_name (str) –

• relation_id (int) –

• is_peer (bool) –

• our_unit (ops.model.Unit) –

• backend (_ModelBackend) –

• cache (_ModelCache) –

name

The name of the local endpoint of the relation (eg ‘db’)

id

The identifier for a particular relation (integer)

app

An Application representing the remote application of this relation. For peer relations this will be the local application.

units

A set of Unit for units that have started and joined this relation.

data

A RelationData holding the data buckets for each entity of a relation. Accessed via eg Relation.data[unit][‘foo’]

class ops.model.RelationData(relation, our_unit, backend)

Bases: collections.abc.Mapping

Represents the various data buckets of a given relation.

Each unit and application involved in a relation has their own data bucket. Eg: {entity: RelationDataContent} where entity can be either a Unit or a Application.

Units can read and write their own data, and if they are the leader, they can read and write their application data. They are allowed to read remote unit and application data.

This class should not be created directly. It should be accessed via Relation.data

Parameters

• relation (ops.model.Relation) –

• our_unit (ops.model.Unit) –

• backend (_ModelBackend) –

class ops.model.RelationDataContent(relation, entity, backend)

Bases: ops.model.LazyMapping, collections.abc.MutableMapping

Data content of a unit or application in a relation.

class ops.model.ConfigData(backend)

Bases: ops.model.LazyMapping

Configuration data.

This class should not be created directly. It should be accessed via Model.config.

class ops.model.StatusBase(*args, **kwargs)

Bases: object

Status values specific to applications and units.

To access a status by name, see StatusBase.from_name(), most use cases will just directly use the child class to indicate their status.

Forbid the usage of StatusBase directly.

name = None

classmethod from_name(name, message)

Get the specific Status for the name (or UnknownStatus if not registered).

Parameters

• name (str) –

• message (str) –

classmethod register(child)

Register a Status for the child’s name.

class ops.model.UnknownStatus(*args, **kwargs)

Bases: ops.model.StatusBase

The unit status is unknown.

A unit-agent has finished calling install, config-changed and start, but the charm has not called status-set yet.

Forbid the usage of StatusBase directly.

name = 'unknown'

class ops.model.ActiveStatus(*args, **kwargs)

Bases: ops.model.StatusBase

The unit is ready.

The unit believes it is correctly offering all the services it has been asked to offer.

Forbid the usage of StatusBase directly.

name = 'active'

class ops.model.BlockedStatus(*args, **kwargs)

Bases: ops.model.StatusBase

The unit requires manual intervention.

An operator has to manually intervene to unblock the unit and let it proceed.

Forbid the usage of StatusBase directly.

name = 'blocked'

class ops.model.MaintenanceStatus(*args, **kwargs)

Bases: ops.model.StatusBase

The unit is performing maintenance tasks.

The unit is not yet providing services, but is actively doing work in preparation for providing those services. This is a “spinning” state, not an error state. It reflects activity on the unit itself, not on peers or related units.

Forbid the usage of StatusBase directly.

name = 'maintenance'

class ops.model.WaitingStatus(*args, **kwargs)

Bases: ops.model.StatusBase

A unit is unable to progress.

The unit is unable to progress to an active state because an application to which it is related is not running.

Forbid the usage of StatusBase directly.

name = 'waiting'

class ops.model.Resources(names, backend)

Bases: object

Object representing resources for the charm.

Parameters

• names (Iterable[str]) –

• backend (_ModelBackend) –

fetch(name)

Fetch the resource from the controller or store.

If successfully fetched, this returns a Path object to where the resource is stored on disk, otherwise it raises a NameError.

Parameters

name (str) –

Return type

pathlib.Path

class ops.model.Pod(backend)

Bases: object

Represents the definition of a pod spec in Kubernetes models.

Currently only supports simple access to setting the Juju pod spec via set_spec.

Parameters

backend (_ModelBackend) –

set_spec(spec, k8s_resources=None)

Set the specification for pods that Juju should start in kubernetes.

See juju help-tool pod-spec-set for details of what should be passed.

Parameters

• spec (Mapping) – The mapping defining the pod specification

• k8s_resources (Optional[Mapping]) – Additional kubernetes specific specification.

Returns

None

class ops.model.StorageMapping(storage_names, backend)

Bases: collections.abc.Mapping

Map of storage names to lists of Storage instances.

Parameters

• storage_names (Iterable[str]) –

• backend (_ModelBackend) –

request(storage_name, count=1)

Requests new storage instances of a given name.

Uses storage-add tool to request additional storage. Juju will notify the unit via <storage-name>-storage-attached events when it becomes available.

Parameters

• storage_name (str) –

• count (int) –

class ops.model.Storage(storage_name, storage_index, backend)

Bases: object

Represents a storage as defined in metadata.yaml.

Parameters

• storage_name (str) –

• storage_index (int) –

name

Simple string name of the storage

id

The index number for storage

property index

The index associated with the storage (usually 0 for singular storage).

property id

The index associated with the storage.

Type

DEPRECATED (use “.index”)

property full_id

Returns the canonical storage name and id/index based identifier.

property location

Return the location of the storage.

class ops.model.Container(name, backend, pebble_client=None)

Bases: object

Represents a named container in a unit.

This class should not be instantiated directly, instead use Unit.get_container() or Unit.containers.

name

The name of the container from metadata.yaml (eg, ‘postgres’).

property pebble

The low-level ops.pebble.Client instance for this container.

can_connect()

Report whether the Pebble API is reachable in the container.

can_connect() returns a bool that indicates whether the Pebble API is available at the time the method is called. It does not guard against the Pebble API becoming unavailable, and should be treated as a ‘point in time’ status only.

If the Pebble API later fails, serious consideration should be given as to the reason for this.

Example:

container = self.unit.get_container("example")
if container.can_connect():
    try:
        c.pull('/does/not/exist')
    except ProtocolError, PathError:
        # handle it
else:
    event.defer()

Return type

bool

autostart()

Autostart all services marked as startup: enabled.

replan()

Replan all services: restart changed services and start startup-enabled services.

start(*service_names)

Start given service(s) by name.

Parameters

service_names (str) –

restart(*service_names)

Restart the given service(s) by name.

Parameters

service_names (str) –

stop(*service_names)

Stop given service(s) by name.

Parameters

service_names (str) –

add_layer(label, layer, *, combine=False)

Dynamically add a new layer onto the Pebble configuration layers.

Parameters

• label (str) – Label for new layer (and label of layer to merge with if combining).

• layer – A YAML string, configuration layer dict, or pebble.Layer object containing the Pebble layer to add.

• combine (bool) – If combine is False (the default), append the new layer as the top layer with the given label (must be unique). If combine is True and the label already exists, the two layers are combined into a single one considering the layer override rules; if the layer doesn’t exist, it is added as usual.

get_plan()

Get the current effective pebble configuration.

Return type

ops.pebble.Plan

get_services(*service_names)

Fetch and return a mapping of status information indexed by service name.

If no service names are specified, return status information for all services, otherwise return information for only the given services.

Parameters

service_names (str) –

Return type

ops.model.ServiceInfoMapping

get_service(service_name)

Get status information for a single named service.

Raises ModelError if service_name is not found.

Parameters

service_name (str) –

Return type

ops.pebble.ServiceInfo

get_checks(*check_names, level=None)

Fetch and return a mapping of check information indexed by check name.

Parameters

• check_names (str) – Optional check names to query for. If no check names are specified, return checks with any name.

• level (Optional[ops.pebble.CheckLevel]) – Optional check level to query for. If not specified, fetch checks with any level.

Return type

ops.model.CheckInfoMapping

get_check(check_name)

Get check information for a single named check.

Raises ModelError if check_name is not found.

Parameters

check_name (str) –

Return type

ops.pebble.CheckInfo

pull(path, *, encoding='utf-8')

Read a file’s content from the remote system.

Parameters

• path (str) – Path of the file to read from the remote system.

• encoding (str) – Encoding to use for decoding the file’s bytes to str, or None to specify no decoding.

Returns

A readable file-like object, whose read() method will return str objects decoded according to the specified encoding, or bytes if encoding is None.

Return type

Union[BinaryIO, TextIO]

push(path, source, *, encoding='utf-8', make_dirs=False, permissions=None, user_id=None, user=None, group_id=None, group=None)

Write content to a given file path on the remote system.

Parameters

• path (str) – Path of the file to write to on the remote system.

• source (Union[bytes, str, BinaryIO, TextIO]) – Source of data to write. This is either a concrete str or bytes instance, or a readable file-like object.

• encoding (str) – Encoding to use for encoding source str to bytes, or strings read from source if it is a TextIO type. Ignored if source is bytes or BinaryIO.

• make_dirs (bool) – If True, create parent directories if they don’t exist.

• permissions (Optional[int]) – Permissions (mode) to create file with (Pebble default is 0o644).

• user_id (Optional[int]) – User ID (UID) for file.

• user (Optional[str]) – Username for file. User’s UID must match user_id if both are specified.

• group_id (Optional[int]) – Group ID (GID) for file.

• group (Optional[str]) – Group name for file. Group’s GID must match group_id if both are specified.

list_files(path, *, pattern=None, itself=False)

Return list of directory entries from given path on remote system.

Despite the name, this method returns a list of files and directories, similar to os.listdir() or os.scandir().

Parameters

• path (str) – Path of the directory to list, or path of the file to return information about.

• pattern (Optional[str]) – If specified, filter the list to just the files that match, for example *.txt.

• itself (bool) – If path refers to a directory, return information about the directory itself, rather than its contents.

Return type

List[ops.pebble.FileInfo]

exists(path)

Return true if the path exists on the container filesystem.

Parameters

path (str) –

Return type

bool

isdir(path)

Return true if a directory exists at the given path on the container filesystem.

Parameters

path (str) –

Return type

bool

make_dir(path, *, make_parents=False, permissions=None, user_id=None, user=None, group_id=None, group=None)

Create a directory on the remote system with the given attributes.

Parameters

• path (str) – Path of the directory to create on the remote system.

• make_parents (bool) – If True, create parent directories if they don’t exist.

• permissions (Optional[int]) – Permissions (mode) to create directory with (Pebble default is 0o755).

• user_id (Optional[int]) – User ID (UID) for directory.

• user (Optional[str]) – Username for directory. User’s UID must match user_id if both are specified.

• group_id (Optional[int]) – Group ID (GID) for directory.

• group (Optional[str]) – Group name for directory. Group’s GID must match group_id if both are specified.

remove_path(path, *, recursive=False)

Remove a file or directory on the remote system.

Parameters

• path (str) – Path of the file or directory to delete from the remote system.

• recursive (bool) – If True, recursively delete path and everything under it.

exec(command, *, environment=None, working_dir=None, timeout=None, user_id=None, user=None, group_id=None, group=None, stdin=None, stdout=None, stderr=None, encoding='utf-8', combine_stderr=False)

Execute the given command on the remote system.

See ops.pebble.Client.exec() for documentation of the parameters and return value, as well as examples.

Parameters

• command (List[str]) –

• environment (Optional[Dict[str, str]]) –

• working_dir (Optional[str]) –

• timeout (Optional[float]) –

• user_id (Optional[int]) –

• user (Optional[str]) –

• group_id (Optional[int]) –

• group (Optional[str]) –

• stdin (Optional[Union[str, bytes, TextIO, BinaryIO]]) –

• stdout (Optional[Union[TextIO, BinaryIO]]) –

• stderr (Optional[Union[TextIO, BinaryIO]]) –

• encoding (str) –

• combine_stderr (bool) –

Return type

ops.pebble.ExecProcess

send_signal(sig, *service_names)

Send the given signal to one or more services.

Parameters

• sig (Union[int, str]) – Name or number of signal to send, e.g., “SIGHUP”, 1, or signal.SIGHUP.

• service_names (str) – Name(s) of the service(s) to send the signal to.

Raises

pebble.APIError – If any of the services are not in the plan or are not currently running.

class ops.model.ContainerMapping(names, backend)

Bases: collections.abc.Mapping

Map of container names to Container objects.

This is done as a mapping object rather than a plain dictionary so that we can extend it later, and so it’s not mutable.

Parameters

• names (Iterable[str]) –

• backend (_ModelBackend) –

class ops.model.ServiceInfoMapping(services)

Bases: collections.abc.Mapping

Map of service names to ops.pebble.ServiceInfo objects.

This is done as a mapping object rather than a plain dictionary so that we can extend it later, and so it’s not mutable.

Parameters

services (Iterable[pebble.ServiceInfo]) –

class ops.model.CheckInfoMapping(checks)

Bases: collections.abc.Mapping

Map of check names to ops.pebble.CheckInfo objects.

This is done as a mapping object rather than a plain dictionary so that we can extend it later, and so it’s not mutable.

Parameters

checks (Iterable[pebble.CheckInfo]) –

exception ops.model.ModelError

Bases: Exception

Base class for exceptions raised when interacting with the Model.

exception ops.model.TooManyRelatedAppsError(relation_name, num_related, max_supported)

Bases: ops.model.ModelError

Raised by Model.get_relation() if there is more than one related application.

exception ops.model.RelationDataError

Bases: ops.model.ModelError

Raised by Relation.data[entity][key] = 'foo' if the data is invalid.

This is raised if you’re either trying to set a value to something that isn’t a string, or if you are trying to set a value in a bucket that you don’t have access to. (eg, another application/unit or setting your application data but you aren’t the leader.)

exception ops.model.RelationNotFoundError

Bases: ops.model.ModelError

Backend error when querying juju for a given relation and that relation doesn’t exist.

exception ops.model.InvalidStatusError

Bases: ops.model.ModelError

Raised if trying to set an Application or Unit status to something invalid.

ops.pebble module

Client for the Pebble API (HTTP over Unix socket).

For a command-line interface for local testing, see test/pebble_cli.py.

exception ops.pebble.Error

Bases: Exception

Base class of most errors raised by the Pebble client.

name()

Return a string representation of the model plus class.

message()

Return the message passed as an argument.

exception ops.pebble.TimeoutError

Bases: TimeoutError, ops.pebble.Error

Raised when a polling timeout occurs.

exception ops.pebble.ConnectionError

Bases: ops.pebble.Error

Raised when the Pebble client can’t connect to the socket.

exception ops.pebble.ProtocolError

Bases: ops.pebble.Error

Raised when there’s a higher-level protocol error talking to Pebble.

exception ops.pebble.PathError(kind, message)

Bases: ops.pebble.Error

Raised when there’s an error with a specific path.

This shouldn’t be instantiated directly.

Parameters

• kind (str) –

• message (str) –

exception ops.pebble.APIError(body, code, status, message)

Bases: ops.pebble.Error

Raised when an HTTP API error occurs talking to the Pebble server.

This shouldn’t be instantiated directly.

Parameters

• body (Dict) –

• code (int) –

• status (str) –

• message (str) –

exception ops.pebble.ChangeError(err, change)

Bases: ops.pebble.Error

Raised by actions when a change is ready but has an error.

For example, this happens when you attempt to start an already-started service:

cannot perform the following tasks: - Start service “test” (service “test” was previously started)

This shouldn’t be instantiated directly.

Parameters

• err (str) –

• change (Change) –

exception ops.pebble.ExecError(command, exit_code, stdout, stderr)

Bases: ops.pebble.Error

Raised when a Client.exec() command returns a non-zero exit code.

Parameters

• command (List[str]) –

• exit_code (int) –

• stdout (Optional[AnyStr]) –

• stderr (Optional[AnyStr]) –

command

Command line of command being executed.

exit_code

The process’s exit code. This will always be non-zero.

stdout

If ExecProcess.wait_output() was being called, this is the captured stdout as a str (or bytes if encoding was None). If ExecProcess.wait() was being called, this is None.

stderr

If ExecProcess.wait_output() was being called and combine_stderr was False, this is the captured stderr as a str (or bytes if encoding was None). If ExecProcess.wait() was being called or combine_stderr was True, this is None.

STR_MAX_OUTPUT = 1024

class ops.pebble.WarningState(value)

Bases: enum.Enum

Enum of states for get_warnings() select parameter.

ALL = 'all'

PENDING = 'pending'

class ops.pebble.ChangeState(value)

Bases: enum.Enum

Enum of states for get_changes() select parameter.

ALL = 'all'

IN_PROGRESS = 'in-progress'

READY = 'ready'

class ops.pebble.SystemInfo(version)

Bases: object

System information object.

Parameters

version (str) –

classmethod from_dict(d)

Create new SystemInfo object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.SystemInfo

class ops.pebble.Warning(message, first_added, last_added, last_shown, expire_after, repeat_after)

Bases: object

Warning object.

Parameters

• message (str) –

• first_added (datetime.datetime) –

• last_added (datetime.datetime) –

• last_shown (Optional[datetime.datetime]) –

• expire_after (str) –

• repeat_after (str) –

classmethod from_dict(d)

Create new Warning object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.Warning

class ops.pebble.TaskProgress(label, done, total)

Bases: object

Task progress object.

Parameters

• label (str) –

• done (int) –

• total (int) –

classmethod from_dict(d)

Create new TaskProgress object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.TaskProgress

class ops.pebble.TaskID

Bases: str

Task ID (a more strongly-typed string).

class ops.pebble.Task(id, kind, summary, status, log, progress, spawn_time, ready_time, data=None)

Bases: object

Task object.

Parameters

• id (ops.pebble.TaskID) –

• kind (str) –

• summary (str) –

• status (str) –

• log (List[str]) –

• progress (ops.pebble.TaskProgress) –

• spawn_time (datetime.datetime) –

• ready_time (Optional[datetime.datetime]) –

• data (Dict[str, Any]) –

classmethod from_dict(d)

Create new Task object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.Task

class ops.pebble.ChangeID

Bases: str

Change ID (a more strongly-typed string).

class ops.pebble.Change(id, kind, summary, status, tasks, ready, err, spawn_time, ready_time, data=None)

Bases: object

Change object.

Parameters

• id (ops.pebble.ChangeID) –

• kind (str) –

• summary (str) –

• status (str) –

• tasks (List[ops.pebble.Task]) –

• ready (bool) –

• err (Optional[str]) –

• spawn_time (datetime.datetime) –

• ready_time (Optional[datetime.datetime]) –

• data (Dict[str, Any]) –

classmethod from_dict(d)

Create new Change object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.Change

class ops.pebble.Plan(raw)

Bases: object

Represents the effective Pebble configuration.

A plan is the combined layer configuration. The layer configuration is documented at https://github.com/canonical/pebble/#layer-specification.

Parameters

raw (str) –

property services

This plan’s services mapping (maps service name to Service).

This property is currently read-only.

property checks

This plan’s checks mapping (maps check name to Check).

This property is currently read-only.

to_dict()

Convert this plan to its dict representation.

Return type

Dict[str, Any]

to_yaml()

Return this plan’s YAML representation.

Return type

str

class ops.pebble.Layer(raw=None)

Bases: object

Represents a Pebble configuration layer.

The format of this is documented at https://github.com/canonical/pebble/#layer-specification.

Parameters

raw (Union[str, Dict]) –

summary

A summary of the purpose of this layer

description

A long form description of this layer

services

A mapping of name to Service defined by this layer

checks

A mapping of check to Check defined by this layer

to_yaml()

Convert this layer to its YAML representation.

Return type

str

to_dict()

Convert this layer to its dict representation.

Return type

Dict[str, Any]

class ops.pebble.Service(name, raw=None)

Bases: object

Represents a service description in a Pebble configuration layer.

Parameters

• name (str) –

• raw (Dict) –

to_dict()

Convert this service object to its dict representation.

Return type

Dict[str, Any]

class ops.pebble.ServiceStartup(value)

Bases: enum.Enum

Enum of service startup options.

ENABLED = 'enabled'

DISABLED = 'disabled'

class ops.pebble.ServiceStatus(value)

Bases: enum.Enum

Enum of service statuses.

ACTIVE = 'active'

INACTIVE = 'inactive'

ERROR = 'error'

class ops.pebble.ServiceInfo(name, startup, current)

Bases: object

Service status information.

Parameters

• name (str) –

• startup (Union[ops.pebble.ServiceStartup, str]) –

• current (Union[ops.pebble.ServiceStatus, str]) –

is_running()

Return True if this service is running (in the active state).

Return type

bool

classmethod from_dict(d)

Create new ServiceInfo object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.ServiceInfo

class ops.pebble.Check(name, raw=None)

Bases: object

Represents a check in a Pebble configuration layer.

Parameters

• name (str) –

• raw (Dict) –

to_dict()

Convert this check object to its dict representation.

Return type

Dict[str, Any]

class ops.pebble.CheckLevel(value)

Bases: enum.Enum

Enum of check levels.

UNSET = ''

ALIVE = 'alive'

READY = 'ready'

class ops.pebble.CheckStatus(value)

Bases: enum.Enum

Enum of check statuses.

UP = 'up'

DOWN = 'down'

class ops.pebble.FileType(value)

Bases: enum.Enum

Enum of file types.

FILE = 'file'

DIRECTORY = 'directory'

SYMLINK = 'symlink'

SOCKET = 'socket'

NAMED_PIPE = 'named-pipe'

DEVICE = 'device'

UNKNOWN = 'unknown'

class ops.pebble.FileInfo(path, name, type, size, permissions, last_modified, user_id, user, group_id, group)

Bases: object

Stat-like information about a single file or directory.

Parameters

• path (str) –

• name (str) –

• type (Union[FileType, str]) –

• size (Optional[int]) –

• permissions (int) –

• last_modified (datetime.datetime) –

• user_id (Optional[int]) –

• user (Optional[str]) –

• group_id (Optional[int]) –

• group (Optional[str]) –

classmethod from_dict(d)

Create new FileInfo object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.FileInfo

class ops.pebble.CheckInfo(name, level, status, failures=0, threshold=0)

Bases: object

Check status information.

A list of these objects is returned from Client.get_checks().

Parameters

• name (str) –

• level (Optional[Union[ops.pebble.CheckLevel, str]]) –

• status (Union[ops.pebble.CheckStatus, str]) –

• failures (int) –

• threshold (int) –

name

The name of the check.

level

The check level: CheckLevel.ALIVE, CheckLevel.READY, or None (level not set).

status

The status of the check: CheckStatus.UP means the check is healthy (the number of failures is less than the threshold), CheckStatus.DOWN means the check is unhealthy (the number of failures has reached the threshold).

failures

The number of failures since the check last succeeded (reset to zero if the check succeeds).

threshold

The failure threshold, that is, how many consecutive failures for the check to be considered “down”.

classmethod from_dict(d)

Create new CheckInfo object from dict parsed from JSON.

Parameters

d (Dict) –

Return type

ops.pebble.CheckInfo

class ops.pebble.ExecProcess(stdin, stdout, stderr, client, timeout, control_ws, stdio_ws, stderr_ws, command, encoding, change_id, cancel_stdin, cancel_reader, threads)

Bases: object

Represents a process started by Client.exec().

To avoid deadlocks, most users should use wait_output() instead of reading and writing the stdin, stdout, and stderr attributes directly. Alternatively, users can pass stdin/stdout/stderr to Client.exec().

This class should not be instantiated directly, only via Client.exec().

Parameters

• stdin (Optional[Union[TextIO, BinaryIO]]) –

• stdout (Optional[Union[TextIO, BinaryIO]]) –

• stderr (Optional[Union[TextIO, BinaryIO]]) –

• client (Client) –

• timeout (Optional[float]) –

• control_ws (ops._vendor.websocket._core.WebSocket) –

• stdio_ws (ops._vendor.websocket._core.WebSocket) –

• stderr_ws (ops._vendor.websocket._core.WebSocket) –

• command (List[str]) –

• encoding (Optional[str]) –

• change_id (ops.pebble.ChangeID) –

• cancel_stdin (Callable[None]) –

• cancel_reader (Optional[int]) –

• threads (List[threading.Thread]) –

stdin

If the stdin argument was not passed to Client.exec(), this is a writable file-like object the caller can use to stream input to the process. It is None if stdin was passed to Client.exec().

stdout

If the stdout argument was not passed to Client.exec(), this is a readable file-like object the caller can use to stream output from the process. It is None if stdout was passed to Client.exec().

stderr

If the stderr argument was not passed to Client.exec() and combine_stderr was False, this is a readable file-like object the caller can use to stream error output from the process. It is None if stderr was passed to Client.exec() or combine_stderr was True.

wait()

Wait for the process to finish.

If a timeout was specified to the Client.exec() call, this waits at most that duration.

Raises

• ChangeError – if there was an error starting or running the process.

• ExecError – if the process exits with a non-zero exit code.

wait_output()

Wait for the process to finish and return tuple of (stdout, stderr).

If a timeout was specified to the Client.exec() call, this waits at most that duration. If combine_stderr was True, stdout will include the process’s standard error, and stderr will be None.

Raises

• ChangeError – if there was an error starting or running the process.

• ExecError – if the process exits with a non-zero exit code.

Return type

Tuple[AnyStr, AnyStr]

send_signal(sig)

Send the given signal to the running process.

Parameters

sig (Union[int, str]) – Name or number of signal to send, e.g., “SIGHUP”, 1, or signal.SIGHUP.

class ops.pebble.Client(socket_path=None, opener=None, base_url='http://localhost', timeout=5.0)

Bases: object

Pebble API client.

Initialize a client instance.

Defaults to using a Unix socket at socket_path (which must be specified unless a custom opener is provided).

get_system_info()

Get system info.

Return type

ops.pebble.SystemInfo

get_warnings(select=<WarningState.PENDING: 'pending'>)

Get list of warnings in given state (pending or all).

Parameters

select (ops.pebble.WarningState) –

Return type

List[ops.pebble.Warning]

ack_warnings(timestamp)

Acknowledge warnings up to given timestamp, return number acknowledged.

Parameters

timestamp (datetime.datetime) –

Return type

int

get_changes(select=<ChangeState.IN_PROGRESS: 'in-progress'>, service=None)

Get list of changes in given state, filter by service name if given.

Parameters

• select (ops.pebble.ChangeState) –

• service (Optional[str]) –

Return type

List[ops.pebble.Change]

get_change(change_id)

Get single change by ID.

Parameters

change_id (ops.pebble.ChangeID) –

Return type

ops.pebble.Change

abort_change(change_id)

Abort change with given ID.

Parameters

change_id (ops.pebble.ChangeID) –

Return type

ops.pebble.Change

autostart_services(timeout=30.0, delay=0.1)

Start the startup-enabled services and wait (poll) for them to be started.

Parameters

• timeout (float) – Seconds before autostart change is considered timed out (float).

• delay (float) – Seconds before executing the autostart change (float).

Returns

ChangeID of the autostart change.

Raises

ChangeError – if one or more of the services didn’t start. If timeout is 0, submit the action but don’t wait; just return the change ID immediately.

Return type

ops.pebble.ChangeID

replan_services(timeout=30.0, delay=0.1)

Replan by (re)starting changed and startup-enabled services and wait for them to start.

Parameters

• timeout (float) – Seconds before replan change is considered timed out (float).

• delay (float) – Seconds before executing the replan change (float).

Returns

ChangeID of the replan change.

Raises

ChangeError – if one or more of the services didn’t stop/start. If timeout is 0, submit the action but don’t wait; just return the change ID immediately.

Return type

ops.pebble.ChangeID

start_services(services, timeout=30.0, delay=0.1)

Start services by name and wait (poll) for them to be started.

Parameters

• services (List[str]) – Non-empty list of services to start.

• timeout (float) – Seconds before start change is considered timed out (float).

• delay (float) – Seconds before executing the start change (float).

Returns

ChangeID of the start change.

Raises

ChangeError – if one or more of the services didn’t stop/start. If timeout is 0, submit the action but don’t wait; just return the change ID immediately.

Return type

ops.pebble.ChangeID

stop_services(services, timeout=30.0, delay=0.1)

Stop services by name and wait (poll) for them to be started.

Parameters

• services (List[str]) – Non-empty list of services to stop.

• timeout (float) – Seconds before stop change is considered timed out (float).

• delay (float) – Seconds before executing the stop change (float).

Returns

ChangeID of the stop change.

Raises

ChangeError – if one or more of the services didn’t stop/start. If timeout is 0, submit the action but don’t wait; just return the change ID immediately.

Return type

ops.pebble.ChangeID

restart_services(services, timeout=30.0, delay=0.1)

Restart services by name and wait (poll) for them to be started.

Parameters

• services (List[str]) – Non-empty list of services to restart.

• timeout (float) – Seconds before restart change is considered timed out (float).

• delay (float) – Seconds before executing the restart change (float).

Returns

ChangeID of the restart change.

Raises

ChangeError – if one or more of the services didn’t stop/start. If timeout is 0, submit the action but don’t wait; just return the change ID immediately.

Return type

ops.pebble.ChangeID

wait_change(change_id, timeout=30.0, delay=0.1)

Wait for the given change to be ready.

If the Pebble server supports the /v1/changes/{id}/wait API endpoint, use that to avoid polling, otherwise poll /v1/changes/{id} every delay seconds.

Parameters

• change_id (ops.pebble.ChangeID) – Change ID of change to wait for.

• timeout (float) – Maximum time in seconds to wait for the change to be ready. May be None, in which case wait_change never times out.

• delay (float) – If polling, this is the delay in seconds between attempts.

Returns

The Change object being waited on.

Raises

TimeoutError – If the maximum timeout is reached.

Return type

ops.pebble.Change

add_layer(label, layer, *, combine=False)

Dynamically add a new layer onto the Pebble configuration layers.

If combine is False (the default), append the new layer as the top layer with the given label. If combine is True and the label already exists, the two layers are combined into a single one considering the layer override rules; if the layer doesn’t exist, it is added as usual.

Parameters

• label (str) –

• layer (Union[str, dict, ops.pebble.Layer]) –

• combine (bool) –

get_plan()

Get the Pebble plan (contains combined layer configuration).

Return type

ops.pebble.Plan

get_services(names=None)

Get the service status for the configured services.

If names is specified, only fetch the service status for the services named.

Parameters

names (Optional[List[str]]) –

Return type

List[ops.pebble.ServiceInfo]

pull(path, *, encoding='utf-8')

Read a file’s content from the remote system.

Parameters

• path (str) – Path of the file to read from the remote system.

• encoding (str) – Encoding to use for decoding the file’s bytes to str, or None to specify no decoding.

Returns

A readable file-like object, whose read() method will return str objects decoded according to the specified encoding, or bytes if encoding is None.

Return type

Union[BinaryIO, TextIO]

push(path, source, *, encoding='utf-8', make_dirs=False, permissions=None, user_id=None, user=None, group_id=None, group=None)

Write content to a given file path on the remote system.

Parameters

• path (str) – Path of the file to write to on the remote system.

• source (Union[bytes, str, BinaryIO, TextIO]) – Source of data to write. This is either a concrete str or bytes instance, or a readable file-like object.

• encoding (str) – Encoding to use for encoding source str to bytes, or strings read from source if it is a TextIO type. Ignored if source is bytes or BinaryIO.

• make_dirs (bool) – If True, create parent directories if they don’t exist.

• permissions (Optional[int]) – Permissions (mode) to create file with (Pebble default is 0o644).

• user_id (Optional[int]) – User ID (UID) for file.

• user (Optional[str]) – Username for file. User’s UID must match user_id if both are specified.

• group_id (Optional[int]) – Group ID (GID) for file.

• group (Optional[str]) – Group name for file. Group’s GID must match group_id if both are specified.

list_files(path, *, pattern=None, itself=False)

Return list of directory entries from given path on remote system.

Despite the name, this method returns a list of files and directories, similar to os.listdir() or os.scandir().

Parameters

• path (str) – Path of the directory to list, or path of the file to return information about.

• pattern (Optional[str]) – If specified, filter the list to just the files that match, for example *.txt.

• itself (bool) – If path refers to a directory, return information about the directory itself, rather than its contents.

Return type

List[ops.pebble.FileInfo]

make_dir(path, *, make_parents=False, permissions=None, user_id=None, user=None, group_id=None, group=None)

Create a directory on the remote system with the given attributes.

Parameters

• path (str) – Path of the directory to create on the remote system.

• make_parents (bool) – If True, create parent directories if they don’t exist.

• permissions (Optional[int]) – Permissions (mode) to create directory with (Pebble default is 0o755).

• user_id (Optional[int]) – User ID (UID) for directory.

• user (Optional[str]) – Username for directory. User’s UID must match user_id if both are specified.

• group_id (Optional[int]) – Group ID (GID) for directory.

• group (Optional[str]) – Group name for directory. Group’s GID must match group_id if both are specified.

remove_path(path, *, recursive=False)

Remove a file or directory on the remote system.

Parameters

• path (str) – Path of the file or directory to delete from the remote system.

• recursive (bool) – If True, and path is a directory recursively deletes it and everything under it. If the path is a file, delete the file and do nothing if the file is non-existent. Behaviourally similar to rm -rf <file|dir>

exec(command, *, environment=None, working_dir=None, timeout=None, user_id=None, user=None, group_id=None, group=None, stdin=None, stdout=None, stderr=None, encoding='utf-8', combine_stderr=False)

Execute the given command on the remote system.

Most of the parameters are explained in the “Parameters” section below, however, input/output handling is a bit more complex. Some examples are shown below:

# Simple command with no output; just check exit code
>>> process = client.exec(['send-emails'])
>>> process.wait()

# Fetch output as string
>>> process = client.exec(['python3', '--version'])
>>> version, _ = process.wait_output()
>>> print(version)
Python 3.8.10

# Fetch both stdout and stderr as strings
>>> process = client.exec(['pg_dump', '-s', ...])
>>> schema, logs = process.wait_output()

# Stream input from a string and write output to files
>>> stdin = 'foo\nbar\n'
>>> with open('out.txt', 'w') as out, open('err.txt', 'w') as err:
...     process = client.exec(['awk', '{ print toupper($0) }'],
...                           stdin=stdin, stdout=out, stderr=err)
...     process.wait()
>>> open('out.txt').read()
'FOO\nBAR\n'
>>> open('err.txt').read()
''

# Real-time streaming using ExecProcess.stdin and ExecProcess.stdout
>>> process = client.exec(['cat'])
>>> def stdin_thread():
...     for line in ['one\n', '2\n', 'THREE\n']:
...         process.stdin.write(line)
...         process.stdin.flush()
...         time.sleep(1)
...     process.stdin.close()
...
>>> threading.Thread(target=stdin_thread).start()
>>> for line in process.stdout:
...     print(datetime.datetime.now().strftime('%H:%M:%S'), repr(line))
...
16:20:26 'one\n'
16:20:27 '2\n'
16:20:28 'THREE\n'
>>> process.wait()  # will return immediately as stdin was closed

# Show exception raised for non-zero return code
>>> process = client.exec(['ls', 'notexist'])
>>> out, err = process.wait_output()
Traceback (most recent call last):
  ...
ExecError: "ls" returned exit code 2
>>> exc = sys.last_value
>>> exc.exit_code
2
>>> exc.stdout
''
>>> exc.stderr
"ls: cannot access 'notfound': No such file or directory\n"

Parameters

• command (List[str]) – Command to execute: the first item is the name (or path) of the executable, the rest of the items are the arguments.

• environment (Optional[Dict[str, str]]) – Environment variables to pass to the process.

• working_dir (Optional[str]) – Working directory to run the command in. If not set, Pebble uses the target user’s $HOME directory (and if the user argument is not set, $HOME of the user Pebble is running as).

• timeout (Optional[float]) – Timeout in seconds for the command execution, after which the process will be terminated. If not specified, the execution never times out.

• user_id (Optional[int]) – User ID (UID) to run the process as.

• user (Optional[str]) – Username to run the process as. User’s UID must match user_id if both are specified.

• group_id (Optional[int]) – Group ID (GID) to run the process as.

• group (Optional[str]) – Group name to run the process as. Group’s GID must match group_id if both are specified.

• stdin (Optional[Union[str, bytes, TextIO, BinaryIO]]) – A string or readable file-like object that is sent to the process’s standard input. If not set, the caller can write input to ExecProcess.stdin to stream input to the process.

• stdout (Optional[Union[TextIO, BinaryIO]]) – A writable file-like object that the process’s standard output is written to. If not set, the caller can use ExecProcess.wait_output() to capture output as a string, or read from ExecProcess.stdout() to stream output from the process.

• stderr (Optional[Union[TextIO, BinaryIO]]) – A writable file-like object that the process’s standard error is written to. If not set, the caller can use ExecProcess.wait_output() to capture error output as a string, or read from ExecProcess.stderr() to stream error output from the process. Must be None if combine_stderr is True.

• encoding (str) – If encoding is set (the default is UTF-8), the types read or written to stdin/stdout/stderr are str, and encoding is used to encode them to bytes. If encoding is None, the types read or written are raw bytes.

• combine_stderr (bool) – If True, process’s stderr output is combined into its stdout (the stderr argument must be None). If False, separate streams are used for stdout and stderr.

Returns

A Process object representing the state of the running process. To wait for the command to finish, the caller will typically call ExecProcess.wait() if stdout/stderr were provided as arguments to exec(), or ExecProcess.wait_output() if not.

Return type

ops.pebble.ExecProcess

send_signal(sig, services)

Send the given signal to the list of services named.

Parameters

• sig (Union[int, str]) – Name or number of signal to send, e.g., “SIGHUP”, 1, or signal.SIGHUP.

• services (List[str]) – Non-empty list of service names to send the signal to.

Raises

APIError – If any of the services are not in the plan or are not currently running.

get_checks(level=None, names=None)

Get the check status for the configured checks.

Parameters

• level (Optional[ops.pebble.CheckLevel]) – Optional check level to query for (default is to fetch checks with any level).

• names (Optional[List[str]]) – Optional list of check names to query for (default is to fetch checks with any name).

Returns

List of CheckInfo objects.

Return type

List[ops.pebble.CheckInfo]

ops.testing module

Infrastructure to build unittests for Charms using the Operator Framework.

Global Variables:

SIMULATE_CAN_CONNECT: This enables can_connect simulation for the test harness. It should be set before you create Harness instances and not changed after. You should set this to true - it will help your tests be more accurate! This causes all containers’ can_connect states initially be False rather than True and causes the testing with the harness to model and track can_connect state for containers accurately. This means that calls that require communication with the container API (e.g. Container.push, Container.get_plan, Container.add_layer, etc.) will only succeed if Container.can_connect() returns True and will raise exceptions otherwise. can_connect state evolves automatically to track with events associated with container state, (e.g. calling container_pebble_ready). If SIMULATE_CAN_CONNECT is True, can_connect state for containers can also be manually controlled using Harness.set_can_connect.

class ops.testing.Harness(charm_cls, *, meta=None, actions=None, config=None)

Bases: Generic[typing.CharmType]

This class represents a way to build up the model that will drive a test suite.

The model that is created is from the viewpoint of the charm that you are testing.

Example:

harness = Harness(MyCharm)
# Do initial setup here
relation_id = harness.add_relation('db', 'postgresql')
# Now instantiate the charm to see events as the model changes
harness.begin()
harness.add_relation_unit(relation_id, 'postgresql/0')
harness.update_relation_data(relation_id, 'postgresql/0', {'key': 'val'})
# Check that charm has properly handled the relation_joined event for postgresql/0
self.assertEqual(harness.charm. ...)

Parameters

• charm_cls – The Charm class that you’ll be testing.

• meta – charm.CharmBase is a A string or file-like object containing the contents of metadata.yaml. If not supplied, we will look for a ‘metadata.yaml’ file in the parent directory of the Charm, and if not found fall back to a trivial ‘name: test-charm’ metadata.

• actions – A string or file-like object containing the contents of actions.yaml. If not supplied, we will look for a ‘actions.yaml’ file in the parent directory of the Charm.

• config – A string or file-like object containing the contents of config.yaml. If not supplied, we will look for a ‘config.yaml’ file in the parent directory of the Charm.

set_can_connect(container, val)

Change the simulated can_connect status of a container’s underlying pebble client.

Calling this method raises an exception if SIMULATE_CAN_CONNECT is False.

Parameters

• container (Union[str, ops.model.Container]) –

• val (bool) –

property charm

Return the instance of the charm class that was passed to __init__.

Note that the Charm is not instantiated until you have called begin().

property model

Return the Model that is being driven by this Harness.

property framework

Return the Framework that is being driven by this Harness.

begin()

Instantiate the Charm and start handling events.

Before calling begin(), there is no Charm instance, so changes to the Model won’t emit events. You must call begin() before charm is valid.

Return type

None

begin_with_initial_hooks()

Called when you want the Harness to fire the same hooks that Juju would fire at startup.

This triggers install, relation-created, config-changed, start, and any relation-joined hooks based on what relations have been defined+added before you called begin. This does NOT trigger a pebble-ready hook. Note that all of these are fired before returning control to the test suite, so if you want to introspect what happens at each step, you need to fire them directly (e.g. Charm.on.install.emit()). In your hook callback functions, you should not assume that workload containers are active; guard such code with checks to Container.can_connect(). You are encouraged to test this by setting the global SIMULATE_CAN_CONNECT variable to True.

To use this with all the normal hooks, you should instantiate the harness, setup any relations that you want active when the charm starts, and then call this method. This method will automatically create and add peer relations that are specified in metadata.yaml.

Example:

harness = Harness(MyCharm)
# Do initial setup here
# Add storage if needed before begin_with_initial_hooks() is called
storage_ids = harness.add_storage('data', count=1)[0]
storage_id = storage_id[0] # we only added one storage instance
relation_id = harness.add_relation('db', 'postgresql')
harness.add_relation_unit(relation_id, 'postgresql/0')
harness.update_relation_data(relation_id, 'postgresql/0', {'key': 'val'})
harness.set_leader(True)
harness.update_config({'initial': 'config'})
harness.begin_with_initial_hooks()
# This will cause
# install, db-relation-created('postgresql'), leader-elected, config-changed, start
# db-relation-joined('postrgesql/0'), db-relation-changed('postgresql/0')
# To be fired.

Return type

None

cleanup()

Called by your test infrastructure to cleanup any temporary directories/files/etc.

Currently this only needs to be called if you test with resources. But it is reasonable to always include a testcase.addCleanup(harness.cleanup) just in case.

Return type

None

add_oci_resource(resource_name, contents=None)

Add oci resources to the backend.

This will register an oci resource and create a temporary file for processing metadata about the resource. A default set of values will be used for all the file contents unless a specific contents dict is provided.

Parameters

• resource_name (str) – Name of the resource to add custom contents to.

• contents (Optional[Mapping[str, str]]) – Optional custom dict to write for the named resource.

Return type

None

add_resource(resource_name, content)

Add content for a resource to the backend.

This will register the content, so that a call to Model.resources.fetch(resource_name) will return a path to a file containing that content.

Parameters

• resource_name (str) – The name of the resource being added

• content (AnyStr) – Either string or bytes content, which will be the content of the filename returned by resource-get. If contents is a string, it will be encoded in utf-8

Return type

None

populate_oci_resources()

Populate all OCI resources.

Return type

None

disable_hooks()

Stop emitting hook events when the model changes.

This can be used by developers to stop changes to the model from emitting events that the charm will react to. Call enable_hooks() to re-enable them.

Return type

None

enable_hooks()

Re-enable hook events from charm.on when the model is changed.

By default hook events are enabled once you call begin(), but if you have used disable_hooks(), this can be used to enable them again.

Return type

None

hooks_disabled()

A context manager to run code with hooks disabled.

Example:

with harness.hooks_disabled():
    # things in here don't fire events
    harness.set_leader(True)
    harness.update_config(unset=['foo', 'bar'])
# things here will again fire events

add_storage(storage_name, count=1)

Declare a new storage device attached to this unit.

To have repeatable tests, each device will be initialized with location set to /<storage_name>N, where N is the counter and will be a number from [0,total_num_disks-1]

Parameters

• storage_name (str) – The storage backend name on the Charm

• count (int) – Number of disks being added

Returns

A list of storage IDs, e.g. [“my-storage/1”, “my-storage/2”].

Return type

List[str]

detach_storage(storage_id)

Detach a storage device.

The intent of this function is to simulate a “juju detach-storage” call. It will trigger a storage-detaching hook if the storage unit in question exists and is presently marked as attached.

Parameters

storage_id (str) – The full storage ID of the storage unit being detached, including the storage key, e.g. my-storage/0.

Return type

None

attach_storage(storage_id)

Attach a storage device.

The intent of this function is to simulate a “juju attach-storage” call. It will trigger a storage-attached hook if the storage unit in question exists and is presently marked as detached.

Parameters

storage_id (str) – The full storage ID of the storage unit being attached, including the storage key, e.g. my-storage/0.

Return type

None

remove_storage(storage_id)

Detach a storage device.

The intent of this function is to simulate a “juju remove-storage” call. It will trigger a storage-detaching hook if the storage unit in question exists and is presently marked as attached. Then it will remove the storage unit from the testing backend.

Parameters

storage_id (str) – The full storage ID of the storage unit being removed, including the storage key, e.g. my-storage/0.

Return type

None

add_relation(relation_name, remote_app)

Declare that there is a new relation between this app and remote_app.

In the case of adding peer relations, remote_app is this app. This function creates a relation with an application and will trigger a relation-created hook. To relate units (and trigger relation-joined and relation-changed hooks), you should also call add_relation_unit().

Parameters

• relation_name (str) – The relation on Charm that is being related to

• remote_app (str) – The name of the application that is being related to

Returns

The relation_id created by this add_relation.

Return type

int

remove_relation(relation_id)

Remove a relation.

Parameters

relation_id (int) – The relation ID for the relation to be removed.

Raises

RelationNotFoundError – if relation id is not valid

Return type

None

add_relation_unit(relation_id, remote_unit_name)

Add a new unit to a relation.

Example:

rel_id = harness.add_relation('db', 'postgresql')
harness.add_relation_unit(rel_id, 'postgresql/0')

This will trigger a relation_joined event. This would naturally be followed by a relation_changed event, which you can trigger with update_relation_data(). This separation is artificial in the sense that Juju will always fire the two, but is intended to make testing relations and their data bags slightly more natural.

Parameters

• relation_id (int) – The integer relation identifier (as returned by add_relation).

• remote_unit_name (str) – A string representing the remote unit that is being added.

Returns

None

Return type

None

remove_relation_unit(relation_id, remote_unit_name)

Remove a unit from a relation.

Example:

rel_id = harness.add_relation('db', 'postgresql')
harness.add_relation_unit(rel_id, 'postgresql/0')
...
harness.remove_relation_unit(rel_id, 'postgresql/0')

This will trigger a relation_departed event. This would normally be followed by a relation_changed event triggered by Juju. However when using the test harness a relation_changed event must be triggererd using update_relation_data(). This deviation from normal Juju behaviour, facilitates testing by making each step in the charm life cycle explicit.

Parameters

• relation_id (int) – The integer relation identifier (as returned by add_relation).

• remote_unit_name (str) – A string representing the remote unit that is being added.

Raises

• KeyError – if relation_id or remote_unit_name is not valid

• ValueError – if remote_unit_name is not valid

Return type

None

get_relation_data(relation_id, app_or_unit)

Get the relation data bucket for a single app or unit in a given relation.

This ignores all of the safety checks of who can and can’t see data in relations (eg, non-leaders can’t read their own application’s relation data because there are no events that keep that data up-to-date for the unit).

Parameters

• relation_id (int) – The relation whose content we want to look at.

• app_or_unit (Union[str, ops.model.Application, ops.model.Unit]) – An Application or Unit instance, or its name, whose data we want to read

Returns

A dict containing the relation data for app_or_unit or None.

Raises

KeyError – if relation_id doesn’t exist

Return type

Mapping

get_pod_spec()

Return the content of the pod spec as last set by the charm.

This returns both the pod spec and any k8s_resources that were supplied. See the signature of Model.pod.set_spec

Return type

(typing.Mapping, typing.Mapping)

get_container_pebble_plan(container_name)

Return the current Plan that pebble is executing for the given container.

Parameters

container_name (str) – The simple name of the associated container

Returns

The pebble.Plan for this container. You can use ops.pebble.Plan.to_yaml() to get a string form for the content. Will raise KeyError if no pebble client exists for that container name. (should only happen if container is not present in metadata.yaml)

Return type

ops.pebble.Plan

container_pebble_ready(container_name)

Fire the pebble_ready hook for the associated container.

This will do nothing if the begin() has not been called. If SIMULATE_CAN_CONNECT is True, this will switch the given container’s can_connect state to True before the hook function is called.

Parameters

container_name (str) –

get_workload_version()

Read the workload version that was set by the unit.

Return type

str

set_model_info(name=None, uuid=None)

Set the name and uuid of the Model that this is representing.

This cannot be called once begin() has been called. But it lets you set the value that will be returned by Model.name and Model.uuid.

This is a convenience method to invoke both Harness.set_model_name and Harness.set_model_uuid at once.

Parameters

• name (Optional[str]) –

• uuid (Optional[str]) –

Return type

None

set_model_name(name)

Set the name of the Model that this is representing.

This cannot be called once begin() has been called. But it lets you set the value that will be returned by Model.name.

Parameters

name (str) –

Return type

None

set_model_uuid(uuid)

Set the uuid of the Model that this is representing.

This cannot be called once begin() has been called. But it lets you set the value that will be returned by Model.uuid.

Parameters

uuid (str) –

Return type

None

update_relation_data(relation_id, app_or_unit, key_values)

Update the relation data for a given unit or application in a given relation.

This also triggers the relation_changed event for this relation_id.

Parameters

• relation_id (int) – The integer relation_id representing this relation.

• app_or_unit (str) – The unit or application name that is being updated. This can be the local or remote application.

• key_values (Mapping) – Each key/value will be updated in the relation data.

Return type

None

update_config(key_values=None, unset=())

Update the config as seen by the charm.

This will trigger a config_changed event.

Note that the key_values mapping will only add or update configuration items. To remove existing ones, see the unset parameter.

Parameters

• key_values (Optional[Mapping[str, str]]) – A Mapping of key:value pairs to update in config.

• unset (Iterable[str]) – An iterable of keys to remove from Config. (Note that this does not currently reset the config values to the default defined in config.yaml.)

Return type

None

set_leader(is_leader=True)

Set whether this unit is the leader or not.

If this charm becomes a leader then leader_elected will be triggered. If Harness.begin() has already been called, then the charm’s peer relation should usually be added prior to calling this method (i.e. with Harness.add_relation) to properly initialize and make available relation data that leader elected hooks may want to access.

Parameters

is_leader (bool) – True/False as to whether this unit is the leader.

Return type

None

set_planned_units(num_units)

Set the number of “planned” units that “Application.planned_units” should return.

In real world circumstances, this number will be the number of units in the application. E.g., this number will be the number of peers this unit has, plus one, as we count our own unit in the total.

A change to the return from planned_units will not generate an event. Typically, a charm author would check planned units during a config or install hook, or after receiving a peer relation joined event.

Parameters

num_units (int) –

Return type

None

reset_planned_units()

Reset the planned units override.

This allows the harness to fall through to the built in methods that will try to guess at a value for planned units, based on the number of peer relations that have been setup in the testing harness.

exception ops.testing.NonAbsolutePathError

Bases: Exception

Error raised by _TestingFilesystem.

This error is raised when an absolute path is required but the code instead encountered a relative path.

Indices and tables

• Index

• Module Index

• Search Page