Revision as of 15:45, 27 August 2021

This page provides getting started information for using Open OnDemand to access HiPerGator.

Open on Demand is only accessible from within the UF network. Use the VPN if off campus.

If you are working off campus, you will need to use the VPN to connect to the UF campus network using AnyConnect VPN or similar software. Please see: https://vpn.ufl.edu for additional information.

Open OnDemand

Open OnDemand is setup to provide a web interface to starting and attaching to HiPerGator jobs and it supports GUI programs, Job Status, and other interactions with HiPerGator via seamless connections through web browsers. This service is available at the following URL:

https://ondemand.rc.ufl.edu

For questions or support, please open a support request with [OnDemand] in the subject.

Getting started video

Please watch our introductory video here: Using Open on Demand on HiPerGator [5 min, 11 sec] This video covers the use of Open on Demand https://openondemand.org/ on HiPerGator via https://ood.rc.ufl.edu/.

Connect to https://ood.rc.ufl.edu/
Launch a terminal
Launch many graphical applications like Rstudio, Matlab and Freeview
Manage job submission
Upload, download and edit files via your browser

Navigating OnDemand

To Navigate the basic functions of OnDemand, first login to https://ood.rc.ufl.edu

Once you access the dashboard, you can use the top menus to navigate.

Files

This menu will allow you to access your groups' storage areas including:

Home
Orange
Blue

Jobs

This menu shows both the job status and job composer links

Job Status: This link shows the Job status window. This queries SLRUM and shows you the current status of your pending, running, and recently completed jobs.
Job Composer: This link allows access to the job composer if you would like to use OnDemand to run your existing SLURM scripts.

Clusters

HiPerGator Shell Access: This link opens a terminal shell in your browser that allows access the HiPerGator

Interactive Apps

Clicking this menu will present a drop-down menu with a list of the current interactive GUI applications available within OnDemand.

If you don't see an application you need, feel free to select the "Console" application and use the HiPerGator `module load` commands to load and run your application.

My Interactive Sessions

Clicking this link will take to you a list of your currently running interactive OnDemand jobs.

Help

This link provides access to some quick links for help on HiPerGator and for OnDemand.

Logout

This link logs you out of the OnDemand page.

Starting an Interactive application

To start an interactive application, first select the application you would like to start from the "Interactive Applications menu". Then you will see a form with the SLURM options available for that application. Fill in the fields with the resources you would like allocated for this application session.

General Form Fields

Version: Select the application version This defines the version of the application you want to load.

Number of MPI Tasks (--ntasks): recommended default, 1

Number of CPU cores requested per MPI task (--cpus-per-task, -p): recommended default, 1

Maximum memory requested for this job in Gigabytes (--mem, -m): recommended default, 1

- Note: If you are using advanced memory options in Additional SLURM Options below, then leave this blank.

SLURM Account (--account, -A): recommended default, (leave blank)

QoS (Required if custom Account is set, --qos, -q): recommended default, (leave blank)

Time Requested for this job in hours (--time, -t): recommended default, 1

Cluster partition (--partition, -p): Recommended default, (default)

Generic Resource Request (--gres): Recommended default, (leave blank)

Additional SLURM Options: Recommended default, (leave blank)

You can have multiple copies of the same application running at the same time by submitting the form multiple times.

Then select "Launch" to submit your job request.

Connecting to an Interactive application

Once a job has started, you can connect using the "My Interactive Applications" menu.

Select this menu and you will see a connection box for each application you have running and pending.
Once the job starts, a Launch (App Name) icon will appear.
Select this link to open a new browser window connecting you to your application.

Job Connect Card

This section outlines several of the key features of the job connect card:

JobID: This is the SLURM JobID for this job
Delete: This will cancel a running job, (or delete the session if the job has already ended)
OOD Session ID: This is the unique identifier for the OOD session for this job, can be clicked to bring up the OOD log directory for troubleshooting
Image Quality: This setting controls the quality of the visual interface at the source, use a lower setting for slower internet connections
Compression: This setting adjusts the amount of CPU based compression used for the NoVNC connection, use higher settings for slower connections but note it will increase CPU usage on both the job and client
Launch Button: Click this button to connect to your running job in a web-browser session

Example highlighting the components of an OOD connection card

@@ Line 1: / Line 1: @@
 [[Category:Software]][[Category:GUI]]
 __TOC__
