openstack
/
python-mistralclient
Code Issues Proposed changes
Python client for Mistral REST API.
481 Commits 9 Branches 83 Tags 8.1 MiB
Python 99.2%
Shell 0.8%
Go to file
Sharat Sharma e182978e4f Changed the README.rst 
Some useful links were missing from the README file which
would be useful for the first timers. So, adding those links
into the file.

Change-Id: Iac89fed65190084878aeac93987cd857793c9424
Partial-Implements: blueprint mistral-python-client-docs
 		2017-01-18 05:22:38 +00:00
doc/source Merge "Removes unnecessary utf-8 encoding" 2017-01-11 11:32:04 +00:00
functionaltests Filter workflow executions by creating task execution id 2016-12-06 09:41:26 +00:00
mistralclient Pass target insecure flag to msitral service 2017-01-16 10:00:47 +01:00
releasenotes Removes unnecessary utf-8 encoding 2017-01-11 11:06:33 +05:30
tools Updated tox.ini to pick up requirements from upper constraints 2016-11-22 12:23:32 +05:30
.gitignore Update .gitignore 2017-01-12 17:53:35 +08:00
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00
CONTRIBUTING.rst Added CONTRIBUTING.rst file 2016-05-26 11:59:46 +07:00
LICENSE Moving Mistral Client code from main Mistral repository 2014-01-17 07:15:03 -08:00
README.rst Changed the README.rst 2017-01-18 05:22:38 +00:00
functional_creds.conf.sample Fixing launching mistralclient tests 2015-07-11 14:11:10 +03:00
requirements.txt Updated from global requirements 2017-01-13 18:51:37 +00: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 Remove commented-out Apache 2 classifier from setup.cfg 2016-12-08 09:47:15 +00:00
setup.py Updated from global requirements 2015-09-17 12:16:50 +00:00
test-requirements.txt Remove unused pylint 2016-11-15 19:06:03 +05:30
tox.ini Updated tox.ini to pick up requirements from upper constraints 2016-11-22 12:23:32 +05:30

README.rst

Team and repository tags

image

Mistral

Latest Version

Downloads

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