Skip to content
Closed
Changes from all commits
Commits
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
43 changes: 38 additions & 5 deletions cylc/flow/cfgspec/globalcfg.py
Original file line number Diff line number Diff line change
Expand Up @@ -826,11 +826,44 @@ def default_for(
range.
''')
Conf('condemned', VDR.V_ABSOLUTE_HOST_LIST, desc=f'''
These hosts will not be used to run jobs.
List run hosts that workflows should *not* run on.

If workflows are already running on
condemned hosts, Cylc will shut them down and
restart them on different hosts.
Any hosts listed here will be subtracted from the
`available <global.cylc[scheduler][run hosts]>`
hosts:

* Workflows will not start on condemned hosts.
* Workflows that are running on condemned hosts will attempt
to migrate to an uncondemned host (providing the
`auto restart
<global.cylc[scheduler][main loop][auto restart]>`
plugin is enabled).

This feature can be used to drain a host for patching, or
remove a host that is surplus to requirement.

Hostnames listed here may be followed by a ``!`` character.
This activates "force mode", workflows running on a
force-condenmed host will shutdown rather than attempting to
migrate (providing the
`auto restart
<global.cylc[scheduler][main loop][auto restart]>` plugin
is enabled).

.. rubric:: Example:

.. code-block:: cylc

[scheduler]
[[run hosts]]
# there are three hosts in the "pool"
available = host1, host2, host3

# however two have been taken out:
# * workflows running on "host1" will attempt to
# restart on "host3"
# * workflows running on "host2" will shutdown
condemned = host1, host2!

.. seealso::

Expand Down Expand Up @@ -1336,7 +1369,7 @@ def default_for(
The means by which task progress messages are reported back to
the running workflow.

..rubric:: Options:
.. rubric:: Options:
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Unrelated syntax error.


zmq
Direct client-server TCP communication via network ports
Expand Down