Using a resource allocation: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
No edit summary
 
(123 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Draft}}
<languages />


=Introduction=
<translate>
=Introduction to RAC= <!--T:1-->


RAC recipients will be notified shortly before the new RAC year (usually first week in April) of the results of their RAC award.
<!--T:2-->
This page is a guide for Principal Investigators (PIs) who have applied to the Alliance's [https://alliancecan.ca/en/services/advanced-research-computing/accessing-resources/resource-allocation-competition Resource Allocation Competition (RAC)], peer-reviewed processed to grant priority access to storage and compute resources beyond what can be obtained via the [https://alliancecan.ca/en/services/advanced-research-computing/accessing-resources/rapid-access-service Rapid Access Service].  


The awards are implemented at the beginning of the RAC year, and recipients can begin to use their awards.
<!--T:3-->
Your award may have come from one of these processes:
* Resources for Research Groups (RRG)
* Research Platforms and Portals (RPP)


=Accounts=
<!--T:4-->
You will be notified of the results of your application before the start of the new RAC year. The RAC year typically begins the first week of April, so you should expect notification sometime in March. You and your sponsored users can begin to use the awarded resources at the beginning of the RAC year.


TBD: something about RAPI's and account names.
== Projects, group names, and allocations == <!--T:5-->


=Sponsored users=
<!--T:6-->
Alliance resources are made available to PIs through Resource Allocation Projects (RAP). Each RAP has a project identifier (RAPI) and an associated group name.


