Make python mistralclient readme better
Mark command line as code blocks to prevent validation errors.
Conflicts:
Updated .zuul.yaml to skip code testing on rst file changes
Change-Id: Ic42f6fa3e6a83cb0c4c3a5a324611411d2df7a1e
(cherry picked from commit 316db62e9c
)
This commit is contained in:

committed by
Sean McGinnis

parent
2dcc2b3eba
commit
8aac707df9
11
.zuul.yaml
11
.zuul.yaml
@@ -22,10 +22,17 @@
|
||||
- release-notes-jobs
|
||||
check:
|
||||
jobs:
|
||||
- python-mistralclient-devstack-dsvm
|
||||
- python-mistralclient-devstack-dsvm:
|
||||
irrelevant-files: &doc-irrelevant-files
|
||||
- ^.*\.rst$
|
||||
- ^.*\.yaml$
|
||||
- openstack-tox-cover:
|
||||
voting: false
|
||||
irrelevant-files: *doc-irrelevant-files
|
||||
- openstackclient-check-plugins:
|
||||
irrelevant-files: *doc-irrelevant-files
|
||||
gate:
|
||||
jobs:
|
||||
- python-mistralclient-devstack-dsvm
|
||||
- python-mistralclient-devstack-dsvm:
|
||||
irrelevant-files: *doc-irrelevant-files
|
||||
|
||||
|
14
README.rst
14
README.rst
@@ -37,16 +37,16 @@ Command Line Interface (CLI) library.
|
||||
Installation
|
||||
------------
|
||||
|
||||
First of all, clone the repo and go to the repo directory:
|
||||
First of all, clone the repo and go to the repo directory::
|
||||
|
||||
$ git clone https://git.openstack.org/openstack/python-mistralclient.git
|
||||
$ cd python-mistralclient
|
||||
|
||||
Then just run:
|
||||
Then just run::
|
||||
|
||||
$ pip install -e .
|
||||
|
||||
or
|
||||
or::
|
||||
|
||||
$ pip install -r requirements.txt
|
||||
$ python setup.py install
|
||||
@@ -56,7 +56,7 @@ Running Mistral client
|
||||
----------------------
|
||||
|
||||
If Mistral authentication is enabled, provide the information about OpenStack
|
||||
auth to environment variables. Type:
|
||||
auth to environment variables. Type::
|
||||
|
||||
$ export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0
|
||||
$ export OS_USERNAME=admin
|
||||
@@ -65,18 +65,18 @@ auth to environment variables. Type:
|
||||
$ 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:
|
||||
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:
|
||||
To make sure Mistral client works, type::
|
||||
|
||||
$ mistral workbook-list
|
||||
|
||||
You can see the list of available commands typing:
|
||||
You can see the list of available commands typing::
|
||||
|
||||
$ mistral --help
|
||||
|
||||
|
Reference in New Issue
Block a user