Skip to content

Commit 63963c5

Browse files
authored
Update docs for trigger-when-paused (#790)
1 parent 6248cad commit 63963c5

File tree

5 files changed

+28
-18
lines changed

5 files changed

+28
-18
lines changed

src/dictionaries/words

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ toolbar
209209
tuple
210210
uiserver
211211
unparsed
212+
unpause
212213
unpaused
213214
unpausing
214215
untracked

src/glossary.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,7 +1151,9 @@ Glossary
11511151

11521152
pause
11531153
When a :term:`workflow` is "paused" the :term:`scheduler` is still
1154-
running but it will not submit any new jobs.
1154+
running but it will not automatically submit new jobs.
1155+
1156+
You can still manually :term:`trigger` tasks in a paused workflow.
11551157

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

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

1250-
When a workflow is resumed, any held tasks remain held.
1252+
When a paused workflow is resumed, any held tasks remain held.
1253+
1254+
If a submitted or running task is held its active job will not be
1255+
affected, but it will not submit any more jobs (such as automatic
1256+
:term:`retries <retry>`) until released.
12511257

12521258

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

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

14901499
message trigger
14911500
A message trigger is a :term:`trigger` based on a

src/user-guide/interventions/index.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -441,53 +441,53 @@ but specify the "failed" output rather than
441441
"succeeded".
442442

443443

444-
Hold The Workflow And Trigger Tasks One By One
445-
----------------------------------------------
444+
Pause The Workflow And Trigger Tasks One By One
445+
-----------------------------------------------
446446

447447
:Example:
448-
I want to hold back the workflow while I manually run one or more tasks
448+
I want to pause the workflow while I manually run one or more tasks
449449
to fix a problem or test a task.
450450

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

457456
.. tab-set::
458457

459458
.. tab-item:: GUI
460459
:sync: gui
461460

462-
.. image:: set-and-release-hold-point.gif
461+
.. image:: trigger-while-paused.gif
463462
:width: 75%
464463

465464
.. tab-item:: CLI
466465
:sync: cli
467466

468467
.. code-block:: console
469468
470-
$ # hold all tasks after the cycle "2000"
471-
$ cylc hold --after=2000 <workflow>
469+
$ # pause the workflow
470+
$ cylc pause <workflow>
472471
473472
$ # trigger the task(s) you want to run
474-
$ cylc trigger <workflow>//<cycle>/<task>
473+
$ cylc trigger --now <workflow>//<cycle>/<task>
475474
476-
$ # release the "hold point" to allow the workflow to continue
477-
$ cylc release --all <workflow>
475+
$ # resume (unpause) the workflow to continue
476+
$ cylc play <workflow>
478477
479478
.. note::
480479

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

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

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

492492

493493
I want to Skip a cycle of tasks and allow the workflow to continue
-3.34 MB
Binary file not shown.
296 KB
Loading

0 commit comments

Comments
 (0)