From 40a40762dc0814390bb4a2fd6fa58b8ece8233ef Mon Sep 17 00:00:00 2001 From: Louis Taylor Date: Thu, 20 Nov 2014 17:34:22 +0000 Subject: [PATCH] Add instructions on generating sample config The readme previously was not updated since zaqar moved to oslo-config-generator generated sample config files. This amends the setup instructions with how to generate them. Change-Id: I20527944e3a4438b5a0c4dac4c07fcbd5d6b64a5 --- README.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 0220fb2e7..94a1878d3 100644 --- a/README.rst +++ b/README.rst @@ -7,9 +7,9 @@ To find more information read our `wiki`_. Running a local Zaqar server with MongoDB ----------------------------------------- -**Note:** These instructions are for running a local instance of Zaqar and -not all of these steps are required. It is assumed you have `MongoDB`_ -installed and running. +**Note:** These instructions are for running a local instance of Zaqar and not +all of these steps are required. It is assumed you have `MongoDB`_ and `tox` +(see "Running tests" section below) installed and running. 1. From your home folder create the ``~/.zaqar`` folder and clone the repo:: @@ -17,10 +17,12 @@ installed and running. $ mkdir .zaqar $ git clone https://github.com/openstack/zaqar.git -2. Copy the Zaqar config files to the directory ``~/.zaqar``:: +2. Generate and copy the Zaqar config files to the directory ``~/.zaqar``:: - $ cp zaqar/etc/zaqar.conf.sample ~/.zaqar/zaqar.conf - $ cp zaqar/etc/logging.conf.sample ~/.zaqar/logging.conf + $ cd zaqar + $ tox -e genconfig + $ cp etc/zaqar.conf.sample ~/.zaqar/zaqar.conf + $ cp etc/logging.conf.sample ~/.zaqar/logging.conf 3. Find ``[drivers]`` section in ``~/.zaqar/zaqar.conf`` and specify to use mongodb storage:: @@ -43,7 +45,7 @@ installed and running. 5. Change directories back to your local copy of the repo:: - $ cd zaqar + $ cd ~/zaqar 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::