Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regapp docs revision #164

Merged
merged 7 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 47 additions & 16 deletions docs/get-started/allocation/requesting-an-allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,39 @@ by clicking the "Request Resource Allocation" button as shown below:

![Requesting an Allocation](images/new_resource_allocation.png)

On the shown page, you will be able to choose either *OpenStack Resource Allocation*
or *OpenShift Resource Allocation* by specifying either **NERC (OpenStack)** or
**NERC-OCP (OpenShift)** in the **Resource** dropdown option. **Note:** The
first option i.e. **NERC (OpenStack)**, is selected by default.

## Request A New OpenStack Resource Allocation for an OpenStack Project

![Request A New OpenStack Resource Allocation](images/coldfront-request-new-openstack-allocation.png)

If users have already been added to the project as
[described here](manage-users-to-a-project.md), the **Users** selection section
will be displayed as shown below:

![Request A New OpenStack Resource Allocation Selecting Users](images/coldfront-request-new-openstack-allocation-with-users.png)

In this section, the project PI/manager(s) can choose user(s) from the project
to be included in this allocation before clicking the "Submit" button.

!!! tip "Read the End User License Agreement Before Submission"
You should read the shown End User License Agreement (the "Agreement").
By clicking the "Submit" button, you agree to the Terms and Conditions.

