How-to guides

• Manage charms
  • Prepare your environment
  • Initialise your charm project
  • Develop your charm
  • Publish your charm
• Write and structure charm code
  • Create a repository and initialise it
  • Define the required dependencies
  • Design your Python modules
  • Handle status
  • Handle errors
  • Validate your charm with every change
• Write unit tests for a charm
  • Setting up your environment
  • Creating the charm and test files
  • Writing a test
  • Mocking beyond the State
• Write integration tests for a charm
  • Prepare your environment
  • Prepare the tox.ini configuration file
  • Create a test file
  • Build your tests
  • Run your tests
  • Generate crash dumps
• Log from your charm
• Run workloads with a machine charm
• Run workloads with a Kubernetes charm
  • Set up the workload container
  • Test container changes
  • Control and monitor services in the workload container
  • Perform health checks on the workload container
  • Manage files in the workload container
  • Run commands on the workload container
  • Use custom notices from the workload container
• Manage storage
  • Implement the feature
• Manage resources
  • Implement the feature
  • Test the feature
• Manage actions
  • Implement the feature
• Manage configuration
  • Implement the feature
• Manage relations
  • Implement the feature
  • Test the feature
• Manage leadership changes
  • Implement response to leadership changes
  • Write integration tests
• Manage libraries
  • Use a library
  • Write a library
• Manage interfaces
  • Register an interface
  • Write tests for an interface
• Manage secrets
  • Secret owner charm
  • Secret observer charm
  • Write tests for your charm
• Manage stored state
  • Storing state for the lifetime of the charm container or machine
  • Storing state for the lifetime of the application
• Manage opened ports
  • Implement the feature
  • Test the feature
• Manage the charm version
  • Implement the feature
  • Test the feature
• Manage the workload version
  • Implement the feature
• Manage metrics
  • Create a Juju user secret
  • Add a configuration option for the secret ID
  • Create a Pebble identity
  • Deploy the charm and grant access to the user secret
  • Access the metrics endpoint
• Trace the charm code
  • Getting started
  • Custom spans and events
  • Adding tracing to charm libraries
  • Migrating from the charm_tracing charm library
  • Lower-level API
• Legacy how-to guides
  • Write legacy unit tests for a charm
  • Turn a hooks-based charm into an ops charm