This repository contains the portal component of Azimuth: its Django REST API, React UI and Helm chart. The portal provides a web interface for managing cloud resources and platforms in an Azimuth deployment.
See the Azimuth organization overview for an introduction to the project, its architecture, other components and history.
| Directory | Contents |
|---|---|
| api | Django REST API for authentication, cloud resources and platform management. |
| ui | React web interface that calls the API. |
| chart | Helm chart for deploying the portal on Kubernetes. |
In an OpenStack deployment, the API manages cloud resources on behalf of the logged-in user. It also creates and updates Kubernetes resources for the platform operators to reconcile.
The local development guide covers API tests and UI builds. (These can be run locally without a cloud account) To work against a running deployment, follow the OpenStack and Tilt development workflow.
The portal Helm chart is one part of an Azimuth deployment. Follow the deployment documentation to configure it alongside the other Azimuth components. Portal configuration options are listed in chart/values.yaml.
Documentation fixes, bug reports and code changes are welcome. See CONTRIBUTING.md for local checks, PR guidance and CI limitations.