Skip to content

Commit 2d0ae94

Browse files
authored
Rework Open OnDemand text to deemphasise CES (#278)
Reworked Open OnDemand text in `docs/safe-haven-services/open-ondemand/**` to deemphasise CES, and containers, as Open OnDemand can run non-CES/container-based apps.
1 parent e388d4e commit 2d0ae94

File tree

14 files changed

+90
-87
lines changed

14 files changed

+90
-87
lines changed
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# About the TRE Open OnDemand service
22

3-
The TRE Open OnDemand service is a web service that runs within a safe haven. The service allows you to run compute and data-related tasks on compute resources available to your safe haven.
4-
5-
The service provides a number of apps that allow for researchers' containers - which package up software, services and their dependencies - to be executed via the TRE Container Execution Service as well as providing apps supporting the execution of standard containers with useful services such as JupyterLab and RStudio Server.
3+
The TRE Open OnDemand service is a web service that runs within a safe haven. The service provides a suite of apps that allows you to run compute and data-related tasks and packages on compute resources available to your safe haven.
64

75
![Open OnDemand home page](../../images/open-ondemand/home-page.png){: class="border-img center"} *Open OnDemand home page*
86

97
To quickly get started with the TRE Open OnDemand Service (hereon referred to as Open OnDemand for brevity):
108

119
* [Access Open OnDemand](access.md).
12-
* Follow [Getting started](getting-started.md) to walk through the key points of the service and using it to run containers via the TRE Container Execution Service.
10+
* Follow [Getting started](getting-started.md) to walk through the key points of the service.
11+
12+
!!! Note
13+
14+
The TRE Open OnDemand service is implemented using [Open OnDemand](https://openondemand.org/).

docs/safe-haven-services/open-ondemand/access.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ To access Open OnDemand:
1414
* Smart Data Foundry, `https://smartdf-ondemand.nsh.loc`
1515
* DataLoch, `https://dap-ondemand.nsh.loc`
1616
1. If using Falkon and an SSL Certificate Error! dialog appears with text 'Would you like to make an exception for this certificate?', then:
17-
* Click **Yes**. It is OK to ignore this error in this specific case, as you are within your safe haven within the TRE, contacting a Safe Haven Services service also running within your safe haven. This error arises as, at time of writing, the certificates for the TRE services have not been installed on your VM.
17+
* Click **Yes**. It is OK to ignore this error in this specific case, as you are within your safe haven within the TRE, contacting a Safe Haven Services service also running within your safe haven. This error arises because, at time of writing, certificates for this service have not been installed on your VM.
1818
1. If using Firefox and a Warning: Potential Security Risk Ahead page appears with text 'Error code: SEC_ERROR_UNKNOWN_ISSUER', then
1919
1. Click **Advanced...**
20-
1. Click **Accept the Risk and Continue**. It is OK to accept this risk in this specific case, as you are within your safe haven within the TRE, contacting a Safe Haven Services service also running within your safe haven. This warning arises as, at time of writing, the certificates for the TRE services have not been installed on your VM.
21-
1. The Open OnDemand log in page will appear.
20+
1. Click **Accept the Risk and Continue**. It is OK to accept this risk in this specific case, as you are within your safe haven within the TRE, contacting a Safe Haven Services service also running within your safe haven. This warning arises because, at time of writing, certificates for this service have not been installed on your VM.
21+
1. A log in page will open.
2222

23-
![Open OnDemand log in page](../../images/open-ondemand/login-page.png){: class="border-img center"} *Open OnDemand log in page*
23+
![Log in page](../../images/open-ondemand/login-page.png){: class="border-img center"} *Log in page*
2424

25-
1. Enter your project username and password. These are the same username and password that you used when logging into your safe haven VM.
26-
1. Click **Log in**
25+
1. Enter your project username and password. These are the same username and password that you use when logging into your safe haven VM.
26+
1. Click **Log in**.
2727
1. The [Open OnDemand home page](home-page.md) will open.
2828

2929
### Troubleshooting: Bad Request
@@ -32,8 +32,8 @@ If you see a page with text:
3232

3333
> Your browser sent a request that this server could not understand.
3434
35-
then revisit the URL and try to log in again. This can arise if there is information in your browser cache from a previous Open OnDemand session.
35+
then revisit the URL and try to log in again. This can arise if there is information in your browser cache from a previous session.
3636

3737
### Troubleshooting: Cannot access Open OnDemand
3838

39-
'For any other problems logging into Open OnDemand, first double-check your username and password. If you still have no success, then please contact your Research Coordinator (or equivalent).
39+
For any other problems logging in, first double-check your username and password. If you still have no success, then please contact your Research Coordinator (or equivalent).

docs/safe-haven-services/open-ondemand/apps.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44

55
## Introduction
66

7-
The following apps are available on Open OnDemand.
7+
The following apps are available as part of Open OnDemand's app suite:
88

99
| App | Type | Description |
1010
| --- | ---- | ----------- |
11-
| [Active Jobs](apps/active-jobs.md) | System Installed App | Open OnDemand app that allows you to browse and manage jobs created via both apps and the Job Composer app |
12-
| [Run Batch Container](apps/batch-container-app.md) | Tenant and TRE Service | Container Execution Service app that allows you to run a batch container on a back-end |
13-
| [Run JupyterLab Container](apps/jupyter-app.md) | Tenant Service | Container Execution Service app that allows you to run a JupyterLab container on a back-end |
14-
| [Run RStudio Server Container](apps/rstudio-app.md) | Tenant Service | Container Execution Service app that allows you to run an RStudio Server container on a back-end |
15-
| [Job Composer](apps/job-composer.md) | System Installed App | Open OnDemand app that allows you to submit a Slurm batch job to a back-end |
11+
| [Active Jobs](apps/active-jobs.md) | System Installed App | Browse and manage jobs created via both apps and the Job Composer app |
12+
| [Run Batch Container](apps/batch-container-app.md) | Tenant and TRE Service | Run a batch container on a back-end |
13+
| [Run JupyterLab Container](apps/jupyter-app.md) | Tenant Service | Run a JupyterLab container on a back-end |
14+
| [Run RStudio Server Container](apps/rstudio-app.md) | Tenant Service | Run an RStudio Server container on a back-end |
15+
| [Job Composer](apps/job-composer.md) | System Installed App | Write and submit a Slurm batch job to a back-end |
1616

1717
The app types are:
1818

19-
* 'System Installed App': apps provided with Open OnDemand.
20-
* 'Tenant Service': apps to run jobs on back-ends within your safe haven.
21-
* 'Tenant and TRE Service': apps to run jobs on back-ends within both your safe haven and on TRE-level compute resources.
19+
* 'System Installed App': General purpose apps provided with Open OnDemand.
20+
* 'Tenant Service': Apps to run jobs on back-ends within your safe haven.
21+
* 'Tenant and TRE Service': Apps to run jobs on back-ends within both your safe haven and on TRE-level compute resources.
2222

2323
Open OnDemand supports a number of ways by which you can see the apps available to you and select an app to run.
2424

@@ -60,6 +60,6 @@ Click **My Interactive Sessions** (overlaid squares icon) on the menu bar to ope
6060

6161
![My Interactive Sessions menu button, an overlaid squares icon](../../images/open-ondemand/my-interactive-sessions-button.png){: class="border-img center"} ***My Interactive Sessions** menu button*
6262

63-
The My Interactive Sessions page has a **selection** of the apps available to you on the left-hand-side.
63+
The My Interactive Sessions page has a **selection** of the interactive apps available to you on the left-hand-side.
6464

6565
Click an app-specific button to access that app.

docs/safe-haven-services/open-ondemand/apps/active-jobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Active Jobs
22

3-
Active Jobs is an Open OnDemand app that allows you to see which of your jobs have been submitted, are running, or have completed.
3+
Active Jobs is an app that allows you to see which of your jobs have been submitted, are running, or have completed.
44

55
The Active Jobs app shows a table of running and recently completed jobs.
66

docs/safe-haven-services/open-ondemand/apps/batch-container-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Run Batch Container
22

3-
Run Batch Container is a Container Execution Service app that allows you to run a container on a back-end. The app is designed to run batch containers, those that perform some computational or data-related task without human interaction when they are running. The app is **not** designed for containers that spawn interactive services (for example, JupyterLab).
3+
Run Batch Container is an app that allows you to run a container on a back-end. The app is designed to run batch containers, those that perform some computational or data-related task without human interaction when they are running. The app is **not** designed for containers that spawn interactive services (for example, JupyterLab).
44

55
Containers run **must** conform to the [Container requirements](../containers.md#container-requirements) of the TRE Container Execution Service.
66

docs/safe-haven-services/open-ondemand/apps/job-composer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Job Composer
22

3-
Job Composer is an Open OnDemand app that allows you to submit a Slurm batch job to a back-end.
3+
Job Composer is an app that allows you to write and submit a Slurm batch job to a back-end.
44

55
!!! Note
66

docs/safe-haven-services/open-ondemand/apps/jupyter-app.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Run JupyterLab Container
22

3-
Run JupyterLab Container is a Container Execution Service app that allows you to run a JupyterLab container on a back-end within your safe haven.
4-
5-
The container is run using Podman.
3+
Run JupyterLab Container is an app that runs a JupyterLab container on a back-end within your safe haven. The JupyterLab container was built for the TRE Open OnDemand service. The container is run using Podman.
64

75
---
86

docs/safe-haven-services/open-ondemand/apps/rstudio-app.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Run RStudio Server Container
22

3-
Run RStudio Server Container is a Container Execution Service app that allows you to run an RStudio Server container on a back-end within your safe haven.
4-
5-
The container is run using Podman.
3+
Run RStudio Server Container is an app that runs an RStudio Server container on a back-end within your safe haven. The RStudio Server container was built for the TRE Open OnDemand service. The container is run using Podman.
64

75
---
86

docs/safe-haven-services/open-ondemand/containers.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
## Introduction
44

5-
The TRE Open OnDemand service is intended to allow you to run jobs that run containers, which package up software, services a nd their dependencies. This includes both your own project-specific containers that you have been authorised to run within your safe haven as well as standard containers with useful services such as JupyterLab and RStudio Server.
5+
Some Open OnDemand apps allow you to run containers, which package up software, services and their dependencies. Some of the apps provided by Open OnDemand run containers built for the TRE Open OnDemand service (e.g., JupyterLab and RStudio Server). Other apps allow you to run your own project-specific containers that you have been authorised to run within your safe haven.
66

77
Container are typically run using Podman or Apptainer, depending on which of these is available on a back-end. Some Open OnDemand apps will select which to use, others allow you to choose.
88

9-
[Run jobs](jobs.md) introduces how Open OnDemand runs tasks, and information you need to know about when running tasks. The page focuses on aspects of running containers within this job execution environment.
9+
[Run jobs](jobs.md) described concepts you need to know about how Open OnDemand runs tasks and apps. The page focuses on concepts related to running containers.
1010

1111
---
1212

1313
## Container requirements
1414

15-
Open OnDemand uses the Container Execution Service tools to run containers. Consequently, containers run via Open OnDemand **must** conform to the requirements of the Container Execution Service. See the [TRE Container User Guide](../tre-container-user-guide/introduction.md) for details of these requirements.
15+
Open OnDemand uses the TRE Container Execution Service tools to run containers. Consequently, containers run via Open OnDemand **must** conform to the requirements of the TRE Container Execution Service. See the [TRE Container User Guide](../tre-container-user-guide/introduction.md) for details of these requirements.
1616

1717
---
1818

1919
## Container registries
2020

21-
The container registries supported by the Container Execution Service, and so accessible from within Open OnDemand, are as follows:
21+
The container registries supported by the TRE Container Execution Service, and so supported by Open OnDemand and its apps, are as follows:
2222

2323
| Container Registry | URL prefix | Example |
2424
| ------------------ | ---------- | ------- |
@@ -27,13 +27,13 @@ The container registries supported by the Container Execution Service, and so ac
2727

2828
!!! Note
2929

30-
For ECDF GitLab, do not put the port number, 5050, into the URL. The Container Execution Service tools will automatically insert this into ECDF GitLab URLs.
30+
For ECDF GitLab, do not put the port number, 5050, into the URL. The TRE Container Execution Service tools will automatically insert this into ECDF GitLab URLs.
3131

3232
---
3333

3434
## Sharing files between a back-end and a container
3535

36-
When the container is run, three directories on the back-end are mounted into the container:
36+
When a container is run via the TRE Container Execution Service, three directories on the back-end are always mounted into the container:
3737

3838
| Back-end directory | Container directory | Description |
3939
| ------------------ | ------------------- | ----------- |
@@ -43,6 +43,10 @@ When the container is run, three directories on the back-end are mounted into th
4343

4444
Together, these mounts provides a means for data, configuration files, scripts and code to be shared between the back-end on which the container is running and the environment within the container itself. Creating or editing a file within any of these directories on the back-end means that the changes will be available within the container, and vice-versa.
4545

46+
!!! Note
47+
48+
Some apps may mount additional app-specific directories into a container and/or allow you to do so yourself.
49+
4650
You can interact with your project's `/safe_data` subdirectory on the back-end, by logging into the back-end, see [Log into back-ends](ssh.md).
4751

4852
When using a back-end where your home directory is common to both the Open OnDemand VM and the back-end, then you can interact with both `safe_outputs/APP_SHORT_NAME/SESSION_ID` and `scratch/APP_SHORT_NAME/SESSION_ID` (and `$HOME/safe_data`, if applicable) via the [File Manager](files.md) and/or by logging into the back-end, see [Log into back-ends](ssh.md).
@@ -79,7 +83,7 @@ For some containers run using Podman that you will find that you the 'root' user
7983

8084
Any files you create in the directories mounted into the container will be owned by your own user, and user group, on the back-end.
8185

82-
For containers run using Apptainer, you will be your own user within the container.
86+
For containers run using Apptainer, you will be your own user within the container.
8387

8488
As a concrete example, consider the `epcc-ces-hello-tre` example container (described in [Getting started](getting-started.md)) which outputs in a log file the permissions of the directories mounted into the a container (as described above).
8589

0 commit comments

Comments
 (0)