You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-33Lines changed: 8 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -5,24 +5,15 @@
5
5
6
6
# Charmcraft -- easily initialise, pack, and publish your charms
7
7
8
-
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](https://juju.is/).
9
-
10
-
||||
11
-
|-|-|- |
12
-
||[Juju](https://juju.is/docs/juju)| Learn how to quickly deploy, integrate, and manage charms on any cloud with Juju. <br> _It's as simple as `juju deploy foo`, `juju integrate foo bar`, ..., on any cloud._|
13
-
||||
14
-
||[Charmhub](https://charmhub.io/)| Sample our existing charms on Charmhub. <br> _A charm can be a cluster ([OpenStack](https://charmhub.io/openstack-base), [Kubernetes](https://charmhub.io/charmed-kubernetes)), a data platform ([PostgreSQL](https://charmhub.io/postgresql-k8s), [MongoDB](https://charmhub.io/mongodb), etc.), an observability stack ([Canonical Observability Stack](https://charmhub.io/cos-lite)), an MLOps solution ([Kubeflow](https://charmhub.io/kubeflow)), and so much more._|
15
-
||||
16
-
|:point_right:|[Charm SDK](https://juju.is/docs/sdk)| Write your own charm! <br> _Juju is written in Go, but our SDK supports easy charm development in Python._|
17
-
8
+
Charmcraft is a CLI tool that makes it easy and quick to initialise, package, and publish Kubernetes and machine charms.
18
9
19
10
## Give it a try
20
11
21
12
Let's use Charmcraft to initialise and pack a Kubernetes charm:
22
13
23
14
### Set up
24
15
25
-
> See [Charm SDK | Set up your development environment automatically > Set up an Ubuntu `charm-dev` VM with Multipass](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass). <br> Choose the MicroK8s track.
16
+
> See [Juju | Set things up](https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-your-deployment/manage-your-deployment-environment/#set-things-up). <br> Choose the automatic track and MicroK8s.
26
17
27
18
### Initialise and pack your charm
28
19
@@ -55,13 +46,13 @@ test_charm.py
55
46
test_charm.py
56
47
```
57
48
58
-
Poke around:
49
+
Poke around:
59
50
60
51
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`.
61
52
62
53
Note that the `src/charm.py` file contains code scaffolding featuring the Charm SDK's Ops library for writing charms.
63
54
64
-
Explore further, start editing the files, or skip ahead and pack the charm:
55
+
Explore further, start editing the files, or skip ahead and pack the charm:
65
56
66
57
```
67
58
charmcraft pack
@@ -79,26 +70,10 @@ But Charmcraft goes far beyond `init` and `pack`. For example, when you're ready
79
70
80
71
### Clean up
81
72
82
-
> See [Charm SDK | Set up your development environment automatically > Clean up](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass).
73
+
> See [Juju | Tear things down](https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-your-deployment/manage-your-deployment-environment/#tear-things-down). <br> Choose the automatic track.
83
74
84
75
## Next steps
85
76
86
-
### Learn more
87
-
88
-
Read our [user documentation](https://juju.is/docs/sdk/charmcraft), which also includes other guides showing Charmcraft in action
89
-
90
-
### Chat with us
91
-
92
-
Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and:
- Report a Charmcraft bug on [GitHub](https://github.com/canonical/charmcraft/issues)
99
-
- Raise a general https://juju.is/docs documentation issue on [GitHub | juju/docs](https://github.com/juju/docs)
100
-
101
-
### Make your mark
102
-
103
-
- Read our [documentation contributor guidelines](https://discourse.charmhub.io/t/documentation-guidelines-for-contributors/1245) and help improve a doc
104
-
- Read our [codebase contributor guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md) and help improve the codebase
77
+
- Read the [docs](https://canonical-charmcraft.readthedocs-hosted.com/en/stable/).
78
+
- Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and join our [chat](https://matrix.to/#/#charmhub-charmcraft:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/charmcraft/issues).
79
+
- Read our [CONTRIBUTING guide](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md) and contribute!
0 commit comments