OpenStack Messaging (Zaqar)
Go to file
Jon Bernard 3c80a58418 Include full license text
The Apache 2.0 license requires that you include a copy of the license
text in the source code distributed under that license.

Change-Id: I0fd94cece535fbe18bf94c7128e412942e6e30b9
2014-03-21 10:16:28 +01:00
doc Merge "Marconi Operations Document" 2014-03-18 20:38:52 +00:00
etc Rename logging.conf-sample to logging.conf.sample 2014-03-12 13:26:37 +01:00
marconi Update license headers on select source files 2014-03-21 10:16:28 +01:00
tests Update license headers on select source files 2014-03-21 10:16:28 +01:00
tools/config Use oslo's config generator to generate sample 2014-03-11 20:14:35 +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
HACKING.rst Update HACKING file with the new structure 2013-09-18 13:53:27 +02: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
README.rst Merge "Rename logging.conf-sample to logging.conf.sample" 2014-03-14 13:55:16 +00:00
doc-test.conf adds docs directory with dev guide 2014-03-18 14:48:54 -04:00
openstack-common.conf Sync from oslo-incubator 2014-03-11 15:42:18 +01:00
requirements.txt Updated from global requirements 2014-03-11 17:30:22 +00: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 adds docs directory with dev guide 2014-03-18 14:48:54 -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
  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.