openstack/zaqar
Code Issues Proposed changes
OpenStack Messaging (Zaqar)
713 Commits 10 Branches 44 Tags 46 MiB
Python 96.3%
PHP 1.5%
Shell 1.2%
HTML 0.8%
Lua 0.2%
9c87c28f5a
Go to file
Joe Gordon 9c87c28f5a Dedup HACKING.rst and remove any pep8 or OpenStack hacking rules 
Point to OpenStack Style Guide instead of directly to pep8 (it points to
pep8). Remove any rules that are already covered in pep8 or in hacking.

This is the same format that integrated projects are using for there
hacking docs.

Change-Id: Idf35d3fafeb77428c9210b6c6a98eb8c319cc3de
2014-04-02 16:36:16 -07:00
doc Switch to oslosphinx 2014-03-26 15:29:13 +04:00
etc Add a help text for auth_strategy 2014-03-28 09:23:19 +01:00
marconi Don't fork marconi-server unless USE_SCREEN=False 2014-04-02 18:13:15 +02:00
tests Improve cleanup of test_insert_queue_header_asterisk 2014-03-28 13:37:15 +08:00
tools/config Add keystone_authtoken to our config generator 2014-03-26 09:29:59 +01:00
.coveragerc Suppress some Coverage report output 2013-03-29 16:07:20 -04:00
.gitignore adds docs directory with dev guide 2014-03-18 14:48:54 -04:00
.gitreview Update .gitreview for incubation org move 2013-09-14 17:44:26 +00:00
.testr.conf Use testr instead of nosetest 2014-01-17 15:43:49 +01:00
AUTHORS.rst refactor: Rename AUTHORS so that it doesn't keep getting overwritten 2013-03-19 16:33:43 -04:00
doc-test.conf adds docs directory with dev guide 2014-03-18 14:48:54 -04:00
HACKING.rst Dedup HACKING.rst and remove any pep8 or OpenStack hacking rules 2014-04-02 16:36:16 -07:00
LICENSE Include full license text 2014-03-21 10:16:28 +01:00
MANIFEST.in Initial import. 2012-11-01 09:52:20 +01:00
openstack-common.conf Sync from oslo-incubator 2014-03-11 15:42:18 +01:00
README.rst Add default mongod URI to README 2014-03-19 22:19:36 -04:00
requirements.txt keystone middleware version change due to a bug 2014-03-28 10:17:21 -04:00
setup.cfg Enable the basic dev doc for Marconi 2014-03-13 22:17:48 +08:00
setup.py Update pbr and requirements to be current 2013-09-18 07:55:39 -07:00
test-requirements.txt Switch to oslosphinx 2014-03-26 15:29:13 +04:00
tox.ini fix(gate): one for pypy, one for docs 2014-03-18 12:50:43 -04:00

README.rst

Marconi

Message queuing service for OpenStack. To find more information read our wiki.

Running a local Marconi server with MongoDB

Note: These instructions are for running a local instance of Marconi and not all of these steps are required. It is assumed you have MongoDB installed and running.

  1. From your home folder create the ~/.marconi folder and clone the repo:

    $ cd
$ mkdir .marconi
$ git clone https://github.com/openstack/marconi.git

  2. Copy the Marconi config files to the directory ~/.marconi:

    $ cp marconi/etc/marconi.conf.sample ~/.marconi/marconi.conf
$ cp marconi/etc/logging.conf.sample ~/.marconi/logging.conf

  3. Find [drivers] section in ~/.marconi/marconi.conf and specify to use mongodb storage:

    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

    By default, you will have:

    uri = mongodb://127.0.0.1:27017

  4. For logging, find the [DEFAULT] section in ~/.marconi/marconi.conf and modify as desired:

    log_file = server.log

  5. Change directories back to your local copy of the repo:

    $ cd marconi

  6. Run the following so you can see the results of any changes you make to the code without having to reinstall the package each time:

    $ pip install -e .

  7. Start the Marconi server with logging level set to INFO so you can see the port on which the server is listening:

    $ marconi-server -v

  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
"Content-type: application/json"

You should get an HTTP 201 along with some headers that will look similar to this:

HTTP/1.0 201 Created
Date: Fri, 25 Oct 2013 15:34:37 GMT
Server: WSGIServer/0.1 Python/2.7.3
Content-Length: 0
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.