# Canonical OpenStack > This is the documentation for Canonical OpenStack, an enterprise-grade cloud > platform that delivers distilled upstream OpenStack excellence in the form of > a human-friendly product. 2026 ## Pages - [Canonical OpenStack documentation](https://canonical-openstack.readthedocs-hosted.com/en/latest/index.html.md): [Canonical OpenStack](https://canonical.com/openstack) is an enterprise-grade cloud platform that de... - [How-to Guides](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/index.html.md): * [Installation](https://canonical-openstack.readthedocs-hosted.com/en/latest//how-to/install/index.... - [Accessing the OpenStack Dashboard](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/using-the-openstack-dashboard/index.html.md): Once OpenStack has been deployed you can use the OpenStack dashboard - [Miscellaneous](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/index.html.md): * [Adding AMD SEV enabled Compute Node](https://canonical-openstack.readthedocs-hosted.com/en/latest... - [Manage workloads with Juju](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/manage-workloads-with-juju/index.html.md): Once Canonical OpenStack has been deployed, you have the option of managing - [Configuring DPDK](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/configuring-dpdk/index.html.md): Open vSwitch (OVS) can be configured to use the [DPDK](https://www.dpdk.org) (Data Plane Development - [Using an existing Juju controller](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/using-an-existing-juju-controller/index.html.md): Canonical OpenStack can use an existing Juju controller during bootstrap - [Managing deployment manifests](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/managing-deployment-manifests/index.html.md): This page shows how to manage deployment manifests. For an overview of - [Register the Juju controller](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/manage-external-juju-controllers/index.html.md): As a prerequisite, perform the following steps in existing Juju - [Configuring GPU Passthrough](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/configuring-gpu-passthrough/index.html.md): The GPU passthrough allows full access and direct control of physical GPU - [Bootstrap highly available Juju controller on top of a LXD cluster](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/bootstrap-highly-available-juju-controller-on-top-of-a-lxd-cluster/index.html.md): Canonical Juju does not yet support controller HA modeling capabilities when deployed on top - [Configuring vTPM](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/configuring-vtpm/index.html.md): Virtual Trusted Platform Module (vTPM) support allows OpenStack instances to - [Configuring SR-IOV](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/configuring-sriov/index.html.md): The Single Root I/O Virtualization (SR-IOV) specification allows splitting - [Managing OpenStack Identity Providers](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/identity-provider-enablement/index.html.md): Perhaps one of the most important user facing features of any cloud is the authentication, authoriza... - [Backup and restore access to a MAAS deployment](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/backup-and-restore-maas-deployment/index.html.md): As part of the management of a MAAS deployment of Canonical OpenStack it is good practice to backup ... - [Reconfigure the Kubernetes API endpoint in Juju](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/reconfigure-k8s-api-endpoint-juju/index.html.md): A known limitation of Canonical OpenStack today is that the Juju Controller - [Use the EPA orchestrator](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/using-the-epa-orchestrator/index.html.md): The Enhanced Performance Accelerator (EPA) orchestrator provides resource allocation for CPU pinning... - [Configuring The Openstack Dashboard Theme](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/configuring-the-openstack-dashboard-theme/index.html.md): The dashboard theme can be set both at bootstrap via the manifest or managed after initial deploymen... - [Adding AMD SEV enabled Compute Node](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/adding-amd-sev-enabled-compute-node/index.html.md): Secure Encrypted Virtualization is a technology from AMD enabling encryption of guest memory. - [Manage a proxied environment](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/manage-a-proxied-environment/index.html.md): This page shows how to configure proxy settings for Canonical OpenStack. This - [Using the OpenStack CLI](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/using-the-openstack-cli/index.html.md): Once OpenStack has been deployed you can interact with your cloud via - [Multi-region deployments](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/multiregion-deployments/index.html.md): OpenStack deployments can span across multiple regions while sharing only the - [Operations](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/index.html.md): * [Cluster upgrades](https://canonical-openstack.readthedocs-hosted.com/en/latest//how-to/operations... - [Backup and Restore](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/backup-and-restore/index.html.md): Regular backups of the Sunbeam cluster are a critical component of any robust disaster recovery plan... - [Live Migration](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/live-migration/index.html.md): An instance migration is the relocation of an instance from one - [Scaling the cluster out](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/scaling-the-cluster-out/index.html.md): Canonical OpenStack scales out, meaning that you can add more machines to the cluster if you need mo... - [Cluster upgrades](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/cluster-upgrades/index.html.md): A full cluster refresh is a multi-step process. Some components require - [Manage experimental features](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/manage-experimental-features/index.html.md): Canonical OpenStack supports experimental features that are not enabled - [Enable and deploy a gated storage backend](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/enable-a-gated-storage-backend/index.html.md): Use this procedure to unlock a gated in-tree storage backend in the CLI and - [Deploy a Pure Storage backend](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/deploy-pure-storage-backend/index.html.md): Use this procedure to deploy a Pure Storage backend for Cinder. The backend is - [Maintenance mode](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/maintenance-mode/index.html.md): Maintenance mode helps by protecting the cluster from potentially disruptive maintenance operations.... - [Scaling the cluster in](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/scaling-the-cluster-in/index.html.md): Canonical OpenStack scales in, meaning that you can remove machines from the cluster if you no longe... - [Removing the primary node](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/operations/removing-the-primary-node/index.html.md): Removing the primary node refers to the removal of the first (bootstrap) node in the cluster and is ... - [Troubleshooting](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/troubleshooting/index.html.md): * [Inspecting the cluster](https://canonical-openstack.readthedocs-hosted.com/en/latest//how-to/trou... - [Inspecting the cluster](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/troubleshooting/inspecting-the-cluster/index.html.md): Sunbeam aims to remove the need for an operator to know all of the - [Telemetry](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/telemetry/index.html.md): This feature deploys the OpenStack Telemetry services Ceilometer, Aodh, - [Optional Features](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/index.html.md): * [Baremetal as a Service](https://canonical-openstack.readthedocs-hosted.com/en/latest//how-to/feat... - [Instance Recovery](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/instance-recovery/index.html.md): This feature deploys [Masakari](https://docs.openstack.org/masakari/latest/index.html), the OpenStac... - [Vault](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/vault/index.html.md): This feature deploys Vault, a tool for securely managing secrets used in - [LDAP Integration](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/ldap/index.html.md): This feature integrates the OpenStack - [Observability](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/observability/index.html.md): This feature integrates Canonical OpenStack with (and optionally deploys) the - [Load Balancer as a Service](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/load-balancer/index.html.md): This feature deploys - [Resource Optimization](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/resource-optimization/index.html.md): This feature deploys [Watcher](https://docs.openstack.org/watcher/latest/index.html), the - [Containers as a Service](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/caas/index.html.md): This feature deploys [Magnum](https://docs.openstack.org/magnum/latest/index.html), the OpenStack Ca... - [DNS as a Service](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/dns/index.html.md): This feature deploys [Designate](https://docs.openstack.org/designate/latest/index.html), the OpenSt... - [Validation](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/validation/index.html.md): This feature deploys [Tempest](https://charmhub.io/tempest-k8s), a - [Orchestration](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/orchestration/index.html.md): This feature deploys [Heat](https://docs.openstack.org/heat), the - [Images Sync](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/images-sync/index.html.md): This feature deploys OpenStack Images Sync, a tool for importing - [Shared Filesystems as a Service](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/shared-filesystem/index.html.md): This feature deploys [Manila](https://docs.openstack.org/manila/latest/index.html), the OpenStack Sh... - [Secrets as a Service](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/secrets/index.html.md): This feature deploys [Barbican](https://docs.openstack.org/barbican/latest/index.html), the OpenStac... - [Object Storage](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/object-storage/index.html.md): The object storage service providing Swift and S3 endpoints is enabled - [Ubuntu Pro](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/ubuntu-pro/index.html.md): This feature enables [Ubuntu Pro](https://ubuntu.com/pro) support for - [Baremetal as a Service](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/baremetal/index.html.md): This feature deploys [Ironic](https://docs.openstack.org/ironic/latest/index.html), the bare metal p... - [Managing TLS](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/managing-tls/index.html.md): * [Implementing TLS using a third-party CA](https://canonical-openstack.readthedocs-hosted.com/en/la... - [Managing CA](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/managing-tls/tls-ca/index.html.md): This feature is used to encrypt all cloud service endpoints (both public - [Implementing TLS using a third-party CA](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/managing-tls/implement-tls-using-a-third-party-ca/index.html.md): This page shows how to implement TLS when using an external Certificate - [Managing Vault](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/features/managing-tls/tls-vault/index.html.md): This feature is used to encrypt all cloud service endpoints (both public - [Installation](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/install/index.html.md): * [Install Canonical OpenStack using the manual bare metal provider](https://canonical-openstack.rea... - [Install Canonical OpenStack using the manual bare metal provider](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/install/install-canonical-openstack-using-the-manual-bare-metal-provider/index.html.md): This how-to guide provides all necessary information to install [Canonical OpenStack](https://canoni... - [Install Canonical OpenStack using Canonical MAAS](https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/install/install-canonical-openstack-using-canonical-maas/index.html.md): This how-to guide provides all necessary information to install [Canonical OpenStack](https://canoni... - [Contribute](https://canonical-openstack.readthedocs-hosted.com/en/latest/contributor/index.html.md): * [Reference](https://canonical-openstack.readthedocs-hosted.com/en/latest//contributor/reference/in... - [Reference](https://canonical-openstack.readthedocs-hosted.com/en/latest/contributor/reference/index.html.md): * [Stable release process](https://canonical-openstack.readthedocs-hosted.com/en/latest//contributor... - [Stable release process](https://canonical-openstack.readthedocs-hosted.com/en/latest/contributor/reference/stable-release/index.html.md): This reference describes the stable release workflow for Canonical OpenStack components. - [Reference](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/index.html.md): * [Enterprise Requirements](https://canonical-openstack.readthedocs-hosted.com/en/latest//reference/... - [Release cycle and supported versions](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/release-cycle-and-supported-versions/index.html.md): The release cycle of Canonical OpenStack is tightly synchronized with the release cycle of upstream ... - [Proxy ACL access](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/proxy-acl-access/index.html.md): For a network that is constrained by a proxy server, efforts will be - [API auditing](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/api-auditing/index.html.md): Canonical OpenStack automatically enables auditing for most OpenStack API - [Example physical configuration](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/example-physical-configuration/index.html.md): Sunbeam requires a properly cabled and configured hardware to be able to install Canonical OpenStack... - [Network debugging](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/network-debugging/index.html.md): This page presents a collection of techniques for interrogating your - [Known limitations](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/known-limitations/index.html.md): This document describes the known limitations of the Sunbeam project. - [Enterprise Requirements](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/enterprise-requirements/index.html.md): For single-node deployments the following minimum hardware specification - [Manifest file reference](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/manifest-file-reference/index.html.md): This resource aims to provide a definitive structure of a deployment - [Interactive configuration prompts](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/interactive-configuration-prompts/index.html.md): The `sunbeam cluster bootstrap`, `sunbeam configure`, and - [Projects and charms](https://canonical-openstack.readthedocs-hosted.com/en/latest/reference/underlying-projects-and-charms/index.html.md): Canonical OpenStack can be organized in terms of a number of underlying projects - [Tutorials](https://canonical-openstack.readthedocs-hosted.com/en/latest/tutorial/index.html.md): This section of our documentation helps you learn how to install and use your - [On-board your users](https://canonical-openstack.readthedocs-hosted.com/en/latest/tutorial/on-board-your-users/index.html.md): We hope you’ve had a great time so far exploring [Canonical OpenStack](https://canonical.com/opensta... - [Get started with OpenStack](https://canonical-openstack.readthedocs-hosted.com/en/latest/tutorial/get-started-with-openstack/index.html.md): If you are here, this likely means that you decided to give [Canonical OpenStack](https://canonical.... - [Explore full potential of OpenStack](https://canonical-openstack.readthedocs-hosted.com/en/latest/tutorial/explore-full-potential-of-openstack/index.html.md): We hope that both you and your team are now getting up to speed with [Canonical OpenStack](https://c... - [Get familiar with OpenStack](https://canonical-openstack.readthedocs-hosted.com/en/latest/tutorial/get-familiar-with-openstack/index.html.md): It’s great to see that you decided to continue your journey with [Canonical OpenStack](https://canon... - [Explanation](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/index.html.md): * [Architecture](https://canonical-openstack.readthedocs-hosted.com/en/latest//explanation/architect... - [Instance Recovery](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/instance-recovery/index.html.md): Each compute node runs a Consul agent which periodically performs a TCP health check against the net... - [Bare metal nodes](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/baremetal-nodes/index.html.md): This document details how to interact with [Ironic](https://docs.openstack.org/ironic/latest/index.h... - [Network traffic isolation with MAAS](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/network-traffic-isolation-with-maas/index.html.md): Canonical OpenStack, in MAAS mode, supports network traffic isolation in a - [Service endpoint encryption](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/service-endpoint-encryption/index.html.md): The encryption of service API endpoints in an OpenStack cloud requires a - [CPU pinning and huge pages](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/epa-orchestrator/index.html.md): The Enhanced Performance Accelerator (EPA) orchestrator provides APIs for allocating isolated CPU co... - [Deployment manifest](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/deployment-manifest/index.html.md): A deployment manifest allows a user to override the default configuration - [Technical motives](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/technical-motives/index.html.md): This page describes the technical motivations behind Canonical OpenStack - [Design considerations](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/design-considerations/index.html.md): There are a few design considerations that need to be taken into account before proceeding with Cano... - [Maintenance Mode](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/maintenance-mode/index.html.md): Maintenance mode provides a safeguard for operators performing critical operations - [Architecture](https://canonical-openstack.readthedocs-hosted.com/en/latest/explanation/architecture/index.html.md): This section provides an overview of the [Canonical OpenStack reference architecture](https://ubuntu... --- For more comprehensive documentation, see [llms-full.txt](https://canonical-openstack.readthedocs-hosted.com/en/latest/llms-full.txt)