You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: coldfront/README.md
+75-57Lines changed: 75 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,37 +6,64 @@
6
6
7
7
8
8
## Login to ColdFront website
9
-
-URL https://localhost:2443/
10
-
-You'll need to login as some of the users for this tutorial to get things started:
9
+
URL https://localhost:2443/
10
+
You'll need to login as some of the users for this tutorial to get things started. Do NOT use the OpenID Connect login option at this point.
11
11
- Login locally as username `hpcadmin` password: `ilovelinux`
12
12
- Logout
13
13
- Login locally as username `cgray` password: `test123`
14
14
- Logout
15
15
- Login locally as username `csimmons` password: `ilovelinux`
16
16
- Login locally as username `sfoster` password: `ilovelinux`
17
17
- Login locally as username `admin` password: `admin`
18
-
- Go to Admin interface, Users
19
-
- Click on the hpcadmin user
20
-
- Make this user a `superuser` by checking the boxes next to `Staff Status` and `Superuser Status` - SAVE
21
-
- Click on the sfoster account and check the box next to `Staff Status` Also under the `User Permissions` section add permissions for `allocation|allocation|Can view all allocations` and `project|project|Can view all projects` Make sure to SAVE the changes.
22
-
- Click on the Home link to go to back to the Admin interface, then click "User Profiles"
23
-
- Click on `cgray` check ``"Is pi"`` SAVE
24
-
- Click on the Home link to go to back to the Admin interface, Click on Resources
25
-
- Add a resource: `cluster, cluster name=hpc, description: anything you want, resource attribute: slurm_cluster=hpc` - click SAVE
26
-
- Logout
18
+
- Go to Admin menu and click on `ColdFront Administration` Once there, scroll halfway down to the `Authentication and Authorization` section. Then click on the `Users` link.
19
+
- Click on the hpcadmin user and scroll down to the `Permissions` section
20
+
- Make this user a `superuser` by checking the boxes next to `Staff Status` and `Superuser Status` - scroll to the bottom and click SAVE
21
+
- Click on the sfoster account and check the box next to `Staff Status` Also under the `User Permissions` section add permissions to make this user the Center Director
- Click on the Home link to go to back to the Admin interface, scroll to the bottom of the page under the `User` section and click `User Profiles`
30
+
- Click on `cgray` check ``"Is pi"`` - click SAVE
31
+
32
+
Create a new resource:
33
+
- Click on the Home link to go to back to the Admin interface, scroll down near the bottom to the `Resource` section and Click on `Resources` then click the `Add Resource` button
34
+
- Add a resource with the following settings:
35
+
Resource type: select `cluster`
36
+
Name: type `hpc`
37
+
Description: enter anything you want
38
+
Ensure that the following are checked: `Is available`, `Is public`, `Is allocatable`
39
+
Under the resource attributes section, click `Add another Resource attribute` and select `slurm_cluster` from the drop down menu. In the `value` field, enter `hpc` - then click SAVE
40
+
- Logout
41
+
42
+
Request an allocation for the new resource as the PI user:
27
43
- Login as the PI using local account username: `cgray` password: `test123`
28
44
- Create a new project, filling in the name, description, and selecting any field of science
29
45
- Request an allocation for resource: hpc
30
46
- Add a user to the project - search for `csimmons` and add to the HPC cluster allocation
31
-
- Logout
47
+
- Logout
48
+
49
+
Activate and setup the new allocation:
32
50
- Login using local account username: `hpcadmin` password: `ilovelinux`
33
-
- Activate the allocation and set the appropriate allocation attributes:
This is because we have not synced the allocation information in ColdFront with Slurm yet.
40
67
41
68
42
69
## Run Slurm plugin to sync active allocations from ColdFront to Slurm
@@ -74,8 +101,8 @@ NOTE: you should already be on the frontend but just in case you're not:
74
101
`ssh -p 6222 hpcadmin@localhost`
75
102
password: `ilovelinux`
76
103
77
-
Check slurm associations for cgray again: they should now show access to the hpc cluster
78
-
`sacctmgr show user cgray -s list`
104
+
Check slurm associations for cgray account: they should now show access to the hpc cluster
105
+
`sacctmgr show account cgray -s list`
79
106
`su - cgray`
80
107
password: `test123`
81
108
`sbatch --wrap "sleep 600"`
@@ -86,42 +113,49 @@ password: `test123`
86
113
## Login to OnDemand website
87
114
- Login back into or refresh your login to Open OnDemand https://localhost:3443/ as username: `cgray` password: `test123`
88
115
- Try to launch an interactive job again. Does it work this time?
89
-
- Go to Active Jobs and click on your running jobs to see more details
116
+
- Go to the `Jobs` menu and click `Active Jobs` and click on your running jobs to see more details
90
117
- Delete (cancel) the jobs so they show the `completed` status
91
118
92
119
120
+
## Annual Project Review
121
+
When the project review functionality is enabled (it is by default) a PI will be forced to review their project once every 365 days. To change this time frame, edit the default in `coldfront.env` We can force a project to be under review in less than a year which is what we'll do for the cgray project.
93
122
94
-
## Login to Open XDMoD website
95
-
- Login to Open XDMoD https://localhost:4443/
96
-
-- Click on `Sign In` at the top left
97
-
-- Under the section "Sign in with local XDMoD account:" Click on "Login Here" and enter username: `admin` password: `admin`
98
-
- Notice there is currently no data in XDMoD
123
+
Login as `hpcadmin` password `ilovelinux`
124
+
Navigate to the `Admin` menu and click on the `ColdFront Administration` link. Scroll to the `Project` section and click on `Projects` Then click on the project that we created earlier. Check the box next to `Force Review`
125
+
NOTE: If there is a project you never want project reviews on, uncheck 'Requires review'
99
126
100
-
127
+
Logout as `hpcadmin` and login as `cgray` password `test123` and notice the warning banner. Click on the allocation and try to renew it. You should see a warning banner telling you it can't be done because the project review is due. When a project review is required, a PI can't request new allocations or renew expiring allocations. They can, however, add/remove users, publications, grants, and research output. Click on the `renew now` link for the allocation to test this out.
101
128
102
-
129
+
Click the `Review Project` link. Provide a reason for not providing grant or publication information, check the box to acknowledge the update and click the Submit button. Now try to renew the expiring allocation.
103
130
131
+
Log out as `cgray`
104
132
105
-
## Login to Open XDMoD container
106
-
-`ssh hpcadmin@xdmod`
107
-
password: `ilovelinux`
108
-
- In order to see the job data just generated in slurm, we need to ingest the data into Open XDMoD and aggregate it. This is normally done once a day on a typical system but for the purposes of this demo, we have created a script that you can run now:
Allocation change requests are turned on by default. This will allow PIs to request date extensions for their allocations. The date ranges default to 30, 60, & 90 days but can be set changed or disabled completely in `hpc-toolset-tutorial/coldfront/coldfront.env`
136
+
See https://coldfront.readthedocs.io/en/latest/config/#coldfront-core-settings for more information.
112
137
113
-
**Note: More information about this script in the Open XDMoD portion of this tutorial**
138
+
If you want PIs to be able to request changes to allocation attributes (i.e. storage quotas, unix group) this needs to be set on the allocation attribute. For this demo, we will allow the PI to request changes on the `slurm_account` attribute.
139
+
- Login as `hpcadmin` password `ilovelinux`
140
+
- Navigate to the `Admin` menu and click on the `ColdFront Administration` link. Under the `Allocation` section, click on `Allocation Attribute Types` Click on `slurm_account_name` check the box next to `Is changeable` and then click the SAVE button. Logout.
141
+
- Login as `cgray` password `test123`
142
+
- Click on the allocation `RENEWAL REQUESTED` button or navigate to the Allocation Detail page through the project. Click on the `Request Change` button, select a date extension, enter a new slurm account and provide a justification. Then click the `SUBMIT` button. Logout.
143
+
- Login as `hpcadmin` password `ilovelinux`
144
+
- Go to the `Admin` menu and click on `Allocation Change Requests`
145
+
- As the admin you have the ability to approve the date extension, change it to another setting or select `no extension` You can remove the `slurm_account_name` request or change it. You can add notes for the PI and users on the allocation to see. Then you can take action such as `Approve` or `Deny` the request. For this demo, let's click the `Approve` button.
146
+
- Next review the pending allocation requests. Navigate to the `Admin` menu and click on `Allocation Requests` Note that the project review status is pending.
147
+
- Click on the `Admin` menu and click on `Pending project reviews`.
114
148
115
-
## Login to Open XDMoD website
116
-
- Login to Open XDMoD https://localhost:4443/
117
-
-- Click on 'Sign In' at the top left
118
-
-- Under the section "Sign in with tutorial:" Click on "Login Here" and enter username: `cgray` password: `test123`
119
-
- You should see the data from the job you just ran
120
-
NOTE: There won't be much info except that we ran a few jobs. More will be presented in the XDMoD portion of the tutorial
149
+
## Center Director Role and Permissions
150
+
At the start of the tutorial we configured the user `sfoster` with the 'Staff Status' role and gave permissions to act as the Center Director. This allows `sfoster` to view all projects, allocations, publications, and grants. We've also given permission to view the pending project review list. Login as `sfoster` password `ilovelinux` to see what additional menus and functionality this account has access to.
121
151
122
-
152
+
Navigate to the `Staff` menu and click on `Project Reviews`
153
+
Click the `Email` button to see this functionality. Go back to the `Project Reviews` and click `Mark Complete`.
123
154
124
-
## Integrating OnDemand with ColdFront
155
+
For more options on allowing permissions for various types of staff access, see the ColdFront manual: https://coldfront.readthedocs.io/en/latest/manual/users/
156
+
157
+
158
+
## Integrating OnDemand with ColdFront (Time Permitting)
125
159
This is a very simple example of modifying the ColdFront configuration to use a plugin. This plugin allows us to provide a link to our OnDemand instance for any allocations for resources that have "OnDemand enabled"
126
160
127
161
We have already added the OnDemand instance info to the ColdFront config. You can see this outside the containers in your git directory: See `hpc-toolset-tutorial/coldfront/coldfront.env`
@@ -130,24 +164,8 @@ Now let's enable OnDemand for our cluster resource:
130
164
- Log back in to the ColdFront Administration site https://localhost:2443/admin/ as the `hpcadmin` acccount - password `ilovelinux`:
131
165
- Navigate to the Resources section and click on the 'HPC' cluster resource. Add a new resource attribute: `OnDemand = "Yes"`
132
166
- Log out and log in as the PI user `cgray` password `test123`
133
-
- Notice on the ColdFront home page next to the allocation for the HPC cluster resource you see the OnDemand logo. Click on the Project name and see this logo also shows up next to the allocation. When we click on that logo, it directs us to the OnDemand instance.
134
-
135
-
## Staff Role
136
-
At the start of the tutorial we configured the user `sfoster` with the 'Staff Status' role and gave permissions to view all projects and all allocations. Login as `sfoster` password `ilovelinux` to see what additional menus and functionality this account has access to.
137
-
138
-
139
-
## Annual Project Review (time permitting)
140
-
When the project review functionality is enabled (it is by default) a PI will be forced to review their project once every 365 days. To change this time frame, edit the default in `coldfront.env` We can force a project to be under review in less than a year which is what we'll do for the cgray project.
167
+
- Notice on the ColdFront home page next to the allocation for the HPC cluster resource you see the OnDemand logo. Click on the Project name and see this logo also shows up next to the allocation. When we click on that logo, it directs us to the OnDemand instance.
141
168
142
-
Login as `hpcadmin` password `ilovelinux` and go to the ColdFront Administration interface. Click on Projects and click on the cgray project that we created earlier. Check the box next to 'Force Review'
143
-
NOTE: If there is a project you never want project reviews on, uncheck 'Requires review'
144
-
145
-
Now login as `cgray` password `test123` and notice the warning banner. Click on the allocation and try to renew it. You should see a warning banner telling you it can't be done because the project review is due. When a project review is required, a PI can't request new allocations or renew expiring allocations. They can, however, add/remove users, publications, grants, and research output.
146
-
147
-
Click the "Review Project" link. Provide a reason for not providing grant or publication information, check the box to acknowledge the update and click the Submit button. Now try to renew the expiring allocation. Log out as `cgray`
148
-
149
-
Login as `hpcadmin` password `ilovelinux`
150
-
View the pending allocation requests. Note that the project review status is pending. View the pending project reviews. Mark this one complete and go back to the pending allocation requests. Click the "Activate" button and ColdFront activates the allocation for another year.
Copy file name to clipboardExpand all lines: docs/requirements.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Requirements
2
2
3
-
For this tutorial you will need to have **13GB of free disk space** and git, docker, docker-compose and a web browser installed on your local machine. This tutorial has been tested on various versions of Linux, MacOS, and Windows 10 with the following package versions:
3
+
For this tutorial you will need to have **20GB of free disk space** and git, docker, docker-compose and a web browser installed on your local machine. This tutorial has been tested on various versions of Linux, MacOS, and Windows 10 with the following package versions:
4
4
5
5
- git 2.17+ (Windows users we recommend: https://gitforwindows.org/)
0 commit comments