Ops documentation¶

Ops is a Python framework for writing and testing Juju charms.

The core ops package provides an API to respond to Juju events and manage your charm’s application. Ops also includes extra packages for testing and tracing charms.

Ops promotes consistent and maintainable charm code. Its APIs help you separate different aspects of your charm, such as managing the application’s state and integrating with other charms.

Get started¶

Generate charm code for a web app

Use our CLI tools to turn your 12-factor app into a charm that’s ready to deploy. We support Django, FastAPI, Go, and more!

Write your first 12-factor app charm

Write your first charm from scratch

For a hands-on introduction to charm development with Ops, try our tutorials:

In this documentation¶

Starting a project	Manage charms • Write and structure charm code
Running workloads	Manage packages on machines • Manage Kubernetes workloads
Adding functionality	Manage relations • Manage configuration • More Juju features
Testing & CI	Write unit tests • Write integration tests
Design & best practices	Holistic vs delta charms • Follow best practices • Trace your charm
Publishing	Make your charm discoverable

How this documentation is organised¶

This documentation uses the Diátaxis documentation structure.

Tutorials
How-to guides
Reference, including ops, ops.testing, and ops.tracing
Explanation

Demo charms¶

The Ops repository has several demo charms that you can experiment with.

Ops releases¶

Read the release notes

Ops releases are tracked in GitHub. To get notified when there’s a new release, watch the Ops repository.

The ops package is published on PyPI.

Project and community¶

Ops is a member of the Ubuntu family. It’s an open source project that warmly welcomes community contributions, suggestions, fixes and constructive feedback.

For support, join Charm Development on Matrix. You’ll be able to chat with the maintainers of Ops (the Canonical Charm Tech team) and a friendly community of charm developers!

To follow along with updates and tips about charm development, join our Discourse forum.

Charmcraft	The CLI tool for initialising charms, packing charms, and interacting with Charmhub. You’ll find the charmcraft.yaml specification especially helpful.
Charmlibs	A listing of charm libraries and guidance on how to distribute your own libraries.
Concierge	A CLI tool for setting up charm development environments.
Jubilant	A Python library that wraps the Juju CLI. Use Jubilant for your integration tests.
Juju	The orchestration engine and CLI tool. You’ll find the hooks reference especially helpful. Juju’s hooks correspond to events that your charm can observe.
Pebble	The service manager inside containers (Kubernetes charms only). You’ll find the layer specification especially helpful.