Evaluate workflow names dynamically, so yaql or jinja expression
is allowed as sub-workflow name. Tasks names are not yet
dynamically evaluated.
Partially implements: blueprint mistral-dynamic-actions
Change-Id: Icfe591e27a4f45c2e3dcfa83512217f3b2122189
doc8 is a linter for documents and used in openstack-manuals. It is better to enforce
document linters for simple checking. This change is to add doc8 in tox file and fix
line too long in some files.
The current rules are as bellow:
- invalid rst format - D000
- lines should not be longer than 79 characters - D001
- no trailing whitespace - D002
- no tabulation for indentation - D003
- no carriage returns (use unix newlines) - D004
- no newline at end of file - D005
Change-Id: Ibba3f0e1c3f724563deb27bbf4f13a8040799687
Closes-bug: #1709571
Added the admin guide in the mistral document index file as per
the doc-migration spec.
Change-Id: I821257f5be8b6778b1a6eaf9c138a06cef8b2792
Closes-Bug: #1706449
The Mistral Upgrade Guide and Mistral Workflow Language Specification
links were misplaced. Changed them. Also removed the unwanted admin
index page.
Change-Id: I49984971ee8ae10105291043ee3240133784fed2
Closes-Bug: #1705462
There is a note saying that nested ad-hoc actions are not supported.
https://review.openstack.org/#/c/334312/ has added this feature.
Change-Id: Ieb17560e57d622507d09c86311014b583d1a4d3a
Closes-Bug: #1705183
In the file doc/source/configuration/index.rst, update the
reference link of policy.json from Mitaka to newest Ocata.
Closes-Bug: #1704081
Change-Id: I25d8a5e8e35cb2ad90bbc42734e4cd4aeac2ac13
As it is required in [1] warning-is-error should be
set for doc building. This change sets the flag and
corrects the warnings.
[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Change-Id: Ia93fd13645830cd8994ef283b72f31cb22cf3fe9
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
This change aligns the Mistral documents folder structure to
the one specified for Pike [1].
Documents were move to thir appropriate folder, but the different
guides do not follow their cookie cutted structure yet.
Install guide is in a separate change [2], while I could not
found the cookie cutter for the rest of the guides.
test-requirements.txt updated with the missing modules.
tox_install.sh modified to do not pass $MODULE_NAME and -e parameter to
edit-constraints.
[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
[2]: https://review.openstack.org/#/c/476499/
[3]: https://etherpad.openstack.org/p/doc-migration-tracking
Change-Id: Ia1101fa2eada446d8eebfefa9bd15d8facd8b3b0
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: Ic0686fc1f1128d52c2ffb195d3cedb30de6f9c73
Contents on the configuration guide page is out-of-date. This patch
updates the contents.
Change-Id: I8f951380739924e52ba257f176115916738ee9bf
Closes-Bug: #1697139
The configuration guide still mentions few deprecated config
options like rabbit_userid, rabbit_host, rabbit_password and
rpc_backend which are deprecated. They are replaced by the
transport_url option.
Change-Id: Iec8ce5c857c4bc0d3f7729d6b71de77cf0addc03
Bug-Id: #1695857
Sometimes people get confused when DSL is used. So, to overcome it
Mistral Workflow Language is used instead of DSL throughout the
documentation.
Change-Id: Ic7516b4f45854fd9960cef3e529dcb507439f8e6
Partially-implements: blueprint add-documentation
* After updating Sphinx to 1.6.2 Sphinx this extension got broken
and our Mistral "doc" CI job too
* We don't use Flask in the project anyway
Change-Id: I051ec26e155344684b69bad6a50f2162febbc928
* There was too much of information in the README.rst which was
redundant. So, added some useful links in the file and removed
redundant information.
* Added the debug_guide which provides some brief information
about the debugging of mistral.
Change-Id: I9d3505864bec6b7ae4e4b2c386a98fd5a808564a
Partial-Implements: blueprint mistral-doc
Implements: blueprint mistral-docs-troubleshooting
Mistral is a service, without a public Python API (other than the
actions api which is being moved out). Therefore including the Python
code in the documentation isn't useful. While it is present, it often
comes up in search results which will be confusing for most users.
Change-Id: Ib9d5e1a7baecf70d8e224cff470f968012317edd
A new option was intorduced to execution_expiration_policy to limit
the amount of finished and not expired executions. This can be used
to keep the number of finished executions under a limit, even if a
huge number of executions are created in a short period of time.
Change-Id: I05a604285a6fc510dd224613215dac8d2c31c541
Related-Bug: #1658946
The previous version contained badly formatted reStructuredText which
caused rendering issues. It also contained the help output for commands,
but it wasn't updated or complete.
This new document tells used how to view and use the CLI so they can get
the help output easily themselves. This removes the rendering issues and
the need to keep this page updated.
Change-Id: Ic97185035ef22a9d6d291b9f396488139e8a7e2d
The examples in this page hit some limitations with the lexer, so it was
updated to handle the unknown tokens and better handle unicode
whitespace characters.
Change-Id: I7883072844ae99bedb8a4c080572da5a31590dd5
The YAQL documentation has greatly improved recently, we should just
reference that rather than starting our own documentation for YAQL.
We may want to include some Mistral specific examples, if we do, we can
re-add this file when needed. Having a file that isn't included in the
documentation tree causes Sphinx to show a warning.
Change-Id: Id7d054697038be5a2e1c03854a8e8f7259e8a7e6
The current example fails highlighting and is skipped because the YAML
lexer rejects it as invalid. This causes a warning to be displayed.
Change-Id: I86c4570fd1f422651a4711417410e7c7b7515637
This isn't valid and causes the following error:
mistral/mistral/doc/source/developer/asynchronous_actions.rst:134:
WARNING: Could not lex literal_block as "HTTP". Highlighting skipped.
Change-Id: Ibd0ce0a52f623ef8b48eefcfaa7c40e8d70c6d0a
This allows us to use the following code blocks in the Mistral documentation.
.. code-block:: mistral
When we do that the code will then be highlighted in a way specific to
Mistral, rather than the generic YAML highlighting or none.
Change-Id: Ie25725b9f803e247d23f58c4b602be938c75cfbd
As there are few more fields added to the client and the document
was not updated, this commit updates the output of each command
accordingly.
Change-Id: Ie5c87b269a58c79bf37c7a93b79d6068352b79bd
Closes-Bug: #1670329
tasks function can be used to get all tasks in state error
of a given workflow execution and more.
Change-Id: I64e101bf36e0d865342e848723b610bfe23423d9