OpenShift

Get started with Keycloak on OpenShift

Before you start

Make sure your machine or container platform can provide sufficient memory and CPU for your desired usage of Keycloak. See Concepts for sizing CPU and memory resources for more on how to get started with production sizing.

  1. Install Red Hat Code Ready Containers and follow the steps in the documentation to install a local OpenShift cluster.

  2. Make sure the cluster is functional by entering the following command:

    crc status

  3. Look for output similar to the following to confirm the cluster is working.

    CRC VM:          Running
OpenShift:       Running
...

  4. Log in as the user developer:

    oc login -u developer -p developer

  5. Create a project called keycloak by entering the following command:

    oc new-project keycloak

Start Keycloak

  1. To start a Keycloak server in your project, enter the following command:

    oc process -f https://raw.githubusercontent.com/keycloak/keycloak-quickstarts/latest/openshift/keycloak.yaml \
    -p KC_BOOTSTRAP_ADMIN_USERNAME=admin \
    -p KC_BOOTSTRAP_ADMIN_PASSWORD=admin \
    -p NAMESPACE=keycloak \
| oc create -f -

    In this example, the user name and password are admin.

  2. Once the command above completes, look for a message similar to this:

    service/keycloak created
route.route.openshift.io/keycloak created
deploymentconfig.apps.openshift.io/keycloak created.

    At this point, OpenShift will provision a Keycloak pod and related resources. As part of the process, OpenShift will try to pull the Keycloak server image. This operation might take some time depending on your network connection.

  3. To make sure Keycloak is provisioned, execute the following command:

    oc get pods

  4. After a while, look for a message similar to the following; it indicates the pod is ready:

    NAME                READY     STATUS      RESTARTS   AGE
keycloak-1-deploy   0/1       Completed   0          1h
keycloak-1-l9kdx    1/1       Running     0          1h

  5. Once the server is provisioned, enter the following command to find out the Keycloak URLs:

    KEYCLOAK_URL=https://$(oc get route keycloak --template='{{ .spec.host }}') &&
echo "" &&
echo "Keycloak:                 $KEYCLOAK_URL" &&
echo "Keycloak Admin Console:   $KEYCLOAK_URL/admin" &&
echo "Keycloak Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
echo ""

Remember these URLs as you will need them throughout this guide. The URL for the account console won’t work right now as you will need to create the realm first.

Log in to the Admin Console

  1. Go to the Keycloak Admin Console.

  2. Log in with the username and password you created earlier.

Create a realm

A realm in Keycloak is equivalent to a tenant. Each realm allows an administrator to create isolated groups of applications and users. Initially, Keycloak includes a single realm, called master. Use this realm only for managing Keycloak and not for managing any applications.

Use these steps to create the first realm.

  1. Open the Keycloak Admin Console.

  2. Click Keycloak next to master realm, then click Create Realm.

  3. Enter myrealm in the Realm name field.

  4. Click Create.

Add realm

Create a user

Initially, the realm has no users. Use these steps to create a user:

  1. Verify that you are still in the myrealm realm, which is shown above the word Manage.

  2. Click Users in the left-hand menu.

  3. Click Create new user.

  4. Fill in the form with the following values:

    • Username: myuser

    • First name: any first name

    • Last name: any last name

  5. Click Create.

Create user

This user needs a password to log in. To set the initial password:

  1. Click Credentials at the top of the page.

  2. Fill in the Set password form with a password.

  3. Toggle Temporary to Off so that the user does not need to update this password at the first login.

Set password

Log in to the Account Console

You can now log in to the Account Console to verify this user is configured correctly.

  1. Open the Keycloak Account Console.

  2. Log in with myuser and the password you created earlier.

As a user in the Account Console, you can manage your account including modifying your profile, adding two-factor authentication, and including identity provider accounts.

Keycloak Account Console

Secure the first application

To secure the first application, you start by registering the application with your Keycloak instance:

  1. Open the Keycloak Admin Console.

  2. Click the word master in the top-left corner, then click myrealm.

  3. Click Clients.

  4. Click Create client

  5. Fill in the form with the following values:

    • Client type: OpenID Connect

    • Client ID: myclient

      Add Client

  6. Click Next

  7. Confirm that Standard flow is enabled.

  8. Click Next.

  9. Make these changes under Login settings.

    • Set Valid redirect URIs to https://www.keycloak.org/app/*

    • Set Web origins to https://www.keycloak.org

  10. Click Save.

Update Client

To confirm the client was created successfully, you can use the SPA testing application on the Keycloak website.

  1. Open https://www.keycloak.org/app/.

  2. Change Keycloak URL to the URL of your Keycloak instance.

  3. Click Save.

  4. Click Sign in to authenticate to this application using the Keycloak server you started earlier.

Taking the next step

Before you run Keycloak in production, consider the following actions:

  • Switch to a production ready database such as PostgreSQL.

  • Configure SSL with your own certificates.

  • Switch the admin password to a more secure password.

For more information, see the server guides.

On this page
Edit this guide