Skip to content

Latest commit

 

History

History
62 lines (53 loc) · 2.33 KB

apb_overview.md

File metadata and controls

62 lines (53 loc) · 2.33 KB
Raw

Overview

This document outlines the steps for each APB task to help people to understand what is happening under the hood.

Provision

  1. Create a new Postgres service, including:
    • Secrets for database admin users
    • Service for the Postgres DB
    • PersistVolume Claim to for the Postgres DB
    • Deployment for the Postgres DB
  2. Create a new Keycloak service, including:
    • Deployment for Keycloak
      • Link Keycloak and Postgres DB
      • Add default Keycloak admin user credential
    • Service for Keycloak
    • Routes (either HTTP or HTTPS depends on the option) for Keycloak
    • Create a new realm in Keycloak using the current OpenShift project name
    • Create a new secret in the current OpenShift namespace with admin user credentials
    • Create a new secret (labelled with the Keycloak service instance ID) in the current namespace with the following info:
      • Name and type of the service
      • Realm name
      • URL of the Keycloak service
    • Persist the admin user credential as _apb_provision_creds
  3. Create a new Keycloak-metrics service, including:
    • Deployment for Keycloak-metrics
    • Persistent volume claim for Keycloak-metrics
    • Service for Keycloak-metrics
    • Copy keycloak-monitoring-prometheus.jar to Keycloak to collect metrics data about Keycloak

Bind

  1. Get the Keycloak admin user token using the Keycloak admin user credential
  2. Create a new bearer-only or public client with a generated ID and password in Keycloak. It is created in the realm that matches the current namespace
  3. Create a new secret with config details about the newly created Keycloak client
  4. Persist the newly created client name and password as _apb_bind_creds

Unbind

  1. Get the Keycloak admin user token using the Keycloak admin user credential
  2. Delete the public or bearer-only client created in the bind step from Keycloak and the OpenShift client secret using the data persisted in _apb_bind_creds

Deprovision

  1. Delete all the routes
    • Keycloak
  2. Delete all the services
    • Keycloak
    • Postgres
    • Keycloak-metrics
  3. Delete all the deployments
    • Keycloak
    • Postgres
    • Keycloak-metrics
  4. Delete all the secrets
    • Keycloak
    • Postgres
  5. Delete all the configmaps
    • Keycloak
  6. Delete all the persistent volume claims
    • Keycloak-metrics
    • Postgres