openstack/deb-mistral
Code Issues Proposed changes

Mistral docs terminology: executions

Browse Source 
Partially implements: blueprint mistral-docs-terminology

Change-Id: Iab9187286cad1d2f591c281d022f9e90a543bfbc
This commit is contained in:
Nikolay Mahotkin 2015-09-02 10:01:27 +03:00
parent e6f2b3f0d2
commit 0ec07768c4
2 changed files with 33 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/dsl/dsl_v2.rst
View File

@ -387,6 +387,8 @@ Reverse Workflow Task Attributes
task. *Optional*.
.. _actions-dsl:
Actions
-------

34
doc/source/terminology/executions.rst
View File

@ -1,17 +1,45 @@
Executions
==========
Executions are runtime objects and they reflect the information about the progress and state of concrete execution type. All executions are persisted in DB.
Workflow Execution
------------------
TBD
A particular execution of specific workflow. When user submits a workflow to run, Mistral creates an object in database for execution of this workflow. It contains all information about workflow itself, about execution progress, state, input and output data. Workflow execution contains at least one *task execution*.
A workflow execution can be in one of a number of predefined states reflecting its current status:
* **RUNNING** - workflow is currently being executed.
* **PAUSED** - workflow is paused.
* **SUCCESS** - workflow has finished successfully.
* **ERROR** - workflow has finished with an error.
Task Execution
--------------
TBD
Defines a workflow execution step. It has a state and result.
**Task state**
A task can be in one of a number of predefined states reflecting its current status:
* **IDLE** - task is not started yet; probably not all requirements are satisfied.
* **WAITING** - task is ready to start but is waiting for specific conditions to perform running.
* **DELAYED** - task was in the running state before and the task execution has been delayed on precise amount of time.
* **RUNNING** - task is currently being executed.
* **SUCCESS** - task has finished successfully.
* **ERROR** - task has finished with an error.
All the actual task states belonging to current execution are persisted in DB.
Task result is an aggregation of all *action executions* belonging to current *task execution*. Usually one *task execution* has at least one *action execution*. But in case of task is executing nested workflow, this *task execution* won't have *action executions*. Instead, there will be at least one *workflow execution*.
Action Execution
----------------
TBD
Execution of specific action. To see details about actions, please refer to :ref:`actions-dsl`
Action execution has a state, input and output data.
Usually action execution belongs to task execution but Mistral also is able to run separate action executions.