Deployment Guide

Authorization Service Setup

Keycloak will be set up first to broker authorization tokens, enabling secure communication for Overture services.

Setting up the Keycloak database

Run PostgreSQL: Use the following command to pull and run the PostgreSQL docker container

bash

docker run --name keycloak-db \
 -e POSTGRES_USER=admin \
 -e POSTGRES_PASSWORD=admin123 \
 -e POSTGRES_DB=keycloakDb \
 -v ./persistentStorage/keycloak-db-data:/var/lib/postgresql/data \
 -d postgres:14

This command runs a postgres image named keycloak-db with the username admin, password admin123 and a database within it called keycloakDb.

Persistent Volumes

It also includes a defined persistent volume -v./persistentStorage/keycloak-db-data:/var/lib/postgresql/data . This volume will be a folder generated at runtime that will serve as local persistent storage within your directory. Meaning the data in your database is backed up outside of docker.

Setting up Keycloak

Create a folder titled keycloakConfigs and place the following configuration files within it:
- The Overture API Key Provider, for extending Keycloak's functionality to support API key authentication.
- The Realm.json, containing pre-configurated settings for our Overture Keycloak realm.
- The Users.json, containing pre-configured user information to populate the realm.

Run Keycloak: To deploy Keycloak, execute the following command. Make sure to run it in the directory containing the files mentioned above.

bash

docker run -d --name keycloak \
  -p 8180:8080 \
  -e KC_DB=postgres \
  -e KC_DB_USERNAME=admin \
  -e KC_DB_PASSWORD=admin123 \
  -e KC_DB_URL=jdbc:postgresql://keycloak-db:5432/keycloakDb \
  -e KEYCLOAK_ADMIN=admin \
  -e KEYCLOAK_ADMIN_PASSWORD=admin123 \
  -e KC_HOSTNAME=localhost \
  -e KC_HEALTH_ENABLED=true \
  -v ./configurationFiles/keycloakConfigs/keycloak-apikeys-1.0.1.jar:/opt/keycloak/providers/keycloak-apikeys.jar \
  -v ./configurationFiles/keycloakConfigs/myrealm-realm.json:/opt/keycloak/data/import/myrealm-realm.json \
  -v ./configurationFiles/keycloakConfigs/myrealm-users-0.json:/opt/keycloak/data/import/myrealm-users-0.json \
  quay.io/keycloak/keycloak:22.0 \
  start-dev --import-realm --hostname-port=8180

Once running, you will be able to access the Keycloak admin console from http://localhost:8180/admin

For more details, click here

Local Port Mapping: The -p 8180:8080 option maps port 8180 on the host machine to port 8080 inside the Docker container. This is crucial as port 8080 is the default port Keycloak listens on, but it's often occupied by other services. By mapping it to port 8180 on the host, we are ensuring that Keycloak remains accessible without interfering with other services running on the same machine.

Configuration Files: The -v options mount the local directories containing the Keycloak configuration files (realm.json, users.json, and the API key provider JAR) to the corresponding paths inside the container. This ensures that Keycloak starts with the desired realm configuration and user definitions, as well as the extended functionality provided by the API key provider.

Base Image: quay.io/keycloak/keycloak:22.0 specifies the Docker image to use, which is version 22.0 of Keycloak from Quay.io. This image includes Keycloak and all its dependencies, optimized for performance and security.

Start Command: The start-dev argument passed to the container instructs Keycloak to start in development mode. This mode is suitable for our example deployment. A production deployment is largely the same with exception to requring a SSL certificate on startup.

Realm Import: The --import-realm flag tells Keycloak to import the realm configuration from the specified JSON file upon startup. This is essential for setting up realms with predefined roles, users, and other settings without requiring manual configurations.

Database Connection: The database-related flags (--db, --db-url, --db-username, --db-password) configure Keycloak to connect to the PostgreSQL database. These settings are critical for persisting user data, sessions, and other operational data securely and reliably.

Server Deployments

If you are looking for information on deploying Keycloak on a server, we recommend seeing Keycloaks official server documentation. Should you require assistance with deployments tailored to your specific needs, please feel free to reach out to us for consultation at contact@overture.bio.

Introduction

Data Management & Storage

Authorization Service Setup
1. Setting up the Keycloak database
2. Setting up Keycloak