openstack/python-mistralclient
Code Issues Proposed changes
Python client for Mistral REST API.
647 Commits 5 Branches 90 Tags 8.2 MiB
Python 99.2%
Shell 0.8%
304922c162
Go to file
Dougal Matthews 304922c162 Add missing oslo.serialization requirement 
We have depended on this in mistralclient/auth/keystone.py for some time.
Often it will be installed by another project, but if you have
mistralclient only in a virtualenv it will be missing.

Change-Id: I6dd6b3e4c885d0396529dc3169cb35e057ffe34d
2018-07-09 11:27:20 +01:00
doc/source Running new workflow based on existing execution. 2018-01-30 04:49:15 +00:00
functionaltests Fix a typo in env variable name 2017-10-07 14:55:30 +00:00
mistralclient Fixing region filter for getting workflow endpoint 2018-07-02 17:40:34 +02:00
playbooks/legacy/python-mistralclient-devstack-dsvm Restore devstack job for python-mistralclient 2018-01-25 15:56:09 -05:00
releasenotes Fix force parameter being always added to URL in execution delete 2018-06-07 15:36:56 +01: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 Switch to using stestr 2018-05-30 17:13:56 +01:00
.zuul.yaml add lower-constraints job 2018-04-09 18:20:03 -04:00
CONTRIBUTING.rst Update and optimize documentation links 2017-07-21 09:57:38 +08:00
functional_creds.conf.sample Fixing launching mistralclient tests 2015-07-11 14:11:10 +03:00
LICENSE Moving Mistral Client code from main Mistral repository 2014-01-17 07:15:03 -08:00
lower-constraints.txt add lower-constraints job 2018-04-09 18:20:03 -04:00
README.rst Add release note link in README 2018-06-28 13:01:56 +08: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 Revert "Adding environment-get-definition for easy environment-update" 2018-06-07 10:12:18 +00:00
setup.py Updated from global requirements 2017-03-02 11:54:47 +00:00
test-requirements.txt Switch to using stestr 2018-05-30 17:13:56 +01:00
tox.ini Add the restructuredtext check to the flake8 job 2018-06-08 11:31:52 +01: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