!!! warning "Important: Requested/Approved Allocated OpenStack Storage Quota & Cost"
Ensure to choose **NERC (OpenStack)** in the Resource option and specify your
Ensure you choose **NERC (OpenStack)** in the Resource option and specify your
anticipated computing units. Each allocation, whether requested or approved,
will be billed for the associated costs based on the **pay-as-you-go** model.
The exception is the **Storage quotas**, specifically the "OpenStack Volume
GB Quota" where the cost is determined by the requested and approved allocation
values to reserve storage from the total NESE storage pool. If you have common
questions or need more information, refer to our
will be billed based on the **pay-as-you-go** model. The exception is for
**Storage quotas**, specifically the "OpenStack Volume GB Quota", where the
cost is determined by [your requested and approved allocation values](allocation-details.md#pi-and-manager-allocation-view-of-openstack-resource-allocation)
to reserve storage from the total NESE storage pool. If you have common questions
or need more information, refer to our
[Billing FAQs](../../get-started/cost-billing/billing-faqs.md) for comprehensive
answers. Keep in mind that you can easily scale and expand your current resource
allocations within your project by following this [this documentation](allocation-change-request.md#request-change-resource-allocation-attributes-for-openstack-project)
allocations within your project by following [this documentation](allocation-change-request.md#request-change-resource-allocation-attributes-for-openstack-project)
later on.

### Resource Allocation Quotas for OpenStack Project
Expand Down Expand Up @@ -50,6 +68,19 @@ integer value that corresponds to multiple OpenStack resource quotas. For exampl

![Request A New OpenShift Resource Allocation](images/coldfront-request-new-openshift-allocation.png)

If users have already been added to the project as
[described here](manage-users-to-a-project.md), the **Users** selection section
will be displayed as shown below:

![Request A New OpenShift Resource Allocation Selecting Users](images/coldfront-request-new-openshift-allocation-with-users.png)

In this section, the project PI/manager(s) can choose user(s) from the project
to be included in this allocation before clicking the "Submit" button.

!!! tip "Read the End User License Agreement Before Submission"
You should read the shown End User License Agreement (the "Agreement").
By clicking the "Submit" button, you agree to the Terms and Conditions.

### Resource Allocation Quotas for OpenShift Project

The amount of quota to start out a resource allocation after approval, can be
Expand All @@ -69,17 +100,17 @@ integer value that corresponds to multiple OpenShift resource quotas. For exampl
| `Ephemeral Storage(GB)` | 5 |

!!! warning "Important: Requested/Approved Allocated OpenShift Storage Quota & Cost"
Ensure to choose **NERC-OCP (OpenShift)** in the Resource option (**Always Remember:**
the first option i.e. **NERC (OpenStack)** is selected by default!) and specify
Ensure you choose **NERC-OCP (OpenShift)** in the Resource option (**Always Remember:**
the first option, i.e. **NERC (OpenStack)** is selected by default!) and specify
your anticipated computing units. Each allocation, whether requested or approved,
will be billed for the associated costs based on the **pay-as-you-go** model.
The exception is the **Storage quotas**, specifically the "OpenShift Request
on Storage Quota (GB)" where the cost is determined by the requested and
approved allocation values to reserve storage from the total NESE storage pool.
If you have common questions or need more information, refer to our
will be billed based on the **pay-as-you-go** model. The exception is for
**Storage quotas**, specifically the "OpenShift Request on Storage Quota (GB)",
where the cost is determined by [your requested and approved allocation values](allocation-details.md#pi-and-manager-allocation-view-of-openshift-resource-allocation)
to reserve storage from the total NESE storage pool. If you have common
questions or need more information, refer to our
[Billing FAQs](../../get-started/cost-billing/billing-faqs.md) for comprehensive
answers. Keep in mind that you can easily scale and expand your current
resource allocations within your project by following this [this documentation](allocation-change-request.md#request-change-resource-allocation-attributes-for-openshift-project)
answers. Keep in mind that you can easily scale and expand your current resource
allocations within your project by following [this documentation](allocation-change-request.md#request-change-resource-allocation-attributes-for-openshift-project)
later on.

---
4 changes: 2 additions & 2 deletions docs/get-started/cost-billing/billing-process-for-harvard.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ with your HarvardKey. The PI's submission of the corresponding HUIT
"**Customer Code**" is now seamlessly integrated into the PI user account role
submission process. This means that PIs can provide the corresponding HUIT
"**Customer Code**" either while submitting [NERC's PI Request Form](https://nerc.mghpcc.org/pi-account-request/)
or by creating a new ticket in [NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php)
under the "NERC PI Account Request" option in the Help Topic dropdown list.
or by submitting a new ticket at [NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php)
under the "NERC PI Account Request" option in the **Help Topic** dropdown menu.

!!! abstract "What if you already have an existing Customer Code?"
*Please note that if you already have an existing active NERC account, you
Expand Down
132 changes: 75 additions & 57 deletions docs/get-started/create-a-user-portal-account.md
Original file line number Diff line number Diff line change
@@ -1,119 +1,137 @@
# User Account Types

NERC offers two types of user accounts: a **Principal Investigator (PI) Account**
and a **General User Account**. All General Users must be assigned by a PI to their
approved project by an active NERC PI account or by delegated manager(s).
and a **General User Account**. All General Users must be assigned to their project
by an active NERC PI or by one of the delegated project manager(s), as
[described here](allocation/manage-users-to-a-project.md). Then, those project
users can be added to the resource allocation during a new allocation request or
at a later time.

!!! question "Principal Investigator Eligibility Information"
- MGHPCC consortium members, whereby they enter into an service agreement with
MGHPCC for the NERC services.

- Non-members of MGHPCC can also be PIs of NERC Services, but must also have an active non-member agreement with MGHPCC.
- Non-members of MGHPCC can also be PIs of NERC Services, but must also have
an active non-member agreement with MGHPCC.

- External research focused institutions will be considered on a case-by-case basis and are subject to an external customer cost structure.
- External research focused institutions will be considered on a case-by-case
basis and are subject to an external customer cost structure.

PI accounts are able to request Resource Allocations. A PI account enables a user
to log into NERC's computational project space; apply for allocations of NERC resources
and grant access to other users; and delegate responsibilities to other collaborators
from the same institutions or elsewhere as managers using
[NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/).
A PI account can request allocations of NERC resources, grant access to other
general users enabling them to log into NERC's computational project space, and
delegate its responsibilities to other collaborators from the same institutions
or elsewhere as managers using [NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/),
as [described here](allocation/manage-users-to-a-project.md#user-roles).

## Getting Started

Any faculty, staff, student, and external collaborator must request a user account
through the [MGHPCC Shared Services (MGHPCC-SS) Account Portal](https://regapp.mss.mghpcc.org/)
through the [MGHPCC Shared Services (MGHPCC-SS) Account Portal](https://regapp.mss.mghpcc.org/),
also known as **"RegApp"**. This is a web-based, single point-of-entry to the NERC
system that displays a user welcome page. The welcome page of the account registration
site displays instructions on how to register a General User account on NERC, which
are shown in the image below:
system that displays a user welcome page. The welcome page of the account
registration site displays instructions on how to register a General User
account on NERC, as shown in the image below:

![MGHPCC Shared Services (MGHPCC-SS) Account Portal Welcome Page](images/regapp-welcome-page.png)

There are two options: either register for a new account or to manage an existing
There are two options: either register for a new account or manage an existing
one. If you are new to NERC and want to register as a new MGHPCC-SS user, click
on the "Register for an Account" button. This will redirect you to a new web page
which shows details about how to register for a new MGHPCC-SS user account. NERC
uses **CILogon** that supports login either using your Institutional Identity
Provider (IdP).

Clicking the "Begin MGHPCC-SS Account Creation Process" button will initiate the
account creation process. You will be redirected to a site managed by CILogon where
you will select your institutional or commercial identity provider as shown below:
account creation process. You will be redirected to a site managed by CILogon
where you will select your institutional or commercial identity provider, as
shown below:

![CILogon Page](images/CILogon.png)

Once selected, you will be redirected to your institutional or commercial identity
provider where you will login as shown here:
provider, where you will log in, as shown here:

![Institutional IdP Login Page](images/institutional_idp.png)

At the completion of that logon, your browser will be redirected to the MGHPCC-SS
Account Management site where you will complete your MGHPCC-SS account creation process.

After successful logon, your browser will redirect back to the MGHPCC-SS Registration
Page and ask for review and confirmation of creating your account with fetched information
to complete the account creation process.
After a successful log on, your browser will be redirected back to the MGHPCC-SS
Registration Page and ask for a review and confirmation of creating your account
with fetched information to complete the account creation process.

![User Account Review Before Creation Page](images/user-account-review-page.png)

!!! warning "Very Important"
If you don't click the "Create MGHPCC-SS Account" button, your account will not
be created! So this is a very important step, to review and also click on the
"Create MGHPCC-SS Account" button to save your information.
If you don't click the "Create MGHPCC-SS Account" button, your account will
not be created! So, this is a very important step. Review your information
carefully and then click on the "Create MGHPCC-SS Account" button to save
your information.

You can make any corrections that you need and fill in any blank fields i.e. "Research
Domain" and then click the "Create MGHPCC-SS Account" button. This will automatically
send an email to your email address with a link to validate and confirm your account
information.
You can make any corrections that you need and fill in any blank fields, such as
"Research Domain", and then click the "Create MGHPCC-SS Account" button. This
will automatically send an email to your email address with a link to validate
and confirm your account information.

![User Account Email Verification Page](images/account-email-verification-page.png)

Once you get an email and click on the provided validation web link, you will make
sure that your user account is created and valid by viewing the following page:
Once you receive an "MGHPCC-SS Account Creation Validation" email, review your
user account information to ensure it is correct. Then, click on the provided
validation web link and enter the unique account creation **Confirmation Code**
provided in the email as shown below:

![MGHPCC-SS Account Creation Validation](images/account_creation_confirmation.png)

Once validated, you need to ensure that your user account is created and valid
by viewing the following page:

![Successful Account Validation Page](images/successful-account-validation.png)

!!! question "Help"
If you have an institutional identity, it's preferable that you use that identity
!!! question "Important Note"
If you have an institutional identity, it's preferable to use that identity
to create your MGHPCC-SS account. Institutional identities are vetted by identity
management teams and provide a higher level of confidence to resource owners
when granting access to resources. You can only link one university account to
a MGHPCC-SS account; if you have multiple university accounts you will only be
able to link one of those accounts to your MGHPCC-SS account. If at a later date,
you want to change which account is connected to your MGHPCC-SS identity you
can by contacting [help@nerc.mghpcc.org](mailto:help@nerc.mghpcc.org?subject=NERC%20User%20Account%Help).
when granting access to resources. You can only link one university account
to an MGHPCC-SS account; if you have multiple university accounts, you will
only be able to link one of those accounts to your MGHPCC-SS account. If, at
a later date, you want to change which account is connected to your MGHPCC-SS
identity, you can do so by contacting [help@mghpcc.org](mailto:help@mghpcc.org?subject=MGHPCC-SS%20User%20Account%Help).

## How to update and modify your MGHPCC-SS account information?

1. Login your MGHPCC-SS account
1. Log in to the [RegApp](https://regapp.mss.mghpcc.org/) using your MGHPCC-SS account.

2. Click on "Manage Your MGHPCC-SS Account" button as shown below:

![MGHPCC-SS Account Update](images/account_update.png)

2. Click on "Manage Your MGHPCC-SS Account" button
3. Review your currently saved account information, make any necessary corrections
or updates to fields, and then click on the "Update MGHPCC-SS Account" button.

3. Review your currently saved account information, change any fields that require
correction or updates and then click on the "Update MGHPCC-SS Account" button.
4. This will send an email to verify your updated account information, so please
check your email address.

4. This will send an email to verify your updated account information so check your
email address.
5. Confirm and validate the new account details by clicking the provided validation
web link and entering the unique **Confirmation Code** provided in the email as
shown below:

5. Confirm and validate the new account details by verifying them by clicking the
provided link on your email.
![MGHPCC-SS Account Update Validation](images/account_update_confirmation.png)

## How to request a Principal Investigator (PI) Account?

The process for requesting and obtaining **PI Account** is relatively simple by
filling out [this NERC Principal Investigator (PI) Account Request form](https://nerc.mghpcc.org/pi-account-request/)
The process for requesting and obtaining a **PI Account** is relatively simple.
You can fill out [this NERC Principal Investigator (PI) Account Request form](https://nerc.mghpcc.org/pi-account-request/)
to initiate the process.

**Alternatively,** PI can request for a Principal Investigator (PI) user account
by submitting a new ticket at
[the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php)
under "NERC PI Account Request" option on **Help Topic** as shown in the image below:
**Alternatively,** users can request a Principal Investigator (PI) user account
by submitting a new ticket at [the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php)
under the "NERC PI Account Request" option in the **Help Topic** dropdown menu,
as shown in the image below:

![the NERC's Support Ticketing System PI Ticket](images/osticket-pi-request.png)

!!! info "Information"
So, once your PI user request is reviewed and approved by NERC's administration
staff - you will recieve an email confirmation form NERC's support system i.e.
help@nerc.mghpcc.org. You are going to get into NERC's ColdFront resource
allocation management portal using the PI user role.
Once your PI user request is reviewed and approved by NERC's admin, you will
receive an email confirmation from NERC's support system, i.e.,
**help@nerc.mghpcc.org**. Then, you can access [NERC's ColdFront resource
allocation management portal](https://coldfront.mss.mghpcc.org/) using the
PI user role, as [described here](allocation/coldfront.md).

---
Binary file modified docs/get-started/images/account-email-verification-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-started/images/account_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/get-started/images/successful-account-validation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/get-started/images/user-account-review-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 4 additions & 5 deletions docs/get-started/user-onboarding-on-NERC.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ The overall user flow can be summarized using the following sequence diagram:
2. **PI** will send a request for a Principal Investigator (PI) user account role
by submitting: [NERC's PI Request Form](https://nerc.mghpcc.org/pi-account-request/).

**Alternatively,** PI can request for a Principal Investigator (PI) user account
role by submitting a new ticket at
[the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php)
under "NERC PI Account Request" option on **Help Topic** as shown in the image
below:
**Alternatively,** users can request a Principal Investigator (PI) user account
by submitting a new ticket at [the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php)
under the "NERC PI Account Request" option in the **Help Topic** dropdown menu,
as shown in the image below:

![the NERC's Support Ticketing System PI Ticket](images/osticket-pi-request.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/migration-moc-to-nerc/Step3.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ the next steps.

1. If for some reason the earlier approved resource quota is not
sufficient you can request further quota by following
[these steps](https://nerc-project.github.io/nerc-docs/get-started/get-an-allocation/#request-change-to-resource-allocation-to-an-existing-project).
[these steps](https://nerc-project.github.io/nerc-docs/get-started/allocation/allocation-change-request/).

1. Repeat [this section](#create-nerc-instances-using-moc-volumes)
for each instance you need to create.
Expand Down
Loading
Loading