Azimuth Operator Documentation
This documentation describes how to manage deployments of Azimuth, including all the required dependencies.
Azimuth is deployed using Ansible with playbooks from the azimuth-ops Ansible collection, driven by configuration derived from the azimuth-config reference configuration.
The azimuth-config repository is designed to be forked for a specific site and is structured
into multiple environments. This structure allows common configuration to be
shared but overridden where required using composition of environments.
Structure of an Azimuth deployment
A fully-featured Azimuth deployment consists of many components - see Azimuth Architecture for details - and several of these components, including Zenith, AWX and Cluster API, require a Kubernetes cluster to run.
However when you consider an Azimuth deployment as a whole, the only real dependency is
an OpenStack cloud to target - we can create a Kubernetes
cluster within an OpenStack project on the target cloud to host our Azimuth deployment.
This is exactly what the playbooks in the azimuth-ops collection will do, when driven by
a configuration derived from azimuth-config.
There are two methods that azimuth-ops can use to deploy Azimuth and all of its
dependencies:
- Onto a managed single-node K3S cluster in an OpenStack project.
- Onto a managed highly-available Kubernetes cluster in an OpenStack project.
Option 1 is useful for development or demo deployments, but is not suitable for a production deployment.
Option 2 is the recommended deployment mechanism for most deployments. In this mode, Terraform is used to provision a single-node K3S cluster that is configured as a Cluster API management cluster. Cluster API is then used to provision a highly-available Kubernetes cluster in the same OpenStack project onto which Azimuth is deployed.
Warning
Option 2 requires that Octavia is available on the target cloud to provide load-balancers for Azimuth components.
Configuring and deploying Azimuth
The rest of this documentation provides details on different aspects of building a production-ready Azimuth configuration and using it to deploy Azimuth.
In the first instance it is recommended to follow the pages in order, implementing the steps in your Azimuth configuration. Once you have a working configuration, you can refer back to specific sections as needed.
Created: March 20, 2023