diff --git a/doc/source/img/Mistral_actions.png b/doc/source/img/Mistral_actions.png new file mode 100644 index 000000000..cfe36dedc Binary files /dev/null and b/doc/source/img/Mistral_actions.png differ diff --git a/doc/source/img/Mistral_cron_trigger.png b/doc/source/img/Mistral_cron_trigger.png new file mode 100644 index 000000000..0dc85dd2b Binary files /dev/null and b/doc/source/img/Mistral_cron_trigger.png differ diff --git a/doc/source/terminology/actions.rst b/doc/source/terminology/actions.rst index 20a86d2b6..81aa220f1 100644 --- a/doc/source/terminology/actions.rst +++ b/doc/source/terminology/actions.rst @@ -1,4 +1,26 @@ Actions ======= -TBD \ No newline at end of file +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 ` + +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`. diff --git a/doc/source/terminology/cron_triggers.rst b/doc/source/terminology/cron_triggers.rst index f37118064..29f0a1cd2 100644 --- a/doc/source/terminology/cron_triggers.rst +++ b/doc/source/terminology/cron_triggers.rst @@ -1,4 +1,10 @@ Cron-triggers ============= -TBD \ No newline at end of file +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 `_