openstack
/
python-mistralclient
Code Issues Proposed changes
Python client for Mistral REST API.
758 Commits 9 Branches 82 Tags 8.1 MiB
Python 99.2%
Shell 0.8%
Go to file
OpenStack Release Bot f1e217ab93 Update master for stable/wallaby 
Add file to the reno documentation build to show release notes for
stable/wallaby.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/wallaby.

Sem-Ver: feature
Change-Id: I5281b365b0316291f92d70d50f75c29ed00af9ba
 		2021-03-19 18:09:38 +00:00
doc remove unicode from code 2021-01-03 17:07:20 +08:00
functionaltests/resources/v2 remove unused gate code 2019-09-01 11:27:54 +03:00
mistralclient Add unit tests for dynamic actions CLI commands 2020-12-09 15:26:56 +07:00
releasenotes Update master for stable/wallaby 2021-03-19 18:09:38 +00:00
tools Avoid tox_install.sh for constraints support 2017-12-02 16:58:08 +00:00
.coveragerc Add script for unit test coverage job 2020-01-01 13:01:28 +02: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 Drop lower-constraints job 2021-01-15 17:18:48 +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 Add support for code sources and dynamic actions 2020-12-09 15:26:44 +07:00
requirements.txt [goal] Migrate testing to ubuntu focal 2020-09-05 16:50:28 +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 Add support for code sources and dynamic actions 2020-12-09 15:26:44 +07:00
setup.py Cleanup py27 support 2020-04-04 17:00:08 +02:00
test-requirements.txt Fix hacking min version to 3.0.1 2020-05-12 19:33:38 -05:00
tox.ini Update TOX_CONSTRAINTS_FILE 2020-12-10 06:45:47 +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 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