Reference¶

These guides provide technical information about Ops APIs.

Core APIs¶

ops.main is the entry point to initialise and run your charm. ops is the API to respond to Juju events and manage the application.

Pebble¶

An API for interacting with Pebble. You usually shouldn’t use this API directly. Instead, use ops.Container for interacting with containers. See How to run workloads with a Kubernetes charm.

ops.pebble

Testing¶

APIs for testing charms. ops.testing includes an API for writing state-transition tests, which are the recommend way to write charm unit tests. Harness is deprecated; for guidance on how to upgrade to state-transition tests, see How to migrate unit tests from Harness.

Tracing¶

An API for tracing charm code and sending data to sources such as the Canonical Observability Stack.

ops.tracing

Hook commands¶

A low-level API for accessing the Juju hook commands. This API isn’t intended for charms to use directly. It primarily supports alternatives to the Ops framework.

ops.hookcmds