Commit Graph

29 Commits

Author SHA1 Message Date
Renat Akhmerov d81dc75a3c Remove the module mistral/actions/action_factory.py
* This module was always a weird entity in the system having just
  one function that essentially creates a dynamic class. It was
  created just because we didn't understand where else to put this
  function. But now after the action provider refactoring we don't
  need it anymore. Action instantiation is now a responsibility of
  action descriptor classes.

Change-Id: Ic4b6a9a7ca2784a892d2998359edb220ff8c8911
2020-10-05 16:15:13 +07:00
Renat Akhmerov 0ec5e48012 Adjust images in the docs and other small fixes
* Some ".. image:" RST directives changed to ".. figure:" where
  it's more suitable.
* All images moved to subfolder where they're used
* Fixed indentation in the Workflow Language specification
* Other minor changes in docs

Change-Id: If2f206a5191d1eecdcf95e1f7b44a87968432876
2020-01-27 11:45:49 +07:00
Renat Akhmerov 9fb213c315 The first iteration of restructuring Mistral doc
* Grouped documentation articles into several main parts: user docs,
  admin docs, developer docs.
* Changed the index page so that it contains links to the index pages
  of the main documentation parts like user docs, admin docs etc.
* Fixed all the broken links
* Removed index generation since it's not informative at all in its
  current form and it exposes code internals (REST controller class
  names)
* Removed obsolete properties that are no longer used by the
  "openstackdocstheme" project
* Removed obsolete static html files
* Moved part of the images to the folders where they are used

Further work:

* Refactor main chapters (user, admin, developer) one by one and
  make them look consistent. For example, there are several pages
  that provide similar kind of information: overview, quick start,
  main features etc. It is a mess that's been accumulated throughout
  the last 4-5 years.
* Fill the gaps. Add all missing pages like: event notifications,
  workflow environment, etc.
* Move cookbooks from Wiki to this doc.

Partially implements: blueprint mistral-restructure-docs
Change-Id: Ia722a6885ad2fb97d63a34285b0a5b1a23da79e8
2020-01-22 14:06:51 +07:00
Dharmendra 3bedead733 Add pdf build support
For more details, please refer:
https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Change-Id: Id3ee99c8793e53b396b80ad02f8bde69aadddc3c
2019-10-22 12:19:46 +00:00
Oleg Ovcharuk 4e926a1f13 Fail-on policy
Fail-on policy allows to fail success tasks by condition. It is useful
in cases we have to fail task if its result is unacceptable and it makes
workflow definition more readable.

Change-Id: I57b4f3d1533982d3b9b7063925f8d70f044aefea
Implements: blueprint fail-on-policy
Signed-off-by: Oleg Ovcharuk <vgvoleg@gmail.com>
2019-08-11 07:21:57 +00:00
Renat Akhmerov 7ae3ec0caf Provide better docs for the "target" task attribute
Change-Id: Ibb0daac0f5f155f4aa7458ab81044fa097c0ea29
Closes-Bug: #1781556
2019-08-02 15:35:43 +07:00
TitanLi 1a2ff63733 A1 B should be tasks rather than workflow levels
recheck no bug A1 and B should be in the task area

Change-Id: If8ff2a19068fd3aebb3f9d3a55d9ed6dfaefdb14
2019-08-02 12:43:19 +08:00
apetrich 9289f7d28e Add release notes to changes to wflanguage execution object
Change-Id: I976fe5723a8bad81f1c6e30618475aa34e3e2050
depends-on: Ia6c954e688589f69a7463f1b8e02244d029e8b7a
2019-06-03 13:58:43 +02:00
Zuul d5d258e552 Merge "Docs improvements: task timeout, global context, Docker and jinja" 2019-05-03 18:35:02 +00:00
Vitalii Solodilov 09cd21d561 Docs improvements: task timeout, global context, Docker and jinja
A not obvious point for users is the task does not retry after a
timeout is triggered. Added clarification in the retry section.

The documentation contains enough example with Jinja usage. Improved
only the create_vm workflow definition.

Added global publishing to the doc. It is brash copy-paste from
https://specs.openstack.org/openstack/mistral-specs/specs/pike/approved/advanced_publishing.html without mention of atomic publish.

Move Docker guides to the installation section.

Change-Id: I149b2e1dff7f86bd356f4dd2f758659469e6a4a8
Closes-Bug: #1789384
Closes-Bug: #1690156
Closes-Bug: #1779244
Signed-off-by: Vitalii Solodilov <mcdkr@yandex.ru>
2019-05-03 17:26:57 +00:00
zhu.boxiang 13d8f532b9 Docs: Change description from on-success to on-error
As was explained above from the example, here it is
on-error clause.

Change-Id: I67d649091e46df0123a236044eb46b3a078b68d2
2019-04-29 14:45:15 +08:00
Oleg Ovcharuk f9f994751a Add delay option to std.echo to emulate external lags.
Change-Id: Id177246996434d2ad1c111b0b7bf78664390045a
Signed-off-by: Oleg Ovcharuk <vgvoleg@gmail.com>
2019-04-24 07:25:19 +00:00
Marc Gariepy 2cbf543103 Add reply-to to std.email
Reply to address is useful when sending email from an unmonitored email
address and to give user a place to respond in order to contact us.

Add Reply-to as described in section 3.6.2 of RFC5222
https://tools.ietf.org/html/rfc5322#section-3.6.2

