openstack
/
python-mistralclient
Code Issues Proposed changes
Python client for Mistral REST API.
486 Commits 9 Branches 83 Tags 8.1 MiB
Python 99.2%
Shell 0.8%
Go to file
Sharat Sharma 1a3094d224 Set the default value of --limit parameter 
The "--limit" parameter of heavy CLI commands should not be
infinite by default. For commands like "mistral task-list" and
"execution-list" we need to set --limit parameter by default to
some reasonable value. The proposal is 100. Otherwise it's easy
to cause a huge load on a server if the result set is not limited.

A warning message is thrown whenever these commands are executed
without using "--limit" parameter.

Change-Id: If0fead181171e5b9c590f3f4c852c6ad2541ff94
Implements: blueprint mistral-cli-default-limit-parameter
(cherry picked from commit fabec4fafc)
 		2017-07-11 14:39:28 +00:00
doc/source Fix doc build if git is absent 2017-03-20 13:28:06 +00:00
functionaltests Filter workflow executions by creating task execution id 2016-12-06 09:41:26 +00:00
mistralclient Set the default value of --limit parameter 2017-07-11 14:39:28 +00:00
releasenotes Set the default value of --limit parameter 2017-07-11 14:39:28 +00:00
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 for stable/ocata 2017-01-30 00:58:23 +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 Make python mistralclient readme better 2016-12-06 10:43:29 +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-05-15 23:38:45 +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 Update UPPER_CONSTRAINTS_FILE for stable/ocata 2017-01-30 00:58:24 +00:00

README.rst

Team and repository tags

image

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:

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