Compute Canada accounts are per person: account sharing is strictly forbidden. Each of a PI's students and collaborators should therefore obtain a personal account under the PI's sponsorship. Students and collaborators should go to the [https://ccdb.computecanada.ca Compute Canada database] to register for an account in their own name, using the sponsor's CCRI when filling out the web form. The PI will receive an e-mail with a link to click on to confirm the sponsorship of this individual. There is no limit on the number of sponsored accounts that a PI can have, however a sponsored account has complete access to the PI's storage and compute allocations so such sponsorship should only be in the context of a genuine and sustained research collaboration. More details on the process of obtaining a Compute Canada account are available [https://www.computecanada.ca/research-portal/account-management/apply-for-an-account/ here].
<!--T:7-->
In general, there are two main types of RAPs:
*Default RAP: A default RAP is automatically created when a PI role is activated. Default quotas and Rapid Access Service quotas for storage and cloud resources are managed via this default RAP. The Default RAP allows PIs and sponsored users to make opportunistic use of compute resources with the default (that is, the lowest) priority. The default RAPI typically takes the form <code>abc-123-aa</code> and has an associated group name that follows the convention <code>def-profname.</code>
*RAC RAP: This RAP is created when the PI receives an award through the Resource Allocation Competition. The RAC RAPI typically takes the form <code>abc-123-ab</code>, with an associated group name that follows the convention <code>rrg-profname</code> or <code>rpp-profname</code> for HPC resources, or <code>cpp-profname</code> or <code>crg-profname</code> for cloud resources.


=Using a compute allocation on a cluster=
<!--T:8-->
A RAC award consists of one or more <b>allocations</b>.  Each allocation consists of a resource (such as <code>graham-cpu</code>, <code>graham-gpu</code>, <code>graham-storage</code>) and an amount, and has a designation like <code>abc-123-aa-001</code>.


When submitting a jobs to the scheduler on a cluster you will need to specify the account to be "billed" for this job, which is the means by which you and your collaborators can make use of any compute allocation you may have on a particular cluster. See [[Running_jobs#Accounts_and_projects | this page]] for more details.
<!--T:9-->
You can find RAPIs and their corresponding group names and allocations by visiting the [https://ccdb.alliancecan.ca CCDB portal].
See [[Running_jobs#Accounts_and_projects|Running jobs: Accounts and projects]] for an illustration.


=Using allocated <code>/project</code> storage=
<!--T:53-->
For more details about RAP and RAP memberships, visit the [[Frequently_Asked_Questions_about_the_CCDB#Resource_Allocation_Project_.28RAP.29|CCDB FAQ page]]


A <code>/project</code> storage allocation on one of the Compute Canada clusters is allocated as a directory of the form <code>/project/rrg-&lt;PI name&gt;</code>. This directory is intended to be shared by all the PI's sponsored users. Details on the use of the project space are in the pages [[Project_layout]] and [[Sharing_data]].
== Sponsored users == <!--T:10-->


Note that the PI also has the RAS (default) project space of the form <code>/project/def-&lt;PI name&gt;</code>. The PI may want to copy or move data from that default to the allocated <code>/project</code> directory.
<!--T:11-->
Alliance accounts are <i>per person:</i> Account sharing is strictly forbidden. Each of your students, employees, or collaborators who will use the resources should therefore obtain their own account under your sponsorship. They should go to the [https://ccdb.alliancecan.ca CCDB] to register in their own name, using your CCRI to indicate your sponsorship when filling out the web form. You (the sponsor) will receive an e-mail with a link to click on to confirm the sponsorship of this individual. There is no limit on the number of sponsored accounts that a PI can have, but such sponsorship should only be in the context of a genuine and sustained research collaboration. More details on the process of obtaining an Alliance account are available [https://alliancecan.ca/en/services/advanced-research-computing/account-management/apply-account here].


=Using a cloud allocation=
= Information on each resource = <!--T:12-->


You should begin by reading some of the information about using Compute Canada's [[Cloud | cloud services]].
<!--T:13-->
For more information, please click on the tab below corresponding to where you have been granted resources.  <i>General-purpose clusters</i> are [[Béluga]], [[Cedar]], and [[Graham]].  More than one tab may apply if, for example, you have been granted an allocation on both [[Niagara]] and a general-purpose cluster.


* Links to terms of service and acceptable use should be included.
<!--T:14-->
<tabs>
 
<!--T:15-->
<tab name="General-purpose clusters">
 
=== Who can use the allocation? === <!--T:16-->
 
<!--T:17-->
By default, every role that you have sponsored through your Alliance CCDB registration has access to your RAC award. Any co-PIs that were listed on your RAC application will also have access.
 
<!--T:18-->
If desired, you can select which users may use your allocation. To do so:
 
<!--T:19-->
1) Log in at https://ccdb.alliancecan.ca/
 
<!--T:20-->
2) From the <i>My Account</i> menu, select <i>Manage RAP Memberships.</i>  This will take you to https://ccdb.alliancecan.ca/resource_allocation_projects/members.  In the Resource Allocation Project (RAP) drop-down list on this page, select the RAP to which you want to add members.
 
<!--T:65-->
3) To add a new member, go to <i>Add Members</i> and enter the CCRI of the user you want to add. Once added, you will see the new member highlighted in yellow.
 
<!--T:66-->
4) If you add a new PI as a member, you can add any of their sponsored users or co-PIs at the same time.  Go to <i>Add Members</i> and click on the <i>In bulk</i> link: this will take you to a new page where you can add all or several of the roles associated with that PI at once. If you do not see the name of the user that you are looking for in that list, then click on <i>Cancel</i> to go back to the RAP membership page and return to step 3.
 
<!--T:21-->
RAP membership is represented as a group in LDAP. It defines a group of users that are authorized to submit jobs against the RAPI (which is the ID of the RAP) and share files within the same Unix group.
 
=== Using a compute allocation === <!--T:22-->
 
<!--T:23-->
When submitting jobs to the scheduler, users will need to specify a group name as the value of the <code>--account</code> option.  Jobs pertaining to the research described in the RAC application should be submitted with the group name corresponding to the RAC award, e.g., <code>--account=rrg-profname-ab</code>.  Jobs pertaining to other research should be submitted with the default group name, e.g., <code>--account=def-profname</code>. 
 
<!--T:24-->
See [[Running_jobs#Accounts_and_projects|Running jobs: Accounts and projects]] for more details.
 
=== Using allocated storage === <!--T:25-->
 
<!--T:26-->
If you have substantial amounts of data to transfer to an Alliance cluster in order to use your storage allocation, we strongly recommend the use of [[Globus]].
 
==== <code>/project</code> ==== <!--T:27-->
 
<!--T:28-->
A <code>/project</code> storage allocation on a general-purpose cluster is created as a directory of the form <code>/project/<group-name></code>, e.g., <code>/project/rrg-profname-ab</code>, and an associated quota defining the amount of data that can be stored in the directory.  Files pertaining to the research described in the RAC application should be stored there by all sponsored users. More guidance on the use of <code>/project</code> space can be found at [[Project layout]] and [[Sharing data]].
 
<!--T:29-->
Note that you will also have default project space of the form <code>/project/def-profname</code>. You may wish to move data from that default project space to the RRG or RPP <code>/project</code> directory, if the data pertains to the research described in the RAC application.
 
==== <code>/nearline</code> ==== <!--T:30-->
 
<!--T:31-->
Please see [[Using nearline storage]].
 
<!--T:32-->
</tab>
 
<!--T:33-->
<tab name="Niagara">
 
=== Who can use the allocation? === <!--T:34-->
 
<!--T:35-->
By default, every role that you have sponsored through your Alliance CCDB registration has access to your RAC award. Any co-PIs that were listed on your RAC application will also have access.
 
<!--T:36-->
If desired, you can select which users may use your allocation. To do so:
 
<!--T:37-->
1) Log in at https://ccdb.alliancecan.ca/
 
<!--T:38-->
2) From the <i>My Account</i> menu, select <i>Manage RAP Memberships</i>.  This will take you to https://ccdb.alliancecan.ca/resource_allocation_projects/members.  In the Resource Allocation Project (RAP) drop-down list on this page, select the RAP to which you want to add members.
 
<!--T:67-->
3) To add a new member, go to <i>Add Members</i> and enter the CCRI of the user you want to add. Once added, you will see the new member highlighted in yellow.
 
<!--T:68-->
4) If you add a new PI as a member, you can add any of their sponsored users or co-PIs at the same time.  Go to <i>Add Members</i> and click on the <i>In bulk</i> link: this will take you to a new page where you can add all or several of the roles associated with that PI at once. If you do not see the name of the user that you are looking for in that list, then click on <i>Cancel</i> to go back to the RAP membership page and return to step 3.
 
<!--T:39-->
RAP membership is represented as a group in LDAP. It defines a group of users that are authorized to submit jobs against the RAPI (which is the ID of the RAP) and share files within the same Unix group.
 
=== Using a compute allocation === <!--T:40-->
 
<!--T:41-->
When a user submits a job to the scheduler, the job will be assigned to the current allocation of the user's PI.  If the user has more than one PI, i.e. more than one group, they must specify a group name as the value of the <code>--account</code> option.
 
<!--T:42-->
See [[Running_jobs#Accounts_and_projects|Running jobs: Accounts and projects]] for more details.
 
=== Using allocated storage === <!--T:43-->
 
<!--T:44-->
If you have substantial amounts of data to transfer to the cluster in order to use your storage allocation, we strongly recommend the use of [[Globus]].
 
==== <code>/project</code> ==== <!--T:45-->
 
<!--T:46-->
The location of a <code>/project</code> storage allocation on Niagara should be found by using the environment variable <code>$PROJECT</code>.  This variable will point to a user-specific directory in the research group's project space.
 
==== <code>/nearline</code> ==== <!--T:47-->
 
<!--T:48-->
A <code>/nearline</code> allocation on Niagara means space in HPSS.  Please see [[Using nearline storage#Niagara|Using nearline storage]].
 
<!--T:49-->
</tab>
 
<!--T:50-->
<tab name="Cloud">
Cloud resources allocated via the Rapid Access Service (RAS) use the default RAP.
 
<!--T:54-->
Cloud resources allocated via the Resource Allocation Competition are awarded through a RAC RAP which follows a different naming convention than default projects. The group name of RAC RAPs with cloud allocations typically takes the form of <code>crg-profname</code> (for cloud resources allocated to a research group) or <code>cpp-profname</code> (for cloud resources allocated to a research platform or portal).
 
=== Who can use the allocation? === <!--T:55-->
If you have an active cloud resource allocation, you should already have a RAP and therefore access to the particular cloud on which you have an allocation.
 
<!--T:56-->
*Default RAP: Cloud resources granted to you via RAS are allocated through your default RAP. All your activated sponsored user roles are always members of your default RAP. That is, confirming sponsorship of a user confers on them membership in your default RAP. However, you can at any time deactivate any role you sponsor. 
*RAC RAP: By default, only the PI is added as a member of a RAP associated with cloud resources allocated via the Resource Allocation Competition. If desired, you can add sponsored users and/or other active Alliance users as members to the RAP. Only members added to your RAP can use your cloud allocation.
 
<!--T:57-->
If desired, you can select which users may use your allocation. To do so:
 
<!--T:58-->
1) Log in at https://ccdb.alliancecan.ca/
 
<!--T:59-->
2) From the <i>My Account</i> menu, select <i>Manage RAP Memberships</i>.  This will take you to https://ccdb.alliancecan.ca/resource_allocation_projects/members.  In the Resource Allocation Project (RAP) drop-down list on this page, select the RAP to which you want to add members.
 
<!--T:62-->
3) Go to <i>Add Members</i>, and click on the <i>In bulk</i> link: this will take you to a new page that will allow you to easily add co-PIs and any of their associated sponsored user roles.
 
<!--T:63-->
4) If the <i>In bulk</i> page in step 3 above does not show the name of the user that you want to add, then click on <i>Cancel</i> to go back to the RAP membership page.  Once there, go to the <i>Add Members</i> section, and enter the CCRI of the member in the <i>One by one using a CCRI</i> field.
 
<!--T:64-->
5) Following step 4 will allow you to add an associated PI that was not included as co-PI in your RAC application. Once a new PI is added as a member to your RAP using this process, you will be able to add any of their associated sponsored user roles through the <i>In bulk</i> mechanism explained in step 3.
 
<!--T:60-->
Important:
*Any new member added to a RAP for your cloud project will automatically has access to your cloud allocation. If desired, at any time you can promote members to Managers, or remove members.
*Membership in your Cloud RAP allows full access to your OpenStack tenants. For more details, see or wiki page on  [[OpenStack#Projects|OpenStack projects]].
 
<!--T:61-->
For information about logging in and using a particular cloud see [[Cloud#Using the cloud|using the cloud]]. If you are unsure about your cloud allocation or if you have difficulty logging into a cloud where you have an allocation, please contact [[technical support]].
</tab>
 
<!--T:51-->
</tabs>
 
</translate>

Latest revision as of 17:58, 11 June 2024

Other languages:

Introduction to RAC[edit]

This page is a guide for Principal Investigators (PIs) who have applied to the Alliance's Resource Allocation Competition (RAC), peer-reviewed processed to grant priority access to storage and compute resources beyond what can be obtained via the Rapid Access Service.

Your award may have come from one of these processes:

  • Resources for Research Groups (RRG)
  • Research Platforms and Portals (RPP)

You will be notified of the results of your application before the start of the new RAC year. The RAC year typically begins the first week of April, so you should expect notification sometime in March. You and your sponsored users can begin to use the awarded resources at the beginning of the RAC year.

Projects, group names, and allocations[edit]

Alliance resources are made available to PIs through Resource Allocation Projects (RAP). Each RAP has a project identifier (RAPI) and an associated group name.

In general, there are two main types of RAPs:

  • Default RAP: A default RAP is automatically created when a PI role is activated. Default quotas and Rapid Access Service quotas for storage and cloud resources are managed via this default RAP. The Default RAP allows PIs and sponsored users to make opportunistic use of compute resources with the default (that is, the lowest) priority. The default RAPI typically takes the form abc-123-aa and has an associated group name that follows the convention def-profname.
  • RAC RAP: This RAP is created when the PI receives an award through the Resource Allocation Competition. The RAC RAPI typically takes the form abc-123-ab, with an associated group name that follows the convention rrg-profname or rpp-profname for HPC resources, or cpp-profname or crg-profname for cloud resources.

A RAC award consists of one or more allocations. Each allocation consists of a resource (such as graham-cpu, graham-gpu, graham-storage) and an amount, and has a designation like abc-123-aa-001.

You can find RAPIs and their corresponding group names and allocations by visiting the CCDB portal. See Running jobs: Accounts and projects for an illustration.

For more details about RAP and RAP memberships, visit the CCDB FAQ page

[edit]

Alliance accounts are per person: Account sharing is strictly forbidden. Each of your students, employees, or collaborators who will use the resources should therefore obtain their own account under your sponsorship. They should go to the CCDB to register in their own name, using your CCRI to indicate your sponsorship when filling out the web form. You (the sponsor) will receive an e-mail with a link to click on to confirm the sponsorship of this individual. There is no limit on the number of sponsored accounts that a PI can have, but such sponsorship should only be in the context of a genuine and sustained research collaboration. More details on the process of obtaining an Alliance account are available here.

Information on each resource[edit]

For more information, please click on the tab below corresponding to where you have been granted resources. General-purpose clusters are Béluga, Cedar, and Graham. More than one tab may apply if, for example, you have been granted an allocation on both Niagara and a general-purpose cluster.

Who can use the allocation?[edit]

By default, every role that you have sponsored through your Alliance CCDB registration has access to your RAC award. Any co-PIs that were listed on your RAC application will also have access.

If desired, you can select which users may use your allocation. To do so:

1) Log in at https://ccdb.alliancecan.ca/

2) From the My Account menu, select Manage RAP Memberships. This will take you to https://ccdb.alliancecan.ca/resource_allocation_projects/members. In the Resource Allocation Project (RAP) drop-down list on this page, select the RAP to which you want to add members.

3) To add a new member, go to Add Members and enter the CCRI of the user you want to add. Once added, you will see the new member highlighted in yellow.

4) If you add a new PI as a member, you can add any of their sponsored users or co-PIs at the same time. Go to Add Members and click on the In bulk link: this will take you to a new page where you can add all or several of the roles associated with that PI at once. If you do not see the name of the user that you are looking for in that list, then click on Cancel to go back to the RAP membership page and return to step 3.

RAP membership is represented as a group in LDAP. It defines a group of users that are authorized to submit jobs against the RAPI (which is the ID of the RAP) and share files within the same Unix group.

Using a compute allocation[edit]

When submitting jobs to the scheduler, users will need to specify a group name as the value of the --account option. Jobs pertaining to the research described in the RAC application should be submitted with the group name corresponding to the RAC award, e.g., --account=rrg-profname-ab. Jobs pertaining to other research should be submitted with the default group name, e.g., --account=def-profname.

See Running jobs: Accounts and projects for more details.

Using allocated storage[edit]

If you have substantial amounts of data to transfer to an Alliance cluster in order to use your storage allocation, we strongly recommend the use of Globus.

/project[edit]

A /project storage allocation on a general-purpose cluster is created as a directory of the form /project/<group-name>, e.g., /project/rrg-profname-ab, and an associated quota defining the amount of data that can be stored in the directory. Files pertaining to the research described in the RAC application should be stored there by all sponsored users. More guidance on the use of /project space can be found at Project layout and Sharing data.

Note that you will also have default project space of the form /project/def-profname. You may wish to move data from that default project space to the RRG or RPP /project directory, if the data pertains to the research described in the RAC application.

/nearline[edit]

Please see Using nearline storage.

Who can use the allocation?[edit]

By default, every role that you have sponsored through your Alliance CCDB registration has access to your RAC award. Any co-PIs that were listed on your RAC application will also have access.

If desired, you can select which users may use your allocation. To do so:

1) Log in at https://ccdb.alliancecan.ca/

2) From the My Account menu, select Manage RAP Memberships. This will take you to https://ccdb.alliancecan.ca/resource_allocation_projects/members. In the Resource Allocation Project (RAP) drop-down list on this page, select the RAP to which you want to add members.

