How-to guides

If you have a specific goal, and are already familiar with Kubernetes, our How-to guides are more specific and contain less background information. They’ll help you achieve an end result but may require you to understand and adapt the steps to fit your specific requirements.

Install and configure

Installation follows a similar pattern on all platforms, but some differences must be addressed in each case. You may also want to customize the installation of your Canonical Kubernetes nodes.

• Install
  • ... from a charm
  • ... in LXD
  • ... with Terraform
  • ... with a custom configuration
  • ... with custom worker configuration
• Configure the cluster

Integrate

Learn how to integrate Canonical Kubernetes with other charms to truly customize your cluster and provide additional functionality.

• Integrate with OpenStack
• Integrate with etcd
• Integrate with ceph-csi

Networking

• Configure proxy settings

Upgrade

Perform major and minor upgrades of your Canonical Kubernetes cluster.

• Upgrade minor version
• Upgrade patch version

Image registry

• Configure a custom registry

Monitoring and troubleshooting

Sometimes things go wrong and you need to troubleshoot. Having observability set up on your cluster can greatly increase the rate at which a problem is identified and solved.

• Troubleshooting
• Validate the cluster
• Integrate with COS Lite

Contribute

Contribute to the Canonical Kubernetes project! Add to the code, documentation or both!

• Contribute

---

Other documentation types

Our Reference section is for when you need to check specific details or information such as the command reference or release notes.

Alternatively, the Tutorials section contains step-by-step tutorials to help guide you through exploring and using Canonical Kubernetes.

For a better understanding of how Canonical Kubernetes works and related topics such as security, our Explanation section helps you expand your knowledge and get the most out of Kubernetes.