Skip to content

Commit e4cd7f8

Browse files
committed
additional updates to tutorial order
1 parent 0696631 commit e4cd7f8

1 file changed

Lines changed: 49 additions & 24 deletions

File tree

coldfront/README.md

Lines changed: 49 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ NOTE: The databases created for this were made for specific dates these tutorial
1717

1818
If interested, you can [view the steps taken](#seeding-the-database-for-the-full-day-tutorial) to pre-seed the database for the extended version of the tutorial
1919

20-
**By default, the containers start with the database being pre-seeded for the full day tutorial.** If you are starting from a different spot in these instructions, you may want to ensure you have the right database in place. To do so, stop the containers, copy in the full day tutorial database, and then restart the containers. Follow these steps:
20+
**By default, the containers start with the database being pre-seeded for the full day tutorial.** If you are starting from a different spot in these instructions, you may want to ensure you have the right database in place. To do so, stop (destroy) the containers, copy in the full day tutorial database, and then restart the containers, following these steps:
2121

2222
```
2323
./hpcts destroy
24-
cp cf_options/coldfront-long.dump database/coldfront.dump
24+
cp cf_options/coldfront-full.dump database/coldfront.dump
2525
./hpcts start
2626
```
2727

@@ -30,6 +30,8 @@ Once the containers are started, navigate to the [ColdFront site - https://local
3030

3131
<hr>
3232

33+
## ColdFront Overview
34+
3335
### PI View: Annual Project Review, Allocation Renewal & Allocation Change Requests
3436

3537
- Login as `cgray` password `test123`
@@ -61,6 +63,7 @@ For more options on allowing permissions for various types of staff access, see
6163

6264
### Activate the allocation request
6365

66+
- Login as `hpcadmin` password `ilovelinux`
6467
- Navigate to the `Admin` menu and click on `Allocation Requests`
6568
Note: the project review status is a green check mark, indicating our Center Director has already approved the submitted project review.
6669

@@ -83,18 +86,17 @@ password: `test123`
8386
`sbatch --wrap "sleep 600"`
8487
You will get an error message that you do not have permission to run on the cluster
8588
`sbatch: error: Batch job submission failed: Invalid account or account/partition combination specified`
89+
- Let's see what slurm access cgray currently has:
90+
`sacctmgr show user cgray -s list`
91+
You should not see any Slurm account information for the `cgray` user
8692
_**This is because we have not synced the allocation information in ColdFront with Slurm yet.**_
8793
- Type `exit` to log out of the cgray account and you should be on the frontend logged in as the hpcadmin account.
8894

8995
### Run Slurm plugin to sync active allocations from ColdFront to Slurm
9096
- Login to the coldfront container & setup ColdFront environment
9197
`ssh coldfront`
92-
`cd /srv/www`
93-
`source venv/bin/activate`
94-
- Let's see what slurm access cgray currently has:
95-
`sacctmgr show user cgray -s list`
96-
- Let's see what slurm access csimmons currently has:
97-
`sacctmgr show user csimmons -s list`
98+
`source /srv/www/venv/bin/activate`
99+
98100
- Now dump the slurm account/association info from ColdFront's active allocations:
99101
`coldfront slurm_dump -c hpc -o ~/slurm_dump`
100102
- Let's see what was created:
@@ -130,11 +132,20 @@ password: `test123`
130132

131133
<hr>
132134

135+
ColdFront Admin Tasks
136+
137+
### Elevating User to PI Status:
138+
139+
Let's give a user PI access:
140+
- If necessary, login as `hpcadmin` password `ilovelinux`
141+
- Go to Admin menu and click on `ColdFront Administration`
142+
- Scroll to the bottom under the `User` section and click on `User Profiles`
143+
- Click on `sfoster` check ``"Is pi"`` - click `SAVE`
144+
145+
133146
### Adding a Resource
134147

135148
Let's add a cloud resource:
136-
- If necessary, login as `hpcadmin` password `ilovelinux`
137-
- Go to Admin menu and click on `ColdFront Administration`
138149
- Scroll to the `Resource` section and click on `Resources`
139150
- Click on the `Add Resource` button
140151
- Select `Cloud` for `Resource Type` and enter a description.
@@ -154,36 +165,47 @@ Allocation change requests allow a project manager to request a change on an act
154165
- Under the `Allocation` section click on `Allocation Attribute Types`
155166
- Let's allow project managers to request an increase in their storage quotas. Click on the number next to `Storage Quota (GB)`
156167
- Check the box `Is Changeable` and then click the `Save` button.
157-
- Now we'll switch over to our PI user. Under the `Authenciation and Authorization` section, click on `Users` then click on `cgray`
168+
- Now we'll switch over to our PI user. Under the `Authentication and Authorization` section, click on `Users` then click on `cgray`
158169
- At the top right, click on `Login As` which redirects us to the ColdFront home page for the user `cgray`. Click on the project name to get to the project detail page.
159170
- Click on the actions icon next to the `Project Storage` resource which takes you to the Allocation Detail page. Click on the `Request Change` button, select a date extension, enter a new amount of storage, and provide a justification. Then click the `SUBMIT` button. You should now see a pending allocation change request on the allocation detail page.
160171
- Click on the `release cgray` button at the top in the yellow banner.
161172

162-
Now let's go look at and activate the allocation change request submitted by `cgray` for the storage resource. As the HPC admin user, activate and setup the new allocation:
163-
- From the ColdFront Administration page, click on the `View Site` link at the top right.
164-
- Navigate to the `Admin` menu and click on `Allocation Change Requests`
165-
- Click on the `Details` button to review and approve the allocation changes requested. 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 `storage_quota` 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.
166-
- At the bottom of the page, click the `View Allocation` button and notice the `Storage Quota` attribute value has changed from 10000 to 20000.
173+
We'll go back to activating that request in a bit....
167174

168175
For more information about configuring Allocation Change Requests [see here](#more-info-on-allocation-change-requests)
169176

170177

171-
### Request Allocations for New Resource
178+
### Create a New Project & Request Allocations for Cloud Resource
172179

173-
Now that you've set up this new resource, let's create a new project and request an allocation it.
180+
Now that you've set up the new cloud resource, let's create a new project and request an allocation it:
174181

175-
- Login as `cgray` password `test123` OR using the ColdFront Administration page, use the "Login As" option
182+
- Login as `sfoster` password `ilovelinux` OR using the ColdFront Administration page, use the "Login As" option
176183
- Click the `Add a project` button and fill out the `Title` and `Description` fields and select a field of science. Click the `Save` button.
177184
- Once redirected to the project detail page, click `Request Resource Allocation` under the Allocations section.
178185
- Select the cloud resource from the drop down, provide a justification, enter the number of CPU hours, and click the `Submit` button.
186+
Click on the `release sfoster` button at the top in the yellow banner.
179187

180188
As the admin, let's configure and activate that allocation:
181189

190+
- Login using local account username: `hpcadmin` password: `ilovelinux`
191+
- Navigate to the `Admin` menu and click on `Allocation Requests`
192+
- Click on the `Details` button next to the `Research Cloud` allocation request to configure and activate the allocation:
193+
click the `Add Allocation Attribute` button and select these allocation attributes from the drop down menu:
194+
`Core Usage (Hours)` Enter: `10000`
195+
`Cloud Storage Quota (TB)` Enter: `10`
196+
`Cloud Account Name` Enter: `cgray`
197+
Notice as you add the core usage and cloud storage quota attributes you see usage graphs displayed. These can tie into a plugin such as XDMoD or the OpenStack community developed plugins for usage information.
182198

199+
Now let's go look at and activate the allocation change request submitted by `cgray` for the storage resource. As the HPC admin user, activate and setup the new allocation:
200+
- From the ColdFront Administration page, click on the `View Site` link at the top right.
201+
- Navigate to the `Admin` menu and click on `Allocation Change Requests`
202+
- Click on the `Details` button to review and approve the allocation changes requested. 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 `storage_quota` 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.
203+
- At the bottom of the page, click the `View Allocation` button and notice the `Storage Quota` attribute value has changed from 10000 to 20000.
183204

184205

185206

186-
## Removing Access
207+
208+
### Removing Access
187209

188210
When an allocation expires or is revoked, the users on that allocation should lose access to the resource. If the allocation has the `freeipa_group` attribute set, all allocation users are removed from the group when the FreeIPA plugin is run. If the allocation is for a Slurm resource, all Slurm user associations and the Slurm account are removed when the Slurm plugin is run. Let's expire a Slurm allocation and then run the `slurm_check` tool.
189211

@@ -198,8 +220,7 @@ When an allocation expires or is revoked, the users on that allocation should lo
198220
```
199221
ssh -p 6222 hpcadmin@localhost
200222
ssh coldfront
201-
cd /srv/www
202-
source venv/bin/activate
223+
source /srv/www/venv/bin/activate
203224
```
204225
- Use the Coldfront slurm_check tool to remove access for the expired allocation. The first command looks at everything in slurm and compares it to what's in ColdFront:
205226
`coldfront slurm_check -c hpc`
@@ -209,6 +230,10 @@ source venv/bin/activate
209230

210231
The `-s` flag tells it to actually sync to slurm so you'll see it removed the user associations for cgray and csimmons and removed the cgray slurm account. You can use the `-n` flag to run in `noop` mode which will give a listing of what it will change without doing the sync.
211232

233+
- Let's look at cgray's slurm account again:
234+
`sacctmgr show user cgray -s list`
235+
There should be no account or association listed any longer
236+
212237

213238
</details>
214239
<br>
@@ -227,7 +252,7 @@ Before beginning the tutorial, you must stop the containers, copy in the correct
227252

228253
```
229254
./hpcts destroy
230-
cp cf_options/coldfront-short.dump database/coldfront.dump
255+
cp cf_options/coldfront-half.dump database/coldfront.dump
231256
./hpcts start
232257
```
233258

@@ -380,7 +405,7 @@ You'll need to login as some of the users for this tutorial to get things starte
380405
- Scroll to the bottom and click `SAVE`
381406
- 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`
382407
- Click on `cgray` check ``"Is pi"`` - click `SAVE`
383-
- Click on `sfoster` check ``"Is pi"`` - click `SAVE`
408+
384409

385410
Create a new cluster resource:
386411
- 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

0 commit comments

Comments
 (0)