openstack/mistral
Code Issues Proposed changes

Clarify usage of break-on and continue-on

Browse Source 
Usage of break-on and continue-on are not very clear. This hopefully
gives some pointers on their usage.

Change-Id: Ide237a23ab85fac7342a8fc9bf748fd0b78bf41d
This commit is contained in:
Brad P. Crochet 2018-03-15 08:29:27 -04:00
parent c77e230a48
commit f2d8b14ac1
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/main_features.rst
View File

@ -138,6 +138,14 @@ There are different types of policies in Mistral.
All parameter values for any policy can be defined as YAQL expressions.
**NOTE:** It would be rare to use both break-on and continue-on in the same
retry block. *break-on* should be used when one expects the action to be in an
ERROR state for some amount of tries, but may eventually go to a SUCCESS state,
thereby stopping the loop. But if *break-on* is *'true'* then the retries will
stop and the task will be in ERROR. *continue-on* should be used if the action
will usually return *SUCCESS*, but the action has other results that can be
used to signal whether to continue the loop or not.
Join
----

8
doc/source/user/wf_lang_v2.rst
View File

@ -385,6 +385,14 @@ Retry policy can also be configured on a single line as:
All parameter values for any policy can be defined as YAQL/Jinja2 expressions.
**NOTE:** It would be rare to use both break-on and continue-on in the same
retry block. *break-on* should be used when one expects the action to be in an
ERROR state for some amount of tries, but may eventually go to a SUCCESS state,
thereby stopping the loop. But if *break-on* is *'true'* then the retries will
stop and the task will be in ERROR. *continue-on* should be used if the action
will usually return *SUCCESS*, but the action has other results that can be
used to signal whether to continue the loop or not.
Input syntax
''''''''''''