openstack
/
python-mistralclient
Code Issues Proposed changes
Python client for Mistral REST API.
686 Commits 9 Branches 82 Tags 8.1 MiB
Python 99.2%
Shell 0.8%
Go to file
Zuul 6ffd1f3aa7 Merge "Release note for the "execution-get-report" command" 2019-03-08 16:46:46 +00:00
doc Follow the new PTI for document build 2018-08-21 02:03:48 +09:00
functionaltests Add missing `--public` option to workbook api 2018-07-21 13:24:48 +02:00
mistralclient Fix execution report printing 2019-02-28 13:33:15 +07:00
releasenotes Release note for the "execution-get-report" command 2019-03-08 21:21:34 +07:00
tools Avoid tox_install.sh for constraints support 2017-12-02 16:58:08 +00:00
.gitignore Switch to using stestr 2018-05-30 17:13:56 +01:00
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00
.stestr.conf Migrate python-mistralclient jobs to Zuul v3 2018-08-01 19:04:32 -04:00
.zuul.yaml add python 3.7 unit test job 2019-02-14 23:58:14 -05:00
CONTRIBUTING.rst Update and optimize documentation links 2017-07-21 09:57:38 +08:00
LICENSE Moving Mistral Client code from main Mistral repository 2014-01-17 07:15:03 -08:00
README.rst Merge "Update links in README" 2018-08-03 06:02:35 +00:00
functional_creds.conf.sample Fixing launching mistralclient tests 2015-07-11 14:11:10 +03:00
lower-constraints.txt Migrate python-mistralclient jobs to Zuul v3 2018-08-01 19:04:32 -04:00
requirements.txt Add missing oslo.serialization requirement 2018-07-09 11:27:20 +01:00
run_functional_tests.sh Add script to run functional CLI and client tests locally 2014-09-30 13:17:58 +04:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-03 21:55:39 -05:00
setup.py Updated from global requirements 2017-03-02 11:54:47 +00:00
test-requirements.txt Update hacking version 2018-12-28 23:04:19 +08:00
tox.ini Merge "Fix Chinese quotes" 2019-02-13 09:42:43 +00:00

README.rst

Team and repository tags

image

Mistral

Latest Version

Mistral is a workflow service. Most business processes consist of multiple distinct interconnected steps that need to be executed in a particular order in a distributed environment. A user can describe such a process as a set of tasks and their transitions. After that, it is possible to upload such a description to Mistral, which will take care of state management, correct execution order, parallelism, synchronization and high availability.

Mistral also provides flexible task scheduling so that it can run a process according to a specified schedule (for example, every Sunday at 4.00pm) instead of running it immediately. In Mistral terminology such a set of tasks and relations between them is called a workflow.

Mistral client

Python client for Mistral REST API. Includes python library for Mistral API and Command Line Interface (CLI) library.

Installation

First of all, clone the repo and go to the repo directory:

$ git clone git://git.openstack.org/openstack/python-mistralclient.git
$ cd python-mistralclient

Then just run:

$ pip install -e .

or:

$ pip install -r requirements.txt
$ python setup.py install

Running Mistral client

If Mistral authentication is enabled, provide the information about OpenStack auth to environment variables. Type:

$ export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0
$ export OS_USERNAME=admin
$ export OS_TENANT_NAME=tenant
$ export OS_PASSWORD=secret
$ export OS_MISTRAL_URL=http://<Mistral host>:8989/v2  (optional, by
  default URL=http://localhost:8989/v2)

and in the case that you are authenticating against keystone over https:

$ export OS_CACERT=<path_to_ca_cert>

Note

In client, we can use both Keystone auth versions - v2.0 and v3. But server supports only v3.*

To make sure Mistral client works, type:

$ mistral workbook-list

You can see the list of available commands typing:

$ mistral --help

Useful Links