Charmed MicroK8s Documentation

The Charmed MicroK8s Operator delivers automated operations management from day 0 to day 2 on the MicroK8s Kubernetes Distribution. It is an open source, end-to-end, Kubernetes cluster lifecycle managment on top of Juju.

MicroK8s is an open-source Kubernetes distribution. It provides the functionality of core Kubernetes components, in a small footprint, scalable from a single node to a high-availability production cluster.

By reducing the resource commitments required in order to run Kubernetes, MicroK8s makes it possible to take Kubernetes into new environments, for example:

  • turning Kubernetes into a lightweight development tool
  • making Kubernetes available for use in minimal environments such as GitHub CI
  • adapting Kubernetes for small-appliance IoT applications

Developers use MicroK8s as an inexpensive proving ground for new ideas. In production, ISVs benefit from lower overheads and resource demands and shorter development cycles, enabling them to ship appliances faster than ever.

Project and community

MicroK8s is an open source project that welcomes community contributions, suggestions, fixes and constructive feedback.

In this documentation

Get started - a hands-on introduction to using Charmed MicroK8s for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Technical information - specifications, APIs, architecture
Concepts - discussion and clarification of key topics


Navigation table
Level Path Navlink
1 tutorial Tutorial
2 getting-started Getting started
1 how-to How To
2 how-to-cluster Deploy a cluster
2 how-to-add-k8s Deploy Kubernetes charms
2 how-to-configuration Configure MicroK8s
2 how-to-traefik-ingress Set up Traefik Ingress
2 how-to-upgrade Upgrade
2 how-to-cos Add observability
2 how-to-advanced-dns Advanced DNS configuration
2 how-to-ceph Use Ceph Storage
1 reference Reference
2 release-notes Release notes
1 explanation Explanation
2 explain-charmed-microk8s Charmed MicroK8s


Mapping table
Path Location
1 Like