openstack/deb-mistral
Code Issues Proposed changes

Mistral terminology: cron-triggers and actions

Browse Source 
Implements blueprint: mistral-docs-terminology

Change-Id: I56e45122fdbeddf0dfa79a1904a8fd646d03d7ad
This commit is contained in:
Nikolay Mahotkin 2015-09-02 15:42:42 +03:00
parent f450651551
commit 6288bf2ec0
4 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/source/img/Mistral_actions.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
doc/source/img/Mistral_cron_trigger.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.3 KiB

24
doc/source/terminology/actions.rst
View File

@ -1,4 +1,26 @@
Actions
=======
TBD
A particular instruction associated with a task that needs to be performed once the task runs. It can be anything like running a shell script, HTTP request, AMQP message or any signal sent to any system external to Mistral. Actions can be synchronous or asynchronous.
In case of asynchronous action Mistral will send a signal to third party service and will be waiting for a corresponding action result to be delivered back to Mistral API. Once the signal is sent, Mistral won't care more about action state and result. Third party service should do a request to Mistral API and provide info about corresponding *action execution* and its state and result.
In case of synchronous action, Mistral will send a signal to Mistral Executor and will be waiting for the result from Executor. Once Executor completes action, it sends the result to Mistral Engine.
.. image:: /img/Mistral_actions.png
System Actions
--------------
System actions are provided by Mistral out of the box and can be used by anyone. It is also possible to add system actions for specific Mistral installation via a special plugin mechanism.
:doc:`How to write an Action Plugin </developer/creating_custom_action>`
Ad-hoc Actions
--------------
Ad-hoc actions are a special types of actions that can be created by user. Ad-hoc actions are always created as a wrapper around any other existing system actions and their main goal is to simplify using same actions many times with similar pattern.
.. note:: Nested ad-hoc actions currently are not supported (i.e. ad-hoc action around another ad-hoc action).
.. note:: More about actions - :ref:`actions-dsl`.

8
doc/source/terminology/cron_triggers.rst
View File

@ -1,4 +1,10 @@
Cron-triggers
=============
TBD
Cron trigger is an object allowing to run workflow on a schedule. User specifies what workflow with what input needs to be run and also specifies how often it should be run.
.. image:: /img/Mistral_cron_trigger.png
:align: center
Cron-pattern is used to describe the frequency of execution in Mistral.
To see more about cron-patterns, refer to `Cron expression <https://en.wikipedia.org/wiki/Cron#CRON_expression>`_