openstack/deb-mistral
Code Issues Proposed changes

Merge "Fixing small issues in documentation"

Browse Source
This commit is contained in:
Jenkins 2015-10-14 07:36:20 +00:00 committed by Gerrit Code Review
commit a9ec61ed98
5 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/developer/index.rst
View File

@ -4,7 +4,6 @@ Developer's Reference
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
webapi/index
creating_custom_action creating_custom_action
devstack devstack
troubleshooting troubleshooting

2
doc/source/developer/webapi/v2.rst
View File

@ -1,8 +1,6 @@
V2 API V2 API
====== ======
.. warning:: (2014-10-5): API described in this document might slightly change within a short period of time (2-3 weeks) and should be now considered experimental. Mistral team is now actively working on stabilization.
This API describes the ways of interacting with Mistral service via HTTP protocol using Representational State Transfer concept (ReST). This API describes the ways of interacting with Mistral service via HTTP protocol using Representational State Transfer concept (ReST).

3
doc/source/dsl/dsl_v2.rst
View File

@ -790,8 +790,7 @@ Input parameters:
dependencies and JS engine.** Currently Mistral uses only V8 Engine and dependencies and JS engine.** Currently Mistral uses only V8 Engine and
its wrapper - PyV8. For installing it, do the next steps: its wrapper - PyV8. For installing it, do the next steps:
1. Install required libraries - boost, g++, libtool, autoconf, 1. Install required libraries - boost, g++, libtool, autoconf, subversion, libv8-legacy-dev: On Ubuntu::
subversion, libv8-legacy-dev: On Ubuntu::
sudo apt-get install libboost-all-dev g++ libtool autoconf libv8-legacy-dev subversion make sudo apt-get install libboost-all-dev g++ libtool autoconf libv8-legacy-dev subversion make

2
doc/source/main_features.rst
View File

@ -21,7 +21,7 @@ tasks on specific Mistral executors. In fact, there are 2 cases:
1. Need to execute the task on single executor. 1. Need to execute the task on single executor.
2. Need to execute the task on one of executor in executors group which has one name. 2. Need to execute the task on one of executor in executors group which has one name.
For enabling task affinity feature, edit edit section "executor" host property For enabling task affinity feature, edit section "executor" host property
in configuration file:: in configuration file::
[executor] [executor]

9
doc/source/quickstart.rst
View File

@ -24,7 +24,7 @@ To use the OpenStack command line tools you should specify environment variables
Write Workflow Write Workflow
-------------- --------------
For example, the following workflow has been written:: For example, we have the following workflow::
--- ---
version: "2.0" version: "2.0"
@ -44,10 +44,13 @@ For example, the following workflow has been written::
task2: task2:
action: std.echo="Done" action: std.echo="Done"
This is a simple workflow iterates through the given list of names in its first task (using "with-items") and stores
them as a task result (using echo action) and then stores word "Done" as a result of the second task.
Create Workflow Object Create Workflow Object
---------------------- ----------------------
Use *python-mistralclient* to create the workflow:: Use *Mistral CLI* to create the workflow::
mistral workflow-create <workflow.yaml> mistral workflow-create <workflow.yaml>
@ -63,7 +66,7 @@ Make sure that output is like the following::
Run Workflow and Check the Result Run Workflow and Check the Result
--------------------------------- ---------------------------------
Use *python-mistralclient* to run just created workflow. Pass variable **names** as **workflow_input**:: Use *Mistral CLI* to run just created workflow. Pass variable **names** as **workflow_input**::
mistral execution-create my_workflow '{"names": ["John", "Mistral", "Ivan", "Crystal"]}' mistral execution-create my_workflow '{"names": ["John", "Mistral", "Ivan", "Crystal"]}'