Installing Charmed Kubernetes

In addition to the easy to follow tutorial for Charmed Kubernetes, additional guides are available to take you through the installation steps for a number of different substrates. The ‘Cloud’ install page covers many different scenarios with Juju-supported clouds.

<span class="p-notification__title">Registry update:</span>
<p class="p-notification__message">The <code>rocks.canonical.com</code> registry is now a temporary service and will be retired in early 2027. <code>ghcr.io/canonical/cdk</code> is the only supported registry going forward and is the default for new deployments of Charmed Kubernetes 1.36 and later. Existing clusters that still use <code>rocks.canonical.com</code> must be updated by setting <code>image-registry</code> on each charm that uses Canonical images. See the <a href="/kubernetes/charmed-k8s/docs/rocks-registry-affected-charms">list of affected charms</a>.</p>

To update a charm, run the following command for each charm in the list:

juju config <charm-name> image-registry=ghcr.io/canonical/cdk

If you encounter any issues, you can reach us via the support channels.

There are also two ‘special case’ scenarios we provide guidance for:

If you wish to uninstall:

We appreciate your feedback on the documentation. You can edit this page or file a bug here.

See the guide to contributing or discuss these docs in our public Slack channel.