Skip to content

Commit 7037119

Browse files
Update sso.md
1 parent 71fae4e commit 7037119

File tree

1 file changed

+11
-8
lines changed
  • docs/admin/runai-setup/authentication

1 file changed

+11
-8
lines changed

docs/admin/runai-setup/authentication/sso.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Single Sign-On (SSO) is an authentication scheme allowing users to log in with a single ID to other, independent, software systems. SSO solves security issues involving multiple user/password data entries, multiple compliance schemes, etc.
44

5-
Run:ai supports SSO using the [SAML 2.0](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language){target=_blank} protocol, Open ID Connect [OIDC](https://openid.net/developers/how-connect-works/){target=_blank} and [OpenShift V4](https://en.wikipedia.org/wiki/OpenShift){target=_blank}.
5+
Run:ai supports SSO using the [SAML 2.0](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language){target=_blank} protocol, Open ID Connect [OIDC](https://openid.net/developers/how-connect-works/){target=_blank} and [OpenShift V4](https://en.wikipedia.org/wiki/OpenShift){target=_blank} (which is based on OIDC).
66

77

88
!!! Caution
@@ -29,7 +29,7 @@ For each of the SSO options, there are prerequisites that should be considered.
2929

3030
### OpenShift V4
3131

32-
Before using OpenShift, first define OAuthClient to control various aspects of the OAuth flow, such as redirect URIs and authentication methods to ensure secure and approprpriate access to resources.
32+
Before using OpenShift, first define OAuthClient. The OAuth client interacts with OpenShift’s OAuth server to authenticate users and request access tokens.
3333

3434
To define OAuthClient, follow these steps:
3535

@@ -44,6 +44,9 @@ redirectURIs:
4444
- https://<runai_env_url>/auth/realms/runai/broker/openshift-v4/endpoint
4545
secret: this-is-my-secret
4646
```
47+
Replace `<runai_env_url>` with the URL of your Run:ai platform.
48+
Replace `my-client` and `this-is-my-secret` with client name and secret you have chosen.
49+
4750
2. Run the following command to apply the OAuthClient object to the environment. Create the object on OpenShift cluster where you define your OpenShift IDP:
4851
```
4952
oc apply <file name>
@@ -75,9 +78,9 @@ You can configure your IdP to map several IdP attributes:
7578

7679
1. Press the `Tools & Settings` then press `General`.
7780
2. Open the `Security` pane and press `+Identity provider`.
78-
3. Select the SSO protocol. Choose `SAML 2` or `Open ID Connect`.
81+
3. Select the SSO protocol. Choose `Custom SAML 2.0`, `Custom OpenID Connect` or `OpenShift V4`.
7982

80-
=== "SAML 2"
83+
=== "SAML 2.0"
8184

8285
1. Choose `From computer` or `From URL`.
8386
@@ -103,7 +106,7 @@ You can configure your IdP to map several IdP attributes:
103106
1. In the `Discovery URL` field, enter the discovery URL .
104107
2. In the `Client ID` field, enter the client ID.
105108
3. In the `Client Secret` field, enter the client secret.
106-
4. Add the OIDC scope to be used during authentication to authorize access to a user's details. Each scope returns a set of user attributes. The scope must match the names in your identity provider.
109+
4. Add the OIDC scope to be used during authentication to authorize access to a user's details (optional). Each scope returns a set of user attributes. The scope must match the names in your identity provider.
107110
5. In the `User attributes` field enter the attribute and the value in the identity provider. (optional)
108111
6.When complete, press `Save`.
109112

@@ -117,11 +120,11 @@ You can configure your IdP to map several IdP attributes:
117120

118121
=== "OpenShift V4"
119122

120-
1. In the `Discovery URL` field, enter the discovery URL .
123+
1. In the `Base URL` field, enter the OpenShift Base URL (https://api.<your-openshift-domain>:6443).
121124
2. In the `Client ID` field, enter the client ID.
122125
3. In the `Client Secret` field, enter the client secret.
123-
4. Add the OIDC scope to be used during authentication to authorize access to a user's details. Each scope returns a set of user attributes. The scope must match the names in your identity provider.
124-
5. In the `User attributes` field enter the attribute and the value in the identity provider. (optional)
126+
4. Add the OIDC scope to be used during authentication to authorize access to a user's details (optional). Each scope returns a set of user attributes. The scope must match the names in your identity provider.
127+
5. In the `User attributes` field enter the attribute and the value in the identity provider (optional).
125128
6. When complete, press `Save`.
126129

127130
4. In the `Logout uri` field, enter the desired URL logout page. If left empty, you will be redirected to the Run:ai portal.

0 commit comments

Comments
 (0)