# Traefik K8s charm

> This is the documentation for the Traefik K8s charm, a Juju Kubernetes charm
> for deploying and managing Traefik as an ingress controller.


2026 CC-BY-SA, Canonical Ltd.

## Pages

- [Traefik operator](index.html.md): A Juju charm deploying and managing Traefik on Kubernetes.
- [Tutorial](tutorial/index.html.md): The Traefik charm tutorial that walks a user through a basic Traefik deployment.
- [Deploy the Traefik charm](tutorial/basic-deployment/index.html.md): Follow step-by-step instructions to achieve a basic deployment of the Traefik charm.
- [How-to guides](how-to/index.html.md): How-to guides covering the entire Traefik charm operations lifecycle.
- [How to enable BasicAuth](how-to/enable-basicauth/index.html.md): This feature is available in traefik-k8s starting from revision 206.
- [How to integrate your charm to Traefik](how-to/integrate/index.html.md): Traefik provides ingress to other charmed applications. If a charm integrates with Traefik, it can d...
- [How to configure TLS termination using a local CA](how-to/tls-termination-using-a-local-ca/index.html.md): Configure TLS termination for the Traefik charm using a local root CA.
- [How to troubleshoot “Gateway Address Unavailable”](how-to/troubleshoot-gateway-address-unavailable/index.html.md): This doc is not complete. Please uncomment and fill in the "Using the \`external_hostname\` config o...
- [How to troubleshoot reachability](how-to/troubleshoot-reachability/index.html.md): After integrating Traefik to your charm, you may encounter reachability errors such as:
- [How to upgrade](how-to/upgrade/index.html.md): The Traefik charm has a stateless workload. It can safely be upgraded through the `juju refresh` com...
- [How to contribute](how-to/contribute/index.html.md): Familiarize yourself with contributing to the Traefik charm documentation.
- [Reference](reference/index.html.md): Technical information related to the Traefik charm.
- [Charm architecture](reference/charm-architecture/index.html.md): Learn more about the architecture of the Traefik charm.
- [Cryptographic documentation for COS-Lite charms](reference/cryptographic-documentation-for-cos-lite-charms/index.html.md): This document provides cryptographic documentation for the COS-Lite bundle.
- [Ingress library reference](reference/ingress-libraries/index.html.md): Reference material for the ingress libraries provided by the Traefik charm.
- [Changelog](changelog/index.html.md): All notable changes to this project will be documented in this file.
- [Explanation](explanation/index.html.md): Explanation material explaining key concepts about the Traefik charm.
- [How TLS works in the Traefik charm](explanation/tls/index.html.md): Learn how TLS is configured for upstream and downstream traffic in the Traefik charm.
- [Security overview](explanation/security/index.html.md): Learn more about the common security risks and best practices for the Traefik charm.
- [Release notes](release-notes/index.html.md): History of stable releases for the Traefik charm.