Keycloak Setup

Owned by aijana.schumann
Last updated: Feb 19, 2021
2 min read

Motivation

Find a user mangement system for ONAP to use which

  • provides a GUI

  • allows setup via REST

  • doubles as oauth provider

Based on the requirements, Keycloak was chosen.

Version

Keycloak version 11.0.3 is used.

General

Keycloak comes with the so-called 'master' realm by default, which governs all other realms ('sub-realms'). It is for administrative purposes.

To allow 'normal' users to authenticate, a new realm should be created (for any given application / as needed) to separate concerns.

If an admin needs access to sub-realms, he should authenticate against the master realm, receive a token, and can then proceed to access the sub-realms.



For further information about keycloak, see the documentation.

Setup

Start docker container

  1. Do a   docker pull quay.io/keycloak/keycloak:11.0.3

  2. Start the docker container with set env vars for 'KEYCLOAK_USER' and 'KEYCLOAK_PASSWORD` on a preferred port. Internal port is 8080.

  3. Navigate to http://localhost:8080/auth/admin and login, getting access to the master realm / admin console.

  4. Create an 'onap' realm

Following, three steps need to be done. The creation of the default users, creating and assigning roles, and the creation of a client for onap/odlux to use for authentication of the users.

Adding Roles

  • Navigate to 'Roles'

  • Add roles as needed

Adding default users

  • Navigate to 'Users'

  • Add users as needed

  • Once created, click a user, navigate to 'Role Mappings' and assign a given role

Adding client

  1. Navigate to 'Clients' and create a new one

  2. Create a client with client ID 'odlux.app' and client protocol 'openid-connect'

  3. Select client and open 'Settings' tab

  4. enable if not already done

    1. Direct Access Grants

    2. Standard Flow Enabled

  5. Add valid redirect urls for your onap installation

  6. Set access type to 'confidential'

  7. (Save. Navigate to the 'credentials' tab and create your secret)

  8. (Note: If the lifespan of a token should be longer, it can be updated under the 'Advanced Settings' dropdown)

Further setup

Before you go and run Keycloak in production there are a few more things that you will want to do, including:

  • Switch to a production ready database such as PostgreSQL

  • Configure SSL with your own certificates

  • Switch the admin password to a more secure password

Quoted from: [https://www.keycloak.org/getting-started/getting-started-docker]