openstack
/
python-mistralclient
Code Issues Proposed changes
Python client for Mistral REST API.
709 Commits 9 Branches 27 Tags 8.1 MiB
Python 99.2%
Shell 0.8%
Go to file
Renat Akhmerov e3357c4a92 Add "retry_count" to execution report 
Change-Id: Ibbfb138c1a565a42b5a169c42e8c99b8e3f77a7c
Closes-Bug: #1814850
Depends-On: I1c937ff05c4a1f3e28010427c03e3e4f113f6fba
 		2019-08-16 17:47:32 +07:00
doc Merge "Bump openstackdocstheme to 1.30.0" 2019-06-06 11:34:16 +00:00
functionaltests Add missing `--public` option to workbook api 2018-07-21 13:24:48 +02:00
mistralclient Add "retry_count" to execution report 2019-08-16 17:47:32 +07:00
releasenotes Update master for stable/stein 2019-03-18 14:53:10 +00: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 OpenDev Migration Patch 2019-04-19 19:42:33 +00:00
.stestr.conf Migrate python-mistralclient jobs to Zuul v3 2018-08-01 19:04:32 -04:00
.zuul.yaml Use openstack-python3-train-jobs for python3 test runtime 2019-06-12 10:07:36 +08: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 Replace git.openstack.org URLs with opendev.org URLs 2019-04-28 14:04:48 +08:00
functional_creds.conf.sample Fixing launching mistralclient tests 2015-07-11 14:11:10 +03:00
lower-constraints.txt Bump openstackdocstheme to 1.30.0 2019-06-06 14:34:16 +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 Add python 3.7 classifier to setup.cfg 2019-06-11 09:11:36 +08: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 Add Python 3 Train unit tests 2019-07-05 12:04:28 -04: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 https://opendev.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