Skip to content

Commit 63b3cda

Browse files
authored
Updated Open OnDemand docs to reflect that apps now constrain resource options using back-end configurations (#294)
Open OnDemand apps now constrain CPU/cores, memory and GPU options based on the resources available to the back-ends as specified in their Open OnDemand cluster configuration files. There is now no need to users to independently check if a back-end has the resources available. Rephrased relevant text in `docs/safe-haven-services/open-ondemand/`: ```text apps/batch-container-app.md apps/jupyter-app.md apps/jupyter-os-app.md apps/rstudio-app.md getting-started.md ```
1 parent 2fd31c4 commit 63b3cda

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ Complete the following information the app form:
1919
* **Container/image URL in container registry**: URL specifying both the container to run and the container registry from which it is to be pulled. For example, `git.ecdf.ed.ac.uk/tre-container-execution-service/containers/epcc-ces-hello-tre:1.1`. See [Container registries](../containers.md#container-registries) for supported container registries.
2020
* **Container registry username**: A container registry username is required.
2121
* **Container registry access token**: An access token associated with the username is required. Using an access token that grants **read-only** access to the container registry is **strongly recommended**.
22-
* **Container runner**: Container runner - 'podman' or 'apptainer' - with which to run the container. Your selected back-end must have the container runner installed.
22+
* **Container runner**: Container runner - 'podman' or 'apptainer' - with which to run the container.
2323
* **Reuse Apptainer SIF file** (Apptainer only): When Apptainer is used, the container is pulled and an Apptainer SIF file created. The SIF file is created for the container every time. If this option is selected, then, if the SIF file can be found in your home directory, it will be reused, not recreated. SIF files are named after image names. For example, `epcc-ces-hello-tre:1.1.sif`.
2424
* **Container name** (Podman only): Name to be given to the container when it is run. Your job will fail if there is already a running container with that name. If omitted, then the default container name is `CONTAINER_NAME-SESSION_ID`, where `CONTAINER_NAME` is derived from the image name (if the image name is `my-container:1.0` then `CONTAINER_NAME` is `my-container`) and `SESSION_ID` is a unique session identifier for the app's job.
25-
* **CPUs/cores**: CPUs/cores requested for the app's job. Your chosen back-end must have the requested number of cores/CPUs available.
26-
* **Memory (GiB)**: Memory requested for the app's job. Your chosen back-end must have the requested memory available.
27-
* **Use GPU?**: Request that the container use a GPU. Your chosen back-end must have GPUs available.
25+
* **CPUs/cores**: CPUs/cores requested for the app's job.
26+
* **Memory (GiB)**: Memory requested for the app's job.
27+
* **Use GPU?**: Request that the container use a GPU. This option is only shown for back-ends that have a GPU.
2828
* **Container runner command-line arguments**: Command-line arguments to pass to the chosen container runner to control its behaviour.
2929
* **Environment variables**: Environment variables to be set within the container when it runs.
3030
* Each line should define one environment variable and value, each in the form, `ENVIRONMENT_VARIABLE=value`. For example:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Complete the following information the app form:
1414

1515
**National Safe Haven users**: If using a 'desktop' back-end, then you must select the 'desktop' you have been granted access to.
1616

17-
* **CPUs/cores**: CPUs/cores requested for the app's job. Your chosen back-end must have the requested number of cores/CPUs available.
18-
* **Memory (GiB)**: Memory requested for the app's job. Your chosen back-end must have the requested memory available.
17+
* **CPUs/cores**: CPUs/cores requested for the app's job.
18+
* **Memory (GiB)**: Memory requested for the app's job.
1919

2020
Click **Launch**.
2121

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Complete the following information the app form:
1414

1515
**National Safe Haven users**: If using a 'desktop' back-end, then you must select the 'desktop' you have been granted access to.
1616

17-
* **CPUs/cores**: CPUs/cores requested for the app's job. Your chosen back-end must have the requested number of cores/CPUs available.
18-
* **Memory (GiB)**: Memory requested for the app's job. Your chosen back-end must have the requested memory available.
17+
* **CPUs/cores**: CPUs/cores requested for the app's job.
18+
* **Memory (GiB)**: Memory requested for the app's job.
1919

2020
Click **Launch**.
2121

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Complete the following information the app form:
1515
**National Safe Haven users**: If using a 'desktop' back-end, then you must select the 'desktop' you have been granted access to.
1616

1717
* **RStudio Server password**: A password is required to secure RStudio Server. Provide a password to use.
18-
* **CPUs/cores**: CPUs/cores requested for the app's job. Your chosen back-end must have the requested number of cores/CPUs available.
19-
* **Memory (GiB)**: Memory requested for the app's job. Your chosen back-end must have the requested memory available.
18+
* **CPUs/cores**: CPUs/cores requested for the app's job.
19+
* **Memory (GiB)**: Memory requested for the app's job.
2020

2121
Click **Launch**.
2222

docs/safe-haven-services/open-ondemand/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ Read the form entries in conjunction with the explanations below and make the su
5656
* Leave this value as-is.
5757
* **Container registry access token**: An access token associated with the username is required. Using an access token that grants **read-only** access to the container registry is **strongly recommended**.
5858
* Leave this value as-is, the access token provides read-only access to pull the container.
59-
* **Container runner**: Container runner - 'podman' or 'apptainer' - with which to run the container. Your selected back-end must have the container runner installed.
59+
* **Container runner**: Container runner - 'podman' or 'apptainer' - with which to run the container.
6060
* Leave this value as-is i.e., 'podman', as this is available on all back-ends.
6161
* **Container name** (Podman only): Name to be given to the container when it is run. Your job will fail if there is already a running container with that name. If omitted, then the default container name is `CONTAINER_NAME-SESSION_ID`, where `CONTAINER_NAME` is derived from the image name (if the image name is `my-container:1.0` then `CONTAINER_NAME` is `my-container`) and `SESSION_ID` is a unique session identifier for the app's job.
6262
* Leave this value as-is.
63-
* **CPUs/cores**: CPUs/cores requested for the app's job. To run jobs via Open OnDemand requires you to select the resources you think your job will need, including the number of CPUs/cores. Your chosen back-end must have the requested number of cores/CPUs available.
63+
* **CPUs/cores**: CPUs/cores requested for the app's job. To run jobs via Open OnDemand requires you to select the resources you think your job will need, including the number of CPUs/cores.
6464
* Leave this value as-is as the all back-ends can provide the default number of cores, and the `epcc-ces-hello-tre` container does not need any more.
65-
* **Memory (GiB)**: Memory requested for the app's job. Your chosen back-end must have the requested memory available.
65+
* **Memory (GiB)**: Memory requested for the app's job.
6666
* Leave this value as-is as the all back-ends can provide the default memory, and the `epcc-ces-hello-tre` container does not need any more.
67-
* **Use GPU?**: Request that the container use a GPU. Your chosen back-end must have GPUs available.
67+
* **Use GPU?**: Request that the container use a GPU. This option is only shown for back-ends that have a GPU.
6868
* Leave this value as-is, as the `epcc-ces-hello-tre` container does not require a GPU.
6969
* **Container runner command-line arguments**: Command-line arguments to pass to the chosen container runner to control its behaviour.
7070
* Leave this value as-is, as the container does not require any such options to be set.

0 commit comments

Comments
 (0)