Open OnDemand¶
Overview¶
OnDemand Loop is deployed as a Phusion Passenger application within the Open OnDemand (OOD) environment, in the same manner as the core OOD dashboard app. This tight integration allows OnDemand Loop to run directly as the current user, giving seamless access to the user's environment on the HPC cluster.
We rely on Open OnDemand to handle all cluster interaction, including authentication, job submission, and terminal access. Additionally, we leverage the OOD Files app to navigate and manage the local HPC filesystem, which is central to how OnDemand Loop reads and writes project data.
Compatibility¶
We have develop the OnDemand Loop Beta version with Open OnDemand version 3.1.7, and we aim to maintain compatibility from this version forward.
Known OOD Releases¶
| OOD Version | Release Date | Status |
|---|---|---|
| 3.1.7 | 2023‑05‑03 | ✅ Tested |
| 3.1.13 | 2025‑05‑23 | 🚫 Not in test scope |
| 3.1.14 | 2025‑07‑11 | 🔜 Planned testing |
| 4.0.0 | 2025‑01‑24 | 🔜 Planned testing |
| 4.0.1 | 2025‑02‑13 | 🚫 Not in test scope |
| 4.0.2 | 2025‑03‑25 | 🚫 Not in test scope |
| 4.0.3 | 2025‑04‑23 | 🚫 Not in test scope |
| 4.0.4 | 2025‑05‑21 | 🚫 Not in test scope |
| 4.0.5 | 2025‑05‑27 | 🚫 Not in test scope |
| 4.0.6 | 2025‑07‑10 | ✅ Tested |
Note
✅ Tested = Confirmed working
⚠️ Not yet tested = Expected compatible, pending verification
🔜 Planned testing = High-priority target for validation
Upgrading Open OnDemand (Development)¶
The Open OnDemand container used in development comes from the ondemand_development project.
Docker images are published under hmdc/sid-ood on Docker Hub and follow the naming convention:
ood-<version>.el8 (e.g., ood-3.1.7.el8)
Currently Supported Open OnDemand versions:
The following images have been configured for compatibility testing and local development:
- v3.1.7
- v3.1.14
- v4.0.0
- v4.0.6
OOD version configuration¶
The environment is configured via the tools/make/ood_versions.mk file.
This file maps each supported Open OnDemand version to its corresponding:
- Docker image (
OOD_IMAGE) - Ruby version (
RUBY_VERSION) - Node.js version (
NODE_VERSION) - Builder image (
LOOP_BUILDER_IMAGE)
The version is selected using the OOD_VERSION variable, which can be set explicitly or defaults to 3.1.7.
To build and start the environment with a specific OOD version:¶
make clean
make release_build OOD_VERSION=3.1.14
make loop_up OOD_VERSION=3.1.14
Development Application Deployment¶
For development purposes, you can build and deploy OnDemand Loop as a development application within your Open OnDemand environment. This approach is useful for testing, customization, or contributing to the project.
make clean
make remote_dev_build
# Copy the ./application folder with the built artifacts into your OnDemand development directory