Add mistralclient documentation
Change-Id: Ia269ac6c8811e8db34a657283b2839d3f2feeba6
This commit is contained in:
parent
a62292bc64
commit
964dd4e88d
45
README.md
45
README.md
@ -1,4 +1,43 @@
|
|||||||
python-mistralclient
|
Mistral client
|
||||||
====================
|
==============
|
||||||
|
|
||||||
Python client for Mistral REST API
|
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://github.com/stackforge/python-mistralclient.git
|
||||||
|
cd python-mistralclient
|
||||||
|
|
||||||
|
Then just run:
|
||||||
|
|
||||||
|
pip install -e .
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
>***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
|
||||||
|
Loading…
Reference in New Issue
Block a user