Skip to content

Installation Guide

jdeananderson edited this page Jan 3, 2025 · 5 revisions

Installation Guide

Prerequisites

On the OnDemand Server

  • Open OnDemand Server with Slurm scheduler
  • Slurm spank plugin support

On cluster nodes

  • Virtualization must be enabled
  • qemu-kvm
  • smbd must be installed, but not configured or running
  • container support (apptainer or similar)
  • node.js
  • Slurm spank plugin support

System Requirements

  • Operating System compatibility
  • Hardware requirements
  • Software dependencies
  • Network requirements

Step-by-Step Installation

  1. Step 1

    # Installation commands
  2. Step 2

    # Configuration commands

Configuration

Basic Configuration

# Example configuration file
key: value
setting: option

Advanced Configuration

  • Custom settings
  • Environment variables
  • Configuration file options

Common Issues & Troubleshooting

Issue Cause Solution
Error 1 Cause 1 Solution 1
Error 2 Cause 2 Solution 2

Selecting Job Connection Options

When submitting a job through Open OnDemand, you can enable or disable each connection method in the submit.yml.erb file.

Example Configuration in submit.yml.erb:

"--iso-netns-options"
    - "guacamole=1,vnc=0,xxxx=1"

How it Works:

  • Each connector (guacamole, vnc, xxxx) is either enabled (1) or disabled (0).
  • Enabled connectors appear as buttons on the job card and the job waits for these services to start before being considered "Running" instead of "Starting."

Ways to Set These Options:

  • Administrator-Defined: Hardcode the options in submit.yml.erb.
  • User-Selectable: Expose the options as form variables in form.yml so that users can choose their preferred connection method at job submission time.