From a0f2cc24ccdb7dd490ab22c44cdc19ff3b869b21 Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Fri, 26 Nov 2021 11:48:36 +0000 Subject: [PATCH] platforms: document how to run jobs on a homeless platform. --- .../config/writing-platform-configs.rst | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/src/reference/config/writing-platform-configs.rst b/src/reference/config/writing-platform-configs.rst index 9d13387a83..c2d5b4c66e 100644 --- a/src/reference/config/writing-platform-configs.rst +++ b/src/reference/config/writing-platform-configs.rst @@ -289,3 +289,44 @@ platform. Job files can be installed on the workflow host. Therefore the same names **cannot** be used for platforms and platform groups. The ``global.cylc`` file will fail validation if the same name is used in both. + +Platform with no ``$HOME`` directory +------------------------------------ + +.. admonition:: Scenario + + You are trying to run jobs on a platform where the compute nodes don't + have a configured ``HOME`` directory. + +So long as the login and compute nodes share a filesystem the workflow can be +installed on the shared filesystem using +:cylc:conf:`global.cylc[install][symlink dirs]`. + +The ``$CYLC_RUN_DIR`` variable can then be set on the compute node to point +at the ``cylc-run`` directory on the shared filesystem using +:cylc:conf:`global.cylc[platforms][]global init-script`. + + .. code-block:: cylc + :caption: part of a ``global.cylc`` config file + + [platforms] + [[homeless-hpc]] + job runner = my-job-runner + install target = homeless-hpc + global init-script = """ + export CYLC_RUN_DIR=/shared/filesystem/cylc-run + """ + + [install] + [[symlink dirs]] + [[[homeless-hpc]]] + run = /shared/filesystem/ + +In this example Cylc will install workflows into +``/shared/filesystem/cylc-run``. + +.. note:: + + If you are running :term:`schedulers ` directly on the login node + and submitting jobs locally then the platform name and install target should + be ``localhost``.