add support for GRES to ondemand desktop,matlab,rstudio apps

Author: sjpb

ansible/roles/openondemand/README.md

@@ -73,7 +73,11 @@ This role enables SSL on the Open Ondemand server, using the following self-sign
 - `openondemand_desktop_screensaver`: Optional. Whether to enable screen locking/screensaver. **NB:** Users must have passwords if this is enabled. Bool, default `false`.
 - `openondemand_filesapp_paths`: List of paths (in addition to $HOME, which is always added) to include shortcuts to within the Files dashboard app.
 - `openondemand_jupyter_partition`: Required. Name of Slurm partition to use for Jupyter Notebook servers. Requires a corresponding group named "openondemand_jupyter" and entry in openhpc_partitions.
-
+- `openondemand_gres_options`: Optional. A list of `[label, value]` items used
+  to provide a drop-down for resource/GRES selection in application forms. The
+  default constructs a list from all GRES definitions in the cluster. See the
+  `option` attribute of the Select Field [form widget](https://osc.github.io/ood-documentation/latest/how-tos/app-development/interactive/form-widgets.html#form-widgets).
+  
 ### Monitoring
 
 - `openondemand_exporter`: Optional. Install the Prometheus [ondemand_exporter](https://github.com/OSC/ondemand_exporter) on the `openondemand` node to export metrics about Open Ondemand itself. Default `true`.

ansible/roles/openondemand/defaults/main.yml

@@ -102,6 +102,9 @@ openondemand_osc_ood_defaults:
   ood_auth_openidc: "{{ openondemand_auth_defaults.oidc.ood_auth_openidc if (openondemand_auth | lower) == 'oidc' else none }}"
   httpd_auth: "{{ openondemand_auth_defaults[openondemand_auth | lower].httpd_auth }}"
 
+# Apps:
 openondemand_code_server_version: 4.102.2
 openondemand_rstudio_version: 2025.05.1-513
 openondemand_matlab_version: ''
+# Below 
+openondemand_gres_options: "{{ _openondemand_sinfo_gres.stdout | to_gres_options }}"

ansible/roles/openondemand/filter_plugins/filters.py

@@ -0,0 +1,42 @@
+#!/usr/bin/python
+# pylint: disable=missing-module-docstring
+
+# Copyright: (c) 2025, StackHPC
+# Apache 2 License
+
+def to_gres_options(stdout):
+  gres_data = {} # k=gres_opt, v=[label, max_count] # where gres_opt is what would be passed to --gres
+  gres_data['none'] = ['None', 0]
+  
+  for line in stdout.splitlines():
+      if '(null)' in line:
+          continue
+      partition, gres = line.split(' ')
+      gres_name, gres_type, gres_number_cores = gres.split(':', maxsplit=2)
+      gres_count, gres_cores = gres_number_cores.split('(')
+
+      for gres_opt in [gres_name, f'{gres_name}:{gres_type}']:
+          if gres_opt not in gres_data:
+              label = f'{gres_type} {gres_name}' if ':' in gres_opt else f'Any {gres_opt}'
+              gres_data[gres_opt] = [label, gres_count]
+          elif gres_count > gres_data[gres_name][1]:
+              gres_data[gres_opt][1] = gres_count
+  gres_options = []
+  for gres_opt in gres_data:
+      max_count = gres_data[gres_opt][1]
+      label = gres_data[gres_opt][0]
+      if gres_opt != 'none':
+          label += f' (max count: {max_count})'
+      gres_options.append((label, gres_opt))
+  return gres_options
+
+
+# pylint: disable=useless-object-inheritance
+class FilterModule(object):
+    """Ansible core jinja2 filters"""
+
+    # pylint: disable=missing-function-docstring
+    def filters(self):
+        return {
+            "to_gres_options": to_gres_options,
+        }

ansible/roles/openondemand/tasks/main.yml

@@ -39,6 +39,16 @@
     vars_from: main.yml
     public: true
 
+- name: Get GRES information
+  command:
+    cmd: sinfo --noheader --format "%R %G" # can't use , or : as separator
+  register: _openondemand_sinfo_gres
+  # partition_name gres
+  # e.g.
+  # gpu gpu:H200:8(S:0-1)
+  # normal (null)
+  # no_smi (null)
+
 - ansible.builtin.include_role:
     name: osc.ood
     tasks_from: install-apps.yml

environments/common/inventory/group_vars/all/openondemand.yml

@@ -122,16 +122,30 @@ openondemand_apps_desktop_default:
     - bc_queue
     - bc_num_hours
     - num_cores
+    - gres
+    - gres_count
     - node
   attributes:
     desktop: xfce
-    # bc_account: # i.e. slurm account
-    #   value: root
     bc_queue:
       value: "{{ openondemand_desktop_partition | default(none) }}"
     num_cores:
       label: Number of cores
       value: 1
+    gres:
+      label: Resources
+      help: Select GPU or other Slurm GRES resources
+      required: true
+      widget: select
+      options: "{{ openondemand_gres_options }}"
+    gres_count:
+      label: Resource count
+      help: Count of GPU or other resources
+      required: false
+      widget: number_field
+      value: 1
+      min: 1
+      step: 1
     node:
       label: Node name
       help: Select a particular node or leave empty to let Slurm pick the next available
@@ -144,6 +158,9 @@ openondemand_apps_desktop_default:
         - <%= "--nodes=1" %>
         - <%= "--ntasks=#{num_cores}" %>
         - <%= "--nodelist=#{node}" %>
+        <% if gres != 'none' %>
+        - <%= "--gres=#{gres}:#{gres_count}" %>
+        <% end %>
 openondemand_apps_desktop: "{{ {'bc_desktop':openondemand_apps_desktop_default} if openondemand_desktop_partition | default(none) else {} }}"
 
 # yamllint disable-line rule:line-length
@@ -158,12 +175,32 @@ openondemand_apps_jupyter_default:
     - bc_queue
     - bc_num_hours
     - num_cores
+    - gres
+    - gres_count
     - node
   attributes: # TODO
     num_cores:
       label: Number of cores
       value: 1
     modules: ""
+    gres:
+      label: Resources
+      help: Select GPU or other Slurm GRES resources
+      required: true
+      widget: select
+      options: "{{ openondemand_gres_options }}"
+    gres_count:
+      label: Resource count
+      help: Count of GPU or other resources
+      required: false
+      widget: number_field
+      value: 1
+      min: 1
+      step: 1
+    node:
+      label: Node name
+      help: Select a particular node or leave empty to let Slurm pick the next available
+      value: ""
     extra_jupyter_args: ""
     bc_queue:
       value: "{{ openondemand_jupyter_partition | default(none) }}"
@@ -182,6 +219,9 @@ openondemand_apps_jupyter_default:
         - <%= "--nodes=1" %>
         - <%= "--ntasks=#{num_cores}" %>
         - <%= "--nodelist=#{node}" %>
+        <% if gres != 'none' %>
+        - <%= "--gres=#{gres}:#{gres_count}" %>
+        <% end %>
 openondemand_apps_jupyter: "{{ {'jupyter':openondemand_apps_jupyter_default} if openondemand_jupyter_partition | default(none) else {} }}"
 
 openondemand_apps_rstudio_default:
@@ -233,6 +273,20 @@ openondemand_apps_rstudio_default:
     bc_email_on_started: false
     auto_modules_RStudio-Server:
       default: false
+    gres:
+      label: Resources
+      help: Select GPU or other Slurm GRES resources
+      required: true
+      widget: select
+      options: "{{ openondemand_gres_options }}"
+    gres_count:
+      label: Resource count
+      help: Count of GPU or other resources
+      required: false
+      widget: number_field
+      value: 1
+      min: 1
+      step: 1
   form:
     - bc_queue
     - rstudio_module
@@ -242,6 +296,8 @@ openondemand_apps_rstudio_default:
     - ram
     - bc_num_hours
     - bc_email_on_started
+    - gres
+    - gres_count
   submit: |
     ---
     batch_connect:
@@ -261,6 +317,9 @@ openondemand_apps_rstudio_default:
         - "<%= cores.blank? ? 1 : cores.to_i %>"<% if auto_queues.start_with?("gpu") %>
         - "--gpus-per-task"
         - "1"<% end %>
+        <% if gres != 'none' %>
+        - <%= "--gres=#{gres}:#{gres_count}" %>
+        <% end %>
 openondemand_apps_rstudio: "{{ {'rstudio':openondemand_apps_rstudio_default} if openondemand_rstudio_partition | default(none) else {} }}"
 
 openondemand_apps_matlab_default:
@@ -274,6 +333,8 @@ openondemand_apps_matlab_default:
     - matlab_module
     - cores
     - ram
+    - gres
+    - gres_count
   attributes:
     desktop: xfce
     # bc_account: # i.e. slurm account
@@ -314,6 +375,20 @@ openondemand_apps_matlab_default:
       step: 1
       value: 30
       cachable: true
+    gres:
+      label: Resources
+      help: Select GPU or other Slurm GRES resources
+      required: true
+      widget: select
+      options: "{{ openondemand_gres_options }}"
+    gres_count:
+      label: Resource count
+      help: Count of GPU or other resources
+      required: false
+      widget: number_field
+      value: 1
+      min: 1
+      step: 1
   submit: |
     ---
     script:
@@ -327,6 +402,9 @@ openondemand_apps_matlab_default:
         - "<%= ram.blank? ? 4 : ram.to_i %>G"
         - "--cpus-per-task"
         - "<%= cores.blank? ? 1 : cores.to_i %>"
+        <% if gres != 'none' %>
+        - <%= "--gres=#{gres}:#{gres_count}" %>
+        <% end %>
 openondemand_apps_matlab: "{{ {'matlab':openondemand_apps_matlab_default} if openondemand_matlab_partition | default(none) else {} }}"
 
 openondemand_apps_codeserver_default: