Skip to content

Commit

Permalink
clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
Milstein committed Feb 4, 2024
1 parent 09d6a6c commit b307cb8
Show file tree
Hide file tree
Showing 34 changed files with 896 additions and 561 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ for best practices:
If your institution already have outlined Best Practices guidelines with your
internal IT department, please contact us to list it here soon by emailing us at
[[email protected]](mailto:[email protected]?subject=NERC%20Best%20Practices%20Question)
or, by submitting a new ticket at [the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php).
or, by submitting a new ticket at [the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php).

---
2 changes: 1 addition & 1 deletion docs/get-started/best-practices/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ store internal data in which information is chosen to keep confidential but the
disclosure of which would not cause material harm to you, your users and your
institution. Your institution may have already classified and categorized data
and implemented security policies and guidance for each category. If your project
includes sensitive data and information then you might need to contact NERCs
includes sensitive data and information then you might need to contact NERC's
admin as soon as possible to discuss other potential options.

- [Backups and/or snapshots](../../openstack/backup/backup-with-snapshots.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/get-started/cost-billing/billing-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ with us to be better aligned to a number of research regulations, policies and
requirements but if your institution does not have an MOU with us, please have
someone from your faculty or administration contact us to discuss it soon by emailing
us at [[email protected]](mailto:[email protected]?subject=NERC%20MOU%20Question)
or, by submitting a new ticket at [the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php).
or, by submitting a new ticket at [the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php).

## Questions & Answers

Expand All @@ -25,8 +25,8 @@ or, by submitting a new ticket at [the NERC's Support Ticketing System (osTicket
??? question "2. If I have an issue with my bill, who do I contact?"

Please send your requests by emailing us at
[[email protected]](mailto:[email protected]?subject=NERC%20MOU%20Question)
or, by submitting a new ticket at [the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php).
[[email protected]](mailto:[email protected]?subject=NERC%20Billing%20Question)
or, by submitting a new ticket at [the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php).

??? question "3. How do I control costs?"

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/cost-billing/billing-process-for-bu.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ directly to investigators and updated on this page.

Please direct any questions about BU’s billing process by emailing us at
[[email protected]](mailto:[email protected]?subject=NERC%20Boston%20University%20Billing%20Question)
or submitting a new ticket to the [the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php).
or submitting a new ticket to the [the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php).

---
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ with your HarvardKey. This is already now part of PI user account role submissio
process that means PI can provide corresponding HUIT “**Customer Code**” while
submitting [NERC's PI Request Form](https://nerc.mghpcc.org/pi-account-request/)
or by submitting a new ticket at
[the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php)
[the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php)
under "**NERC PI Account Request**" option on **Help Topic** dropdown list.

!!! abstract "What if you already have an existing Customer Code?"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ for comprehensive answers.
If your institution does not have an MOU with us, please have someone from your
faculty or administration contact us to discuss it soon by emailing us at
[[email protected]](mailto:[email protected]?subject=NERC%20MOU%20Question)
or, by submitting a new ticket at [the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php).
or, by submitting a new ticket at [the NERC's Support Ticketing System](https://mghpcc.supportsystem.com/open.php).

---
4 changes: 2 additions & 2 deletions docs/get-started/create-a-user-portal-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ PI accounts are able to request Resource Allocations. A PI account enables a use
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
[NERCs ColdFront interface](https://coldfront.mss.mghpcc.org/).
[NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/).

## Getting Started

Expand Down Expand Up @@ -104,7 +104,7 @@ filling out [this NERC Principal Investigator (PI) Account Request form](https:/

**Alternatively,** PI can request for a Principal Investigator (PI) user account
by submitting a new ticket at
[the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php)
[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:

![the NERC's Support Ticketing System PI Ticket](images/osticket-pi-request.png)
Expand Down
44 changes: 30 additions & 14 deletions docs/get-started/get-an-allocation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# What is NERC's ColdFront?

NERC uses [NERCs ColdFront interface](https://coldfront.mss.mghpcc.org/), an
NERC uses [NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/), an
open source resource allocation management system called
[ColdFront](https://github.com/ubccr/coldfront) to provide a single point-of-entry
for administration, reporting, and measuring scientific impact of NERC resources
Expand All @@ -12,14 +12,14 @@ General Users who are not PIs or Managers on a project see a read-only view of t
NERC's ColdFront.

Whereas, once a PI Account request is granted, the PI will receive an email confirming
the request approval and how to connect NERCs ColdFront.
the request approval and how to connect NERC's ColdFront.

PI or project managers can use NERC's ColdFront as a self-service web-portal to do
the following tasks:

- Add or manage or archive projects

- Request allocations that fall under projects to NERCs resources such as clusters,
- Request allocations that fall under projects to NERC's resources such as clusters,
cloud resources, servers, storage, and software licenses

- Add/remove user access to/from allocated resources who is a member of the project
Expand All @@ -39,7 +39,7 @@ periodic review by center director to demonstrate need for the resources

## How to login to NERC's ColdFront?

[NERCs ColdFront interface](https://coldfront.mss.mghpcc.org/) provides user with
[NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/) provides user with
login page as shown here:

![ColdFront Login Page](images/coldfront-login-page.png)
Expand All @@ -62,7 +62,7 @@ below:

## What PIs need to fill in order to request a Project?

Once logged in to NERCs ColdFront, PIs can choose Projects sub-menu located under
Once logged in to NERC's ColdFront, PIs can choose Projects sub-menu located under
the Project menu.

![Projects sub-menu](images/coldfront-projects-sub-menu.png)
Expand Down Expand Up @@ -146,10 +146,18 @@ detail page and they see the status change to "project review pending".

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

!!! warning "Very Important"
Make sure to select **NERC (OpenStack)** on Resource option and specify
your expected Units of computing. Be mindful, you can extend your current resource
allocations on your current project later on by following [this documentation](#request-change-resource-allocation-attributes-for-openstack-project).
!!! warning "Very Important: Requested/Approved Allocated Storage Quota and Cost"
Ensure to 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 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](#request-change-resource-allocation-attributes-for-openstack-project)
later on.

#### Resource Allocation Quotas for OpenStack Project

Expand Down Expand Up @@ -197,11 +205,19 @@ integer value that corresponds to multiple OpenShift resource quotas. For exampl
| `Storage(GB)` | 20 |
| `Ephemeral Storage(GB)` | 5 |

!!! warning "Very Important"
Make sure to select **NERC-OCP (OpenShift)** on Resource option (Remember: the
first option i.e. **NERC (OpenStack)** is selected by default!) and specify
your expected Units of computing. Be mindful, you can extend your current resource
allocations on your current project later on by following [this documentation](#request-change-resource-allocation-attributes-for-openshift-project).
!!! warning "Very Important: Requested/Approved Allocated Storage Quota and Cost"
Ensure to choose **NERC-OCP (OpenShift)** in the Resource option (**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 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](#request-change-resource-allocation-attributes-for-openshift-project)
later on.

## Adding and removing User from the Project

Expand Down
12 changes: 6 additions & 6 deletions docs/get-started/user-onboarding-on-NERC.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# User Onboarding Process Overview

NERCs Research allocations are available to faculty members and researchers, including
NERC's Research allocations are available to faculty members and researchers, including
postdoctoral researchers and students, at a U.S. based institution in New England.
In order to get access to resources provided by NERCs computational infrastructure,
In order to get access to resources provided by NERC's computational infrastructure,
you must first register and obtain a user account.

The overall user flow can be summarized using the following sequence diagram:
Expand All @@ -16,7 +16,7 @@ by submitting: [NERC's PI Request Form](https://nerc.mghpcc.org/pi-account-reque

**Alternatively,** PI can request for a Principal Investigator (PI) user account
role by submitting a new ticket at
[the NERC's Support Ticketing System (osTicket)](https://mghpcc.supportsystem.com/open.php)
[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:

Expand All @@ -30,7 +30,7 @@ by submitting: [NERC's PI Request Form](https://nerc.mghpcc.org/pi-account-reque

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

3. Wait until the PI request gets approved by the **NERCs admin**.
3. Wait until the PI request gets approved by the **NERC's admin**.

4. Once a PI request is **approved**, **PI** can add a new project and also search
and add user(s) to the project - Other **general user(s)** can also see the project(s)
Expand All @@ -40,12 +40,12 @@ once they are added to a project via: [https://coldfront.mss.mghpcc.org](https:/
or **NERC-OCP (OpenShift)** for the newly added project and select which user(s)
can use the requested allocation.

6. Wait until the requested resource allocation gets approved by the **NERCs admin**.
6. Wait until the requested resource allocation gets approved by the **NERC's admin**.

7. Once **approved**, **PI and the corresponding project users** can go to either
NERC Openstack horizon web interface: [https://stack.nerc.mghpcc.org](https://stack.nerc.mghpcc.org)
or NERC OpenShift web console: [https://console.apps.shift.nerc.mghpcc.org](https://console.apps.shift.nerc.mghpcc.org)
based on approved **Resource Type** and they can start using the NERCs resources
based on approved **Resource Type** and they can start using the NERC's resources
based on the approved project **quotas**.

---
2 changes: 2 additions & 0 deletions docs/openshift/applications/creating-a-sample-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ using the **oc new-app** command from the command line terminal.

i. Make sure you have the `oc` CLI tool installed and configured on your local
machine following [these steps](../logging-in/install-the-openshift-cli/#first-time-usage).

!!! info "Information"
Some users may have access to multiple projects. Run the following command to
switch to a specific project space: `oc project <your-project-namespace>`.
Expand All @@ -74,6 +75,7 @@ as part of the new-app argument, with `oc new-app <image url>~<git url>`. If it
using a test application based on Node.js, we could use the same command as before
but add `nodejs~` before the URL of the Git repository.
For example: `oc new-app nodejs~https://github.com/myuser/mypublicrepo`.

!!! note "Important Note"
If you are using a private remote Git repository, you can use the
`--source-secret` flag to specify an existing source clone secret that
Expand Down
8 changes: 4 additions & 4 deletions docs/openstack/access-and-security/security-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ hosts a web server, you need a security group which allows access to ports 80

![Security Groups](images/security_groups.png)

!!! warn "Important Note"
!!! warning "Important Note"
We strongly advise against altering the **default** security group and suggest
refraining from adding extra security rules to it. This is because the
**default** security group is automatically assigned to any newly created VMs.
Expand All @@ -34,7 +34,7 @@ hosts a web server, you need a security group which allows access to ports 80
very highly configurable, for insance, you might create a basic/ generic group
for ssh (port 22) and icmp (which is what we will show as an example here)
and then a separate security group for http (port 80) and https (port 443)
access if youre running a web service on your instance.
access if you're running a web service on your instance.

You can also limit access based on where the traffic originates, using either
IP addresses or security groups to define the allowed sources.
Expand Down Expand Up @@ -128,7 +128,7 @@ Instances will now accept all incoming ICMP packets.

Save the changes to apply the new security rules to the selected security group.

!!! warn "Important Note"
!!! warning "Important Note"
Security group changes may take some time to propagate to the instances
associated with the modified group. Ensure that new rules align with your
network security requirements.
Expand All @@ -146,7 +146,7 @@ Compute -> Instances tab and then select "Edit Security Groups" as shown below:
![Edit Security Groups](images/adding_new_security_groups.png)

Then select all Security Group(s) that you want to attach to this VM by clicking
on [+] sign and then click "Save" as shown here:
on "+" icon and then click "Save" as shown here:

![Select Security Groups](images/edit_security_group.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ The Sysprep will generate **QCOW2** image i.e. `win2k22.qcow2` on `/home/<YourUs
### 12. Create OpenStack image and push to NERC's image list

You can copy/download this windows image to the folder where you configured your
OpenStack CLI as described [Here](../openstack-cli/openstack-CLI.md) and upload
OpenStack CLI as described [Here](../../openstack-cli/openstack-CLI.md) and upload
to the NERC's OpenStack running the following OpenStack Image API command:

openstack image create --disk-format qcow2 --file win2k22.qcow2 MS-Windows-2022
Expand Down
Loading

0 comments on commit b307cb8

Please sign in to comment.