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

Jump to bottom

Fix docstring broken WRT config changes #3978

Merged
merged 1 commit into from
Dec 3, 2020
Merged

Fix docstring broken WRT config changes #3978

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 14 additions & 11 deletions cylc/flow/main_loop/auto_restart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"""Automatically restart suites if they are running on bad servers.

Loads in the global configuration to check if the server a suite is running
on is listed in :cylc:conf:`global.cylc[scheduler]condemned hosts`.
on is listed in :cylc:conf:`global.cylc[scheduler][run hosts]condemned`.

This is useful if a host needs to be taken off-line e.g. for scheduled
maintenance.
Expand All @@ -36,13 +36,15 @@

- [Normal Mode]

- When a host is added to the :cylc:conf:`condemned hosts` list, any suites
- When a host is added to the
:cylc:conf:`global.cylc[scheduler][run hosts]condemned` list, any suites
running on that host will automatically shutdown then restart selecting a
new host from :cylc:conf:`run hosts`.
new host from :cylc:conf:`global.cylc[scheduler][run hosts]available`.
- For safety, before attempting to stop the suite cylc will first wait
for any jobs running locally (under background or at) to complete.
- *In order for Cylc to be able to successfully restart suites the
:cylc:conf:`run hosts` must all be on a shared filesystem.*
:cylc:conf:`global.cylc[scheduler][run hosts]available` must all be on a
shared filesystem.*

- [Force Mode]

Expand All @@ -58,21 +60,22 @@

[scheduler]
[[run hosts]]
available = pub
condemned = foo, bar!
available = pub
condemned = foo, bar!

.. warning::

Cylc will reject hosts with ambiguous names such as ``localhost`` or
``127.0.0.1`` for this configuration as `:cylc:conf:`condemned hosts`
``127.0.0.1`` for this configuration as
`:cylc:conf:`[scheduler][run hosts]condemned`
are evaluated on the suite host server.

To prevent large numbers of suites attempting to restart simultaneously the
:cylc:conf:`[scheduler]auto restart delay` setting defines a period of time in
seconds.
:cylc:conf:`global.cylc[scheduler]auto restart delay` setting defines a period
of time in seconds.
Suites will wait for a random period of time between zero and
:cylc:conf:`[scheduler]auto restart delay` seconds before attempting to stop
and restart.
:cylc:conf:`global.cylc[scheduler]auto restart delay` seconds before
attempting to stop and restart.

Suites that are started up in no-detach mode cannot auto stop-restart on a
different host - as it will still end up attached to the condemned host.
Expand Down