View source for Frequently Asked Questions about the CCDB

<languages/>

<translate>

= CCDB basics = <!--T:1-->

== What is the purpose of the CCDB? == <!--T:4-->

<!--T:5-->
The CCDB is the main accounting system of the Federation. The [https://ccdb.alliancecan.ca CCDB web site] provides one access point for all the Federation facilities.

== What can I do on the portal? == <!--T:6-->

<!--T:7-->
* register
* manage personal information and roles
* link to consortium sites to apply for accounts
* apply for the Resource Allocations Competitions (RAC)
* manage RAP information and membership

== What is a CCI and why would I want one? == <!--T:8-->

<!--T:9-->
A CCI is a unique personal and national identifier. When you register at https://ccdb.alliancecan.ca a CCI is created for you.

== Who is eligible to get a CCI? == <!--T:10-->

<!--T:11-->
In order to register with the CCDB you must
* be a faculty member at a Canadian institution that is registered with the CCDB, or
* be sponsored by a faculty member at a Canadian institution that is registered with the CCDB. 
People who can be sponsored include, but is not limited to, graduate students and research staff that report to the sponsoring faculty member.

== What is a role? == <!--T:12-->

<!--T:13-->
A role is an identifier that represents the combination of a person's position (e.g., faculty, graduate student, postdoctoral fellow, etc.), institution, and sponsor. In order to access our computational resources you must have a valid and up-to-date role. Most people will only have one role at a time, but when you change institution, sponsor, or position you will need to apply for a new role rather than update the old one. We ask you to do this so we can maintain accurate records for usage reporting to our governmental funding agencies.

== What is a CCRI? == <!--T:14-->

<!--T:15-->
A CCRI is the unique identifier for your role (see "What is a Role?"). Since one person may have multiple roles over time, one CCI may be associated with more than one CCRI. Every job that runs on a national cluster is attributed to a CCRI.

= Resource Allocation Projects (RAP) = <!--T:16-->
== What is a RAP? ==

<!--T:17-->
Access to our national computational resources are made available to PIs through Resource Allocation Projects (RAP). Each RAP is identified by a RAPI and an associated group name.

<!--T:44-->
Researchers are usually working on at least one research project. For reporting purposes, we need to be able to provide statistics on how our facilities are used, but the word “project” is too ambiguous, therefore we use a name which does not have any implicit meanings. Also, computing resources are not allocated to individuals, they are allocated to groups of researchers. The RAP is the group of researchers which resources are allocated to.

<!--T:36-->
In general, there are two main types to RAPs:
*Default RAP: A default RAP is automatically created when a PI role is activated. Default 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 user of compute resources with the default (that is, the lowest) priority. On CCDB, it uses the convention <tt>def-profname</tt>.
*RAC RAP: This RAP is created when the PI receives an award through the RAC application process. The RAC RAPI typically takes the form <tt>abc-123-ab</tt>, with an associated group name typically of the form of <tt>rrg-profname-xx</tt> or <tt>rpp-profname-xx</tt> for HPC allocations, and <tt>crg-profname-xx</tt> or <tt>cpp-profname-xx</tt> for Cloud allocations, depending on the competition.

== What is a group name? == <!--T:45-->
Group name is an alias of the Research Allocation Project Identifier (RAPI). Each RAPI has a unique group name (one-to-one mapping), but it is often easier for users to remember the group name. 

<!--T:46-->
Typically, group names follows this convention (where “xx” represents some sequence of digits and letters):
*Default RAP: <tt>def-[profname][-xx]</tt>
* RRG/HPC resource RAP: <tt>rrg-[profname][-xx]</tt>
* RPP/HPC resource RAP: <tt>rpp-[profname][-xx]</tt>
* RRG/Cloud resource RAP: <tt>crg-[profname][-xx]</tt>
* RPP/Cloud resource RAP: <tt>cpp-[profname][-xx]</tt>

<!--T:47-->
The group name is used as a POSIX group name with an associated POSIX group ID and is propagated through LDAP in the dn attribute: <code>dn: cn=rpp-profname,ou=Group,dc=computecanada,dc=ca</code>

== Who has access to a RAP? == <!--T:48-->
<b>Default RAP: </b> All of a PI's activated sponsored user roles are always members of the PI's default RAP. That is, confirming sponsorship of a user confers on them membership in a PI's default RAP. This cannot be modified. However, a PI can at any time deactivate any role they sponsor.

<!--T:49-->
<b>RAC RAP:</b> Membership works differently depending on whether the RAC RAP has HPC or Cloud resources allocated:
*HPC resources: At the time a new RAP is created with HPC resources (e.g. CPU, GPU, project storage, nearline storage, etc.), CCDB automatically adds as members of the RAP a) all of a PI's sponsored user roles, <i>and</i> b) all associated Co-PI roles, <i>and</i> c) all sponsored users roles of all of the associated Co-PIs. Any new role that the PI sponsors <i>after</i> a RAP has been created will also be automatically added as member of the RAP.
*Cloud resources: At the time a new RAP is created with Cloud resources allocated, only the PI is added as a member of that RAP.

