openstack/zaqar
Code Issues Proposed changes

Update the Marconi readme with more detailed installation instructions

Browse Source 
Change-Id: Ie9e8c8caf7fd92024a097b914aadb2ef75d75989
This commit is contained in:
Chad Lung 2013-10-24 10:58:40 -05:00
parent a24ce88789
commit 73dae3d2be
1 changed files with 48 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.rst
View File

@ -1,39 +1,68 @@
Marconi
=======
Message queuing service for OpenStack
Message queuing service for `OpenStack`_
Running a local Marconi server with MongoDB
-------------------------------------------
1. `Install MongoDB`_
2. Start a MongoDB instance::
**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.
mongod
1. From your home folder create the ``~/.marconi`` folder and clone the repo::
3. Clone the Marconi repo::
$ cd
$ mkdir .marconi
$ git clone https://github.com/openstack/marconi.git
git clone https://github.com/openstack/marconi.git
2. Copy the Marconi config files to the directory ``~/.marconi``::
4. cd to your local copy of the repo
5. Copy the Marconi config files to the directory **~/.marconi**::
$ cp marconi/etc/marconi-proxy.conf-sample ~/.marconi/marconi-proxy.conf
$ cp marconi/etc/marconi-queues.conf-sample ~/.marconi/marconi-queues.conf
$ cp marconi/etc/logging.conf-sample ~/.marconi/logging.conf
cp -r marconi/etc/*.conf-sample ~/.marconi/marconi.conf
6. Find the ``[drivers:storage:mongodb]`` section in
**~/.marconi/marconi-queues.conf** and modify the URI to point
3. Find the ``[drivers:storage:mongodb]`` section in
``~/.marconi/marconi-queues.conf`` and modify the URI to point
to your local mongod instance::
uri = mongodb://localhost
uri = mongodb://$MONGODB_HOST:$MONGODB_PORT
7. 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::
4. For logging, find the ``[DEFAULT]`` section in
``~/.marconi/marconi-queues.conf`` and modify as desired::
pip install -e .
log_file = server.log
8. Start the marconi server::
5. Change directories back to your local copy of the repo::
marconi-server
$ 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::
$ marconi-server
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" -d '{"metadata": "Sample Queue"}'
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
.. _`Install mongodb` : http://docs.mongodb.org/manual/installation/
.. _`OpenStack` : http://openstack.org/
.. _`MongoDB` : http://docs.mongodb.org/manual/installation/
.. _`pyenv` : https://github.com/yyuu/pyenv/
.. _`virtualenv` : https://pypi.python.org/pypi/virtualenv/