bump ood app releases, update matlab submit script, optimise portal.yml

Author: bertiethorpe

ansible/portal.yml

@@ -13,10 +13,11 @@
         name: openondemand
         tasks_from: main.yml
 
-- hosts: openondemand_desktop
+- hosts: openondemand_desktop:openondemand_matlab
   tags:
     - openondemand
     - openondemand_desktop
+    - openondemand_matlab
   become: yes
   gather_facts: yes
   tasks:
@@ -49,19 +50,6 @@
         tasks_from: rstudio_compute.yml
       when: appliances_mode != 'configure' # is run during build
 
-# Requires openondemand_matlab_partition to be set in group_vars, as well as MATLAB installed on target compute nodes
-- hosts: openondemand_matlab
-  tags:
-    - openondemand
-    - openondemand_matlab
-  become: yes
-  gather_facts: yes
-  tasks:
-    - import_role:
-        name: openondemand
-        tasks_from: vnc_compute.yml
-      when: appliances_mode != 'configure' # is run during build
-
 - hosts: openondemand_codeserver
   tags:
     - openondemand

ansible/roles/openondemand/defaults/main.yml

@@ -104,5 +104,6 @@ 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 }}"
 
-ondemand_code_server_version: 4.102.2
-ondemand_rstudio_version: 2025.05.1-513
+openondemand_code_server_version: 4.102.2
+openondemand_rstudio_version: 2025.05.1-513
+openondemand_matlab_version: ''

ansible/roles/openondemand/tasks/codeserver_compute.yml

@@ -1,6 +1,6 @@
 - name: Download Code Server RPM
   ansible.builtin.get_url:
-    url: "https://github.com/coder/code-server/releases/download/v{{ ondemand_code_server_version }}/code-server-{{ ondemand_code_server_version }}-amd64.rpm"
+    url: "https://github.com/coder/code-server/releases/download/v{{ openondemand_code_server_version }}/code-server-{{ openondemand_code_server_version }}-amd64.rpm"
     dest: /tmp/code-server.rpm
     mode: '0644'
 
@@ -19,18 +19,18 @@
 
 - name: Create modulefile for Code Server
   copy:
-    dest: "/opt/ohpc/pub/modulefiles/code-server/{{ ondemand_code_server_version }}"
+    dest: "/opt/ohpc/pub/modulefiles/code-server/{{ openondemand_code_server_version }}"
     mode: "0644"
     content: |
       #%Module1.0#####################################################################
 
       proc ModulesHelp { } {
-          puts stderr "This module loads code-server {{ ondemand_code_server_version }}."
+          puts stderr "This module loads code-server {{ openondemand_code_server_version }}."
           puts stderr "\nCode Server provides a browser-based VSCode instance.\n"
       }
 
       module-whatis "Name: code-server"
-      module-whatis "Version: {{ ondemand_code_server_version }}"
+      module-whatis "Version: {{ openondemand_code_server_version }}"
       module-whatis "Category: IDE"
       module-whatis "Description: Run VS Code in your browser with Code Server"
       module-whatis "URL: https://github.com/coder/code-server"

ansible/roles/openondemand/tasks/rstudio_compute.yml

@@ -9,7 +9,7 @@
 
 - name: Download RStudio Server RPM
   ansible.builtin.get_url:
-    url: "https://download2.rstudio.org/server/rhel{{ ansible_distribution_major_version }}/x86_64/rstudio-server-rhel-{{ ondemand_rstudio_version }}-x86_64.rpm"
+    url: "https://download2.rstudio.org/server/rhel{{ ansible_distribution_major_version }}/x86_64/rstudio-server-rhel-{{ openondemand_rstudio_version }}-x86_64.rpm"
     dest: /tmp/rstudio-server.rpm
     mode: '0644'
 
@@ -28,19 +28,19 @@
 
 - name: Write modulefile for RStudio Server
   ansible.builtin.copy:
