Skip to main content

The main tool to build, upload, and develop in general the Juju charms.

Project description

charmcraft Tests Spread Weekly Spread

Charmcraft -- easily initialise, pack, and publish your charms

Charmcraft is a CLI tool that makes it easy and quick to initialise, package, and publish Kubernetes and machine charms. It is an official component of the Charm SDK, itself a part of the Juju universe.

Juju Learn how to quickly deploy, integrate, and manage charms on any cloud with Juju.
It's as simple as juju deploy foo, juju integrate foo bar, ..., on any cloud.
Charmhub Sample our existing charms on Charmhub.
A charm can be a cluster (OpenStack, Kubernetes), a data platform (PostgreSQL, MongoDB, etc.), an observability stack (Canonical Observability Stack), an MLOps solution (Kubeflow), and so much more.
:point_right: Charm SDK Write your own charm!
Juju is written in Go, but our SDK supports easy charm development in Python.

Give it a try

Let's use Charmcraft to initialise and pack a Kubernetes charm:

Set up

See Charm SDK | Set up your development environment automatically > Set up an Ubuntu charm-dev VM with Multipass.
Choose the MicroK8s track.

Initialise and pack your charm

In your Multipass VM shell, create a charm directory and use Charmcraft to initialise your charm file structure:

mkdir my-new-charm
cd my-new-charm
charmcraft init

This has created a standard charm directory structure:

$ ls -R
.:
CONTRIBUTING.md  README.md        pyproject.toml    src    tox.ini
LICENSE          charmcraft.yaml  requirements.txt  tests

./src:
charm.py

./tests:
integration  unit

./tests/integration:
test_charm.py

./tests/unit:
test_charm.py

Poke around:

Note that the charmcraft.yaml file shows that what we have is an example charm called my-new-charm, which builds on Ubuntu 22.04 and which uses an OCI image resource httpbin from kennethreitz/httpbin.

Note that the src/charm.py file contains code scaffolding featuring the Charm SDK's Ops library for writing charms.

Explore further, start editing the files, or skip ahead and pack the charm:

charmcraft pack

If you didn't take any wrong turn or simply left the charm exactly as it was, this should work and yield a file called my-new-charm_ubuntu-22.04-amd64.charm (the architecture bit may be different depending on your system's architecture). Use this name and the resource from the metadata.yaml to deploy your example charm to your local MicroK8s cloud with Juju:

juju deploy ./my-new-charm_ubuntu-22.04-amd64.charm --resource httpbin-image=kennethreitz/httpbin

Congratulations, you’ve just initialised and packed your first Kubernetes charm using Charmcraft!

But Charmcraft goes far beyond init and pack. For example, when you're ready to share your charm with the world, you can use Charmcraft to publish your charm on Charmhub. Run charmcraft help to preview more.

Clean up

See Charm SDK | Set up your development environment automatically > Clean up.

Next steps

Learn more

Read our user documentation, which also includes other guides showing Charmcraft in action

Chat with us

Read our Code of conduct and:

File an issue

Make your mark

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

charmcraft-3.2.2.tar.gz (424.1 kB view details)

Uploaded Source

Built Distribution

charmcraft-3.2.2-py3-none-any.whl (223.3 kB view details)

Uploaded Python 3

File details

Details for the file charmcraft-3.2.2.tar.gz.

File metadata

  • Download URL: charmcraft-3.2.2.tar.gz
  • Upload date:
  • Size: 424.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for charmcraft-3.2.2.tar.gz
Algorithm Hash digest
SHA256 eab931c9a37756c8f4eeabe55d98aa4862cb92474702e16b4224f31b1c0708e9
MD5 05c6f08352b04b55e141906c114bfb81
BLAKE2b-256 1280b464c8b5e44c93315de664e6398c9132d837ed2f4d468cf366fc5beeb418

See more details on using hashes here.

File details

Details for the file charmcraft-3.2.2-py3-none-any.whl.

File metadata

  • Download URL: charmcraft-3.2.2-py3-none-any.whl
  • Upload date:
  • Size: 223.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for charmcraft-3.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9428aac43ed7986e6655fb42d24b0f3167cb77bde3cbc40e6bcaff7ad13a2ec8
MD5 edade5d1951caf73ac0c6a504b327e9a
BLAKE2b-256 fc9500a3f561236eb58701d02f21ad6de252bfeb520da27264262fa47ec9bd1e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page