Set up SSO with OpenShift

Single Sign-On (SSO) is an authentication scheme, allowing users to log-in with a single pair of credentials to multiple, independent software systems.

This article explains the procedure to configure single sign-on to NVIDIA Run:ai using the OpenID Connect protocol in OpenShift V4.

Prerequisites

Before starting, make sure you have the following available from your OpenShift cluster:

• OpenShift OAuth client:

  • ClientID - The ID used to identify the client with the Authorization Server.

  • Client Secret - A secret password that only the Client and Authorization Server know.

• Base URL - The OpenShift API Server endpoint (for example, https://api.<cluster-url>:6443)

Setup

Adding the identity provider

1. Go to General settings

2. Open the Security section and click +IDENTITY PROVIDER

3. Select OpenShift V4

4. Enter the Base URL, Client ID, and Client Secret from your OpenShift OAuth client.

5. Copy the Redirect URL to be used in your OpenShift OAuth client

6. (Optional) Enter the user attributes and their value in the identity provider as shown in the below table

7. Click SAVE

Attribute	Default value in NVIDIA Run:ai	Description
User role groups	GROUPS	If it exists in the IDP, it allows you to assign NVIDIA Run:ai role groups via the IDP. The IDP attribute must be a list of strings.
Linux User ID	UID	If it exists in the IDP, it allows researcher containers to start with the Linux User UID. Used to map access to network resources such as file systems to users. The IDP attribute must be of type integer.
Linux Group ID	GID	If it exists in the IDP, it allows researcher containers to start with the Linux Group GID. The IDP attribute must be of type integer.
Supplementary Groups	SUPPLEMENTARYGROUPS	If it exists in the IDP, it allows researcher containers to start with the relevant Linux supplementary groups. The IDP attribute must be a list of integers.
Email	email	Defines the user attribute in the IDP holding the user's email address, which is the user identifier in NVIDIA Run:ai
User first name	firstName	Used as the user’s first name appearing in the NVIDIA Run:ai platform
User last name	lastName	Used as the user’s last name appearing in the NVIDIA Run:ai platform

Testing the setup

1. Open the NVIDIA Run:ai platform as an admin

2. Add access rules to an SSO user defined in the IDP

3. Open the NVIDIA Run:ai platform in an incognito browser tab

4. On the sign-in page click CONTINUE WITH SSO You are redirected to the OpenShift IDP sign-in page

5. In the identity provider sign-in page, log in with the SSO user who you granted with access rules

6. If you are unsuccessful signing-in to the identity provider, follow the Troubleshooting section below

Editing the identity provider

You can view the identity provider details and edit its configuration:

1. Go to General settings

2. Open the Security section

3. On the identity provider box, click Edit identity provider

4. You can edit either the Base URL, Client ID, Client Secret, or the User attributes

Removing the identity provider

You can remove the identity provider configuration:

1. Go to General settings

2. Open the Security section

3. On the identity provider card, click Remove identity provider

4. In the dialog, click REMOVE to confirm

Note

To avoid losing access, removing the identity provider must be carried out by a local user.

Troubleshooting

If testing the setup was unsuccessful, try the different troubleshooting scenarios according to the error you received.

Troubleshooting scenarios

Error: "403 - Sorry, we can’t let you see this page. Something about permissions…"

Description: The authenticated user is missing permissions

Mitigation:

1. Validate either the user or its related group/s are assigned with access rules

2. Validate groups attribute is available in the configured OIDC Scopes

3. Validate the user’s groups attribute is mapped correctly

Advanced:

1. Open the Chrome DevTools: Right-click on page → Inspect → Console tab

2. Run the following command to retrieve and copy the user’s token: localStorage.token;

3. Paste in https://jwt.io

4. Under the Payload section validate the value of the user’s attributes

Error: "401 - We’re having trouble identifying your account because your email is incorrect or can’t be found."

Description: Authentication failed because email attribute was not found.

Mitigation:

1. Validate email attribute is available in the configured OIDC Scopes

2. Validate the user’s email attribute is mapped correctly

Error: "Unexpected error when authenticating with identity provider"

Description: User authentication failed

Mitigation: Validate the the configured OIDC Scopes exist and match the Identity Provider’s available scopes

Advanced: Look for the specific error message in the URL address

Error: "Unexpected error when authenticating with identity provider (SSO sign-in is not available)"

Description: User authentication failed

Mitigation:

1. Validate the the configured OIDC scope exists in the Identity Provider

2. Validate the configured Client Secret match the Client Secret value in the OAuthclient Kubernetes object.

Advanced: Look for the specific error message in the URL address

Error: "unauthorized_client"

Description: OIDC Client ID was not found in the OpenShift IDP

Mitigation: Validate the the configured Client ID matches the value in the OAuthclient Kubernetes object