-    dest: "/opt/ohpc/pub/modulefiles/rstudio-server/{{ ondemand_rstudio_version }}"
+    dest: "/opt/ohpc/pub/modulefiles/rstudio-server/{{ openondemand_rstudio_version }}"
     mode: '0644'
     content: |
       #%Module1.0#####################################################################
 
       proc ModulesHelp { } {
           puts stderr " "
-          puts stderr "This module loads RStudio Server {{ ondemand_rstudio_version }}"
+          puts stderr "This module loads RStudio Server {{ openondemand_rstudio_version }}"
           puts stderr "\nRStudio Server provides a browser-based interface to R.\n"
       }
 
       module-whatis "Name: rstudio-server"
-      module-whatis "Version: {{ ondemand_rstudio_version }}"
+      module-whatis "Version: {{ openondemand_rstudio_version }}"
       module-whatis "Category: IDE"
       module-whatis "Description: RStudio Server - IDE for R"
       module-whatis "URL: https://www.rstudio.com"

docs/openondemand.md

@@ -24,7 +24,7 @@ To enable the Open OnDemand server, add single host to the `openondemand` invent
 
 To enable compute nodes for virtual desktops, Jupyter notebooks, RStudio, VSCode, or MATLAB (accessed through the Open OnDemand portal), add nodes/groups to the `openondemand_desktop`, `openondemand_jupyter`, `openondemand_rstudio`, `openondemand_codeserver`, and `openondemand_matlab` inventory groups respectively. These may be all or a subset of the `compute` group.
 
-*Note* that due to licensing, the MATLAB batch connect app only works with a MATLAB distribution already installed on the target site compute nodes, as well as Lmod configured with the correct modulefiles. MATLAB app also requires the same TurboVNC and Xfce Desktop software installed for the virtual desktop, so this is included for `openondemand_matlab` groups. To enable the MATLAB app, the `openondemand_matlab_partition` must also be defined in group_vars as it is set to `null` by default.
+*Note* that due to licensing, the MATLAB batch connect app only works with a MATLAB distribution already installed on the target site compute nodes, as well as Lmod configured with a module file for the software. See the compute node prerequisite software installation (e.g.`roles/openondemand/tasks/rstudio_compute.yml`) for where these modulefiles are written to. We append them to the `/opt/ohpc/pub/modulefiles` directory on the compute node for simplicity. MATLAB app also requires the same TurboVNC and Xfce Desktop software installed for the virtual desktop, so this is included for `openondemand_matlab` groups. To enable the MATLAB app, the `openondemand_matlab_partition` must also be defined in group_vars as it is set to `''` by default.
 
 The above functionality is configured by running the `ansible/portal.yml` playbook. This is automatically run as part of `ansible/site.yml`.
 

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

@@ -15,7 +15,7 @@ openondemand_auth: basic_pam
 openondemand_jupyter_partition: "{{ openhpc_partitions[0]['name'] }}"
 openondemand_desktop_partition: "{{ openhpc_partitions[0]['name'] }}"
 openondemand_rstudio_partition: "{{ openhpc_partitions[0]['name'] }}"
-openondemand_matlab_partition: null # Requires target site to already have MATLAB so set to null
+openondemand_matlab_partition: '' # Requires target site to already have MATLAB so set to empty
 openondemand_codeserver_partition: "{{ openhpc_partitions[0]['name'] }}"
 
 # Regex defining hosts which openondemand can proxy; the default regex is compute nodes (for apps) and grafana host,
@@ -92,15 +92,15 @@ openondemand_install_app_jupyter:
 openondemand_install_app_rstudio:  # mapping, values as for ansible.builtin.git: repo (required)/dest/version(default main)/umask
   rstudio:
     repo: https://github.com/stackhpc/ood-stackhpc-rstudio.git
-    version: main
+    version: 2025.08.1
 openondemand_install_app_matlab:
   matlab:
     repo: https://github.com/stackhpc/ood-stackhpc-matlab.git
     version: main
 openondemand_install_app_codeserver:
   codeserver:
     repo: https://github.com/stackhpc/bc_osc_codeserver.git
