Keycloak Setup

This guide provides instructions for configuring Keycloak after deploying Observo Manager.

Prerequisites

  • Observo Manager successfully deployed via Helm

  • Access to the Observo UI Endpoint

  • Keycloak credentials from helm values file

Access Keycloak Admin Console

  1. Navigate to: <OBSERVO_URL>/observo-auth

  2. Log in with admin credentials configured in keycloak section of manager helm values file:

     auth:
       adminUser: admin
       adminPassword: 1234

Client Configuration

Observo requires two OpenID Connect clients in keycloak:

  1. observo-ui: For user interface access

  2. observo-client: For site communication

Configure observo-ui Client

  1. In Keycloak admin console, go to Clients

  2. Click Import Client img.png

  3. Upload the observo-ui client configuration

Configure observo-client Client

  1. In Keycloak admin console, go to Clients

  2. Click Import Client

  3. Upload the observo-client configuration

  4. Configure Service Account Roles:

    • Navigate to Clientsobservo-clientService Account Roles

    • Click Assign Role

    • Search for and select the admin role

    • Click Assign img_1.png

Realm Configuration

Theme Setup

  1. Navigate to Realm SettingsThemes

  2. Set Login Theme to Observo

  3. Click Save

Session Configuration

  1. Navigate to Realm SettingsSessions

  2. Set the following values:

    • SSO Session Idle: 10 days

    • SSO Session Max: 10 days

  3. Click Save img_2.png

Token Configuration

  1. Navigate to Realm SettingsTokens

  2. Set Access Token Lifespan to 10 days

  3. Click Save

Admin User Setup

Create the Observo admin user:

  1. Navigate to Users

  2. Click Add user

  3. Configure user details:

  4. Click Save img_3.png

Configure Admin User

  1. Set Password:

    • Go to Credentials tab

    • Set a password for the user

    • Disable Temporary password if needed

  2. Assign Admin Role:

    • Go to Role Mapping tab

    • Click Assign Role

    • Search for and select admin role

    • Click Assign

Verification

  1. Log out of the admin console

  2. Navigate to Observo UI

  3. Log in using:

    • Username: observoadmin

    • Password: [your set password]

Last updated

Was this helpful?