openstack/zaqar
Code Issues Proposed changes

Fixed incorrect reST syntax

Browse Source 
Triple backticks were inadvertantly used in place of double backticks.

Change-Id: I0703335ddaa6c1c238053e2283b0a76127c84b43
This commit is contained in:
Alex Gaynor 2014-05-06 09:17:48 -07:00
parent 44f2850288
commit 74eb5eb77a
4 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/api.rst
View File

@ -61,4 +61,4 @@ Create the queue::
content-length: 0
location: /v1/queues/test-queue
```HTTP/1.1 201 Created``` response proves that service is functioning properly.
``HTTP/1.1 201 Created`` response proves that service is functioning properly.

2
doc/source/glossary.rst
View File

@ -73,5 +73,5 @@ protocol, which is one of the main requirements in today’s scalable applicatio
Catalog Database
If sharding is enabled, catalog database has to be created. Catalog database
maintains ```queues``` to ```queues database``` mapping. Storage layer has
maintains ``queues`` to ``queues database`` mapping. Storage layer has
to guarantee durability and availability of data.

4
doc/source/ha.rst
View File

@ -21,8 +21,8 @@ is the storage layer which keeps all the data and meta-data about queues and mes
For a HA setup, a load balancer has to be placed in front of the web servers.
Load balancer setup is out of scope in this document.
For storage we will use ```mongoDB``` in order to provide high availability with
minimum administration overhead. For transport, we will use ```wsgi```.
For storage we will use ``mongoDB`` in order to provide high availability with
minimum administration overhead. For transport, we will use ``wsgi``.
To have a small footprint while providing HA, we will use 2 web servers which
will host the application and 3 mongoDB servers (configured as replica-sets)

18
doc/source/installing.rst
View File

@ -38,7 +38,7 @@ Install mongoDB on three servers and setup the replica-set.
Configure Package Management System (YUM)
#########################################
Create a ```/etc/yum.repos.d/mongodb.repo``` file to hold the following
Create a ``/etc/yum.repos.d/mongodb.repo`` file to hold the following
configuration information for the MongoDB repository:
If you are running a 64-bit system, use the following configuration::
@ -66,7 +66,7 @@ version of MongoDB and the associated tools::
#yum install mongo-10gen mongo-10gen-server
Edit ```/etc/sysconfig/mongod```::
Edit ``/etc/sysconfig/mongod``::
logpath=/var/log/mongo/mongod.log
logappend=true
@ -86,8 +86,8 @@ Start mongoDB on all database servers::
Configure Replica Set
#####################
Assuming that primary mongodb servers hostname is ```mydb0.example-queues.net```,
once you install mongoDB on three servers go to ```mydb0``` and run the commands below;::
Assuming that primary mongodb servers hostname is ``mydb0.example-queues.net``,
once you install mongoDB on three servers go to ``mydb0`` and run the commands below;::
mydb0# mongo local --eval "printjson(rs.initiate())"
mydb0# rs.add("mydb1.example-queues.net")
@ -121,16 +121,16 @@ On web servers run these commands::
web# git clone https://github.com/openstack/marconi.git .
web# pip install . -r ./requirements.txt --upgrade --log /tmp/marconi-pip.log
Create ```/srv/marconi``` folder to store related configurations files.
Create ``/srv/marconi`` folder to store related configurations files.
Create ```/srv/marconi/marconi_uwsgi.py``` with the following content::
Create ``/srv/marconi/marconi_uwsgi.py`` with the following content::
from keystoneclient.middleware import auth_token
from marconi.transport.wsgi import app
app = auth_token.AuthProtocol(app.app, {})
Create ```/srv/marconi/uwsgi.ini``` file with the following content::
Create ``/srv/marconi/uwsgi.ini`` file with the following content::
[uwsgi]
http = 192.168.192.168:80
@ -145,7 +145,7 @@ Create ```/srv/marconi/uwsgi.ini``` file with the following content::
The uwsgi configuration options above can be modified for different performance requirements.
Create marconi configuration file ```/etc/marconi.conf```::
Create marconi configuration file ``/etc/marconi.conf``::
[DEFAULT]
# Show more verbose log output (sets INFO log level output)
@ -245,7 +245,7 @@ web servers run this command::
curl -i -X PUT -H 'X-Auth-Token: $TOKEN' -d '{"weight": 100, "uri": "mongodb://mydb0,mydb1,mydb2:27017/?replicaSet=catalog&w=2&readPreference=secondaryPreferred", "options": {"partitions": 8}}' http://localhost:8888/v1/shards/shard1
Above ```$TOKEN``` is the authentication token retrieved from identity service.
Above ``$TOKEN`` is the authentication token retrieved from identity service.
If you choose not to enable keystone authentication you won't have to pass a token.
Reminder: In larger deployments, catalog database and queues databases (shards)