== How to manage memberships for a RAC RAP == <!--T:50-->
The PI can modify the membership of any of their RAC RAPs at any time. Any user with an active Alliance account can be added as a member of a RAC RAP. The PI may, for example, want to allow access to user roles they are not sponsoring (i.e. a co-PI) or remove one or more of their sponsored user roles from their RAC RAP and limit them to only be able to access their default RAP. 

<!--T:51-->
There are three RAP membership permission levels:
*Owner: The PI is the sole owner of the RAP and all the allocations associated to that RAP. This cannot be changed. The Owner can add or remove RAP managers and members.
*Manager: An elevated permission (on CCDB only, not on the clusters) delegated by the Owner or another Manager that allows making membership changes. Managers can also use the PI's allocation in the corresponding cluster(s). Important: Members that have promoted to "Manager" on a RAC RAP cannot make changes (e.g., change ownership of the files, apply ACLs, manage permissions on Globus, etc.) on the project/nearline file systems on behalf of the PIs.
* Member: Members can use the PI’s allocation in the corresponding cluster(s). Members cannot make any modifications to the RAP memberships.

<!--T:52-->
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.

<!--T:53-->
For detailed instructions about how to add members to a RAC RAP, please visit the [[Using_a_resource_allocation#Information_on_each_resource|Using a resource allocation page]]

= Registering for an account = <!--T:18-->

== <span id="duplicate_accounts" /> I had an account in the past, but my position or sponsor has changed or I have lost my password. Should I sign up for a new one? == <!--T:19-->

<!--T:20-->
Each person can only have one Alliance account (that is, one CCI). Requests for duplicate CCI's are refused. If you have an existing CCI and have changed position, you should apply for a new role (which will have a new CCRI) instead. To do so, please log in with your existing account and visit the [https://ccdb.alliancecan.ca/me/add_role apply for a new role] form. If you have forgotten your password, you may [https://ccdb.alliancecan.ca/security/forgot reset it]. If you can no longer access the email address you have on file please email [mailto:accounts@tech.alliancecan.ca accounts@tech.alliancecan.ca] and we can update it for you.

== How do I sign up? == <!--T:21-->

<!--T:22-->
Go to the [https://ccdb.alliancecan.ca/account_application register] link. Note that you will have to accept the certain policies and agreements to get an account. You can read these policies on the Alliance website: https://alliancecan.ca/en/services/advanced-research-computing/account-management/policies 

<!--T:37-->
Once your account has been approved, you will be able to see at any time on CCDB the agreements that you have accepted by going to My Account / Agreements [https://ccdb.alliancecan.ca/agreements/user_index]

== What position do I select when applying for a role? == <!--T:23-->

<!--T:24-->
There are two main types of roles:
* ''sponsor'' roles, often referred to as Primary Investigators or PIs, and
* ''sponsored'' roles. 
Only faculty members can be sponsors. Administrators who are not faculty but who lead research projects must contact [mailto:accounts@tech.alliancecan.ca accounts@tech.alliancecan.ca] so that we can make appropriate accommodations. Faculty roles are only granted to faculty from Canadian post-secondary academic institutions who are eligible for CFI funding.

<!--T:25-->
Sponsored roles fall into two groups: internal and external. The difference is in whether the applicant is part of the supervisors local group, or a collaborator from a different institution. Available roles are:

<!--T:26-->
* students: undergraduate, masters, doctoral;
* researchers affiliated with the same institution as the PI: post-doctoral fellow, researcher (but only if the person is paid by the PI's institution);
* non-research staff (e.g. administrators, secretaries, etc.—people who do not typically need access to compute resources);
* collaborators affiliated with a different institution than the PI: external collaborator.

<!--T:28-->
An external collaborator is anyone working with the group whom the PI is willing to sponsor. Note however that external collaborators must specify an institution different from that of the PI.

<!--T:54-->
The full list of roles are available on the Alliance website: https://alliancecan.ca/en/services/advanced-research-computing/account-management/user-roles-access-resources-and-services-federation

== What happens after I submit my request? == <!--T:29-->

<!--T:30-->
You will receive an email with a link to confirm the email address you provided. If you are a principal investigator (typically, a faculty member), your application will be approved by consortium staff; otherwise, it will need to be confirmed by the principal investigator you identified as your sponsor before it is approved by consortium staff.

= Further help = <!--T:33-->

== How can I get help for something not covered in this FAQ? == <!--T:34-->

<!--T:35-->
For any questions not covered here, send email to [mailto:accounts@tech.alliancecan.ca accounts@tech.alliancecan.ca].

</translate>