Waldur Docker-compose deployment

Prerequisites

at least 8GB RAM on Docker Host to run all containers
Docker v1.13+

Prepare environment

# clone repo
git clone https://github.com/waldur/waldur-docker-compose.git
cd waldur-docker-compose
# setup settings
cp .env.example .env

Booting up

# start containers
docker-compose up -d

# verify
docker-compose ps
docker exec -t waldur-mastermind-worker status

# Create user
docker exec -t waldur-mastermind-worker waldur createstaffuser -u admin -p password -e admin@example.com

# Create demo categories for OpenStack: Virtual Private Cloud, VMs and Storage
docker exec -t waldur-mastermind-worker waldur load_categories vpc vm storage

Waldur HomePort will be accessible on http://localhost. API will listen on http://localhost/api.

Healthcheck can be accessed on http://localhost/health-check.

Tearing down and cleaning up:

1	`docker-compose down`

Logs

Logs emitted by the containers are collected and saved in the waldur_logs folder. You can change the location by editing environment variable (.env) and updating LOG_FOLDER value.

Known issues

When Waldur is launched for the first time, it applies initial database migrations. It means that you may need to wait few minutes until these migrations are applied. Otherwise you may observe HTTP error 500 rendered by REST API server. This issue would be resolved after upgrade to Docker Compose 1.29.

Upgrading Waldur

1 2	`docker-compose pull docker-compose restart`

Using TLS

This setup supports following types of SSL certificates:

Email - set environment variable TLS to your email to register Let's Encrypt account and get free automatic SSL certificates.

Example:

1	`TLS=my@email.com`

Internal - set environment variable TLS to "internal" to generate self-signed certificates for dev environments

Example:

1	`TLS=internal`

Custom - set environment variable TLS to "cert.pem key.pem" where cert.pem and key.pem - are paths to your custom certificates (this needs modifying docker-compose with path to your certificates passed as volumes)

Example:

1	`TLS=cert.pem key.pem`

Custom Caddy configuration files

To add additional caddy config snippets into the caddy virtual host configuration add .conf files to config/caddy-includes/

Keycloak

Keycloak is an Identity and Access Management software bundled with waldur-docker-compose.

To create a keycloak admin account run:

1 2	`docker exec keycloak /opt/jboss/keycloak/bin/add-user-keycloak.sh -u <USERNAME> -p <PASSWORD> docker restart keycloak`

Login to the admin interface at https://localhost/auth/admin and create Waldur users

Last update: 2021-11-24