Skip to content

Commit c49049d

Browse files
yarongolyarongol
committed
four-how-to-users-etc
1 parent b125a9a commit c49049d

File tree

9 files changed

+328
-2
lines changed

9 files changed

+328
-2
lines changed

‎docs/admin/runai-setup/authentication/accessrules.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
This article explains the procedure to manage Access rules.
2+
3+
Access rules provide users, groups, or applications privileges to system entities.
4+
5+
An access rule is the assignment of a role to a subject in a scope: \<Subject\> is a \<Role\> in a \<Scope\>.
6+
7+
For example, user **user@domain.com** is a **department admin** in **department A**.
8+
9+
## Access rules table
10+
11+
The Access rules table can be found under **Tools & Settings** in the Run:ai platform.
12+
13+
The Access rules table provides a list of all the access rules defined in the platform, and allows you to manage them.
14+
15+
16+
17+
!!! Note
18+
__Flexible management__
19+
20+
It is also possible to manage access rules directly for a specific user, application, project, or department.
21+
22+
![](img/accessrulestable.png)
23+
24+
The Access rules table consists of the following columns:
25+
26+
| Column | Description |
27+
| :---- | :---- |
28+
| Type | The type of subject assigned to the access rule (user, SSO group, or application). |
29+
| Subject | The user, SSO group, or application assigned with the role |
30+
| Role | The role assigned to the subject |
31+
| Scope | The scope to which the subject has access. Click the name of the scope to see the scope and its subordinates |
32+
| Authorized by | The user who granted the access rule |
33+
| Creation time | The timestamp for when the rule was created |
34+
| Last updated | The last time the access rule was updated |
35+
36+
### Customizing the table view
37+
38+
* Filter \- Click ADD FILTER, select the column to filter by, and enter the filter values
39+
* Search \- Click SEARCH and type the value to search by
40+
* Sort \- Click each column header to sort by
41+
* Column selection \- Click COLUMNS and select the columns to display in the table
42+
* Download table \- Click MORE and then Click Download as CSV
43+
44+
## Adding new access rules
45+
46+
To add a new access rule:
47+
48+
1. Click **\+NEW ACCESS RULE**
49+
1. Select a subject **User, SSO Group**, or **Application**
50+
1. Select or enter the subject identifier:
51+
* **User Email** for a local user created in Run:ai or for SSO user as recognized by the IDP
52+
* **Group name** as recognized by the IDP
53+
* **Application name** as created in Run:ai
54+
1. Select a role
55+
1. Select a scope
56+
1. Click **SAVE RULE**
57+
58+
!!!Note
59+
An access rule consists of a single subject with a single role in a single scope. To assign multiple roles or multiple scopes to the same subject, multiple access rules must be added.
60+
61+
## Editing an access rule
62+
63+
Access rules cannot be edited. To change an access rule, you must delete the rule, and then create a new rule to replace it.
64+
65+
## Deleting an access rule
66+
67+
1. Select the access rule you want to delete
68+
1. Click **DELETE**
69+
1. On the dialog, click **DELETE** to confirm the deletion
70+
71+
## Using API
72+
73+
Go to the [Access rules](https://app.run.ai/api/docs\#tag/Access-rules) API reference to view the available actions
74+

‎docs/admin/runai-setup/authentication/applications.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
This article explains the procedure to manage applications and it’s permissions.
2+
3+
Applications are used for API integrations with Run:ai. An application contains a secret key. Using the secret key you can obtain a token and use it within subsequent API calls.
4+
5+
Applications are managed locally and assigned with Access Rules to manage its permissions.
6+
7+
For example, application **ci-pipeline-prod** assigned with a **Researcher** role in **Cluster: A**.
8+
9+
## Applications table
10+
11+
The Applications table can be found under **Tools & Settings** in the Run:ai platform.
12+
13+
The Applications table provides a list of all the applications defined in the platform, and allows you to manage them.
14+
15+
![](img/appstable.png)
16+
17+
18+
The Applications table consists of the following columns:
19+
20+
| Column | Description |
21+
| :---- | :---- |
22+
| Application | The name of the application |
23+
| Status | The status of the application |
24+
| Access rule(s) | The access rules assigned to the application |
25+
| Last login | The timestamp for the last time the user signed in |
26+
| Created by | The user who created the application |
27+
| Creation time | The timestamp for when the application was created |
28+
| Last updated | The last time the application was updated |
29+
30+
### Customizing the table view
31+
32+
* Filter \- Click ADD FILTER, select the column to filter by, and enter the filter values
33+
* Search \- Click SEARCH and type the value to search by
34+
* Sort \- Click each column header to sort by
35+
* Column selection \- Click COLUMNS and select the columns to display in the table
36+
* Download table \- Click MORE and then Click Download as CSV
37+
38+
## Creating an application
39+
40+
To create an application:
41+
42+
1. Click **\+NEW APPLICATION**
43+
1. Enter the application’s **Name**
44+
1. Click **CREATE**
45+
1. Copy the credentials and store it securely:
46+
* **Application name**
47+
* **Secret key**
48+
1. Click **DONE**
49+
50+
!!!Note
51+
The secret key is visible only at the time of creation, it cannot be recovered but can be regenerated.
52+
53+
## Adding an access rule to an application
54+
55+
To create an access rule:
56+
57+
1. Select the application you want to add an access rule for
58+
1. Click **ACCESS RULES**
59+
1. Click **\+ACCESS RULE**
60+
1. Select a role
61+
1. Select a scope
62+
1. Click **SAVE RULE**
63+
1. Click **CLOSE**
64+
65+
## Deleting an access rule from an application
66+
67+
To delete an access rule:
68+
69+
1. Select the application you want to remove an access rule from
70+
1. Click **ACCESS RULES**
71+
1. Find the access rule assigned to the user you would like to delete
72+
1. Click on the trash icon
73+
1. Click **CLOSE**
74+
75+
## Regenerating key
76+
77+
To regenerate an application’s key:
78+
79+
1. Select the application you want to regenerate it’s secret key
80+
1. Click **REGENERATE KEY**
81+
1. Click **REGENERATE**
82+
1. Review the user’s credentials and store it securely:
83+
* **Application** name
84+
* **Secret key**
85+
1. Click **DONE**
86+
87+
!!!Warning
88+
Regenerating an application key revokes its previous key.
89+
90+
## Deleting an application
91+
92+
1. Select the application you want to delete
93+
1. Click **DELETE**
94+
1. On the dialog, click **DELETE** to confirm the deletion
95+
96+
## Using API
97+
98+
Go to the [Applications](https://app.run.ai/api/docs\#tag/Applications), [Access rules](https://app.run.ai/api/docs\#tag/Access-rules) API reference to view the available actions
99+

‎docs/admin/runai-setup/authentication/img/accessrulestable.png

175 KB
Loading

‎docs/admin/runai-setup/authentication/img/appstable.png

45.7 KB
Loading

‎docs/admin/runai-setup/authentication/img/rolestable.png

218 KB
Loading

‎docs/admin/runai-setup/authentication/img/userstable.png

50.9 KB
Loading

‎docs/admin/runai-setup/authentication/roles.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
This article explains the roles in the Run:ai platform.
2+
3+
A role is a set of permissions that can be assigned to a subject in a scope.
4+
5+
A permission is a set of actions (View, Edit, Create & Delete) over a Run:ai entity (e.g. projects, workloads, users).
6+
7+
## Roles table
8+
9+
The Roles table can be found under **Tools & Settings** in the Run:ai platform.
10+
11+
The Roles table displays a list of predefined roles available to users in the Run:ai platform. It is not possible to create additional rules or edit or delete existing rules.
12+
13+
![](img/rolestable.png)
14+
15+
16+
The Roles table consists of the following columns:
17+
18+
| Column | Description |
19+
| :---- | :---- |
20+
| Role | The name of the role |
21+
| Created by | The name of the role creator |
22+
| Creation time | The timestamp when the role was created |
23+
24+
### Customizing the table view
25+
26+
* Filter \- Click ADD FILTER, select the column to filter by, and enter the filter values
27+
* Search \- Click SEARCH and type the value to search by
28+
* Sort \- Click each column header to sort by
29+
* Column selection \- Click COLUMNS and select the columns to display in the table
30+
* Download table \- Click MORE and then Click Download as CSV
31+
32+
## Reviewing a role
33+
34+
* **Role name** \- The name of the role
35+
* **Permissions** \- Displays the available permissions defining the role, as follows:
36+
37+
| Column | Description |
38+
| :---- | :---- |
39+
| Entity | A system-managed object that can be viewed, edited, created or deleted by a user based on their assigned role and scope |
40+
| View | If checked, an assigned user with this role can view instances of this type of entity within their defined scope |
41+
| Edit | If checked, an assigned user with this role can change the settings of an instance of this type of entity within their defined scope |
42+
| Create | If checked, an assigned user with this role can create new instances of this type of entity within their defined scope |
43+
| Delete | If checked, an assigned user with this role can delete instances of this type of entity within their defined scope |
44+
45+
*
46+
## Using API
47+
Go to the [Roles](https://app.run.ai/api/docs\#tag/Roles) API reference to view the available actions
48+

‎docs/admin/runai-setup/authentication/users.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
This article explains the procedure to manage users and their permissions.
2+
3+
Users can be managed locally, or via the Identity provider, while assigned with Access Rules to manage its permissions.
4+
5+
For example, user **user@domain.com** is a **department admin** in **department A**.
6+
7+
## Users table
8+
9+
The Users table can be found under **Tools & Settings** in the Run:ai platform.
10+
11+
The users table provides a list of all the users in the platform.
12+
You can manage local users and manage user permissions (access rules) for both local and SSO users.
13+
14+
!!! Note
15+
__Single Sign-On users__
16+
SSO users are managed by the identity provider and appear once they have signed in to Run:ai
17+
18+
![](img/userstable.png)
19+
20+
The Users table consists of the following columns:
21+
22+
| Column | Description |
23+
| :---- | :---- |
24+
| User | The unique identity of the user (email address) |
25+
| Type | The type of the user \- SSO / local |
26+
| Last login | The timestamp for the last time the user signed in |
27+
| Access rule(s) | The access rules assigned to the user |
28+
| Created By | The user who created the user |
29+
| Creation time | The timestamp for when the user was created |
30+
| Last updated | The last time the user was updated |
31+
32+
### Customizing the table view
33+
34+
* Filter \- Click ADD FILTER, select the column to filter by, and enter the filter values
35+
* Search \- Click SEARCH and type the value to search by
36+
* Sort \- Click each column header to sort by
37+
* Column selection \- Click COLUMNS and select the columns to display in the table
38+
* Download table \- Click MORE and then Click Download as CSV
39+
40+
## Creating a local user
41+
42+
To create a local user:
43+
44+
1. Click **\+NEW LOCAL USER**
45+
1. Enter the user’s **Email address**
46+
1. Click **CREATE**
47+
1. Review and copy the user’s credentials:
48+
* **User Email**
49+
* **Temporary password** to be used on first sign-in
50+
1. Click **DONE**
51+
52+
!!! Note
53+
The temporary password is visible only at the time of user’s creation, and must be changed after the first sign-in
54+
55+
## Adding an access rule to a user
56+
57+
To create an access rule:
58+
59+
1. Select the user you want to add an access rule for
60+
1. Click **ACCESS RULES**
61+
1. Click **\+ACCESS RULE**
62+
1. Select a role
63+
1. Select a scope
64+
1. Click **SAVE RULE**
65+
1. Click **CLOSE**
66+
67+
## Deleting user’s access rule
68+
69+
To delete an access rule:
70+
71+
1. Select the user you want to remove an access rule from
72+
1. Click **ACCESS RULES**
73+
1. Find the access rule assigned to the user you would like to delete
74+
1. Click on the trash icon
75+
1. Click **CLOSE**
76+
77+
## Resetting a user password
78+
79+
To reset a user’s password:
80+
81+
1. Select the user you want to reset it’s password
82+
1. Click **RESET PASSWORD**
83+
1. Click **RESET**
84+
1. Review and copy the user’s credentials:
85+
* **User Email**
86+
* **Temporary password** to be used on next sign-in
87+
1. Click **DONE**
88+
89+
## Deleting a user
90+
91+
1. Select the user you want to delete
92+
1. Click **DELETE**
93+
1. In the dialog, click **DELETE** to confirm the deletion
94+
95+
!!!Note
96+
To ensure administrative operations are always available, at least one local user with System Administrator role should exist.
97+
98+
## Using API
99+
100+
Go to the [Users](https://app.run.ai/api/docs\#tag/Users), [Access rules](https://app.run.ai/api/docs\#tag/Access-rules) API reference to view the available actions
101+

‎mkdocs.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,12 +176,16 @@ nav:
176176
- 'Scaling' : 'admin/runai-setup/config/large-clusters.md'
177177
- 'Authentication & Authorization' :
178178
- 'Overview' : 'admin/runai-setup/authentication/authentication-overview.md'
179-
- 'Access control' : 'admin/runai-setup/access-control/rbac.md'
180-
- 'Researcher Authentication' : 'admin/runai-setup/authentication/researcher-authentication.md'
181179
- 'Single Sign-On' :
182180
- 'Setup SSO with SAML' : 'admin/runai-setup/authentication/sso/saml.md'
183181
- 'Setup SSO with OpenID Connect' : 'admin/runai-setup/authentication/sso/openidconnect.md'
184182
- 'Setup SSO with OpenShift' : 'admin/runai-setup/authentication/sso/openshift.md'
183+
- 'Users' : 'admin/runai-setup/authentication/users.md'
184+
- 'Applications' : 'admin/runai-setup/authentication/applications.md'
185+
- 'Roles' : 'admin/runai-setup/authentication/roles.md'
186+
- 'Access Rules' : 'admin/runai-setup/authentication/accessrules.md'
187+
- 'Access control' : 'admin/runai-setup/access-control/rbac.md'
188+
- 'Researcher Authentication' : 'admin/runai-setup/authentication/researcher-authentication.md'
185189
- 'Notifications System':
186190
- 'Email and System Notifications': 'admin/runai-setup/notifications/notifications.md'
187191
- 'Maintenance' :

0 commit comments

Comments
 (0)