c07cf48a60
The writing styles at few places were not in compliance with the OpenStack writing style as mentioned in http://docs.openstack.org/contributor-guide/writing-style /general-writing-guidelines.html. This patch changes the heading styles and adds a few other minor changes in the documents. Change-Id: I0d90ba32ddcef0427b1dc4358206210f166e798a Partial-Implements: blueprint mistral-doc
167 lines
6.3 KiB
ReStructuredText
167 lines
6.3 KiB
ReStructuredText
Quick Start
|
|
===========
|
|
|
|
Prerequisites
|
|
-------------
|
|
|
|
Before you start following this guide, make sure you have completed these
|
|
three prerequisites.
|
|
|
|
Install and run Mistral
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Go through the installation manual: :doc:`Mistral Installation Guide </guides/installation_guide>`
|
|
|
|
Install Mistral client
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To install mistralclient, please refer to :doc:`Mistral Client / CLI Guide </guides/mistralclient_guide>`
|
|
|
|
Export Keystone credentials
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To use the OpenStack command line tools you should specify environment
|
|
variables with the configuration details for your OpenStack installation. The
|
|
following example assumes that the Identity service is at ``127.0.0.1:5000``,
|
|
with a user ``admin`` in the ``admin`` tenant whose password is ``password``:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ export OS_AUTH_URL=http://127.0.0.1:5000/v2.0/
|
|
$ export OS_TENANT_NAME=admin
|
|
$ export OS_USERNAME=admin
|
|
$ export OS_PASSWORD=password
|
|
|
|
Write a workflow
|
|
----------------
|
|
|
|
For example, we have the following workflow.
|
|
|
|
.. code-block:: yaml
|
|
|
|
---
|
|
version: "2.0"
|
|
|
|
my_workflow:
|
|
type: direct
|
|
|
|
input:
|
|
- names
|
|
|
|
tasks:
|
|
task1:
|
|
with-items: name in <% $.names %>
|
|
action: std.echo output=<% $.name %>
|
|
on-success: task2
|
|
|
|
task2:
|
|
action: std.echo output="Done"
|
|
|
|
This simple workflow iterates through a list of names in ``task1`` (using
|
|
`with-items`), stores them as a task result (using the `std.echo` action) and
|
|
then stores the word "Done" as a result of the second task (`task2`).
|
|
|
|
To learn more about the Mistral Workflows and what you can do, read the
|
|
:doc:`Mistral DSL specification </dsl/dsl_v2>`
|
|
|
|
Upload the workflow
|
|
-------------------
|
|
|
|
Use the *Mistral CLI* to create the workflow::
|
|
|
|
$ mistral workflow-create <workflow.yaml>
|
|
|
|
The output should look similar to this::
|
|
|
|
+-------------+--------+---------+---------------------+------------+
|
|
| Name | Tags | Input | Created at | Updated at |
|
|
+-------------+--------+---------+---------------------+------------+
|
|
| my_workflow | <none> | names | 2015-08-13 08:44:49 | None |
|
|
+-------------+--------+---------+---------------------+------------+
|
|
|
|
|
|
Run the workflow and check the result
|
|
-------------------------------------
|
|
|
|
Use the *Mistral CLI* to start the new workflow, passing in a list of names
|
|
as JSON::
|
|
|
|
$ mistral execution-create my_workflow '{"names": ["John", "Mistral", "Ivan", "Crystal"]}'
|
|
|
|
Make sure the output is like the following::
|
|
|
|
+-------------+--------------------------------------+
|
|
| Field | Value |
|
|
+-------------+--------------------------------------+
|
|
| ID | 056c2ed1-695f-4ccd-92af-e31bc6153784 |
|
|
| Workflow | my_workflow |
|
|
| Description | |
|
|
| State | RUNNING |
|
|
| State info | None |
|
|
| Created at | 2015-08-28 09:05:00.065917 |
|
|
| Updated at | 2015-08-28 09:05:00.844990 |
|
|
+-------------+--------------------------------------+
|
|
|
|
After a moment, check the status of the workflow execution (replace the
|
|
example execution id with the ID output above)::
|
|
|
|
$ mistral execution-get 056c2ed1-695f-4ccd-92af-e31bc6153784
|
|
|
|
+-------------+--------------------------------------+
|
|
| Field | Value |
|
|
+-------------+--------------------------------------+
|
|
| ID | 056c2ed1-695f-4ccd-92af-e31bc6153784 |
|
|
| Workflow | my_workflow |
|
|
| Description | |
|
|
| State | SUCCESS |
|
|
| State info | None |
|
|
| Created at | 2015-08-28 09:05:00 |
|
|
| Updated at | 2015-08-28 09:05:03 |
|
|
+-------------+--------------------------------------+
|
|
|
|
The status of each **task** also can be checked::
|
|
|
|
$ mistral task-list 056c2ed1-695f-4ccd-92af-e31bc6153784
|
|
|
|
+--------------------------------------+-------+---------------+--------------------------------------+---------+
|
|
| ID | Name | Workflow name | Execution ID | State |
|
|
+--------------------------------------+-------+---------------+--------------------------------------+---------+
|
|
| 91874635-dcd4-4718-a864-ac90408c1085 | task1 | my_workflow | 056c2ed1-695f-4ccd-92af-e31bc6153784 | SUCCESS |
|
|
| 3bf82863-28cb-4148-bfb8-1a6c3c115022 | task2 | my_workflow | 056c2ed1-695f-4ccd-92af-e31bc6153784 | SUCCESS |
|
|
+--------------------------------------+-------+---------------+--------------------------------------+---------+
|
|
|
|
Check the result of task *'task1'*::
|
|
|
|
$ mistral task-get-result 91874635-dcd4-4718-a864-ac90408c1085
|
|
|
|
[
|
|
"John",
|
|
"Mistral",
|
|
"Ivan",
|
|
"Crystal"
|
|
]
|
|
|
|
If needed, we can go deeper and look at a list of the results of the
|
|
**action_executions** of a single task::
|
|
|
|
$ mistral action-execution-list 91874635-dcd4-4718-a864-ac90408c1085
|
|
|
|
+--------------------------------------+----------+---------------+-----------+---------+------------+-------------+
|
|
| ID | Name | Workflow name | Task name | State | State info | Is accepted |
|
|
+--------------------------------------+----------+---------------+-----------+---------+------------+-------------+
|
|
| 20c2b65d-b899-437f-8e1b-50fe477fbf4b | std.echo | my_workflow | task1 | SUCCESS | None | True |
|
|
| 6773c887-6eff-46e6-bed9-d6b67d77813b | std.echo | my_workflow | task1 | SUCCESS | None | True |
|
|
| 753a9e39-d93e-4751-a3c1-569d1b4eac64 | std.echo | my_workflow | task1 | SUCCESS | None | True |
|
|
| 9872ddbc-61c5-4511-aa7e-dc4016607822 | std.echo | my_workflow | task1 | SUCCESS | None | True |
|
|
+--------------------------------------+----------+---------------+-----------+---------+------------+-------------+
|
|
|
|
Check the result of the first **action_execution**::
|
|
|
|
$ mistral action-execution-get-output 20c2b65d-b899-437f-8e1b-50fe477fbf4b
|
|
|
|
{
|
|
"result": "John"
|
|
}
|
|
|
|
**Congratulations! Now you are ready to use OpenStack Workflow Service!**
|