Install OSIE, the OpenStack dashboard and billing system
On Kubernetes with Helm, or on a single VM with Docker Compose
Kubernetes · Docker Compose · Repository layout · Documentation
Important
On the MongoDB, RabbitMQ or Keycloak bundled with chart 26.8.2 or earlier? Move off them first with migrate-bundled.
OSIE is the dashboard and billing system for OpenStack clouds: a client portal, an admin dashboard and the API behind both. This repository holds the two ways to install it.
| Kubernetes | Docker Compose | |
|---|---|---|
| For | production | one VM, a trial or a small install |
| Runs | the OSIE Helm chart, with MongoDB and RabbitMQ from their operators | osie-api, osie-ui, osie-admin, MongoDB, RabbitMQ and Caddy |
| TLS | your ingress controller or Gateway | Caddy, with Let's Encrypt for a domain or a self-signed certificate for an IP address |
| High availability | a 3-member MongoDB replica set and a 3-node RabbitMQ cluster | no |
| Guide | kubernetes/README.md | docker-compose/README.md |
Three steps, each in kubernetes/README.md:
-
Operators. Install the Percona MongoDB operator and the RabbitMQ cluster operator.
-
Databases. Apply the MongoDB and RabbitMQ resources from
kubernetes/infrastructure/, as a single node or highly available. -
OSIE. Install the chart with values.example.yaml, which reads the database credentials from the Secrets the operators create:
helm repo add osie https://helm.osie.io helm install osie osie/osie --namespace osie -f kubernetes/values.example.yaml
The chart deploys only OSIE. Its README covers the Gateway API, TLS to MongoDB and RabbitMQ, and every setting.
An interactive installer sets up Docker, TLS, secrets and the services on one Debian, Ubuntu or RHEL family VM:
wget https://raw.githubusercontent.com/osie/deployment/main/docker-compose/install.sh
sudo bash install.shIt asks for a public domain or an IP address, checks DNS for a domain, installs Docker if needed and
starts everything from /opt/osie. --hostname <domain> runs it without questions.
docker-compose/README.md has every option and the day-to-day commands.
kubernetes/
├── infrastructure/ # MongoDB and RabbitMQ resources, single node or HA
├── values.example.yaml # chart values for the operator-managed databases
├── migrate-bundled/ # migrate.sh, its README and its test bench
└── README.md
docker-compose/
├── install.sh # the single-VM installer
├── docker-compose.base.yml # OSIE, MongoDB and RabbitMQ
├── docker-compose.caddy.prod.yml # Caddy in front, with TLS
├── caddy/ config/
└── README.md
- OSIE documentation
- Installing OSIE on Kubernetes
- osie-io/osie-helm, the Helm chart