Commit Graph

321 Commits

Author SHA1 Message Date
Arnaud Morin 814b7dd4e0 Amend doc to help running tempest mistral tests
As a contributor, when we want to manually run devstack mistral
tempest tests, I was struggling remember how to do it.

Signed-off-by: Arnaud Morin <arnaud.morin@ovhcloud.com>
Change-Id: Ie0791dabf26e5864ec7de1f04331bdef0008a8cc
2023-12-14 08:36:42 +00:00
Zuul 431ece5581 Merge "Info endpoint" 2023-05-17 09:05:03 +00:00
Zuul 4289317a91 Merge "Task skipping feature" 2023-02-14 13:22:17 +00:00
Zuul 5e581ee040 Merge "Adding root_execution_id parameter to mistral loggers" 2023-02-14 10:44:01 +00:00
Vasudeo Nimbekar 88e7e7ceee Adding root_execution_id parameter to mistral loggers
After this patch, user can update logging format to include root_execution_id in logs, which will be helpful to find and debug logs related to specific workflow execution.

  - Logs about creation and status changes of Mistral entities(execution,
    task, action execution, etc) are changed to INFO log level.
  - User can update logging_context_format_string to include root_execution_id in logs.

Implements: Implements: blueprint improve-mistral-loggers

Change-Id: I54fe058e5451abba6ea7f69d03d498d78a90993e
2023-02-13 05:01:39 +00:00
Vasudeo Nimbekar 7c35734300 Merge mistral tasks data to execution context
after this patch user can choose option whether to replace or merge task data to the execution context.
ex: merge_strategy: replace/merge

Implements: blueprint merge-mistral-tasks-data
Change-Id: I3c96bab9953c4995f2b718ac48dff0f153872026
2023-01-31 17:27:17 +05:30
Zuul bfcc417044 Merge "Add an ability to hide sensitive data from http action logs" 2023-01-25 13:49:52 +00:00
Oleg Ovcharuk 3919e6a52b Add an ability to hide sensitive data from http action logs
Opportunity to hide sensitive data from http action logs, such as:
* Request headers
* Request body
* Response body

Change-Id: I6d1b1844898343b8fa30f704761096e3d2936c4d
Implements: blueprint mistral-hide-sensitive-data-from-http-actions-logs
Signed-off-by: Oleg Ovcharuk <vgvoleg@gmail.com>
2023-01-24 21:54:00 +00:00
Arnaud Morin e75b6b356f Refactor mistral documentation
* renaming developer doc to contributor doc
* flattening contributor doc to ease reading the whole content in a shot
* rewrite devstack documentation
* adding Axel and myself as maintainers

Signed-off-by: Arnaud Morin <arnaud.morin@ovhcloud.com>
Change-Id: If25d342c7cc2568b2d86c88bf6a049522559bf50
2023-01-18 21:20:28 +01:00
Arnaud Morin c77a51a05a Fix doc builds
A new release of dnspython has been release, which is breaking the docs
tests. See [1]

dnspython is fixed to <2.3.0 in upper-constraints, so we should rely on
requirements.txt from mistral to trigger the correct build.

[1] https://github.com/eventlet/eventlet/issues/781

Signed-off-by: Arnaud Morin <arnaud.morin@ovhcloud.com>
Change-Id: I5f86f8264792c8e651c0bb2d2f63151657fea1be
2023-01-18 18:02:03 +01:00
Oleg Ovcharuk e72a4e9a70 Task skipping feature
This patch adds an ability to rerun failed workflow by
skipping failed tasks. Workflow behavior in skip case could
be configured by new fields in task definition:
* on-skip
* publish-on-skip

Change-Id: Ib802a1b54e69c29b4d0361f048c2b9c076a4c176
Implements: blueprint mistral-task-skipping-feature
Signed-off-by: Oleg Ovcharuk <vgvoleg@gmail.com>
2022-12-01 01:47:30 +03:00
Oleg Ovcharuk 517789943a Info endpoint
For many various support reasons, Mistral should have a special
endpoint to store all necessary info data. This endpoint will read
json from created by admin info file. To configure this you should
use mistral configuration:

[api]
enable_info_endpoint = True
info_json_file_path = info.json

