openstack/zaqar
Code Issues Proposed changes

Improve README file

Browse Source 
Fix curl command example, add link to wiki and section about tests.

Change-Id: I7033cf3e281d0738a8b11f6b81afd900eebb81fd
This commit is contained in:
Nataliia Uvarova 2014-03-13 10:18:46 +01:00
parent 122aeac53a
commit ddf9004111
2 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.rst
View File

@ -1,7 +1,8 @@
Marconi Marconi
======= =======
Message queuing service for `OpenStack`_ Message queuing service for `OpenStack`_.
To find more information read our `wiki`_.
Running a local Marconi server with MongoDB Running a local Marconi server with MongoDB
------------------------------------------- -------------------------------------------
@ -21,9 +22,13 @@ installed and running.
$ cp marconi/etc/marconi.conf-sample ~/.marconi/marconi.conf $ cp marconi/etc/marconi.conf-sample ~/.marconi/marconi.conf
$ cp marconi/etc/logging.conf-sample ~/.marconi/logging.conf $ cp marconi/etc/logging.conf-sample ~/.marconi/logging.conf
3. Find the ``[drivers:storage:mongodb]`` section in 3. Find ``[drivers]`` section in ``~/.marconi/marconi.conf``
``~/.marconi/marconi.conf`` and modify the URI to point and specify to use mongodb storage::
to your local mongod instance::
storage = mongodb
Then find the ``[drivers:storage:mongodb]`` section
and modify the URI to point to your local mongod instance::
uri = mongodb://$MONGODB_HOST:$MONGODB_PORT uri = mongodb://$MONGODB_HOST:$MONGODB_PORT
@ -49,7 +54,7 @@ installed and running.
8. Test out that Marconi is working by creating a queue:: 8. Test out that Marconi is working by creating a queue::
$ curl -i -X PUT http://127.0.0.1:8888/v1/queues/samplequeue -H $ curl -i -X PUT http://127.0.0.1:8888/v1/queues/samplequeue -H
"Content-type: application/json" -d '{"metadata": "Sample Queue"}' "Content-type: application/json"
You should get an **HTTP 201** along with some headers that will look You should get an **HTTP 201** along with some headers that will look
similar to this:: similar to this::
@ -60,9 +65,23 @@ similar to this::
Content-Length: 0 Content-Length: 0
Location: /v1/queues/samplequeue Location: /v1/queues/samplequeue
Running tests
-------------
First install additional requirements::
pip install tox
And then run tests::
tox -e py27
You can read more about running functional tests in separate `TESTS_README`_.
.. _`OpenStack` : http://openstack.org/ .. _`OpenStack` : http://openstack.org/
.. _`MongoDB` : http://docs.mongodb.org/manual/installation/ .. _`MongoDB` : http://docs.mongodb.org/manual/installation/
.. _`pyenv` : https://github.com/yyuu/pyenv/ .. _`pyenv` : https://github.com/yyuu/pyenv/
.. _`virtualenv` : https://pypi.python.org/pypi/virtualenv/ .. _`virtualenv` : https://pypi.python.org/pypi/virtualenv/
.. _`wiki` : https://wiki.openstack.org/wiki/Marconi/
.. _`TESTS_README` : https://github.com/openstack/marconi/blob/master/tests/functional/README.rst

2
tests/functional/README.rst
View File

@ -66,5 +66,5 @@ Adding New Tests
messages/test_messages.py messages/test_messages.py
claim/test_claims.py claim/test_claims.py
.. _README : https://github.com/stackforge/marconi/blob/master/README.rst .. _README : https://github.com/openstack/marconi/blob/master/README.rst
.. _requests : https://pypi.python.org/pypi/requests .. _requests : https://pypi.python.org/pypi/requests