Keycloak

Prerequisites

• Install and configure Keycloak on your server or cloud environment.

• Create a new realm in Keycloak for your application.

---

Steps on Keycloak Admin Console

Creating a Client

Here, we will add Devtron as a client for using Keycloak SSO.

1. In the Admin Console, go to Clients and click Create client.

   

   Figure 1: Creating Client on Keycloak
2. Within General Settings:

   • Enter devtron in the Client ID field. We will use this ID while configuring SSO later in Devtron.

   • Enter Devtron in the Name field.

   

   Figure 2: Client ID and Name
3. Within Capability config, turn on Client Authentication.

   

   Figure 3: Enabling Client Authentication Toggle
4. Within Login settings, enter https://<DEVTRON_BASE_URL>/orchestrator/api/dex/callback in the following fields.

   • Valid redirect URIs

   • Valid post logout redirect URIs

   • Web origins

   Click here to know where to find DEVTRON_BASE_URL.

   

   Figure 4: Entering Callback/Redirect URIs
5. Click Save.

Getting Client Secret

Here, we will obtain the secret we need while configuring SSO in Devtron.

1. Go to the Credentials tab of the client you created.

   

   Figure 5: Obtaining Client Secret
2. Use the copy button next to the Client Secret field and paste it somewhere for future reference.

Creating Users

Here, we will create a user that can log in to Devtron via SSO. We will assign a username and password that the user can enter while logging in to Devtron via Keycloak SSO.

1. In the Admin Console, go to Users and click Add user.

2. Give a username (e.g., usertest) in the Username field and enter the user's email address (e.g., [email protected]) in the Email field.

   

   Figure 6: Creating User Data
3. Click Create. Your user creation will be successful.

4. Go to the Credentials tab of the user you created.

   

   Figure 7: Adding User Password
5. Click Set password.

6. Enter the password and confirm it.

7. Click Save.

Retrieving Issuer URL

Here, we will obtain the Issuer URL we need while configuring SSO in Devtron.

1. In the Admin Console, go to Realm settings.

2. In the General tab, scroll down to the Endpoints field, and click the OpenID Endpoint Configuration link.

   

   Figure 8: OpenID Endpoint Configuration Link
3. This will open a new page, copy the value of the key named issuer, and paste it somewhere for future reference.

   

   Figure 9: Locating Issuer URL

---

Steps on Devtron

Configuring OIDC SSO

Who Can Perform This Action?

Users need to have super-admin permission to configure SSO.

Here, we will set up an OIDC SSO and enter the values we obtained in the previous section.

1. Go to Global Configurations → SSO Login Services → OIDC.

   

   Figure 10: Choosing OIDC SSO
2. Below the URL field, take the help of the Click to use option to populate the exact URL if the displayed one is incorrect.

   

   Figure 11: Populating Correct Orchestrator URL
3. In the Configuration editor, do the following:

   • In the issuer field, paste the URL you got while retrieving issuer URL.

   • In the clientID field, paste the ID you entered while creating the client.

   • In the clientSecret field, paste the secret you got under client credentials tab.

   • In the redirectURI field, make sure to enter the same redirect URI you gave in step 4 of client creation.

   

   Figure 12: Sample Keycloak SSO Config
4. Click Save or Update to activate Keycloak SSO login.

Adding Users

Who Can Perform This Action?

Users need to have super-admin permission to add users.

Here, we will add the user we created in the Keycloak Admin Console. If this step is skipped, the user might not be able to log in to Devtron via Keycloak.

1. Go to Global Configurations → Authorization → User Permissions.

2. Click + Add Users.

   

   Figure 13: Adding Users to Devtron
3. In the Email addresses field, enter the email address of the user you created in Keycloak.

   

   Figure 14: Entering User Data and Permissions
4. Assign necessary permissions to this new user. Refer user permissions to know more.

5. Click Save.

Now, you may log out and test the Keycloak OIDC login method using the user credentials. Clicking the Login with Oidc button will land you on Keycloak's login page.

Figure 15a: Login using OIDC method

Figure 15b: Keycloak's Login Page

Note

Kindly get in touch with us if you encounter any issues while logging out of Keycloak on Devtron as it might be buggy.