]> review.fuel-infra Code Review - openstack-build/cinder-build.git/commitdiff
Fix a few Sphinx warnings
authorDoug Hellmann <doug.hellmann@dreamhost.com>
Fri, 28 Jun 2013 23:22:58 +0000 (19:22 -0400)
committerDoug Hellmann <doug.hellmann@dreamhost.com>
Fri, 5 Jul 2013 20:09:50 +0000 (16:09 -0400)
Corrects some rst formatting to eliminate warnings in
the documenation build.

Change-Id: I4026a1c8e7fae1928ca50d80aa1b5440faf754da
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
doc/source/devref/architecture.rst
doc/source/devref/index.rst
doc/source/devref/rpc.rst
doc/source/devref/services.rst
doc/source/index.rst

index 667eae600ebf8d007efb3691a2a660bddd4d1720..6da07b4367833f117addc2d51ad381fc329e700c 100644 (file)
@@ -16,7 +16,7 @@
       under the License.
 
 Cinder System Architecture
-========================
+==========================
 
 The Cinder Block Storage Service is intended to be ran on one or more nodes.
 
index 4e795010733a13e240237130a1343df283d13ef1..4ea636745d035c5291236d9d185eb8534b77f415 100644 (file)
@@ -32,7 +32,7 @@ Programming HowTos and Tutorials
 
 
 Background Concepts for Cinder
-----------------------------
+------------------------------
 .. toctree::
    :maxdepth: 3
 
index f122ed3d3c6d0d093928a8168ec6afe64671c6cb..7ac823fcb2144e36e4f41ad5d8574bbb43c36628 100644 (file)
@@ -15,7 +15,7 @@
       under the License.
 
 AMQP and Cinder
-=============
+===============
 
 AMQP is the messaging technology chosen by the OpenStack cloud.  The AMQP broker, either RabbitMQ or Qpid, sits between any two Cinder components and allows them to communicate in a loosely coupled fashion. More precisely, Cinder components (the compute fabric of OpenStack) use Remote Procedure Calls (RPC hereinafter) to communicate to one another; however such a paradigm is built atop the publish/subscribe paradigm so that the following benefits can be achieved:
 
@@ -33,7 +33,7 @@ Cinder uses direct, fanout, and topic-based exchanges. The architecture looks li
 Cinder implements RPC (both request+response, and one-way, respectively nicknamed 'rpc.call' and 'rpc.cast') over AMQP by providing an adapter class which take cares of marshaling and unmarshaling of messages into function calls. Each Cinder service (for example Compute, Volume, etc.) create two queues at the initialization time, one which accepts messages with routing keys 'NODE-TYPE.NODE-ID' (for example compute.hostname) and another, which accepts messages with routing keys as generic 'NODE-TYPE' (for example compute). The former is used specifically when Cinder-API needs to redirect commands to a specific node like 'euca-terminate instance'. In this case, only the  compute node whose host's hypervisor is running the virtual machine can kill the instance. The API acts as a consumer when RPC calls are request/response, otherwise is acts as publisher only.
 
 Cinder RPC Mappings
------------------
+-------------------
 
 The figure below shows the internals of a message broker node (referred to as a RabbitMQ node in the diagrams) when a single instance is deployed and shared in an OpenStack cloud. Every Cinder component connects to the message broker and, depending on its personality (for example a compute node or a network node), may use the queue either as an Invoker (such as API or Scheduler) or a Worker (such as Compute, Volume or Network). Invokers and Workers do not actually exist in the Cinder object model, but we are going to use them as an abstraction for sake of clarity. An Invoker is a component that sends messages in the queuing system via two operations: 1) rpc.call and ii) rpc.cast; a Worker is a component that receives messages from the queuing system and reply accordingly to rcp.call operations.
 
index 801f7c7a767714a48586828e43715bf94b4075bb..e2dd6d2b05bc65f78ab84b4089ff1d352a84dd3c 100644 (file)
@@ -26,7 +26,7 @@ Currently, Managers and Drivers are specified by flags and loaded using utils.lo
 
 
 The :mod:`cinder.service` Module
-------------------------------
+--------------------------------
 
 .. automodule:: cinder.service
     :noindex:
@@ -36,7 +36,7 @@ The :mod:`cinder.service` Module
 
 
 The :mod:`cinder.manager` Module
-------------------------------
+--------------------------------
 
 .. automodule:: cinder.manager
     :noindex:
index e48f06133136872dbef5f3e94a42472d9d8e3503..77ddd28be02ab8228d19ae73082e97faad444efc 100644 (file)
@@ -16,7 +16,7 @@
       under the License.
 
 Welcome to Cinder's developer documentation!
-==========================================
+============================================
 
 Cinder is an OpenStack project to provide "block storage as a service".