-Here is some getting started information for using Open OnDemand to access HPG.
-<span style="color:red">'''The OnDemand service is accessible only within the UF campus network and using the campus VPN.'''</span>
+This page provides getting started information for using Open OnDemand to access HiPerGator.
+{{Note|Open on Demand is only accessible from within the UF network. Use the [https://vpn.ufl.edu VPN] if off campus.|warn}}
 If you are working off campus, you will need to use the VPN to connect to the UF campus network using [https://connect.ufl.edu/it/wiki/Pages/glvpn-anyconnect-install.aspx AnyConnect VPN] or similar software. Please see: [https://vpn.ufl.edu https://vpn.ufl.edu] for additional information.
 =Open OnDemand=
-Open OnDemand [https://openondemand.org/ Open OnDemand] is setup to provide a web-only interface to starting and attaching to HiPerGator and it supports GUI programs, Job Status, and other interactions with HPG via seamless connections through web browsers. This service is available at the following URL:
+[https://openondemand.org/ Open OnDemand] is setup to provide a web interface to starting and attaching to HiPerGator jobs and it supports GUI programs, Job Status, and other interactions with HiPerGator via seamless connections through web browsers. This service is available at the following URL:
 https://ondemand.rc.ufl.edu
-To provide feedback, please open a support request with [OnDemand] in the subject.  Please note:
+For questions or support, please open a support request with [OnDemand] in the subject.
-'''Ondemand is currently a Beta service. Users are welcome to test the service and submit support requests with feedback. However, no SLA is guaranteed and all features should be considered experimental.'''
+==Getting started video==
-==Getting started video==
 Please watch our introductory video here:
 [https://mediasite.video.ufl.edu/Mediasite/Play/4654bfa838624de894085bf54678848f1d Using Open on Demand on HiPerGator]
@@ Line 36: / Line 38: @@
 ===Files===
-This menu, if selected, will allow you to access your group's storage areas including:
+This menu will allow you to access your groups' storage areas including:
 *Home
 *Orange
-*UFRC
+*Blue
 ===Jobs===
 This menu shows both the job status and job composer links
-*Job Status: This link shows the Job status window.  This query's SLRUM and shows you the current status of your pending, running, and recently completed jobs.
+*Job Status: This link shows the Job status window.  This queries SLRUM and shows you the current status of your pending, running, and recently completed jobs.
-*Job Composer: This link allows access to the job composer if you would like to use OnDemand to run your existing SLRUM scripts.
+*Job Composer: This link allows access to the job composer if you would like to use OnDemand to run your existing SLURM scripts.
 ===Clusters===
-*HiPerGator Shell Access: This link opens a web terminal in your browser that allows access the HiPerGator login shell
+*HiPerGator Shell Access: This link opens a terminal shell in your browser that allows access the HiPerGator
 ===Interactive Apps===
@@ Line 56: / Line 58: @@
 Clicking this menu will present a drop-down menu with a list of the current interactive GUI applications available within OnDemand.
-If you don't see an application you need, feel free to select the "Console" application and use the HPG modules system to load and run your application.
+If you don't see an application you need, feel free to select the "Console" application and use the HiPerGator `module load` commands to load and run your application.
 ===My Interactive Sessions===
@@ Line 64: / Line 66: @@
 ===Help===
-This link provides access to some quick links for help on HPG and for OnDemand.
+This link provides access to some quick links for help on HiPerGator and for OnDemand.
 ===Logout===
@@ Line 71: / Line 73: @@
 ==Starting an Interactive application==
+To start an interactive application, first select the application you would like to start from the "Interactive Applications menu".  Then you will see a form with the SLURM options available for that application.  Fill in the fields with the resources you would like allocated for this application session.
+===General Form Fields===
+Version: Select the application version
+This defines the version of the application you want to load.
+*Number of MPI Tasks (--ntasks): recommended default, 1
+*Number of CPU cores requested per MPI task (--cpus-per-task, -p): recommended default, 1
+*Maximum memory requested for this job in Gigabytes (--mem, -m): recommended default, 1
+**'''Note: If you are using advanced memory options in Additional SLURM Options below, then leave this blank.'''
+*SLURM Account (--account, -A): recommended default, (leave blank)
+*QoS (Required if custom Account is set, --qos, -q): recommended default, (leave blank)
+*Time Requested for this job in hours (--time, -t): recommended default, 1
+*Cluster partition (--partition, -p): Recommended default, (default)
+*Generic Resource Request (--gres): Recommended default, (leave blank)
+Additional SLURM Options: Recommended default, (leave blank)
+You can have multiple copies of the same application running at the same time by submitting the form multiple times.
+Then select "Launch" to submit your job request.
+==Connecting to an Interactive application==
+Once a job has started, you can connect using the "My Interactive Applications" menu.
+*Select this menu and you will see a connection box for each application you have running and pending.
+*Once the job starts, a Launch (App Name) icon will appear.
+*Select this link to open a new browser window connecting you to your application.
+==Job Connect Card==
+This section outlines several of the key features of the job connect card:
+# JobID:  This is the SLURM JobID for this job
+# Delete:  This will cancel a running job, (or delete the session if the job has already ended)
+# OOD Session ID: This is the unique identifier for the OOD session for this job, can be clicked to bring up the OOD log directory for troubleshooting
+# Image Quality: This setting controls the quality of the visual interface at the source, use a lower setting for slower internet connections
+# Compression: This setting adjusts the amount of CPU based compression used for the NoVNC connection, use higher settings for slower connections but note it will increase CPU usage on both the job and client
+# Launch Button: Click this button to connect to your running job in a web-browser session
+[[File:OOD-Card.png|50%|center|Example highlighting the components of an OOD connection card]]

Difference between revisions of "Open OnDemand"