Difference between revisions of "Open OnDemand"

From UFRC
Jump to navigation Jump to search
(Undo revision 27880 by Cabreraruizdiazj (talk))
Tag: Undo
 
(35 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[Category:Software]][[Category:GUI]]
 
[[Category:Software]][[Category:GUI]]
__TOC__
+
{|align=right
 
+
  |__TOC__
 +
  |}
  
 
This page provides getting started information for using Open OnDemand to access HiPerGator.
 
This page provides getting started information for using Open OnDemand to access HiPerGator.
 +
[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
  
{{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 run into issues, please look at our guide for [[Open OnDemand Troubleshooting]]. For questions or support, please open a support request with [OnDemand] in the subject.  
 
 
 
 
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=
 
[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
 
 
 
For questions or support, please open a support request with [OnDemand] in the subject.  
 
  
 
==Getting started video==
 
==Getting started video==
Line 23: Line 15:
 
[[File:Play_icon.png|frameless|30px|link=https://mediasite.video.ufl.edu/Mediasite/Play/4654bfa838624de894085bf54678848f1d]] [5 min, 11 sec]
 
[[File:Play_icon.png|frameless|30px|link=https://mediasite.video.ufl.edu/Mediasite/Play/4654bfa838624de894085bf54678848f1d]] [5 min, 11 sec]
 
This video covers the use of Open on Demand https://openondemand.org/ on HiPerGator via https://ood.rc.ufl.edu/.
 
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/
+
# Connect to https://ood.rc.ufl.edu/
* Launch a terminal
+
# Launch a terminal
* Launch many graphical applications like Rstudio, Matlab and Freeview
+
# Launch many graphical applications like Rstudio, Matlab and Freeview
* Manage job submission
+
# Manage job submission
* Upload, download and edit files via your browser
+
# Upload, download and edit files via your browser
  
==Navigating OnDemand==
+
==Navigating OnDemand Menus==
  
 
To Navigate the basic functions of OnDemand, first login to [https://ood.rc.ufl.edu https://ood.rc.ufl.edu]
 
To Navigate the basic functions of OnDemand, first login to [https://ood.rc.ufl.edu https://ood.rc.ufl.edu]
  
[[File:OnDemand.png|On Demand Dashboard|500px]]
+
[[File:OnDemand.png|On Demand Dashboard|500px | right]]
  
 
Once you access the dashboard, you can use the top menus to navigate.
 
Once you access the dashboard, you can use the top menus to navigate.
  
===Files===
+
{| cellpadding = "5"
 +
|-
 +
|
 +
'''Files'''<br>
 
This menu will allow you to access your groups' storage areas including:
 
This menu will allow you to access your groups' storage areas including:
 
 
*Home
 
*Home
 
*Orange
 
*Orange
 
*Blue
 
*Blue
 +
If you're having issues, view our tips for the [[Open OnDemand Files | Files App]]
  
===Jobs===
+
'''Interactive Apps'''<br>
 +
Clicking this menu will present a drop-down menu with a list of the current interactive GUI applications available within OnDemand.<br>
 +
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.
 +
 
 +
'''Clusters'''<br>
 +
HiPerGator Shell Access: This link opens a terminal shell in your browser that allows access the HiPerGator
 +
||
 +
'''Jobs'''<br>
 
This menu shows both the job status and job composer links
 
This menu shows both the job status and job composer links
  
Line 50: Line 52:
 
*Job Composer: This link allows access to the job composer if you would like to use OnDemand to run your existing SLURM 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===
+
'''My Interactive Sessions'''<br>
 
 
*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.
 
Clicking this link will take to you a list of your currently running interactive OnDemand jobs.
  
===Help===
+
'''Help'''<br>
 
 
 
This link provides access to some quick links for help on HiPerGator and for OnDemand.
 
This link provides access to some quick links for help on HiPerGator and for OnDemand.
  
===Logout===
+
'''Logout'''<br>
 
 
 
This link logs you out of the OnDemand page.
 
This link logs you out of the OnDemand page.
 +
|}
  
 
==Starting an Interactive application==
 
==Starting an Interactive application==
Line 79: Line 69:
 
Version: Select the application version
 
Version: Select the application version
 
This defines the version of the application you want to load.
 
This defines the version of the application you want to load.
 +
<div style="column-count:2">
 +
We recommend leaving the following fields at the default of 1:
 +
*Number of MPI Tasks (--ntasks)
 +
*Number of CPU cores requested per MPI task (--cpus-per-task, -p)
 +
*Maximum memory requested for this job in Gigabytes (--mem, -m)
 +
**'''Note''': If you are using advanced memory options in Additional SLURM Options below, then leave this blank.
 +
*Time Requested for this job in hours (--time, -t)
  
*Number of MPI Tasks (--ntasks): recommended default, 1
+
We recommend leaving the following fields blank as default
 
+
*SLURM Account (--account, -A):  
*Number of CPU cores requested per MPI task (--cpus-per-task, -p): recommended default, 1
+
*QoS (Required if custom Account is set, --qos, -q)
 
+
*Cluster partition (--partition, -p)
*Maximum memory requested for this job in Gigabytes (--mem, -m): recommended default, 1
+
*Generic Resource Request (--gres)
 
+
*Additional SLURM Options
**'''Note: If you are using advanced memory options in Additional SLURM Options below, then leave this blank.'''
+
</div>
 
+
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.
*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.
 
  
 
==Display Environment on the Console==
 
==Display Environment on the Console==
Line 108: Line 90:
 
You can use the "Console" Interactive application from the OOD menu to get a console session enabled with the frame-buffer.  To do this:
 
You can use the "Console" Interactive application from the OOD menu to get a console session enabled with the frame-buffer.  To do this:
  
1) login to https://ood.rc.ufl.edu
+
# login to https://ood.rc.ufl.edu
  {{Note|Please note, you will need to connect to the Gatorlink VPN if you are connecting from off campus or eduroam wifi|warn}}
+
# Select the "Console" Application
 
+
#* Interactive Apps -> Console
2) Select the "Console" Application
+
# Fill in the form with your job resource request (please make sure to ask for at least 4 GB of RAM to make sure you have enough to render the frame buffers) and then select "Launch" at the bottom of the form. For specific parameters, see the [https://help.rc.ufl.edu/doc/GPU_Access#Open_On_Demand_Access Open OnDemand Access] page
 
+
# Select "Launch Console" from the "My Interactive Sessions" page once your job starts.
Interactive Apps -> Console
 
 
 
3) Fill in the form with your job resource request (please make sure to ask for at least 4 GB of RAM to make sure you have enough to render the frame buffers) and then select "Launch" at the bottom of the form. For specific parameters, see the [https://help.rc.ufl.edu/doc/GPU_Access#Open_On_Demand_Access Open OnDemand Access] page
 
 
 
4) Select "Launch Console" from the "My Interactive Sessions" page once your job starts.
 
 
 
  
 
This console session will open in your web browser and will have both the DISPLAY variable set and the X11 server started.
 
This console session will open in your web browser and will have both the DISPLAY variable set and the X11 server started.
Line 129: Line 105:
 
*Select this link to open a new browser window connecting you to your application.
 
*Select this link to open a new browser window connecting you to your application.
  
 +
===Connecting to a HWGUI application===
 +
 +
To use the hardware accelerated resources with your interactive sessions, please select the hwgui partition from the partition list when submitting your job resource form. 
 +
 +
Additionally, many applications that require hardware acceleration by default have been added under the HWGUI Apps section of the Interactive Apps menu.
 +
 +
[[File:OOD-Card.png|600px|right|Example highlighting the components of an OOD connection card]]
 
==Job Connect Card==
 
==Job Connect Card==
 
 
This section outlines several of the key features of the job connect card:
 
This section outlines several of the key features of the job connect card:
  
Line 139: Line 121:
 
# 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
 
# 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
 
# 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]]
 

Latest revision as of 16:46, 5 May 2023

This page provides getting started information for using Open OnDemand to access HiPerGator. 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

If you run into issues, please look at our guide for Open OnDemand Troubleshooting. 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 Play icon.png [5 min, 11 sec] This video covers the use of Open on Demand https://openondemand.org/ on HiPerGator via https://ood.rc.ufl.edu/.

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

Navigating OnDemand Menus

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

On Demand Dashboard

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

If you're having issues, view our tips for the Files App

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.

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

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.

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.

We recommend leaving the following fields at the default of 1:

  • Number of MPI Tasks (--ntasks)
  • Number of CPU cores requested per MPI task (--cpus-per-task, -p)
  • Maximum memory requested for this job in Gigabytes (--mem, -m)
    • Note: If you are using advanced memory options in Additional SLURM Options below, then leave this blank.
  • Time Requested for this job in hours (--time, -t)

We recommend leaving the following fields blank as default

  • SLURM Account (--account, -A):
  • QoS (Required if custom Account is set, --qos, -q)
  • Cluster partition (--partition, -p)
  • Generic Resource Request (--gres)
  • Additional SLURM Options

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.

Display Environment on the Console

You can use the "Console" Interactive application from the OOD menu to get a console session enabled with the frame-buffer. To do this:

  1. login to https://ood.rc.ufl.edu
  2. Select the "Console" Application
    • Interactive Apps -> Console
  3. Fill in the form with your job resource request (please make sure to ask for at least 4 GB of RAM to make sure you have enough to render the frame buffers) and then select "Launch" at the bottom of the form. For specific parameters, see the Open OnDemand Access page
  4. Select "Launch Console" from the "My Interactive Sessions" page once your job starts.

This console session will open in your web browser and will have both the DISPLAY variable set and the X11 server started.

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.

Connecting to a HWGUI application

To use the hardware accelerated resources with your interactive sessions, please select the hwgui partition from the partition list when submitting your job resource form.

Additionally, many applications that require hardware acceleration by default have been added under the HWGUI Apps section of the Interactive Apps menu.

Example highlighting the components of an OOD connection card

Job Connect Card

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

  1. JobID: This is the SLURM JobID for this job
  2. Delete: This will cancel a running job, (or delete the session if the job has already ended)
  3. 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
  4. Image Quality: This setting controls the quality of the visual interface at the source, use a lower setting for slower internet connections
  5. 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
  6. Launch Button: Click this button to connect to your running job in a web-browser session