openstack/zaqar
Code Issues Proposed changes

Update development-environment.rst guide

Browse Source 
Update development-environment.rst guide to include recent changes, for example
removed or updated sample configuration files as well as installing required
dependencies.

With these changes applied it was possible to successfully run a Zaqar server.

Change-Id: If113dc39a7a5466f15ebd3d9defede4e8c1b8098
This commit is contained in:
Christian Schwede 2015-06-29 06:51:10 +00:00
parent 8472ef58da
commit e6a16f1dc3
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/source/development-environment.rst
View File

@ -95,22 +95,26 @@ Configuration
$ mkdir ~/.zaqar $ mkdir ~/.zaqar
2. Copy the Zaqar configuration samples to the directory .zaqar/:: 2. Create the sample configuration file zaqar/etc/zaqar.conf.sample::
$ tox -e genconfig
3. Copy the Zaqar configuration samples to the directory ~/.zaqar/::
$ cp zaqar/etc/zaqar.conf.sample ~/.zaqar/zaqar.conf $ cp zaqar/etc/zaqar.conf.sample ~/.zaqar/zaqar.conf
$ cp zaqar/etc/logging.conf.sample ~/.zaqar/logging.conf $ cp zaqar/etc/logging.conf.sample ~/.zaqar/logging.conf
3. Find the [drivers] section in ~/.zaqar/zaqar.conf and specify mongodb as the message store:: 4. Find the [drivers] section in ~/.zaqar/zaqar.conf and specify mongodb as the message store::
storage = mongodb storage = mongodb
4. Find the [drivers:storage:mongodb] section and modify the URI to point to your local mongod instance:: 5. Find the [drivers:message_store:mongodb] section and modify the URI to point to your local mongod instance::
uri = mongodb://$MONGODB_HOST:$MONGODB_PORT # default = mongodb://localhost:27017 uri = mongodb://$MONGODB_HOST:$MONGODB_PORT # default = mongodb://localhost:27017
5. For logging, find the [DEFAULT] section in ~/.zaqar/zaqar.conf and modify as desired:: 6. For logging, find the [handler_file] section in ~/.zaqar/logging.conf and modify as desired::
log_file = server.log args=('zaqar.log', 'w')
Installing and using virtualenv Installing and using virtualenv
############################### ###############################
@ -121,22 +125,26 @@ Installing and using virtualenv
2. Create and activate a virtual environment:: 2. Create and activate a virtual environment::
$ virtualenv marconi $ virtualenv zaqarenv
$ source zaqar/bin/activate $ source zaqarenv/bin/activate
3. Install Zaqar:: 3. Install Zaqar::
$ pip install -e . $ pip install -e .
4. Start the Zaqar server:: 4. Install the required Python binding for MongoDB::
$ pip install pymongo
5. Start the Zaqar server::
$ zaqar-server -v $ zaqar-server -v
5. Verify Zaqar is running by creating a queue:: 6. Verify Zaqar is running by creating a queue::
$ curl -i -X PUT http://localhost:8888/v1/queues/samplequeue -H "Content-type: application/json" $ curl -i -X PUT http://localhost:8888/v1/queues/samplequeue -H "Content-type: application/json"
6. Get ready to code! 7. Get ready to code!
.. note:: .. note::