Skip to content
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
4 changes: 2 additions & 2 deletions docs/get-started/allocation/adding-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Clicking on the "Add a project" button will show the interface below:
!!! danger "Very Important: Project Title Length Limitation"

Please ensure that the project title is both concise and does not exceed a
length of **63 characters**.
length of **45 characters**.

PIs need to specify an appropriate title (**less than 63 characters**), description
PIs need to specify an appropriate title (**less than 45 characters**), description
of their research work that will be performed on the NERC (in one or two paragraphs),
the field(s) of science or research domain(s), and then click the "Save" button.
Once saved successfully, PIs effectively become the "manager" of the project, and
Expand Down
97 changes: 97 additions & 0 deletions docs/get-started/cost-billing/how-pricing-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,103 @@ how the calculation works for OpenShift and OpenStack.
of SU) \* (time Pod was running), summed up to project level rounded up to the
whole hour.

## Where Can I View My Current Usage Invoice?

Using [NERC's ColdFront interface](https://coldfront.mss.mghpcc.org/), now makes
it easier to keep track of your daily usage charges for each allocation. A new
allocation attribute **`Cumulative Daily Charges for Month`** is available directly
within the *Allocation Detail* page, giving you a transparent, **day-by-day** view
of **your monthly costs**.

**Steps:**

1. Log in to the [NERC ColdFront interface](https://coldfront.mss.mghpcc.org/)
using the same institutional authentication method you used when registering with
NERC via [RegApp](https://regapp.mss.mghpcc.org/).

2. Navigate to Projects and open the project associated with your allocation.

3. Select the *specific Allocation* you want to review.

4. In the **Allocation Detail** page, look for the *Allocation Attribute* labeled:
`Cumulative Daily Charges for Month` as shown below:

![Cumulative Daily Charges for Month](images/cumulative-daily-charge-for-month.png)

### Understanding the "Cumulative Daily Charges for Month" Attribute Format

The `Cumulative Daily Charges for Month` allocation attribute stores daily running
totals in a simple, **date-indexed (UTC)** format, along with the **total cost in
USD**.

```sh
YYYY-MM-DD: TOTAL USD
```

Each entry reflects the **total accumulated billable charges for that month as of
the end of that specific day**. These values are refreshed nightly by a scheduled
**CronJob**, ensuring that the cumulative totals remain up to date.

For example:

```sh
2025-12-07: 123.00 USD
```

This indicates that **as of December 7, 2025**, the total billable usage for that
allocation for the month has reached **123.00 USD**.

!!! info "Cumulative Daily Charges for Month"

The value of this quota attribute is updated nightly to incorporate the latest
available invoice data, ensuring daily cumulative totals remain current.

### How to Use this Information

You can use the daily cumulative totals to:

- Monitor your **month-to-date spending** with near real-time visibility.

- Identify any **unusual spikes or sudden changes** in usage.

- Plan workloads and **manage your budget more effectively**.

- Communicate usage patterns and trends to your **team or project members**.

## Monthly Allocation Alert Emails

In addition, a new *Allocation Attribute* labeled **Monthly Allocation Cost Alert**
is now available to provide *automated cost alert notifications* for Project
**PIs and Manager(s)**, as shown below:

![Monthly Allocation Cost Alert](images/monthly-allocation-cost-alert.png)

This attribute helps users monitor potential budget overruns by allowing them to
set a **threshold amount in USD**. When the cumulative charges for the month
**exceed** this value, email alerts are automatically sent to the Project
**PIs and Manager(s)**.

!!! warning "Important Note"

By default, the **`Monthly Allocation Cost Alert`** allocation attribute is
set to `0` for all existing allocations. In this state, **no email notifications
will be sent**. To enable alerts, Project **PIs or Manager(s)** must set a
preferred threshold value (**in USD**) for this attribute by submitting a
**[Change Request](../allocation/allocation-change-request.md)**.

If an allocation has the `Monthly Allocation Cost Alert` attribute configured,
ColdFront will:

- Monitor the total billable cost for the month to maintain better control over
spending and ensure proper oversight.

- Send alert email notifications to the Project **PI and Manager(s)** when the
allocation's monthly charges exceed the configured threshold.

- Ensure Project **PIs and Manager(s)** are promptly informed of over-usage through
automated email alerts, eliminating the need to wait until the end of the
monthly billing cycle to review charges.

## How to Pay?

To ensure a comprehensive understanding of the billing process and payment options
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 8 additions & 3 deletions docs/get-started/user-onboarding-on-NERC.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,18 @@ The overall user flow can be summarized using the following sequence diagram:

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)
once they are added to a project via: [https://coldfront.mss.mghpcc.org](https://coldfront.mss.mghpcc.org/).
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) once they are added to a project via: [https://coldfront.mss.mghpcc.org](https://coldfront.mss.mghpcc.org/).

For detailed instructions about **NERC's ColdFront** and how to use it, refer
to [this guide](allocation/coldfront.md).

!!! danger "Very Important: Project Title Length Limitation"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this necessary?

Copy link
Contributor Author

@Milstein Milstein Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@knikolla: Lately, PIs have been using longer project titles, which is causing issues when creating RHOAI Workbenches with custom long names. We need to update the ColdFront plugin to enforce a maximum length of 25 characters for ColdFront Project titles. This ensures that Workbench names and their associated CRDs can fit properly within the auto-generated user namespace based on the project title.

Copy link
Contributor

@knikolla knikolla Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Milstein Is this related to this? nerc-project/coldfront-plugin-cloud#225

In that PR you proposed 50. Via that ColdFront already has the ability to crop project names if they are longer, just the length needs to be adjusted.

It would be much better if this can be fixed by merging that PR to an appropriate maximum length so that it shortens the project title to an appropriate length regardless of what PIs insert. PIs aren't going to read the documentation before requesting a project.


Sorry, wrong @ to Quan by mistake.


Please ensure that the project title is both concise and does not exceed
a length of **45 characters**.

5. **PI or project Manager** can request resource allocation either **NERC (OpenStack)**,
**NERC-OCP (OpenShift)** or **NERC-OCP-EDU (OpenShift)** for the newly added
project and select which user(s) can use the requested allocation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Enter your token (input will not be visible):
Add token as git credential? (Y/n)
Token is valid (permission: write).
Your token has been saved in your configured git credential helpers (store).
Your token has been saved to /home/wauplin/.cache/huggingface/token
Your token has been saved to /home/<your-user-name>/.cache/huggingface/token
Login successful
```

Expand Down Expand Up @@ -228,6 +228,8 @@ hf download RedHatAI/Llama-3.2-3B-Instruct-FP8

![Uploaded Llama Model Success](images/minio-llama-model-uploaded.png)

!!!

### Set up URI

**Alternatively,** for the `Llama-3.2-3B-Instruct-FP8` model, you can use a publicly
Expand Down