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
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
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
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>
* 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
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
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>
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>
The path for get-pip.py script in version 3.2 has been changed
with this commit [1].
[1] 2360f025eb
Change-Id: I3986238b0a65fb652b30a8a47448a1d02212166e
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
* 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
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
* 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
Removed dupliocated Mistral overviews and merged content into description on
index page.
Change-Id: Ia7c260494a8a659988db2329bf3504be9b4b67fa
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
* 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
* 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
* 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
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
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
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>