The main tool to build, upload, and develop in general the Juju charms.
Project description
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-devVM 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
- Report a Charmcraft bug on GitHub
- Raise a general https://juju.is/docs documentation issue on GitHub | juju/docs
Make your mark
- Read our documentation contributor guidelines and help improve a doc
- Read our codebase contributor guidelines and help improve the codebase
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file charmcraft-3.1.1.tar.gz.
File metadata
- Download URL: charmcraft-3.1.1.tar.gz
- Upload date:
- Size: 424.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 37a5099cc715227aea3f7fe6bebb06d8e3ca6122a2621812301c4daeb0825f3a |
|
| MD5 | 96abec4472bac52d7fa98234f66234c8 |
|
| BLAKE2b-256 | 4b7724455dd47274add9ec1beae1d804ca52e04f7d634a0b249cfa9ae2624e88 |
File details
Details for the file charmcraft-3.1.1-py3-none-any.whl.
File metadata
- Download URL: charmcraft-3.1.1-py3-none-any.whl
- Upload date:
- Size: 266.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4a962600eb876aa9fd787d2199687e17c653cb26563dec77dd22d691e23b163c |
|
| MD5 | 96ad6d3a2b538d4534476b52bb6e7200 |
|
| BLAKE2b-256 | 6ce0af25b1dca37d7b4e1609e382861dbc8a9b0b22d9ee177a057b97c34346c8 |
