Skip to content

Commit 6ecd909

Browse files
s-sajid-alis-sajid-ali
committed
improve section1, add more coldfront material
 renamed: docs/hpc/01_getting_started/02_getting_and_renewing_an_account.md -> docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx new file: docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx renamed: docs/hpc/01_getting_started/03_walkthrough_approve_hpc_account_request.md -> docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md renamed: docs/hpc/01_getting_started/04_walkthrough_renew_hpc_account_iiq.md -> docs/hpc/01_getting_started/05_walkthrough_renew_hpc_account.md deleted: docs/hpc/01_getting_started/06_coldfront_requesting_an_allocation_request.md renamed: docs/hpc/01_getting_started/05_hpc_accounts_external_collaborators.md -> docs/hpc/01_getting_started/06_hpc_accounts_external_collaborators.md new file: docs/hpc/01_getting_started/07_what_is_coldfront.mdx new file: docs/hpc/01_getting_started/08_coldfront_creating_a_project.mdx new file: docs/hpc/01_getting_started/09_coldfront_requesting_an_allocation_request.mdx renamed: docs/hpc/01_getting_started/07_approving_an_allocation_request.md -> docs/hpc/01_getting_started/10_approving_an_allocation_request.md new file: docs/hpc/01_getting_started/static/allocation_request_submit.png modified: docs/hpc/01_getting_started/static/allocation_requests.png new file: docs/hpc/01_getting_started/static/approve_renewal.png new file: docs/hpc/01_getting_started/static/approve_select_everything.png modified: docs/hpc/01_getting_started/static/approver_staff.png modified: docs/hpc/01_getting_started/static/approving_allocation.png new file: docs/hpc/01_getting_started/static/bulk_acct_req_form.png new file: docs/hpc/01_getting_started/static/faculty_request_form.png new file: docs/hpc/01_getting_started/static/faculty_request_landing.png new file: docs/hpc/01_getting_started/static/identity_landing.png new file: docs/hpc/01_getting_started/static/project_add_button.png new file: docs/hpc/01_getting_started/static/project_create.png new file: docs/hpc/01_getting_started/static/project_dropdown.png new file: docs/hpc/01_getting_started/static/request_account.png new file: docs/hpc/01_getting_started/static/request_burger.png new file: docs/hpc/01_getting_started/static/request_form.png deleted: docs/hpc/01_getting_started/static/school_resource.png deleted: docs/hpc/01_getting_started/static/uni_resource.png modified: docs/hpc/03_storage/05_research_project_space.mdx modified: docs/hpc/05_submitting_jobs/03_slurm_tutorial.md
1 parent 68b0226 commit 6ecd909

30 files changed

Lines changed: 181 additions & 41 deletions

docs/hpc/01_getting_started/02_getting_and_renewing_an_account.md renamed to docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
14
# Getting and Renewing an Account
25

36
[nyu vpn link]: https://www.nyu.edu/life/information-technology/infrastructure/network-services/vpn.html
@@ -25,11 +28,11 @@ NYU HPC clusters and related resources are available to full-time NYU faculty an
2528

2629
## Getting a new account on the NYU HPC clusters
2730

28-
To request an NYU HPC account please log in to [NYU Identity Management service][nyu ims link] and follow the link to "Request HPC account". We have a walkthrough of how to \[request an account through IIQ]. If you are a student, alumni or an external collaborator you need an NYU faculty sponsor.
31+
To request an NYU HPC account please log in to [NYU Identity Management service][nyu ims link] and follow the link to "Request HPC account". We have a walkthrough of how to [request an account through IIQ](03_walkthrough_request_hpc_account.mdx). If you are a student, alumni or an external collaborator you need an NYU faculty sponsor.
2932

3033
## Renewing HPC account
3134

32-
Each year, non-faculty users must renew their HPC account by filling in the account renewal form from the [NYU Identity Management service][nyu ims link]. See [Renewing your HPC account with IIQ](./03_walkthrough_approve_hpc_account_request.md) for a walkthrough of the process.
35+
Each year, non-faculty users must renew their HPC account by filling in the account renewal form from the [NYU Identity Management service][nyu ims link]. See [Renewing your HPC account](05_walkthrough_renew_hpc_account.md) for a walkthrough of the process.
3336

3437
## Information for faculty who sponsor HPC users
3538

@@ -61,13 +64,13 @@ HPC faculty sponsors are expected to:
6164

