Adds extra info about python-marconiclient and usage instructions
Extends the readme with information about what is included in the python-marconiclient package and adds some usage instructions for the API (link to the existing wiki page) and the CLI Change-Id: I6c5a588d85af53237b3cb11bb9cc8b6e31472fd1 Closes-Bug: #1350867
This commit is contained in:
34
README.rst
34
README.rst
@@ -30,6 +30,40 @@ For the adventurous, you may also install the latest code directly from GitHub::
|
|||||||
|
|
||||||
pip install git+https://github.com/openstack/python-marconiclient.git
|
pip install git+https://github.com/openstack/python-marconiclient.git
|
||||||
|
|
||||||
|
=================
|
||||||
|
What's in the box
|
||||||
|
=================
|
||||||
|
|
||||||
|
By installing python-marconiclient you get programmatic access to the Marconi v1.0 API library. Plus, it installs a plugin to python-openstackclient that allows you to perform simple queue operations.
|
||||||
|
|
||||||
|
==========
|
||||||
|
How to use
|
||||||
|
==========
|
||||||
|
|
||||||
|
-------------
|
||||||
|
Python client
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Details about design, features, usage and workflow can be found in the `Python Client Wiki`_.
|
||||||
|
|
||||||
|
.. _Python Client Wiki: https://wiki.openstack.org/wiki/Marconi/PythonClient
|
||||||
|
|
||||||
|
----------------------
|
||||||
|
Command line interface
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
Marconi bases its client implementation in the `OpenStack Client`_. It can be installed and configured by following the instructions in `Getting Started`_ and `Configuration`_ in the OpenStack Client readme respectively.
|
||||||
|
|
||||||
|
The CLI currently allows creation, removal and listing of queues. Some examples are:
|
||||||
|
|
||||||
|
$ openstack queue list --limit 3
|
||||||
|
$ openstack queue create myqueue
|
||||||
|
$ openstack queue delete myqueue
|
||||||
|
|
||||||
|
.. _`OpenStack Client`: https://github.com/openstack/python-openstackclient
|
||||||
|
.. _`Getting Started`: https://github.com/openstack/python-openstackclient#getting-started
|
||||||
|
.. _`Configuration`: https://github.com/openstack/python-openstackclient#configuration
|
||||||
|
|
||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
|
Reference in New Issue
Block a user