Certificate Management documentation¶

Welcome! This documentation helps you manage TLS certificates in Juju deployments, whether you are a charm operator or a charm developer.

For Charm Developers¶

The tls-certificates library helps charm authors automate certificate requests, renewal, and revocation in Juju. This documentation explains how to implement the requirer side of the tls-certificates interface in your charm, enabling your application to request and manage X.509 certificates from TLS provider charms.

Not sure if you need this library? Start with Do I need to implement the TLS library?

👉 Go to Developer docs

For Charm Operators¶

The main aim of this documentation is to help you choose and deploy the right TLS provider charm for your use case. The decision tree below gives a quick overview of available TLS providers, with detailed guidance in our documentation for each option.

        %%{init: {'theme': 'default', 'themeVariables': {'fontSize': '11px'}, 'flowchart': {'nodeSpacing': 25, 'rankSpacing': 25, 'curve': 'linear', 'padding': 10}}}%%
flowchart TD
  A{Do you have existing<br/>PKI infrastructure?}
  B{Does it expose an<br/>ACME interface?}
  C{Do you need a<br/>full-featured solution?}

  D["🔗 Lego"]
  E["🔗 Manual TLS certificates"]
  F{Do you need<br/>HSM support?}
  G["🔗 Self-signed certificates"]
  H["🔗 Notary"]
  I["🔗 Vault"]

  A -->|Yes| B
  A -->|No| C

  B -->|Yes| D
  B -->|No| E

  C -->|Yes| F
  C -->|No| G

  F -->|Yes| H
  F -->|No| I

  classDef charmLink fill:#FFF5F0,stroke:#E95420,stroke-width:2px,color:#333
  classDef plainNode fill:#fff,stroke:#333,stroke-width:2px,color:#333

  class D,E,G,H,I charmLink
  class A,B,C,F plainNode

  click D "https://charmhub.io/lego" "View Lego charm documentation"
  click E "https://charmhub.io/manual-tls-certificates" "View Manual TLS charm documentation"
  click G "https://charmhub.io/self-signed-certificates" "View Self-signed certificates charm documentation"
  click H "https://canonical-notary.readthedocs-hosted.com/en/latest/" "View Notary documentation"
  click I "https://charmhub.io/vault" "View Vault charm documentation"

👉 Go to Operator docs

Project and community¶

Canonical Certificate Management is an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

Thinking about using Juju for your next project? Get in touch !