SDK How-to guides

[tmihoc (Teodora Mihoc)]

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

[sed-i (Leon)]

Add the following next to “Document your library”?

Document your charm

BTW is the linking to charmhub instead of juju.is/tutorials intentional?

Juju | How to add docs to your charm page on Charmhub

[tmihoc (Teodora Mihoc)]

Hi @sed-i! Thanks for your feedback—I’ll make them adjacent. Note 1: I’m not sure that doc should be called “How to document your charm”, because it doesn’t really discuss that; rather, only the mechanics of how to add documentation on Charmhub. Note 2: This is very much work in progress. There’s lots that will be moved around in the days to come. Note 3: Yes, linking to juju.is/tutorials was on purpose, as the idea is to keep all documentation together under juju.is/docs. Of course, the formatting is still for juju.is/tutorials, so that poses a small challenge. I’ll probably create a juju.is/docs copy without that formatting, and then add a note in the tutorials doc to link to that.

[tony-meyer]

The “Write functional tests for charm libraries using Scenario” link goes to the Discourse topic rather than the juju.is/docs/ page (which also seems to not exist - I assume it’s the same issue). I’m not sure how to fix this myself, sorry.