Add engine state diagram

Add a nice visual representation of the states the action
engine yields back while executing (which are available from
its run_iter method) and give a brief overview of what these
states mean and how they are used (in diagram and in text).

Change-Id: Idc6abc83e0ed7510c0e4c58b7fcfc26cce3e98a2
This commit is contained in:
Joshua Harlow
2014-05-21 18:49:06 -07:00
committed by Thomas Goirand
parent 1aec454e2f
commit 336caf6ddb
3 changed files with 43 additions and 10 deletions

View File

@@ -232,7 +232,9 @@ The graph (and helper objects) previously created are now used for guiding
further execution. The flow is put into the ``RUNNING`` :doc:`state <states>`
and a
:py:class:`~taskflow.engines.action_engine.graph_action.FutureGraphAction`
object starts to take over and begins going through the stages listed below.
object starts to take over and begins going through the stages listed
below (for a more visual diagram/representation see
the :ref:`engine state diagram <engine states>`).
Resumption
^^^^^^^^^^

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

View File

@@ -1,9 +1,40 @@
------------------------------
States of Task, Retry and Flow
------------------------------
------
States
------
Flow States
===========
.. _engine states:
Engine
======
.. image:: img/engine_states.png
:height: 265px
:align: right
:alt: Action engine state transitions
Executing
---------
**RESUMING** - Prepare flow to be resumed.
**SCHEDULING** - Schedule nodes to be worked on.
**WAITING** - Wait for nodes to finish executing.
**ANALYZING** - Analyze and process result/s of node completion.
End
---
**SUCCESS** - Engine completed successfully.
**REVERTED** - Engine reverting was induced and all nodes were not completed
successfully.
**SUSPENDED** - Engine was suspended while running..
Flow
====
.. image:: img/flow_states.png
:height: 400px
@@ -60,8 +91,8 @@ chance to run.
type of misuse/state violation is occurring, and should be reported as such.
Task States
===========
Task
====
.. image:: img/task_states.png
:height: 265px
@@ -91,8 +122,8 @@ goes to the FAILURE state.
**REVERTED** - The task that has been reverted appears it this state.
Retry States
============
Retry
=====
.. image:: img/retry_states.png
:height: 275px