SDK How-to guides

Step-by-step guides covering key operations and common tasks related to the Charm SDK

• Build a 12-Factor app charm
• Build a charm or bundle
• Manage bundles
• Set things up
  • Set up your development environment
  • Set up a charm project
  • Manage extensions
  • Install and manage Charmcraft
    • Install Charmcraft
    • Configure Charmcraft
    • Authenticate Charmcraft in remote environments
    • Change step behavior when creating a charm
  • Include extra files in a charm
• Develop
  • Configure logging in a charm
  • Use charm resources
  • Run workloads with a charm - machines
  • Run workloads with a charm - Kubernetes
  • Set the charm version
  • Set the workload version
  • Add an action to a charm
  • Add a config option to a charm
  • Use storage in a charm
  • Use secrets in a charm
  • Use charm libraries
    • Find and use a charm library
    • Create and publish a charm library
    • Write a scenario test for a charm library
    • Document a charm library
  • Handle leadership
  • Add an integration to a charm
  • Observe your charm
  • Manage interfaces
    • Register an interface
    • Write interface tests
• Test and debug
  • Get started with charm testing
  • Write a unit test for a charm
  • Write a scenario test for a charm
  • Write integration tests for a charm
  • Pack a charm
  • Deploy a charm
  • Debug a charm
  • Get logs from a Kubernetes charm
• Document
  • Add docs to a charm on Charmhub
  • Document a charm: The README file
• Market
  • Publish a charm
  • Create a track for your charm
  • Create an icon for a charm
• Miscellaneous
  • Align an old charm with charmcraft and ops
    • Turn a hooks-based charm into an ops charm
    • Pack a reactive-based charm with Charmcraft
    • Pack a hooks-based charm with Charmcraft