Change-Id: I6f344dc15a4ca5c69a6b21841544a31f95eb393f
Implements: blueprint mistral-info-endpoint
Signed-off-by: Oleg Ovcharuk <vgvoleg@gmail.com>
2022-11-17 22:06:37 +00:00
shanyunfan33 fbf8091364 remove unicode from code
remove unicode from code

Change-Id: Ief9d24e83d74c1f7bf17c96abd713ee5b563361d
2022-08-12 14:41:59 +00:00
Manpreet Kaur b64ba9a43f [Doc] Moving to OFTC
This patch updates Freenode to OFTC as IRC server in document.

Change-Id: I90cd2f1460151e3e8b21717eff5e4a9df940daa4
2021-06-02 22:36:48 +05:30
Daniel Pawlik 85b9b525fb Change get-pip url
The path for get-pip.py script in version 3.2 has been changed
with this commit [1].

[1] 2360f025eb

Change-Id: I3986238b0a65fb652b30a8a47448a1d02212166e
2021-03-08 15:06:51 +01:00
Renat Akhmerov 4319dbcb36 Add API docs for code sources and dynamic actions
Change-Id: I2b1c85803ea60e621b08192ec3644f071a74ebb6
2021-01-04 20:24:28 +07:00
Ghanshyam Mann 7cf2014c2e [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc and tests.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: I3b9aeb3379a76f7e40dab0c46e27f4447a0c3d03
2020-12-22 16:47:46 +07:00
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
Andreas Jaeger 4b52d4d458 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Remove python 3 versioning from lower-constraints and
requirements to pass requirements-check.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Id478711abb1783422ebb4ee9937d1b7202fdf2f3
2020-05-21 15:50:23 +02:00
hyunsikYang d33313f84e typo of guide 'How to write a Custom Action in mistral'
Change-Id: I48f36ad4ed2decc872e7a5ab2e086283d504da89
Related-Bug: #1874391
2020-04-23 08:06:11 +00:00
Renat Akhmerov c90472d3e6 [ussuri][goal] Add project specific contributor docs
* This patch adds more content to the contributor docs as described
  at https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Change-Id: I6eea5db63070bd60fe2475f1fd34e43f855f6aa2
2020-04-17 15:19:36 +07:00
Renat Akhmerov 6fb17d8266 Add YAQL sanitizing for iterators
* This patch also adds handling for iterators in the sanitizing
  function for YAQL results. JSON serialization for iterators now
  works correctly but the issue is that they can be used only once.
  So, for example, if we got a result from YAQL and performed JSON
  serialization for it, then the iterator is already empty and
  the data structure is just corrupted. So we can't further pass
  to executors and other subsystems. The solution is just to sanitize
  iterators after they're just returned from YAQL.
* Added a test to make sure that action input reaches an executor
  not corrupted, although it gets saved into DB and hence serialized
  into JSON.
* Changed the Sphinx entry in requirements.txt so that the version
  3.0.0 is now excluded (it breaks the build).

Closes-Bug: #1871567
Change-Id: I47abe0904b49d72e33eb10080c71fb81980d44da
2020-04-08 15:44:13 +07:00
Zuul 0237898d59 Merge "Remove OpenStack actions from mistral" 2020-03-06 09:08:24 +00:00
Zuul 3ca452229c Merge "Add an article about profiling into the docs" 2020-03-04 12:02:22 +00:00
Renat Akhmerov cc825ebcd3 Add an article about profiling into the docs
Change-Id: I79befa91fcaf393ec19498372f1e6c6953151867
2020-03-04 17:30:05 +07:00
Andrea Visnyei a683984001 Removing duplicated descriptions
Removed dupliocated Mistral overviews and merged content into description on
 index page.

Change-Id: Ia7c260494a8a659988db2329bf3504be9b4b67fa
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2020-03-02 07:17:48 +00:00
Eyal 8bdf341af7 Remove OpenStack actions from mistral
Depends-on: https://review.opendev.org/#/c/703296/
Depends-On: https://review.opendev.org/#/c/704280/
Change-Id: Id62fdabe7699e7c3b2977166e253cfc77779e467
2020-02-26 10:12:01 +02:00
Zuul 8fa44a6215 Merge "Adjust images in the docs and other small fixes" 2020-01-27 09:44:13 +00:00
Zuul 2a714b49de Merge "Move "Long Running Business Process" article from Wiki to docs" 2020-01-27 09:44:12 +00: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 6928615fde Move "Long Running Business Process" article from Wiki to docs
* Moved from
  https://wiki.openstack.org/wiki/Mistral/Long_Running_Business_Process

Change-Id: I573a7dc6079c7218c7d0dd38385db5cece07f0d4
Closes-Bug: #1779318
2020-01-27 11:45:47 +07:00
Zuul 1f703e19b0 Merge "Move the article about testing from Wiki to the built-in docs" 2020-01-23 14:24:35 +00:00
Zuul e41ed12148 Merge "Move FAQ from Wiki to the built-in docs" 2020-01-23 14:24:34 +00:00
Zuul 44ff14109c Merge "Move "Cloud Cron" cookbook from Wiki to the built-in docs" 2020-01-23 14:24:33 +00:00
Renat Akhmerov 9dfdd20541 Move the article about testing from Wiki to the built-in docs
* Significant part of the original article is outdated
  (https://wiki.openstack.org/wiki/Mistral/Testing) so only the actual
  parts were moved.

Partial-Bug: #1779318

Change-Id: Ia5a43db418282041c6e169e301528ef1a35777af
2020-01-23 17:27:13 +07:00
Renat Akhmerov 12b2eceb35 Move FAQ from Wiki to the built-in docs
* This patch moves the list of frequently asked questions from
  https://wiki.openstack.org/w/index.php?title=Mistral&oldid=152120
  to the docs. However, it makes some changes because some info
  is already outdated.

Change-Id: I55a80ed2906bb3fae101d9adc044ed028b6a9d24
Partial-Bug: #1779318
2020-01-23 17:27:11 +07:00
Zuul f662bf8be1 Merge "The first iteration of restructuring Mistral doc" 2020-01-23 07:12:56 +00:00
Renat Akhmerov 5c05636ee4 Move "Cloud Cron" cookbook from Wiki to the built-in docs
* Since Mistral Wiki has been retired we need to move all important
  info published there into the docs residing in the project repo.
  This patch moves the article published at
  https://wiki.openstack.org/wiki/Mistral/Cookbooks/AdministrationCloudCron
  to the docs.

Change-Id: I4764fb3beba1ff05091a4ce04c93fe56d39528d5
Partial-Bug: #1779318
2020-01-23 11:41:28 +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
Eyal 55f181f8aa Fix requirements remove py2
Change-Id: If18cd11db29a45f64666172674e1eb55b0a51d73
2020-01-15 16:17:26 +02:00
Renat Akhmerov 63ab3d4062 Add the 1st version of Mistral coding guidelines into the docs
Change-Id: I07f3f7e83f7521c320f6b21b806692289c8a01ab
2020-01-09 17:16:56 +07:00
Zuul f6c2db1a48 Merge "Add pdf build support" 2019-11-14 13:42:56 +00:00
caoyuan 6e89218125 tox: Keeping going with docs
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: Ife98c47af59355540fa30d7ca762f857759c1274
2019-10-24 13:20:19 +00: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
Eyal 0b8dd84b18 Add a cookiecutter template to generate custom stuff
* Custom actions and yaql expressions

Change-Id: I5843135fb8adbeb73d1e205cf81f4c60e8b5b306
2019-09-11 16:39:35 +03:00
Bo Tran 6418132a9b Fix missing in workflow documents
Fix error missing of change-id: Ic3ca93c967269fe0f4c3f7124470fb04661122ed
Thanks you!

Change-Id: I334067414efdcca281f0a300d3cc9a4ebdb90cba
2019-09-10 15:21:11 +07:00
Bo Tran f13b69ca69 Fix workflow documents
Change the way get result of tasks

Change-Id: Ic3ca93c967269fe0f4c3f7124470fb04661122ed
2019-09-09 17:40:56 +07:00
Andras Kovi 5eb2a21607 Improve workflow notifications and webhook data
The task_execution_id is required to be able to restore the hierarchy
of tasks and workflows on the notification receiver side. Also, including
the event in the notification is very useful.

Also fix the documentation as multiline strings are not supported in
ini files.

Change-Id: I714fd5c32b0f31f85ac5a4d22d161e662bf18687
2019-09-04 07:12:20 +02: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
Zuul ee94087c89 Merge "Create docs for the workflow namespaces feature" 2019-08-08 09:31:02 +00:00