Image config ref - rpc, api sections

This change collects all RPC tables together to be more useful,
and collects API tables together with some helpful notes about
API versioning.

Change-Id: I49414e6e8b514018600c5aa47699c8e986fb8a5c
Closes-Bug: 1292588
This commit is contained in:
Tom Fifield 2014-04-14 20:37:28 +08:00 committed by Anne Gentle
parent 4588778170
commit 42f2a043bc
3 changed files with 47 additions and 8 deletions

View File

@ -27,23 +27,17 @@
<para>You can modify many options in the OpenStack Image Service. <para>You can modify many options in the OpenStack Image Service.
The following tables provide a comprehensive list.</para> The following tables provide a comprehensive list.</para>
<xi:include href="../common/tables/glance-common.xml"/> <xi:include href="../common/tables/glance-common.xml"/>
<xi:include href="../common/tables/glance-amqp.xml"/>
<xi:include href="../common/tables/glance-api.xml"/>
<xi:include href="../common/tables/glance-db.xml"/> <xi:include href="../common/tables/glance-db.xml"/>
<xi:include href="../common/tables/glance-imagecache.xml"/> <xi:include href="../common/tables/glance-imagecache.xml"/>
<xi:include href="../common/tables/glance-logging.xml"/> <xi:include href="../common/tables/glance-logging.xml"/>
<xi:include href="../common/tables/glance-matchmaker.xml"/> <xi:include href="../common/tables/glance-matchmaker.xml"/>
<xi:include href="../common/tables/glance-paste.xml"/> <xi:include href="../common/tables/glance-paste.xml"/>
<xi:include href="../common/tables/glance-policy.xml"/> <xi:include href="../common/tables/glance-policy.xml"/>
<xi:include href="../common/tables/glance-qpid.xml"/>
<xi:include href="../common/tables/glance-rabbitmq.xml"/>
<xi:include href="../common/tables/glance-redis.xml"/> <xi:include href="../common/tables/glance-redis.xml"/>
<xi:include href="../common/tables/glance-registry.xml"/> <xi:include href="../common/tables/glance-registry.xml"/>
<xi:include href="../common/tables/glance-rpc.xml"/>
<xi:include href="../common/tables/glance-ssl.xml"/>
<xi:include href="../common/tables/glance-testing.xml"/> <xi:include href="../common/tables/glance-testing.xml"/>
<xi:include href="../common/tables/glance-wsgi.xml"/> <xi:include href="image-service/section_image-service-api.xml"/>
<xi:include href="../common/tables/glance-zmq.xml"/> <xi:include href="image-service/section_image-service-rpc.xml"/>
<xi:include href="image-service/section_image-service-ISO-support.xml"/> <xi:include href="image-service/section_image-service-ISO-support.xml"/>
<xi:include href="image-service/section_image-service-backends.xml"/> <xi:include href="image-service/section_image-service-backends.xml"/>
<xi:include href="image-service/section_image-service-sample-configuration-files.xml" /> <xi:include href="image-service/section_image-service-sample-configuration-files.xml" />

View File

@ -0,0 +1,24 @@
<section xml:id="image-configuring-api"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns="http://docbook.org/ns/docbook"
version="5.0">
<title>Configure the API</title>
<para>The Image Service has two APIs: the user-facing API, and
the registry API, which is for internal requests that require
access to the database.</para>
<para>Both of the APIs currently have two major versions, v1 and v2.
It is possible to run either or both version, by setting appropriate
values of <literal>enable_v1_api</literal>,
<literal>enable_v2_api</literal>, <literal>enable_v1_registry</literal> and
<literal>enable_v2_registry</literal>. If the v2 API is used, running
<systemitem class="service">glance-registry</systemitem> is optional, as
v2 of <systemitem class="service">glance-api</systemitem>
can connect directly to the database.</para>
<para>Tables of all options used to configure the APIs, including enabling
SSL and modifying WSGI settings are found below.</para>
<xi:include href="../../common/tables/glance-api.xml"/>
<xi:include href="../../common/tables/glance-ssl.xml"/>
<xi:include href="../../common/tables/glance-wsgi.xml"/>
</section>

View File

@ -0,0 +1,21 @@
<section xml:id="image-configuring-rpc"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns="http://docbook.org/ns/docbook" version="5.0">
<title>Configure the RPC messaging system</title>
<para>OpenStack projects use an open standard for messaging
middleware known as AMQP. This messaging middleware enables the
OpenStack services that run on multiple servers to talk to each
other. The OpenStack common library project, oslo, supports three
implementations of AMQP: <application>RabbitMQ</application>,
<application>Qpid</application>, and
<application>ZeroMQ</application>.</para>
<para>The following tables contain settings to configure the
messaging middleware for the Image Service:</para>
<xi:include href="../../common/tables/glance-rabbitmq.xml"/>
<xi:include href="../../common/tables/glance-qpid.xml"/>
<xi:include href="../../common/tables/glance-zmq.xml"/>
<xi:include href="../../common/tables/glance-amqp.xml"/>
<xi:include href="../../common/tables/glance-rpc.xml"/>
</section>