Change-Id: Ib6b2bdc130e4f9e5170eb88760d69c3e08d2a1c7
2019-04-15 06:35:31 +00:00
Marc Gariepy 9c65b7d271 Fix doc
smtp_password is Optional in 'std.email'.

Change-Id: If2ae751780eb99f04f920ebb6b7e121225a81280
2019-04-10 11:36:29 -04:00
guotao.bj 278fc3319a Remove those copy words occured twice times in wf_lang_v2.rst
Change-Id: I5e8e0fca235e34b0663c4557c9e3405abfcd5e36
2019-01-04 11:50:58 +00:00
Jose Castro Leon 3c430ef0a2 Improve std.email action
Adds support for cc and bcc addresses to send mails as copy to
administrators and also html formatting. If the html body is specified
the mail will be sent as multipart.

Closes-Bug: #1783349

Change-Id: I2b90354c33052c4b7ae3a98a08e7df1055524a25
2018-07-31 08:43:03 +02:00
Andras Kovi c08e44f17b Allow engine commands as task name
A change for disabling some task names has introduced a massively
backward incompatible behavior. E.g. even though there is a 'noop' engine
command, the usual way of handling noop is in many cases is to create a
task called the same. The other commands are not used that often but
noop is massively present in currently deployed workflows and it is
not possible to mitigate the error if the workflows are coming from
3rd parties.

This change re-enables the usage of the engine commands as task names
and adds documentation on why this is a useful feature.

Change-Id: If90ee5f787e4587a25c156d12c7750407081bf0d
Related-Change: https://review.openstack.org/#/c/535297
2018-07-19 14:23:18 +00:00
Zuul 85a24b20a6 Merge "Added 'safe-rerun' policy to task-defaults section" 2018-04-25 15:56:53 +00:00
Vitalii Solodilov 5f89e2e71f Added JavaScript evaluator which doesn't require a compilation
* Added new JavaScript evaluator py_mini_racer. Advantages:
    * is distributed as wheel package
    * supports differences platforms
    * live project
* BUILD_V8EVAL was removed because it was replaced by py_mini_racer in
Mistral Docker image
* Added stevedore integration to javascript evaluators
* Refreshed javascript tests. Add test for py_mini_racer evaluator
* Install py_mini_racer library in during mistral test
* Refreshed javascript action doc

Change-Id: Id9d558b9b8374a2c2639e10cb1868f4e67f96e86
Implements: blueprint mistral-add-py-mini-racer-javascript-evaluator
Signed-off-by: Vitalii Solodilov <mcdkr@yandex.ru>
2018-04-23 17:04:18 +00:00
Vitalii Solodilov a29c7d9f7f Added 'safe-rerun' policy to task-defaults section
Change-Id: Ib6641bda008a813660af5584c9319fcaddcd416f
Signed-off-by: Vitalii Solodilov <mcdkr@yandex.ru>
2018-04-23 20:46:43 +04:00
Tovin Seven e7da6af151 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ic260c2534d3b9ae0baca9ac11cb8b7ad4fc37184
2018-04-20 16:57:04 +07:00
Brad P. Crochet 7657458e61 Fix join examples and text
The 'join' example for using a number did not have a proper workflow.
It looks like it was copied from the 'all' example and not completely
changed. Also, disambiguate the wording of the description for that
example. It used the word 'once' in a place where it looked as though
it meant 'one time' instead of 'as soon as'.

Change-Id: I9b89768c0f0b7d325db08ea9345965a9263a64c8
Closes-Bug: #1761827
2018-04-06 14:17:39 -04:00
hardikj f5c0be6ee9 Fix std.ssh "password" parameter
Fixes the bug where calling std.ssh action without "password" input was resulting in error.
Closes-bug: #1756272

Change-Id: I5f7af13326933658014a9c42c495d779bec7f14f
2018-03-27 15:27:15 +05:30
Brad P. Crochet f2d8b14ac1 Clarify usage of break-on and continue-on
Usage of break-on and continue-on are not very clear. This hopefully
gives some pointers on their usage.

Change-Id: Ide237a23ab85fac7342a8fc9bf748fd0b78bf41d
2018-03-15 08:29:27 -04:00
Zuul 3426fb4080 Merge "Fixed the length of a task name" 2018-03-13 11:50:26 +00:00
Vitalii Solodilov 4a077b6f98 Fixed the length of a task name
* verified the length of task name while creating a workflow
* fixed bug when join task has a long name
* added the length limitation to the spec docs

Change-Id: I233e6b0f30d42b939757e9c1caf4965ecc375aee
Signed-off-by: Vitalii Solodilov <mcdkr@yandex.ru>
2018-03-09 11:02:48 +04:00
Vitalii Solodilov d2ffecd003 Add the 'error_data' parameter to the FailAction
This may be useful for a testing purpose if you want to emulate a
action error with data for timeout, retry and the rest of task policies

Change-Id: I679b8338dade284817000670e96ab108481372ae
Signed-off-by: Vitalii Solodilov <mcdkr@yandex.ru>
2018-02-25 08:19:57 +00:00
Renat Akhmerov 7423a58365 Explain better combinations of task names and engine commands in docs
Closes-Bug: #1682377
Change-Id: I6c53fc6b3debaf27b01a03b5180f3ef56ddf3e8f
2018-02-20 10:31:30 +02:00
Renat Akhmerov 57e6936d6c Fix docs to better reflect Jinja and YAQL usage
Closes-Bug: #1641174
Change-Id: I6e2a10932c648836a1e0632b4cd0fce3ab78f946
2018-01-31 17:27:09 +07:00