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
37 changes: 24 additions & 13 deletions docs/openshift/storage/storage-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,30 +182,41 @@ examples of access modes:

**1. NERC OpenStack Object Storage (Swift):**

**Prerequisites**: You must have an active [OpenStack Resource Allocation](../../get-started/allocation/requesting-an-allocation.md#request-a-new-openstack-resource-allocation-for-an-openstack-project)
on your project to use NERC OpenStack Object Storage (Swift). The **"OpenStack
Swift Quota (GiB)"** attribute specifies the capacity of your object storage quota.
- **Prerequisites**:

You must have at least one active **NERC (OpenStack)** type resource allocation.
You can refer to [this documentation](../../get-started/allocation/requesting-an-allocation.md#request-a-new-openstack-resource-allocation-for-an-openstack-project)
on how to get allocation and request "NERC (OpenStack)" type resource allocations
on your project. The **"OpenStack Swift Quota (GiB)"** attribute defines
the total object storage quota assigned to your allocation.

!!! note "Very Important Note"

On NERC OpenStack, Object Storage (Swift) and Block Storage (Volumes/Cinder)
are managed by separate allocation quota attributes: "OpenStack Swift Quota
(GiB)" and "OpenStack Volume Quota (GiB)" respectively.
For any **NERC (OpenStack)** resource allocation, *Object Storage (Swift)*
and *Block Storage (Volumes/Cinder)* are managed through separate allocation
quota attributes: **"OpenStack Swift Quota (GiB)"** for object storage and
**"OpenStack Volume Quota (GiB)"** for block storage.

For more details on how to set up persistent storage using OpenStack Object
Storage (Swift), follow this [**user guide**](../../openstack/persistent-storage/object-storage.md).

**2. MinIO-based Storage on NERC OpenShift (OCP):**
**2. MinIO-based Local S3-Compatible Object Storage on NERC OpenShift (OCP):**

- **Prerequisites**:

**Prerequisites**: You must have an active [OpenShift Resource Allocation](../../get-started/allocation/requesting-an-allocation.md#request-a-new-openshift-resource-allocation-for-an-openshift-project)
on your project. The **"OpenShift Request on NESE Storage Quota (GiB)"** attribute
specifies the capacity of your storage quota for that allocation.
You must have at least one active **NERC-OCP (OpenShift)** type resource
allocation. You can refer to [this documentation](../../get-started/allocation/requesting-an-allocation.md#request-a-new-openshift-resource-allocation-for-an-openshift-project)
on how to get allocation and request "NERC-OCP (OpenShift)" type resource
allocations on your project. The **"OpenShift Request on NESE Storage Quota
(GiB)"** attribute defines the total storage quota assigned to your allocation.

!!! note "Very Important Note"

On NERC OpenShift, the "OpenStack Swift Quota (GiB)" allocation
attribute is used by MinIO-based storage, which mounts a PersistentVolume
via a PVC into the running Pod.
For any **NERC-OCP (OpenShift)** resource allocation, the **"OpenShift
Request on NESE Storage Quota (GiB)"** attribute defines the total storage
capacity available to your allocation. This quota is used by MinIO-based
storage, which mounts a *PersistentVolume* through a PVC into the running
Pod.

For more details on setting up persistent storage using MinIO-based storage,
follow this [**user guide**](minio.md). You may also review how it is configured
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,20 +73,21 @@ workflow.
cd simple-node-app
```

6. Run either `setsecret.cmd` file if you are using **Windows** or `setsecret.sh`
file if you are using **Linux** based machine. Once executed, verify Github Secrets
are set Properly under your github repo's
6. Run either the `setsecret.cmd` file if you are using Windows or the `setsecret.sh`
file if you are on a Linux-based machine. Once executed, verify that the GitHub
Secrets are set properly under your repository's
_settings >> secrets and variables >> Actions_ as shown here:

![GitHub Secrets](images/github-secrets.png)

!!! note "Important Note"

If you are going to use the GitHub Container Registry (GHCR) then you
don't need to set other **Registry related secrets** i.e.
`IMAGE_REGISTRY_USER` and `MY_REGISTRY_PASSWORD`. These two additional
secrets also need to set if you want to use either **Quay.io** or **Dockerhub**
registry.
If you are using the **GitHub Container Registry (GHCR)**, you do **not**
need to set other registry-related secrets, such as `IMAGE_REGISTRY_USER`
and `MY_REGISTRY_PASSWORD`, as they are obtained directly from your repository.

These two additional secrets are required only if you plan to use **Quay.io**
or **Dockerhub** registries.

7. Enable and Update GitHub Actions Pipeline on your own forked repo:

Expand All @@ -108,8 +109,15 @@ workflow.
4. Log in to your NERC OpenShift cluster's project space
5. Create an OpenShift app from the image and expose it to the internet

8. Edit the top-level 'env' section as marked with '🖊️' if the defaults are not
suitable for your project.
8. Edit the top-level `env` section as marked with '🖊️' in the `openshift.yml`
file if the default values are not suitable for your project.

!!! warning "Very Important Note"

In the provided sample OpenShift workflow YAML file (`openshift.yml`),
uncomment the lines for your chosen registry: `GitHub Container Registry
(GHCR)`, `quay.io`, or `docker.io`. By default, `GHCR` is used as the
appropriate lines are already uncommented.

9. (Optional) Edit the build-image step to build your project:

Expand All @@ -122,6 +130,13 @@ workflow.

![GitHub Actions Successfully Complete](images/github-actions-successful.png)

!!! tips "Troubleshooting"

Repositories on `GitHub Container Registry (GHCR)`, `quay.io`, and `docker.io`
are **private by default**. This means that when you push an image for the
first time, you must change its visibility to **Public** for the pipeline
to work successfully.

11. Verify that you can see the newly deployed application on the NERC's OpenShift
Container Platform at [https://console.apps.shift.nerc.mghpcc.org](https://console.apps.shift.nerc.mghpcc.org)
as [described here](../../../openshift/logging-in/access-the-openshift-web-console.md),
Expand Down
10 changes: 5 additions & 5 deletions nerc-theme/main.html
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{% extends "base.html" %} {% block announce %}
<div class="parent">

<!-- <div class="maintain">
<div class="maintain">
<div>
Upcoming NERC's ColdFront service upgrade and maintenance
Upcoming NERC system maintenance and upgrade
</div>
<div>
(Tuesday Nov 11, 2025 8:00 AM - 12:00 PM)
(Tuesday, Dec 9, 2025 8:00 AM - 12:00 PM)
<a style="color: #00efff"
href="https://nerc.mghpcc.org/event/coldfront-maintenance-20251111/"
href="https://nerc.mghpcc.org/event/nerc-system-maintenance-20251209/"
target="_blank">[Event Details]</a>
</div>
</div> -->
</div>

<!-- <div class="upgrade">
</div> -->
Expand Down