Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update platforms admin doc. #486

Merged
merged 3 commits into from
Jun 29, 2022
Merged

Update platforms admin doc. #486

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f53e8a
Update platforms admin doc.
hjoliver Jun 28, 2022
5f89a11
Tweak.
hjoliver Jun 28, 2022
8f95cad
Update src/reference/config/writing-platform-configs.rst
hjoliver Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/reference/config/writing-platform-configs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,20 +145,25 @@ Background Jobs on Cluster with Other Options
- Allow some background jobs to use an alternative shell,
or an alternative ssh command.

.. note::

The "background" and "at" job runners require single-host platforms,
because the job ID is only valid on the submission host.

.. code-block:: cylc
:caption: part of a ``global.cylc`` config file

[platforms]
[[spice_cluster_background]]
hosts = login_node_1, login_node_2
hosts = login_node_1
job runner = background
[[spice_cluster_background_fish]]
hosts = login_node_1, login_node_1
hosts = login_node_2
job runner = background
# Use fish shell
shell = /bin/fish
[[spice_cluster_long_ssh]]
hosts = login_node_1, login_node_1
hosts = login_node_1
job runner = background
# extend the default ssh timeout from 10 to 30 seconds.
ssh command = myPeculiarSSHImplementation --someoption=yes
Expand All @@ -167,7 +172,7 @@ Background Jobs on Cluster with Other Options
Submit PBS Jobs from Localhost
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- **Platforms can share hosts and not share batch systems.**
- **Platforms can share hosts without sharing batch systems.**
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Off topic, but as-is this could be interpreted as saying "platforms cannot share batch systems"?)

hjoliver marked this conversation as resolved.
Show resolved Hide resolved

.. admonition:: Scenario

Expand Down