Skip to content

Commit

Permalink
Update docs for trigger-when-paused (#790)
Browse files Browse the repository at this point in the history
  • Loading branch information
wxtim authored Jan 8, 2025
1 parent 6248cad commit 63963c5
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 18 deletions.
1 change: 1 addition & 0 deletions src/dictionaries/words
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ toolbar
tuple
uiserver
unparsed
unpause
unpaused
unpausing
untracked
Expand Down
13 changes: 11 additions & 2 deletions src/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1151,7 +1151,9 @@ Glossary

pause
When a :term:`workflow` is "paused" the :term:`scheduler` is still
running but it will not submit any new jobs.
running but it will not automatically submit new jobs.

You can still manually :term:`trigger` tasks in a paused workflow.

This can be useful if you want to make a change to a running workflow.

Expand Down Expand Up @@ -1247,7 +1249,11 @@ Glossary
:term:`Tasks <task>` can be :term:`held <hold>` with ``cylc hold`` and
:term:`released <release>` with ``cylc release``.

When a workflow is resumed, any held tasks remain held.
When a paused workflow is resumed, any held tasks remain held.

If a submitted or running task is held its active job will not be
affected, but it will not submit any more jobs (such as automatic
:term:`retries <retry>`) until released.


release
Expand Down Expand Up @@ -1486,6 +1492,9 @@ Glossary
:term:`custom <custom output>` task outputs. In the latter case they
are known as :term:`message triggers <message trigger>`.

The term "trigger" also refers the action of manually triggering
a task to run, via the ``cylc trigger`` command or the GUI.


message trigger
A message trigger is a :term:`trigger` based on a
Expand Down
32 changes: 16 additions & 16 deletions src/user-guide/interventions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -441,53 +441,53 @@ but specify the "failed" output rather than
"succeeded".


Hold The Workflow And Trigger Tasks One By One
----------------------------------------------
Pause The Workflow And Trigger Tasks One By One
-----------------------------------------------

:Example:
I want to hold back the workflow while I manually run one or more tasks
I want to pause the workflow while I manually run one or more tasks
to fix a problem or test a task.

:Solution:
* Hold all tasks after a specified cycle.
* Pause the workflow.
* Trigger the task(s) you want to run.
* When you're done triggering, release the held tasks to allow the workflow
to continue.
* When you're done triggering, resume (unpause) the workflow.

.. tab-set::

.. tab-item:: GUI
:sync: gui

.. image:: set-and-release-hold-point.gif
.. image:: trigger-while-paused.gif
:width: 75%

.. tab-item:: CLI
:sync: cli

.. code-block:: console
$ # hold all tasks after the cycle "2000"
$ cylc hold --after=2000 <workflow>
$ # pause the workflow
$ cylc pause <workflow>
$ # trigger the task(s) you want to run
$ cylc trigger <workflow>//<cycle>/<task>
$ cylc trigger --now <workflow>//<cycle>/<task>
$ # release the "hold point" to allow the workflow to continue
$ cylc release --all <workflow>
$ # resume (unpause) the workflow to continue
$ cylc play <workflow>
.. note::

The difference between the workflow "paused" state and the task "held" state:

Workflow Pause
When a workflow is :term:`paused <pause>`, no new jobs will be submitted.
This gives you an opportunity to make changes to the workflow, however, if
you trigger tasks, they will not run until the workflow is resumed.
When a workflow is :term:`paused <pause>` new jobs will not be submitted
automatically, but you can still trigger tasks manually.
This gives you an opportunity to make changes to the workflow.

Task Hold
When a task is :term:`held <hold>`, then it will not submit (if ready to
submit) until released.
submit) until released. If you hold a running task its job will not be
affected, but it will not submit any :term:`retries <retry>` until released.


I want to Skip a cycle of tasks and allow the workflow to continue
Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 63963c5

Please sign in to comment.