Skip to content

Commit

Permalink
Andy updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@monaghaa
monaghaa committed Sep 10, 2021
1 parent e0fc644 commit ee52cbd
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions docs/gateways/OnDemand.md
View file
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
## CU Open OnDemand _(Browser based access for all of your HPC resources)_
## CURC Open OnDemand _(Browser based portal for CURC HPC resources)_

CU OnDemand is a browser based, integrated, single access point for all of your HPC resources. CU OnDemand provides a graphical interface to view, edit, download, and upload files, manage and create job templates, and access CURC interactive applications (Viz cluster, Matlab, and JupyterNotebooks), all via a web browser and with minimal knowledge of Linux and scheduler commands.
CURC Open OnDemand is a browser based, integrated, single access portal for all of your high performance computing (HPC) resources. CURC Open OnDemand provides a graphical interface to view, edit, download, and upload files, manage and create job templates for CURC's Summit and Blanca clusters, and access CURC interactive applications (visualization nodes, Matlab, and JupyterNotebooks), all via a web browser and with minimal knowledge of Linux and scheduler commands.

### Getting started with CU Open OnDemand
### Getting started with CURC Open OnDemand

> **_NOTE:_** _This is a beta release of Open OnDemand currenly only available to CU users_
To connect to CU OnDemand, visit [https://ondemand.rc.colorado.edu](https://ondemand.rc.colorado.edu/). The first page of CU OnDemand will bring you to a login prompt. Use your CU Research Computing credentials to login and 2-factor authenticate using Duo. If you need a CU Research Computing account please visit [our acccount request page](https://curc.readthedocs.io/en/latest/access/logging-in.html) to get started.
To connect to CURC Open OnDemand, visit [https://ondemand.rc.colorado.edu](https://ondemand.rc.colorado.edu/). The first page of CU Open OnDemand will bring you to a login prompt. Use your CU Research Computing credentials and Duo 2-factor authentication to login. If you need a CU Research Computing account please visit [our account request page](https://curc.readthedocs.io/en/latest/access/logging-in.html) to get started.

![](OnDemand/login_page.png)

### Features

When you have successfully logged into Cu OnDemand you will see the landing page with the following features broken into tabs along the top of the page: Files, Jobs, Clusters (shell access), Interactive Apps, and My Interactive Sessions.
When you have successfully logged into CU Open OnDemand you will see the landing page with the following features broken into tabs along the top of the page: __Files__, __Jobs__, __Clusters__ (shell access), __Interactive Apps__, and __My Interactive Sessions__.

![](OnDemand/landing_page.png)

#### File Menu

The File menu allows users to view and operate on files in three different file spaces: the user’s home directory, project directory, and if applicable shared PetaLibary directories.
The _File_ menu allows you to view and operate on files in three different file spaces: your _home_ directory, _projects_ directory, and (if applicable) shared _PetaLibary_ directories.

Selecting one of the file spaces will open a separate browser window which will allow you to navigate the space in a graphical setting similar to a file browser on personal computers. From here users can download, upload, create, delete, and open files.
Selecting one of the file spaces will open a separate browser window which will allow you to navigate the space in a graphical setting similar to a file browser on a personal computer. From here you can download, upload, create, delete, and open files.

> **_NOTE 1:_** _Use [Globus](https://curc.readthedocs.io/en/latest/compute/data-transfer.html#globus-transfers) to transfer files to /scratch/summit or /rc_scratch._
> **_NOTE 1:_** _Use [Globus](https://curc.readthedocs.io/en/latest/compute/data-transfer.html#globus-transfers) to transfer files to `/scratch/summit` or `/rc_scratch.`_
> **_NOTE 2:_** _If you have more than 1 GB of data to transfer, please use [Globus](https://curc.readthedocs.io/en/latest/compute/data-transfer.html#globus-transfers)._
![](OnDemand/home_file.png)

For additional detail: [OSC's File Transfer and Management help page](https://www.osc.edu/resources/online_portals/ondemand/file_transfer_and_management).
For additional documentation visit [OSC's File Transfer and Management help page](https://www.osc.edu/resources/online_portals/ondemand/file_transfer_and_management).

#### Jobs Menu

Jobs can be monitored, created, edited and scheduled with the job management tools under the “Jobs” menu.
Jobs can be monitored, created, edited and scheduled with the job management tools under the _Jobs_ menu.

* __Active Jobs:__ Under the “Active Jobs” tab you can view active jobs. You can choose to view your jobs (or all jobs) as well as choose from specific clusters (Blanca, Summit, Viz-Core, or all Custers). From this menu you can cancel your own jobs.

Expand All @@ -42,24 +42,24 @@ Jobs can be monitored, created, edited and scheduled with the job management too

![](OnDemand/job_composer.png)

#### Clusters (i.e. Shell Access)
#### Clusters Menu (i.e. Shell Access)

The Clusters tab provides shell access to login nodes on CURC clusters. The shell terminal is similar to many other tools that provide terminal access.
The _Clusters_ menu provides shell access to login nodes on CURC clusters. The shell terminal is similar to many other tools that provide terminal access.

* __Summit:__ The Summit tab will launch a terminal that RC users can use to manually access an RC Login node. After the tab opens, type your CURC password and accept the Duo push to your phone to complete login to the terminal.

* __Blanca:__ The Blanca tab will launch a terminal that RC users can use to manually access an RC Login node. After the tab opens, type your CURC password and accept the Duo push to your phone to complete login to the terminal. To load the Blanca Slurm environment, make sure to type “module load slurm/blanca upon login. More information on using the [Blanca cluster can be found here](https://curc.readthedocs.io/en/latest/access/blanca.html).
* __Blanca:__ The Blanca tab will launch a terminal that RC users can use to manually access an RC Login node. After the tab opens, type your CURC password and accept the Duo push to your phone to complete login to the terminal. To load the Blanca Slurm environment, make sure to type “module load slurm/blanca upon login. More information on using the Blanca cluster can be found [in the Blanca documentation](https://curc.readthedocs.io/en/latest/access/blanca.html).

#### Interactive Applications
#### Interactive Applications Menu

The Interactive Applications menu contains options to launch certain applications that have graphical user interfaces (GUIs), for interactive use on CURC clusters. Current supported applications include a __remote desktop from the visual cluster (viz), MATLAB, and Jupyter Notebook__.
The _Interactive Applications_ menu contains options to launch certain applications that have graphical user interfaces (GUIs), for interactive use on CURC clusters. Current supported applications include a __remote desktop atop the visualization ("Viz") cluster__ (aka "EnginFrame"), __MATLAB__, and __Jupyter Notebook__.

##### Remote Desktop (Viz-Core VNC)

1. When starting a Remote Desktop session on the Viz cluster you may customize the resources allocated to the session and other characteristics of the dispatched Slurm job. The default will open a Remote Desktop with 1 node (2 cores) for 1 hour (no need to specify account).
1. When starting a Remote Desktop session on the _Viz_ cluster you may customize the resources allocated to the session and other characteristics of the dispatched Slurm job. The default will open a Remote Desktop with 1 node (2 cores) for 1 hour (no need to specify account).
![](OnDemand/viz_launch.png)
2. Click “launch” to submit the Remote Destop job to the queue. The wait time depends on the number of cores as well as time requested.
3. When your Remote Desktop is ready you can click the “Launch VIZ CORE VNC.” In most cases the default compression and image quality will suffice but if you do have problems with image quality of the Remote Desktop you can adjust these settings as necessary.
2. Click “launch” to submit the Remote Destop job to the queue. The wait time depends on the number of other users presently on the resource. Requesting smaller, shorter jobs may faciliate shorter wait times.
3. When your Remote Desktop is ready you can click the “Launch VIZ CORE VNC.” In most cases the default compression and image quality will suffice but if you do have problems with image quality you can adjust these settings as necessary.
4. With the Remote Desktop session running and open, you should be able to run standard Linux desktop applications that have a graphical user interface (GUI). Instructions to use graphical software can be found at the [RC EnginFrame page](https://curc.readthedocs.io/en/latest/gateways/enginframe.html#step-3-use-graphical-software).

> **_NOTE:_** _Closing the window will not terminate the job, you can use the “My Interactive Sessions” tab to view all open interactive sessions and terminate them._
Expand All @@ -71,7 +71,7 @@ The Interactive Applications menu contains options to launch certain application
2. Click “launch” to submit the MATLAB job to the queue. The wait time depends on the number of cores, nodes, and time requested.
3. When your Matlab session is ready you can click the “Launch MATLAB on Core- CURC” In most cases the default compression and image quality will suffice but if you do have problems with image quality of the Remote Desktop you can adjust as necessary. An interactive Matlab session will be started in a new window.

> **_NOTE:_** _Matlab can also be opened in the Remote Desktop (VIZ CORE VNC), once you’ve opened a Remote Desktop session instructions can be found at the [RC EnginFrame page](https://curc.readthedocs.io/en/latest/gateways/enginframe.html#step-3-use-graphical-software)._
> **_NOTE:_** _Matlab can also be opened in the Remote Desktop (VIZ CORE VNC), once you’ve opened a Remote Desktop session instructions can be found at the [RC EnginFrame page](https://curc.readthedocs.io/en/latest/gateways/enginframe.html#step-3-use-graphical-software). Some users find running Matlab in the Remote Desktop (VIZ CORE VNC) option provides an enhanced experience._
> **_NOTE:_** _Closing the window will not terminate the job, you can use the “My Interactive Sessions” tab to view all open interactive sessions and terminate them._
Expand All @@ -88,10 +88,11 @@ The Interactive Applications menu contains options to launch certain application

> **_NOTE:_** _Closing the window will not terminate the job, you can use the “My Interactive Sessions” tab to view all open interactive sessions and terminate them._
> **_NOTE:_** _Users can also run Jupyter Notebooks in the CURC Jupyterhub at https://jupyter.rc.colorado.edu_.
#### My Interactive Sessions

The “My Interactive Sessions” tab will let you view and manage all of your current open Interactive applications. From this window you can view the node/core count, status, as well as time remaining for current sessions.
The _My Interactive Sessions_ menu will let you view and manage all of your current open Interactive applications. From this window you can view the node/core count, status, as well as time remaining for current sessions.

Closing the window an interactive application is opened in will not terminate the session, you will need to click the “Delete” button for the individual session.
![](OnDemand/my_interactive_sessions.png)

0 comments on commit ee52cbd

Please sign in to comment.