303 Commits

Author SHA1 Message Date
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
Renat Akhmerov
059248f86e Create docs for the workflow namespaces feature
Closes-Bug: #1757102

Change-Id: I4bc6feec72973469ddafab1ce06cff9c8affd48c
2019-08-07 15:53:26 +07: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
Zuul
e35407a6d6 Merge "Bump openstackdocstheme to 1.30.0" 2019-06-06 10:09:44 +00:00
翟小君
6dc981d814 Bump openstackdocstheme to 1.30.0
Some minor updates including fixing issues with the HTML5 output
generated by Sphinx 2.0, inlining the OpenStack logo rather than
referencing it from elsewhere, and adding a new SOURCE_DATE_EPOCH option
for use in reproducible builds in new release openstackdocstheme 1.30.0.
...to pick up many improvements, including the return of table borders.

Change-Id: I22b652e1eb007616e697cb238fcd9e5f010cd693
2019-06-06 14:27:41 +08:00
pengyuesheng
0731cd1d87 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details
Depend-On: https://review.opendev.org/#/c/663060/

Change-Id: Ia9ab0cfb134f0f6ca168e8e746582fe1fc7c9710
2019-06-06 11:02:02 +08:00
Zuul
38d0abb139 Merge "Add release notes to changes to wflanguage execution object" 2019-06-05 11:22:15 +00: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
Hervé Beraud
831162ac0a Constraint networkx to <2.3 for Python 2
NetworkX released 2.3, dropping support for Python 2.

 https://github.com/networkx/networkx/blob/master/doc/news.rst

 Also see I0a9700926c9a0db93e782c853c33f1aaee3d4876

 fixed sphinx requirements also according to global requirements
 
 jsonschema should be uncaped also according to global requirements
 but there are conflicts with zakarclient designateclient and irconicclient
 
 so for now I put it in remark

Change-Id: Iea3dbcfa1f6ddf2c413ede5e73fa076c6edccfdf
2019-05-23 09:10:07 +00: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
Zuul
8e94e87259 Merge "Replace git.openstack.org URLs with opendev.org URLs" 2019-04-24 15:11:36 +00:00
zhulingjie
46fd1b8a75 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I52d44a333d2eaa4a2e65c150e3640a4a84e291aa
2019-04-24 15:44:25 +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
Brad P. Crochet
0085d08baa Stop using deprecated keystone_authtoken/auth_uri
keystone_authtoken/auth_uri is deprecated [1]. Use www_authenticate_uri
instead.

keystonemiddleware in requirements and lower constraints should be increased
because www_authenticate_uri was introduced in keystonemiddleware 4.18.0.

[1] https://review.openstack.org/#/c/508522/

Change-Id: I99b0ee941d702a28fb4f392d9747d0e2257a42c8
Closes-Bug: #1788174
2019-02-19 10:37:23 +00:00