Merge pull request #145 from dsajdak/master

minor re-arrange of order

Author: aebruno

coldfront/README.md

@@ -5,7 +5,7 @@
 - View `hpc-toolset-tutorial/coldfront/coldfront-nginx.conf` for an example of ColdFront web configuration  
 
 
-## Login to ColdFront website
+### Login to ColdFront, setup account permissions & create resource  
 URL https://localhost:2443/  
 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.
 - Login locally as username `hpcadmin` password: `ilovelinux`
@@ -39,17 +39,22 @@ Ensure that the following are checked:  `Is available`, `Is public`, `Is allocat
 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`
 Click `Add another Resource attribute` and select `OnDemand` from the drop down menu.  In the `value` field, enter `Yes`  
 - Then click SAVE  
+ **See more info on the OnDemand plugin at the end**
+
+Make an allocation attribute changeable:  
+- 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  
- **See below for more info on the OnDemand plugin at the end**
 
-Request an allocation for the new resource as the PI user:  
+### Create a project & request an allocation  
+As the PI user: Request an allocation for the new resource:  
 - Login as the PI using local account username: `cgray` password: `test123`
-- Create a new project, filling in the name, description, and selecting any field of science  
-- Request an allocation for resource: hpc  
-- Add a user to the project - search for `csimmons` and add to the HPC cluster allocation  
+- Click the `Add a project` button to reate a new project, filling in the name, description, and selecting any field of science  
+- Once redirected to the project detail page, request an allocation by clicking on the `Request Resource Allocation` button.  Select the `hpc` resource from the drop down menu, provide any justification, and click the `Submit` button    
+- Click the `Add Users` button to add a user to the project - search for `csimmons`, select the HPC cluster allocation, check the box next to the username, and click the `Add Selected Users to Project`  
 - Logout  
 
-Activate and setup the new allocation:  
+### Activate the allocation request  
+As the HPC admin user, activate and setup the new allocation:  
 - Login using local account username: `hpcadmin` password: `ilovelinux`  
 - Navigate to the `Admin` menu and click on `Allocation Requests`  
 - Click on the `Detail` button to configure and activate the allocation:  
@@ -60,7 +65,7 @@ click the `Add Allocation Attribute` button and select these allocation attribut
 Set the status to `Active`, set the start date to today, and set the expiration date to the end of this month (you'll see why later)  
 Click the `Update` button   
 
-## Login to OnDemand website
+### Login to OnDemand & test interactive app  
 - Login to Open OnDemand  https://localhost:3443/ as username: `cgray` password: `test123`
 - Click on the `Interactive Apps` menu and click on `HPC Desktop`
 - Try to launch an interactive Job by clicking on the `Launch` button  
@@ -69,7 +74,7 @@ You will get an error message that you do not have permission to run on the clus
 This is because we have not synced the allocation information in ColdFront with Slurm yet.  
 
 
-## Run Slurm plugin to sync active allocations from ColdFront to Slurm
+### Run Slurm plugin to sync active allocations from ColdFront to Slurm
 - Login to the frontend container first, then to the coldfront container:  
 `ssh -p 6222 hpcadmin@localhost`  
 password: `ilovelinux`  
@@ -99,7 +104,7 @@ NOTE: The csimmons user is under the cgray slurm account
 `exit`  
 
 
-## Login (or go back) to frontend container
+### Login (or go back) to frontend container
 NOTE: you should already be on the frontend but just in case you're not:  
 `ssh -p 6222 hpcadmin@localhost`  
 password: `ilovelinux`  
@@ -113,52 +118,50 @@ password: `test123`
 `exit` (logout from cgray account)  
 
 
-## Login to OnDemand website
+### Try interactive app in OnDemand again  
 - Login back into or refresh your login to Open OnDemand  https://localhost:3443/ as username: `cgray` password: `test123`  
 - Try to launch an interactive job again.  Does it work this time?  
 - Go to the `Jobs` menu and click `Active Jobs` and click on your running jobs to see more details    
 - Delete (cancel) the jobs so they show the `completed` status  
 
 
-## Annual Project Review
+### Annual Project Review, Allocation Renewal & Allocation Change Requests
 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.  
 
 Login as `hpcadmin` password `ilovelinux`  
 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`  
 NOTE: If there is a project you never want project reviews on, uncheck 'Requires review'  
 
-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.  
-
-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`
+- Logout as `hpcadmin` and login as `cgray` password `test123` and notice the `Needs Review` label next to the project.  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 allocation change requests nor 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.  
 
+- 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.  
 
-## Allocation Change Requests  
-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`  
-See https://coldfront.readthedocs.io/en/latest/config/#coldfront-core-settings for more information.
+- 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.  
 
-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.  
-- Login as `hpcadmin` password `ilovelinux`  
-- 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.  
-- Login as `cgray` password `test123`  
-- 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.
 - Login as `hpcadmin` password `ilovelinux`  
 - Go to the `Admin` menu and click on `Allocation Change Requests`  
 - 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.  
 - Next review the pending allocation requests.  Navigate to the `Admin` menu and click on `Allocation Requests`  Note that the project review status is pending.  
-- Click on the `Admin` menu and click on `Pending project reviews`.   
+- Logout as the `hpcadmin` user   
+ **See more info on allocation change requests at the end**   
+
+### Center Director Role and Permissions  
+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.  
 
-## Center Director Role and Permissions  
-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.
+- Login as `sfoster` password `ilovelinux` to see what additional menus and functionality this account has access to.
 
-Navigate to the `Staff` menu and click on `Project Reviews`  
+- Navigate to the `Staff` menu and click on `Project Reviews`  
 Click the `Email` button to see this functionality.  Go back to the `Project Reviews` and click `Mark Complete`.  
 
 For more options on allowing permissions for various types of staff access, see the ColdFront manual:  https://coldfront.readthedocs.io/en/latest/manual/users/  
 
+### More info on Allocation Change Requests  
+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`  
+See https://coldfront.readthedocs.io/en/latest/config/#coldfront-core-settings for more information.
+
+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 allowed the PI to request changes on the `slurm_account` attribute.  
 
-## Integrating OnDemand with ColdFront   
+### More info on the OnDemand Plugin  
 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"  
 
 We have already added the OnDemand instance URL to the ColdFront config.  You can see this outside the containers in your git directory:  See `hpc-toolset-tutorial/coldfront/coldfront.env`