3) To add a new member, go to Add Members and enter the CCRI of the user you want to add. Once added, you will see the new member highlighted in yellow.

4) If you add a new PI as a member, you can add any of their sponsored users or co-PIs at the same time. Go to Add Members and click on the In bulk link: this will take you to a new page where you can add all or several of the roles associated with that PI at once. If you do not see the name of the user that you are looking for in that list, then click on Cancel to go back to the RAP membership page and return to step 3.

RAP membership is represented as a group in LDAP. It defines a group of users that are authorized to submit jobs against the RAPI (which is the ID of the RAP) and share files within the same Unix group.

Using a compute allocation[edit]

When a user submits a job to the scheduler, the job will be assigned to the current allocation of the user's PI. If the user has more than one PI, i.e. more than one group, they must specify a group name as the value of the --account option.

See Running jobs: Accounts and projects for more details.

Using allocated storage[edit]

If you have substantial amounts of data to transfer to the cluster in order to use your storage allocation, we strongly recommend the use of Globus.

/project[edit]

The location of a /project storage allocation on Niagara should be found by using the environment variable $PROJECT. This variable will point to a user-specific directory in the research group's project space.

/nearline[edit]

A /nearline allocation on Niagara means space in HPSS. Please see Using nearline storage.

Cloud resources allocated via the Rapid Access Service (RAS) use the default RAP.

