Skip to content

Commit 879cc8d

Browse files
authored
Finalise Waldur workflow docs for MLP (#117)
1 parent ace070b commit 879cc8d

File tree

13 files changed

+61
-17
lines changed

13 files changed

+61
-17
lines changed

docs/access/mfa.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,6 @@ Steps:
6767
5. To complete the OTP registration process, please enter the 6 digit OTP from the authenticator app at the bottom of the the same QR code page. Optionally, you can input your device name where you imported the OTP seed by scanning the QR code
6868
6. On successful registration you will be logged into the CSCS web application that you accessed in step-1
6969

70-
!!! todo
71-
do we need the images from KB?
72-
7370
### Resetting the Authenticator
7471

7572
In case users lose access to their mobile device/Authenticator OTP, users can reset their OTP by following the below self-service process.

docs/accounts/account-create.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
[](){#ref-account-create}
2+
# Creating an account
3+
4+
!!! warning
5+
The process for creating an account documented here applies only to users who are invited using the new [project and resource management tool][ref-account-waldur] (Waldur).
6+
7+
When the CSCS Account Manager, project PI or Deputy PI invites the users they will receive an invitation email if the invited user has an **existing** CSCS account then the user clicks on the URL from the email and log-in with a username, password, OTP, and accept the invitation **whereas** if the invited user is new then the user needs to follow the step-by-step instructions below to get an account
8+
9+
The email contains a URL that redirects you to the registration page:
10+
11+
![](../images/access/invitation.png)
12+
13+
Clicking the "Create a new account" button will lead the user to the second step where he needs to provide his personal information as shown below:
14+
15+
![](../images/access/registration-form.png)
16+
17+
After submitting personal information, users have to wait for CSCS to review and approve the submission.
18+
19+
Once accepted, you will recieve an email with a link to set your password.
20+
21+
```title="Acceptance email"
22+
Dear John Doe,
23+
24+
Your username is nchallap.
25+
26+
Please click here to set your password.
27+
28+
Yours sincerely,
29+
30+
CSCS Support Team.
31+
```
32+
33+
Following the link in this email will take you to a page where you set your password.
34+
35+
![](../images/access/password.png)
36+
37+
After your password has been set, you will be redirected to a page where you log in using your username and password
38+
39+
![](../images/access/first-login.png)
40+
41+
From here you will need to set up [multi-factor authentification][ref-mfa-configure-otp] (MFA).
42+
43+
Once MFA has been configured, you will finally be redirected to the CSCS portal as shown:
44+
45+
![](../images/access/waldur-user-dashboard.png)

docs/accounts/waldur.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,17 @@ Navigate to the site project management portal [portal.cscs.ch](https://portal.c
1515

1616
After login to the portal, choose the corresponding organization in which the project was created.
1717

18-
!!! todo
19-
screenshot
18+
![waldur-org](../images/access/waldur-organisation.png)
2019

21-
In this example, The project was hosted by the CSCS organization, and say the project name is `csstaff_n`, From the organization dashboard navigate to Projects and click on `csstaff_n` Project
20+
In this example, the project was hosted by the CSCS organization and the project name is `csstaff_n`. From the organization dashboard navigate to Projects and click on the `csstaff_n` project
2221

23-
!!! todo
24-
screenshot
22+
![waldur-proj](../images/access/waldur-project.png)
2523

2624
## Invite users
2725

2826
From the project dashboard, navigate to Team -> Invitations
2927

30-
!!! todo
31-
screenshot
28+
![waldur-proj](../images/access/waldur-invitations.png)
3229

3330
!!! info
3431
Using both the web interface and bulk invitation, the following roles can be assigned in the tool:
@@ -39,14 +36,18 @@ From the project dashboard, navigate to Team -> Invitations
3936

4037
=== "invite individual users"
4138

42-
To invite a user, click on the "Invite Users" button on the right hand side of the tab.
39+
To invite an individual user, click on the green "Invite Users" button on the right hand side of the tab.
4340

44-
!!! todo
45-
screenshot
41+
You will then be prompted to enter the invitee's email address and assign them a role (PI, deputy PI or member)
4642

47-
!!! todo
48-
screenshot
43+
![waldur-proj](../images/access/waldur-email.png)
4944

45+
!!! note "Role definitions"
46+
The Waldur tool uses the following labels for the roles:
47+
48+
* **Project administrator**: PI
49+
* **Project manager**: deputy PI
50+
* **Project member**: member
5051

5152
=== "bulk invite"
5253

@@ -61,7 +62,7 @@ From the project dashboard, navigate to Team -> Invitations
6162
```
6263

6364
!!! note
64-
An email will be sent to the invited user:
65+
An email will be sent to invited users:
6566

6667
* users who already have CSCS accounts should click on the link in the email they received, and authenticate against CSCS KeyCloak with username, password, and OTP to accept the invitation.
67-
* new users should follow the procedure to create a CSCS account.
68+
* new users should follow the procedure to [create a CSCS account][ref-account-create].

docs/images/access/first-login.png

58.2 KB
Loading

docs/images/access/invitation.png

121 KB
Loading

docs/images/access/password.png

105 KB
Loading
175 KB
Loading
172 KB
Loading
291 KB
Loading
231 KB
Loading

0 commit comments

Comments
 (0)