openstack/deb-mistral
Code Issues Proposed changes

Update the wording in the actions terminology docs

Browse Source 
This patch rewords the action terminology to improve the readability.

Change-Id: I5bdb6c1ab9b10d2dc6ad19a335c04048cf01a89e
This commit is contained in:
Dougal Matthews 2016-12-06 10:47:12 +00:00
parent f6e4e237d1
commit 24405a4f99
1 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,20 +1,20 @@
Actions Actions
======= =======
A particular instruction associated with a task that needs to be performed Actions are a particular instruction associated with a task that will be
once the task runs. It can be anything like: running a shell script, HTTP performed when the task runs. For instance: running a shell script, making an
request or sending a signal to some system external to Mistral. Actions can be HTTP request, or sending a signal to an external system. Actions can be
synchronous or asynchronous. synchronous or asynchronous.
In case of synchronous action, Mistral will send a signal to the Mistral With synchronous actions, Mistral will send a signal to the Mistral Executor
Executor and will be waiting for the result from the Executor. Once the and wait for a result. Once the Executor completes the action, the result will
Executor completes the action, it sends the result to the Mistral Engine. be sent to the Mistral Engine.
In case of asynchronous action, Mistral will send a signal to third party With asynchronous actions, Mistral will send a signal to a third party service
service and will be waiting for a corresponding action result to be delivered and wait for a corresponding action result to be delivered back via the Mistral
back to the Mistral API. Once the signal is sent, Mistral won't care more API. Once the signal has been sent, Mistral isn't responsible for the state and
about action state and result. Third party service should send a request to result of the action. The third-party service should send a request to the
the Mistral API and provide info about corresponding *action execution* and Mistral API and provide information corresponding to the *action execution* and
its state and result. its state and result.
.. image:: /img/Mistral_actions.png .. image:: /img/Mistral_actions.png
@ -24,9 +24,8 @@ its state and result.
System actions System actions
-------------- --------------
System actions are provided by Mistral out of the box and can be used by System actions are provided by Mistral out of the box and are available to all
anyone. It is also possible to add system actions for specific Mistral users. Additional actions can be added via the custom action plugin mechanism.
installation via a special plugin mechanism.
:doc:`How to write an Action Plugin </developer/creating_custom_action>` :doc:`How to write an Action Plugin </developer/creating_custom_action>`
@ -34,9 +33,15 @@ installation via a special plugin mechanism.
Ad-hoc actions Ad-hoc actions
-------------- --------------
Ad-hoc actions are a special types of actions that can be created by user. Ad-hoc actions are defined in YAML files by users. They wrap existing actions
Ad-hoc actions are always created as a wrapper around any other existing and their main goal is to simplify using the same action multiple times. For
system actions and their main goal is to simplify using same actions example, if the same HTTP request is used in multiple workflows, it can be
many times with similar pattern. defined in one place and then re-used without the need to duplicate all of the
parameters.
.. note:: Nested ad-hoc actions currently are not supported (i.e. ad-hoc action around another ad-hoc action). More about actions - :ref:`actions-dsl`. More about actions; :ref:`actions-dsl`.
.. note::
Nested ad-hoc actions (i.e. ad-hoc actions wrapping around other ad-hoc
actions) are not currently supported.