How-to guides

• Set up Charmcraft
  • Install Charmcraft
  • Check the installed version of Charmcraft
• Manage charms
  • Initialise a charm
  • Add charm project metadata, an icon, docs
  • Add runtime details to a charm
  • Pack a charm
  • Publish a charm on Charmhub
• Manage a 12-factor app charm
  • Prepare an OCI image for a 12-factor app charm
  • Initialise a 12-factor app charm
  • Manage configurations for a 12-factor app charm
  • Manage relations for a 12-factor app charm
  • Manage secrets for a 12-factor app charm
  • Use 12-factor app charms
• Manage extensions
  • View all the available extensions
  • View details about the extension in use
• Manage resources
  • Declare a resource
  • Publish a resource on Charmhub
  • View all the resources published on Charmhub
  • Manage resource revisions
• Manage libraries
  • Initialise a library
  • Publish a library on Charmhub
  • View the libs published for a charm
  • Use a library
• Manage parts
  • Remove a part’s assets
  • Download or retrieve artifacts defined for a part
  • Build artifacts defined for a part
  • Stage built artifacts into a common staging area
  • Prime artifacts defined for a part
  • Build the charm or bundle
• Manage the current Charmhub user
  • Log in to Charmhub
  • Check the currently logged in user
  • Log out of Charmhub
• Manage names
  • Register a name on Charmhub
  • View registered names
  • Unregister a name
• Manage charm revisions
  • Create a charm revision
  • View the existing charm revisions
  • Promote a charm revision to a better risk level
  • Release a charm revision into a channel
• Manage channels
  • Create a channel
  • View the available channels
  • Customise a channel’s track
  • Open a channel
  • Close a channel
• Manage tracks
  • Request a track guardrail
  • Create a track
• Manage icons
  • Learn about icon requirements and best practices
  • Create an icon
  • Validate an icon
  • Add an icon to its charm’s Charmhub page
• Manage charm bundles
  • Create a bundle
  • Pack a bundle
  • Publish a bundle on Charmhub
• How to write a Kubernetes charm for an async Flask app
• Make the rock async
  • Configure the async application
• Migrate plugins
  • Migrate to poetry
  • Migrate to python
• Build
  • Cache intermediate build artefacts
  • Pack a hook-based charm with Charmcraft
  • Pack a reactive charm with Charmcraft