Cloud resources allocated via the Resource Allocation Competition are awarded through a RAC RAP which follows a different naming convention than default projects. The group name of RAC RAPs with cloud allocations typically takes the form of crg-profname (for cloud resources allocated to a research group) or cpp-profname (for cloud resources allocated to a research platform or portal).

Who can use the allocation?[edit]

If you have an active cloud resource allocation, you should already have a RAP and therefore access to the particular cloud on which you have an allocation.

  • Default RAP: Cloud resources granted to you via RAS are allocated through your default RAP. All your activated sponsored user roles are always members of your default RAP. That is, confirming sponsorship of a user confers on them membership in your default RAP. However, you can at any time deactivate any role you sponsor.
  • RAC RAP: By default, only the PI is added as a member of a RAP associated with cloud resources allocated via the Resource Allocation Competition. If desired, you can add sponsored users and/or other active Alliance users as members to the RAP. Only members added to your RAP can use your cloud allocation.

If desired, you can select which users may use your allocation. To do so:

1) Log in at https://ccdb.alliancecan.ca/

2) From the My Account menu, select Manage RAP Memberships. This will take you to https://ccdb.alliancecan.ca/resource_allocation_projects/members. In the Resource Allocation Project (RAP) drop-down list on this page, select the RAP to which you want to add members.

3) Go to Add Members, and click on the In bulk link: this will take you to a new page that will allow you to easily add co-PIs and any of their associated sponsored user roles.

4) If the In bulk page in step 3 above does not show the name of the user that you want to add, then click on Cancel to go back to the RAP membership page. Once there, go to the Add Members section, and enter the CCRI of the member in the One by one using a CCRI field.

5) Following step 4 will allow you to add an associated PI that was not included as co-PI in your RAC application. Once a new PI is added as a member to your RAP using this process, you will be able to add any of their associated sponsored user roles through the In bulk mechanism explained in step 3.

Important:

  • Any new member added to a RAP for your cloud project will automatically has access to your cloud allocation. If desired, at any time you can promote members to Managers, or remove members.
  • Membership in your Cloud RAP allows full access to your OpenStack tenants. For more details, see or wiki page on OpenStack projects.

For information about logging in and using a particular cloud see using the cloud. If you are unsure about your cloud allocation or if you have difficulty logging into a cloud where you have an allocation, please contact technical support.