6265
- Respond promptly to account-related requests from HPC staff
6366

64-
Each year, your sponsored users must renew their account. You will need to approve the renewal by logging into the [NYU Identity Management service][nyu ims link]. We have a [walkthrogh of the approval process here](./03_walkthrough_approve_hpc_account_request.md)
67+
Each year, your sponsored users must renew their account. You will need to approve the renewal by logging into the [NYU Identity Management service][nyu ims link]. We have a [walkthrogh of the approval process here](04_walkthrough_approve_hpc_account_request.md)
6568

6669
## Bulk HPC Accounts for Courses
6770

6871
HPC bulk accounts request is disabled for HPC sponsors.
6972

70-
- If you would like to use JupyterHub for your classes, please don't submit the form below, read \[Jupyter Hub page] instead (the link to an intake form is also there)
73+
- If you would like to use JupyterHub for your classes, please don't submit the form below, read \[Jupyter Hub page]**TODO Add a page for JHub in the Cloud section** instead (the link to an intake form is also there)
7174

7275
- Please fill out this [request form][hpc account request form link for courses] for the course, we'll create HPC accounts for the class per request
7376

@@ -81,7 +84,7 @@ NYU partners (\[look for the list here]) with many state and national facilities
8184

8285
If you are part of collaboration with NYU researcher you need to obtain an **affiliate** status before applying for an NYU HPC account. A full-time NYU faculty member must sponsor a non-NYU collaborator for an affiliate status.
8386

84-
Please see [instructions for affiliate management][affiliate and account management link] (NYU NetID login is required to follow the link). [Please read instructions about sponsoring external collaborators here](./05_hpc_accounts_external_collaborators.md).
87+
Please see [instructions for affiliate management][affiliate and account management link] (NYU NetID login is required to follow the link). [Please read instructions about sponsoring external collaborators here](06_hpc_accounts_external_collaborators.md).
8588

8689

8790
## Access to cluster after Graduation
@@ -97,13 +100,25 @@ If you are not part of a collaboration, your access to cluster will end together
97100

98101
In order to request a new HPC account or renew an expired one, you need to be connected to the NYU VPN if you are working remotely, Please see [instructions on how to install and use the NYU VPN][nyu vpn link]. Linux clients are not officially supported, however we were able to successfully use openVPN client. Here are installation and connection instructions for a debian linux distribution with apt package manager:
99102

100-
```sh
101-
apt-get install openconnect
102-
sudo openconnect -b vpn.nyu.edu
103-
```
104103

105-
_When prompted follow the instructions and provide your netID, password, and authenticate with ('push', 'phone1' or 'sms')_
104+
<Tabs>
105+
<TabItem value="anyconnect" label="anyconnect" default>
106+
- Download the VPN package from [here](https://cdn.shanghai.nyu.edu/sites/default/files/anyconnect-core-linux64-4.10.07061.zip) and unzip the file;
107+
- Type the following command in the Terminal
108+
```sh
109+
sudo sh anyconnect-core-linux64-4.10.07061.sh
110+
```
111+
</TabItem>
112+
<TabItem value="openconnect" label="openconnect">
113+
- Type the following command in the Terminal
114+
```sh
115+
apt-get install openconnect
116+
sudo openconnect -b vpn.nyu.edu
117+
```
118+
- When prompted follow the instructions and provide your netID, password, and authenticate with ('push', 'phone1' or 'sms')
119+
This method was tested on few Linux distributions and settings however is not guaranteeed to work in future.
120+
</TabItem>
121+
</Tabs>
106122

107-
This method was tested on few Linux distributions and settings however is not guaranteeed to work in future.
108123

109124
:::

‎docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
# How to request an HPC account
5+
6+
First, check if you already have an account. You can check this by attempting to log in to the cluster, according to the instructions at [Connecting to the HPC Cluster](../02_connecting_to_hpc/01_connecting_to_hpc.md)
7+
8+
:::info VPN Needed
9+
You need to be on the NYU VPN to perform this task!
10+
:::
11+
12+
Login to the URL given below, using your NetID/password, to create or manage HPC Account Requests:
13+
https://identity.it.nyu.edu/
14+
15+
16+
<Tabs>
17+
<TabItem value="end-users" label="Researcher/End-User" default>
18+
Upon logging in, an end user’s landing page will look like this:
19+
![Request account landing page](./static/identity_landing.png)
20+
21+
Note that if the menu does not appear, select the "burger" menu on the top left hand corner:
22+
![Request burger](./static/request_burger.png)
23+
24+
Navigate to Manage Accounts > Request HPC Account:
25+
26+
![Request account left hand button](./static/request_account.png)
27+
28+
You will be prompted with a form. Continue to fill it out and Submit.
29+
![Request account form](./static/request_form.png)
30+
</TabItem>
31+
<TabItem value="sponsors" label="Faculty/Sponsor/Approver">
32+
When an approver/sponsor/faculty logs in, it will look like this:
33+
![Faculty landing](./static/faculty_request_landing.png)
34+
with “QuickLinks” to both “Bulk HPC Account Request” and “Request HPC Account” and will show any recent or pending approvals or forms.
35+
36+
If the **Request HPC Account** QuickLink is clicked, the following form appears:
37+
![Faculty request form](./static/faculty_request_form.png)
38+
39+
The user’s name will be prepopulated, and the forms required fields must be completed (sponsor, reason for request, consent to terms of use). After clicking “Submit” the chosen sponsor will be notified of the request and provisioning will only occur after approval.
40+
41+
If the **Bulk HPC Account Request** QuickLink is clicked, the following form appears:
42+
![Bulk account request form](./static/bulk_acct_req_form.png)
43+
44+
The requestor’s name will be prepopulated, and the forms required fields must be completed (sponsor, list of netids, course identifier, reason for request, consent to terms of use). These requests are auto-approved since they are usually submitted by the sponsor themselves or a member of the HPC Admin team.
45+
</TabItem>
46+
</Tabs>
47+
48+
49+

docs/hpc/01_getting_started/03_walkthrough_approve_hpc_account_request.md renamed to docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# How to approve an HPC Account Request
22

3+
:::info VPN Needed
4+
You need to be on the NYU VPN to perform this task!
5+
:::
6+
37
When someone nominates you as their HPC sponsor, you should be notified by email. You can also [log into IIQ at any time](https://iiq.nyu.edu/identityiq), and if you have a request awaiting your approval, it will appear in your "Actions Items" box, as per the following screenshot:
48
!["Actions Items" box](./static/work_item.png)
59

@@ -9,5 +13,11 @@ Another way to get to pending approvals is to click on the line item in the “L
913

1014
Here, the Approve or Deny button should be clicked, then confirmed, in order to complete the request.
1115

12-
If you have any difficulties or questions, please contact us at hpc@nyu.edu.
16+
For HPC Account Renewals, the page will look like this:
17+
![Approver renewal](./static/approve_renewal.png)
18+
19+
Here, all systems should be selected by clicking the check box in the menu bar, and choosing “Select Everything”.
20+
![Approve select everything](./static/approve_select_everything.png)
21+
22+
Then, the “Select Bulk Action” menu is used to Approve or Reject all items selected. Please note that the line items may span multiple pages and all items must be acted upon in order to complete the request. Clicking “Complete” will complete the request.
1323

docs/hpc/01_getting_started/04_walkthrough_renew_hpc_account_iiq.md renamed to docs/hpc/01_getting_started/05_walkthrough_renew_hpc_account.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# Renewing your HPC Account with IIQ
1+
# Renewing your HPC Account
22

3-
Login to the URL given below, using your netid/password, to create or manage HPC Account Requests:
3+
Login to the URL given below, using your NetID/password, to create or manage HPC Account Requests:
44

5-
https://identity.it.nyu.edu/ (NYU VPN is required)
5+
:::info VPN Needed
6+
You need to be on the NYU VPN to perform this task!
7+
:::
8+
9+
https://identity.it.nyu.edu/
610

711
Upon logging in, an end user’s landing page will look like this
812

‎docs/hpc/01_getting_started/06_coldfront_requesting_an_allocation_request.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

docs/hpc/01_getting_started/05_hpc_accounts_external_collaborators.md renamed to docs/hpc/01_getting_started/06_hpc_accounts_external_collaborators.md

File renamed without changes.

‎docs/hpc/01_getting_started/07_what_is_coldfront.mdx‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
# HPC project management portal
5+
6+
Coldfront is the HPC project and allocation management portal for Torch at NYU. You can access it by navigating to [coldfront.hpc.nyu.edu](https://coldfront.hpc.nyu.edu). With it you can:
7+
<Tabs>
8+
<TabItem value="PIs" label="PIs" default>
9+
- Create a project
10+
- Request allocations for your projects
11+
- Add/Delete members associated with your project
12+
- Modify access to allocations for the members of your project
13+
14+
</TabItem>
15+
<TabItem value="researchers" label="Researchers">
16+
- View the projects and allocations you are part of
17+
- View the SLURM accounts for projects you are part of
18+
</TabItem>
19+
<TabItem value="school approvers" label="School Approvoers">
20+
- Approve the resource allocation requests from PIs for projects associated with your school
21+
</TabItem>
22+
</Tabs>
23+
24+
25+
<br/>
26+
27+
:::info[VPN Needed]
28+
You need to be connected to the NYU VPN or be present on campus to access the Coldfront HPC project management portal.
29+
:::
30+
31+
How do I:
32+
- Create a project: refer to [creating a project](08_coldfront_creating_a_project.mdx)
33+
- Request an allocation: refer to [submitting an allocation request](09_coldfront_requesting_an_allocation_request.mdx)
34+
- Approve an allocation request: refer to [approving an allocation request](10_approving_an_allocation_request.md)
35+
- View resources that are available to me: refer to TODO
36+
37+
A coldfront allocation is needed to perform any work on Torch. The next sections describe the project and allocation reqeust process in detail.

‎docs/hpc/01_getting_started/08_coldfront_creating_a_project.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# How to create a project on Coldfront
2+
3+
Login to coldfront at [coldfront.hpc.nyu.edu](https://coldfront.hpc.nyu.edu) either on-campus or on the VPN. Navigate to the "Project" item in the navigation bar on the top of the page and select "Projects" from the drop down menu.<br/>
4+
![Project Dropdown](./static/project_dropdown.png)
5+
6+
<br/>
7+
If you are a PI, you will be able to see a button "+ Add a Project" button that will let you create a new project. <br/>
8+
9+
![Project Add Button](./static/project_add_button.png)
10+
11+
Click on it to head to the project creation page where you can add the project title, description and the school it will be associated with. The school a project is associated with determines the resources it will have access to. The school approver for the associated school has the capacity to approve allocation requests for resources associated with the school.<br/>
12+
![Project Create](./static/project_create.png)

‎docs/hpc/01_getting_started/09_coldfront_requesting_an_allocation_request.mdx‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
# How to submit an allocation request
5+
6+
Login to coldfront at [coldfront.hpc.nyu.edu](https://coldfront.hpc.nyu.edu) either on-campus or on the VPN. Navigate to the "Project" item in the navigation bar on the top of the page and select "Projects" from the drop down menu.<br/>
7+
![Project Dropdown](./static/project_dropdown.png)
8+
9+
From the list of project, click on the project you'd like to submit an allocation request for and you'll see the current details:
10+
!["PI_One Project" section](./static/PI_one_project.png)
11+
12+
If you scroll down, you'll see "+Request Resource Allocation" button.
13+
!["PI request allocation" section](./static/PI_request_allocation.png)
14+
15+
After clicking "+Request Resource Allocation", you'll see a list of resources you can request for. All projects can request access to Torch, which provides access to the cluster. However, depending on the school the project is affiliated with, high priority resources are available.
16+
17+
<Tabs>
18+
<TabItem value="tandon" label="Tandon" default>
19+
- tandon_advanced: includes both A100 and H100 GPUs
20+
- tandon_priority: includes A100 GPUs only
21+
</TabItem>
22+
<TabItem value="arts-sciences" label="Arts & Sciences">
23+
- cilvr: A100 GPUs
24+
- cds: rtx8000 and A100
25+
- chemistry: A100 GPUs
26+
</TabItem>
27+
</Tabs>
28+
29+
Please select a resource and fill in justification to complete the allocation request process.
30+
![Allocation request justify submit](./static/allocation_request_submit.png)
31+
32+
Now your allocation request is created! You'll see an allocation request with "New" status.
33+
!["Allocation request created" section](./static/allocation_request_created.png)
34+
35+
If you have any difficulties or questions, please contact us at hpc@nyu.edu.
36+

docs/hpc/01_getting_started/07_approving_an_allocation_request.md renamed to docs/hpc/01_getting_started/10_approving_an_allocation_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to approve an Allocation Request
1+
# How to approve an allocation request
22

33
If you are an approver for your school, first login to coldfront page and you'll see "staff" navigation bar.
44
Click the "staff" navigation bar and click "Allocation Requests" to see a list of requests waiting for your approval.

0 commit comments

Comments
 (0)