Skip to content

Commit b62eeca

Browse files
committed
Run-16866-added-scopes and OpenShift info
1 parent b6fc813 commit b62eeca

File tree

1 file changed

+41
-4
lines changed
  • docs/admin/runai-setup/authentication

1 file changed

+41
-4
lines changed

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

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Single Sign-On
22

3-
Single Sign-On (SSO) is an authentication scheme that allows a user 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.
3+
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.
4+
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}.
46

5-
Run:ai supports SSO using the [SAML 2.0](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language){target=_blank} protocol and Open ID Connect or [OIDC](https://openid.net/developers/how-connect-works/){target=_blank}.
67

78
!!! Caution
89
Single sign-on is only available with SaaS installations where the tenant has been created post-January 2022 or any Self-hosted installation of release 2.0.58 or later. If you are using single sign-on with older versions of Run:ai, please contact Run:ai customer support
@@ -13,14 +14,41 @@ Run:ai supports SSO using the [SAML 2.0](https://en.wikipedia.org/wiki/Security_
1314

1415
## SAML Prerequisites
1516

16-
**XML Metadata**—you must have an *XML Metadata file* retrieved from your IdP. Upload the file to a web server such that you will have a URL to the file. The URL must have the *XML* file extension. For example, to connect using Google, you must create a custom SAML App [here](https://admin.google.com/ac/apps/unified){target=_blank}, download the Metadata file, and upload it to a web server.
17+
**XML Metadata**—you must have an *XML Metadata file* retrieved from your IdP. Upload the file to a web server so that you have a URL to the file. The URL must have the *XML* file extension. For example, to connect using Google, you must create a custom SAML App [here](https://admin.google.com/ac/apps/unified){target=_blank}, download the Metadata file, and upload it to a web server.
1718

1819
## OIDC Prerequisites
1920

2021
* **Discovery URL**—the OpenID server where the content discovery information is published.
2122
* **ClientID**—the ID used to identify the client with the Authorization Server.
2223
* **Client Secret**—a secret password that only the Client and Authorization Server know.
2324

25+
26+
## OpenShift Prerequisites
27+
28+
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.
29+
30+
To define OAuthClient, follow these steps:
31+
32+
1. Create a new ```OAuthClient``` Kubernetes object with the following content
33+
```
34+
apiVersion: oauth.openshift.io/v1
35+
grantMethod: auto
36+
kind: OAuthClient
37+
metadata:
38+
name: my-client
39+
redirectURIs:
40+
- https://<runai_env_url>/auth/realms/runai/broker/openshift-v4/endpoint
41+
secret: this-is-my-secret
42+
```
43+
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:
44+
```
45+
oc apply <file name>
46+
```
47+
3. Check that the file has been applied successfully by running the following command:
48+
```
49+
oc get oauthclient
50+
```
51+
2452
### Additional attribute mappings
2553

2654
You can configure your IdP to map several IdP attributes:
@@ -71,10 +99,19 @@ You can configure your IdP to map several IdP attributes:
7199
1. In the `Discovery URL` field, enter the discovery URL .
72100
2. In the `Client ID` field, enter the client ID.
73101
3. In the `Client Secret` field, enter the client secret.
74-
4. Add 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.
102+
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.
75103
5. In the `User attributes` field enter the attribute and the value in the identity provider. (optional)
76104
6.When complete, press `Save`.
77105

106+
=== "OpenShift V4"
107+
108+
1. In the `Discovery URL` field, enter the discovery URL .
109+
2. In the `Client ID` field, enter the client ID.
110+
3. In the `Client Secret` field, enter the client secret.
111+
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.
112+
5. In the `User attributes` field enter the attribute and the value in the identity provider. (optional)
113+
6. When complete, press `Save`.
114+
78115
4. In the `Logout uri` field, enter the desired URL logout page. If left empty, you will be redirected to the Run:ai portal.
79116
5. In the `Session timeout` field, enter the amount of idle time before users are automatically logged out. (Default is 60 minutes)
80117

0 commit comments

Comments
 (0)