-    version: master
+    version: 2025.08.1
 # osc:ood role var (NB only active when not in configure):
 ood_install_apps: >-
   {{
@@ -197,7 +197,7 @@ openondemand_apps_rstudio_default:
       help: Choose your RStudio module
       widget: select
       options:
-        - ["rstudio-server/{{ ondemand_rstudio_version }}","RStudio v{{ ondemand_rstudio_version }}"]
+        - ["rstudio-server/{{ openondemand_rstudio_version }}","RStudio v{{ openondemand_rstudio_version }}"]
     extra_modules_script:
       label: Extra modules script
       help: If you'd like to load additional modules alongside RStudio-Server, put the 'module load ...' commands into a text file (one 'module load...' per line) and specify its path here
@@ -247,6 +247,7 @@ openondemand_apps_rstudio_default:
       template: "basic"
       conn_params:
         - csrf_token
+        - rstudio_module
     script:
       native:
         - "--partition"
@@ -269,29 +270,62 @@ openondemand_apps_matlab_default:
     - desktop
     - bc_queue
     - bc_num_hours
-    - num_cores
-    - node
+    - matlab_module
+    - cores
+    - ram
   attributes:
     desktop: xfce
     # bc_account: # i.e. slurm account
     #   value: root
     bc_queue:
       value: "{{ openondemand_matlab_partition | default(none) }}"
-    num_cores:
-      label: Number of cores
+    matlab_module:
+      label: MATLAB module
+      required: true
+      cachable: true
+      help: Choose your MATLAB module
+      widget: select
+      options:
+        - ["matlab/{{ openondemand_matlab_version }}","MATLAB v{{ openondemand_matlab_version }}"]
+    cores:
+      label: Number of CPU cores
+      help: How many CPU cores to reserve for your session. NB Ensure this is within the maximum allowed by your chosen partition.
+      widget: number_field
+      min: 1
+      max: 48
+      step: 1
       value: 1
-    node:
-      label: Node name
-      help: Select a particular node or leave empty to let Slurm pick the next available
-      value: ""
+      cachable: true
+    ram:
+      widget: number_field
+      label: RAM in GB
+      help: How much RAM to reserve for your session. NB Ensure this is within the maximum allowed by your chosen partition
+      min: 4
+      max:  700
+      step: 1
+      value: 4
+      cachable: true
+    bc_num_hours:
+      widget: number_field
+      help: Maximum runtime in hours for your session. NB Ensure this is within the maximum allowed by your chosen partition
+      min: 1
+      max: 240
+      step: 1
+      value: 30
+      cachable: true
   submit: |
     ---
     script:
       job_name: "ood-matlab"
       native:
-        - <%= "--nodes=1" %>
-        - <%= "--ntasks=#{num_cores}" %>
-        - <%= "--nodelist=#{node}" %>
+        - "--partition"
+        - "<%= bc_queue %>"
+        - "--ntasks"
+        - "1"
+        - "--mem"
+        - "<%= ram.blank? ? 4 : ram.to_i %>G"
+        - "--cpus-per-task"
+        - "<%= cores.blank? ? 1 : cores.to_i %>"
 openondemand_apps_matlab: "{{ {'matlab':openondemand_apps_matlab_default} if openondemand_matlab_partition | default(none) else {} }}"
 
 openondemand_apps_codeserver_default:
@@ -312,7 +346,7 @@ openondemand_apps_codeserver_default:
       help: Choose your Code Server module
       widget: select
       options:
-        - ["code-server/{{ ondemand_code_server_version }}","Code Server v{{ ondemand_code_server_version}}"]
+        - ["code-server/{{ openondemand_code_server_version }}","Code Server v{{ openondemand_code_server_version}}"]
     bc_queue:
       value: "{{ openondemand_codeserver_partition | default(none) }}"
     cores:
@@ -345,7 +379,7 @@ openondemand_apps_codeserver_default:
     batch_connect:
       template: "basic"
       conn_params:
-        - code_server_version
+        - codeserver_module
     script:
       job_name: "ood-codeserver"
       native: