Skip to content

Commit 5e754e0

Browse files
committed
Merge branch 'main' of github.com:nerc-project/nerc-docs into openshift_virtualization_contents
2 parents 7ee3463 + 62406c3 commit 5e754e0

File tree

18 files changed

+192
-31
lines changed

18 files changed

+192
-31
lines changed

docs/get-started/cost-billing/how-pricing-works.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,4 +227,137 @@ and a transparent relationship with us.
227227
If you have any some common questions or need further information, see our
228228
[Billing FAQs](billing-faqs.md) for comprehensive answers.
229229

230+
## SU Conservation - How to Save Cost?
231+
232+
With SUs being the primary metric for resource consumption, it's crucial to actively
233+
manage your workloads when they're not in use.
234+
235+
Below are practical ways to conserve SUs across different NERC services:
236+
237+
### NERC OpenStack
238+
239+
Once you're logged in to [NERC's Horizon dashboard](https://stack.nerc.mghpcc.org).
240+
241+
Navigate: Project -> Compute -> Instances.
242+
243+
After launching an instance (On the left side bar, click on
244+
_Project -> Compute -> Instances_), several options are available under the
245+
Actions menu located on the right hand side of your screen as shown here:
246+
247+
![Instance Management Actions](images/instance_actions.png)
248+
249+
**Shelve your VM when not in use**:
250+
251+
In [NERC OpenStack](../../openstack/index.md), if your VM does not need to run
252+
continuously, you can **shelve** it to free up consumed resources such as vCPUs,
253+
RAM, and disk. This action releases all allocated resources while preserving the
254+
VM's state.
255+
256+
- Click _Action -> Shelve Instance_.
257+
258+
- Releases all computing resources (i.e., vCPU, RAM, and disk).
259+
260+
- We strongly recommend detaching volumes before shelving.
261+
262+
- Status will change to `Shelved Offloaded`.
263+
264+
You can later **unshelve** the VM without needing to recreate it - allowing you
265+
to reduce costs without losing any progress.
266+
267+
- To unshelve the instance, click _Action -> Unshelve Instance_.
268+
269+
For more details on *shelving a VM*, see the explanation [here](../../openstack/management/vm-management.md#instance-management-actions).
270+
271+
### NERC OpenShift
272+
273+
**Scale your pods to 0 replicas**:
274+
275+
In [NERC OpenShift](../../openshift/index.md), if your application or job is idle,
276+
you can scale its pod replica count to **0**. This effectively frees up compute
277+
resources (CPU, GPU, and RAM) while retaining the configuration, environment settings,
278+
and persistent volume claims (PVCs) for future use.
279+
280+
#### Using Web Console
281+
282+
1. Go to the [NERC's OpenShift Web Console](https://console.apps.shift.nerc.mghpcc.org).
283+
284+
2. Click on the **Perspective Switcher** drop-down menu and select **Developer**.
285+
286+
3. Click the pod or application you want to scale to see the _Overview_ panel to
287+
the right.
288+
289+
4. In the **Details** tab (usually the *default* tab when you open the deployment):
290+
291+
5. Look for the Pod count or Replicas section.
292+
293+
6. Use the up/down arrows next to the number to adjust the replica count.
294+
295+
7. Set it to **0** by clicking down arrow as shown below:
296+
297+
![Scaling Pod to 0](images/scale-0-pod.png)
298+
299+
8. OpenShift will automatically scale down the pods to 0.
300+
301+
When you need to run your application again, you can scale up the pod count or
302+
replicas to reclaim the necessary resources.
303+
304+
#### Using the OpenShift `oc` CLI
305+
306+
##### Prerequisite
307+
308+
- Install and configure the **OpenShift CLI (oc)**, see [How to Setup the
309+
OpenShift CLI Tools](../../openshift/logging-in/setup-the-openshift-cli.md)
310+
for more information.
311+
312+
!!! info "Information"
313+
314+
Some users may have access to multiple projects. Run the following command to
315+
switch to a specific project space: `oc project <your-project-namespace>`.
316+
317+
Please confirm the correct project is being selected by running `oc project`,
318+
as shown below:
319+
320+
oc project
321+
Using project "<your_openshift_project_where_pod_deployed>" on server "https://api.shift.nerc.mghpcc.org:6443".
322+
323+
If your application or job is idle, you can scale your pod's replica count to
324+
**0** by running the following `oc` command:
325+
326+
```sh
327+
oc scale deployment <your-deployment> --replicas=0
328+
```
329+
330+
When you need to run your application again, you can scale up the pod count or
331+
replicas to reclaim the necessary resources by running:
332+
333+
```sh
334+
oc scale deployment <your-deployment> --replicas=1
335+
```
336+
337+
### NERC RHOAI
338+
339+
**Toggle the Workbench to "Stopped"**:
340+
341+
In [NERC Red Hat OpenShift AI (RHOAI)](../../openshift-ai/index.md), workbench
342+
environments can be toggled between **Running** and **Stopped** states.
343+
344+
1. Go to the [NERC's OpenShift Web Console](https://console.apps.shift.nerc.mghpcc.org).
345+
346+
2. After logging in to the NERC OpenShift console, access the NERC's Red Hat OpenShift
347+
AI dashboard by clicking the application launcher icon (the black-and-white
348+
icon that looks like a grid), located on the header.
349+
350+
3. When you've completed a workload such as model development or experimentation
351+
using the [Data Science Project (DSP)](../../openshift-ai/data-science-project/using-projects-the-rhoai.md)
352+
**Workbench**, you can stop the compute resources by toggling the status from
353+
**Running** to **Stopped**, as shown below:
354+
355+
![Toggle Workbench](images/toggle-workbench.png)
356+
357+
This action immediately releases the compute resources allocated to the notebook
358+
environment within the Workbench setup.
359+
360+
When you need to run your workbench again, just toggle its status back from
361+
**Stopped** to **Running**.
362+
230363
---
36.7 KB
Loading
101 KB
Loading
80.4 KB
Loading

docs/openstack/backup/backup-with-snapshots.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ openstack server rebuild --image my-snapshot test-nerc-0
9797

9898
#### Using Horizon dashboard
9999

100-
Once you're logged in to NERC's Horizon dashboard, you can create a snapshot via
101-
the "Compute -> Instances" page by clicking on the "Create snapshot" action button
102-
on desired instance as shown below:
100+
Once you're logged in to [NERC's Horizon dashboard](https://stack.nerc.mghpcc.org),
101+
you can create a snapshot via the "Compute -> Instances" page by clicking on the
102+
"Create snapshot" action button on desired instance as shown below:
103103

104104
![Create Instance Snapshot](images/create-instance-snapshot.png)
105105

@@ -237,9 +237,9 @@ openstack volume snapshot delete my-volume-snapshot
237237

238238
#### Using NERC's Horizon dashboard
239239

240-
Once you're logged in to NERC's Horizon dashboard, you can create a snapshot via
241-
the "Volumes" menu by clicking on the "Create Snapshot" action button
242-
on desired volume as shown below:
240+
Once you're logged in to [NERC's Horizon dashboard](https://stack.nerc.mghpcc.org),
241+
you can create a snapshot via the "Volumes" menu by clicking on the "Create Snapshot"
242+
action button on desired volume as shown below:
243243

244244
![Create Volume Snapshot](images/volume-create-snapshot.png)
245245

docs/openstack/create-and-connect-to-the-VM/create-a-Windows-VM.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,45 @@ from an external volume:
1313

1414
!!! note "Recommendations"
1515

16-
- The recommended method to create a Windows desktop virtual machine is `boot
17-
from volume`, although you can also launch a Windows-based instance following
18-
the normal process using `boot from image` as [described here](launch-a-VM.md).
16+
- The recommended method for creating a Windows desktop virtual machine is to
17+
**boot from volume**. However, you can also launch a Windows-based instance
18+
using the standard **boot from image** method, as [described here](launch-a-VM.md).
19+
When launching a Windows VM using **boot from image**, please ensure that you
20+
have configured a **Security Group** that allows **RDP (port 3389)**, as shown
21+
below:
22+
23+
![Launch Instance Security Group for RDP](images/security_group_for_rdp.png)
24+
25+
To access the Windows VM, you must log in via **Remote Desktop**, as
26+
[described here](#how-to-add-remote-desktop-login-to-your-windows-instance).
27+
28+
To configure a password for the **Administrator** user account:
29+
30+
1. Go to the **Configuration** section during instance launch.
31+
32+
2. Enter the following PowerShell-based custom script:
33+
34+
```powershell
35+
#ps1
36+
37+
net user Administrator '<Your_Own_Admin_Password>'
38+
```
39+
40+
3. Replace `<Your_Own_Admin_Password>` with your desired password.
41+
42+
**Note**: Ensure that your script in the "Configuration" section resembles
43+
the format shown below:
44+
45+
![Setting Administrator Password Custom Script](images/set_windows_administrator_password.png)
46+
47+
This enables Remote Desktop login for the **Administrator** user account.
1948

2049
- To ensure smooth upgrade and maintenance of the system, select at least
2150
100 GiB for the size of the volume.
2251

2352
- Make sure your project has sufficient [storage quotas](../../get-started/allocation/allocation-details.md#general-user-view).
2453

25-
### Create a volume from image
54+
### Create a Bootable Volume from the Existing Windows Image
2655

2756
### 1. Using NERC's Horizon dashboard
2857

@@ -106,14 +135,14 @@ service to the volume service
106135
"available" means the volume can now be used for booting. A set of volume_image
107136
meta data is also copied from the image service.
108137

109-
### Launch instance from existing bootable volume
138+
### Launch instance from existing Bootable Volume
110139

111140
### 1. Using Horizon dashboard
112141

113142
Navigate: Project -> Volumes -> Volumes.
114143

115-
Once successfully Volume is created, we can use the Volume to launch an instance
116-
as shown below:
144+
Once successfully Volume is created by [following this](#create-a-bootable-volume-from-the-existing-windows-image),
145+
we can use the Bootable Volume to launch an Windows instance as shown below:
117146

118147
![Launch Instance from Volume](images/launch_instance_from_volume.png)
119148

@@ -143,7 +172,7 @@ shown below:
143172
Make sure to substitute `<Your_Own_Admin_Password>` with your preferred password,
144173
which will enable Remote Desktop login to the Windows VM.
145174

146-
```sh
175+
```powershell
147176
#ps1
148177

149178
net user Administrator '<Your_Own_Admin_Password>'

docs/openstack/create-and-connect-to-the-VM/flavors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,8 +263,8 @@ Our team will review your request and reach out to you to discuss further.
263263

264264
### Using Horizon dashboard
265265

266-
Once you're logged in to NERC's Horizon dashboard, you can navigate to
267-
_Project -> Compute -> Instances_.
266+
Once you're logged in to [NERC's Horizon dashboard](https://stack.nerc.mghpcc.org),
267+
you can navigate to _Project -> Compute -> Instances_.
268268

269269
You can select the instance you wish to extend or change the flavor. Here, you
270270
will see several options available under the Actions menu located on the right-hand

docs/openstack/create-and-connect-to-the-VM/images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ up new instances.
1212

1313
## NERC Images List
1414

15-
Once you're logged in to NERC's Horizon dashboard.
15+
Once you're logged in to [NERC's Horizon dashboard](https://stack.nerc.mghpcc.org).
1616

1717
Navigate to _Project -> Compute -> Images_.
1818

docs/openstack/create-and-connect-to-the-VM/launch-a-VM.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
## Using Horizon dashboard
1313

14-
Once you're logged in to NERC's Horizon dashboard.
14+
Once you're logged in to [NERC's Horizon dashboard](https://stack.nerc.mghpcc.org).
1515

1616
Navigate: Project -> Compute -> Instances.
1717

docs/openstack/management/vm-management.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,7 @@ actions are executed through the openstack command with the relevant parameters.
8888

8989
- Click _Action -> Shelve Instance_.
9090

91-
- When shelved it stops all computing, stores a snapshot of the instance. The
92-
shelved instances are already imaged as part of the shelving process and appear
93-
in _Project -> Compute -> Images_ as "<Instance_Name>\_shelved".
91+
- Releases all computing resources (i.e., vCPU, RAM, and disk).
9492

9593
- We strongly recommend detaching volumes before shelving.
9694

0 commit comments

Comments
 (0)