openstack/openstack-manuals
Code Issues Proposed changes

Added sample files for the Image Service

Browse Source 
Added glance-api-paste.ini, glance-api.conf, glance-policy.json,
glance-registry-paste.ini,glance-registry.conf, and
glance-scrubber.conf file references (glance project). Placed
under new section.

Change-Id: Ib5e6d3e640af8c23972d7f763d1ab081f5a00fbb
Partial-Bug: #1281348
This commit is contained in:
Summer Long 2014-02-19 12:20:56 +10:00
parent 8d94af1f02
commit 1aea25bb64
2 changed files with 83 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/config-reference/ch_imageservice.xml
View File

@ -8,41 +8,42 @@
xmlns:ns3="http://www.w3.org/1998/Math/MathML" xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook"> xmlns:ns="http://docbook.org/ns/docbook">
<title>Image Service</title> <title>Image Service</title>
<para>Compute relies on an external image service to store virtual <para>Compute relies on an external image service to store virtual
machine images and maintain a catalog of available images. By machine images and maintain a catalog of available images. By
default, Compute is configured to use the OpenStack Image Service default, Compute is configured to use the OpenStack Image Service
(Glance), which is currently the only supported image (Glance), which is currently the only supported image
service.</para> service.</para>
<xi:include href="../common/tables/nova-glance.xml"/> <xi:include href="../common/tables/nova-glance.xml"/>
<para>If your installation requires euca2ools to register new <para>If your installation requires euca2ools to register new
images, you must run the <systemitem class="service">nova-objectstore</systemitem> images, you must run the <systemitem class="service">nova-objectstore</systemitem>
service. This service provides an Amazon S3 front-end for Glance, service. This service provides an Amazon S3 front-end for Glance,
which is required by euca2ools.</para> which is required by euca2ools.</para>
<xi:include href="../common/tables/nova-s3.xml"/> <xi:include href="../common/tables/nova-s3.xml"/>
<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-api.xml"/> <xi:include href="../common/tables/glance-api.xml"/>
<xi:include href="../common/tables/glance-cinder.xml"/> <xi:include href="../common/tables/glance-cinder.xml"/>
<xi:include href="../common/tables/glance-db.xml"/> <xi:include href="../common/tables/glance-db.xml"/>
<xi:include href="../common/tables/glance-filesystem.xml"/> <xi:include href="../common/tables/glance-filesystem.xml"/>
<xi:include href="../common/tables/glance-gridfs.xml"/> <xi:include href="../common/tables/glance-gridfs.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-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-qpid.xml"/>
<xi:include href="../common/tables/glance-rabbitmq.xml"/> <xi:include href="../common/tables/glance-rabbitmq.xml"/>
<xi:include href="../common/tables/glance-rbd.xml"/> <xi:include href="../common/tables/glance-rbd.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-rpc.xml"/>
<xi:include href="../common/tables/glance-s3.xml"/> <xi:include href="../common/tables/glance-s3.xml"/>
<xi:include href="../common/tables/glance-sheepdog.xml"/> <xi:include href="../common/tables/glance-sheepdog.xml"/>
<xi:include href="../common/tables/glance-ssl.xml"/> <xi:include href="../common/tables/glance-ssl.xml"/>
<xi:include href="../common/tables/glance-swift.xml"/> <xi:include href="../common/tables/glance-swift.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="../common/tables/glance-wsgi.xml"/>
<xi:include href="../common/tables/glance-zmq.xml"/> <xi:include href="../common/tables/glance-zmq.xml"/>
<xi:include href="image-service/section_image-service-sample-configuration-files.xml" />
</chapter> </chapter>

55
doc/config-reference/image-service/section_image-service-sample-configuration-files.xml Normal file
View File

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?><section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="section_image-service-sample-configuration-files">
<title>Image Service sample configuration files</title>
<para>All the files in this section can be found in the <filename class="directory">/etc/glance/</filename>
directory.</para>
<section xml:id="section_glance-api.conf">
<title>glance-api.conf</title>
<para>The configuration file for the Image Service API is found in the
<filename>glance-api.conf</filename> file.</para>
<para>This file must be modified after installation.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf"/></programlisting>
</section>
<section xml:id="section_glance-registry.conf">
<title>glance-registry.conf</title>
<para>Configuration for the Image Service's registry, which
stores the metadata about images, is found in the
<filename>glance-registry.conf</filename> file.</para>
<para>This file must be modified after installation.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf"/></programlisting>
</section>
<section xml:id="section_glance-api-paste.conf">
<title>glance-api-paste.ini</title>
<para>Configuration for the Image Service's API middleware pipeline is found in the
<filename>glance-api-paste.ini</filename> file.</para>
<para>You should not need to modify this file.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini"/></programlisting>
</section>
<section xml:id="section_glance-registry-paste.conf">
<title>glance-registry-paste.ini</title>
<para>The Image Service's middleware pipeline for its registry is found in the
<filename>glance-registry-paste.ini</filename> file.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini"/></programlisting>
</section>
<section xml:id="section_glance-scrubber.conf">
<title>glance-scrubber.conf</title>
<para><command>glance-scrubber</command> is a utility for the Image Service that cleans
up images that have been deleted; its configuration is stored in the
<filename>glance-scrubber.conf</filename> file.</para>
<para>Multiple instances of <systemitem>glance-scrubber</systemitem> can be run in a single
deployment, but only one of them can be designated as the
<systemitem>cleanup_scrubber</systemitem> in the
<filename>glance-scrubber.conf</filename> file. The
<systemitem>cleanup_scrubber</systemitem> coordinates other
<systemitem>glance-scrubber</systemitem> instances by maintaining the master queue
of images that need to be removed.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf"/></programlisting>
</section>
<section xml:id="section_glance-policy.json">
<title>policy.json</title>
<para>The <filename>/etc/glance/policy.json</filename> file defines additional access controls
that apply to the Image Service.</para>
<programlisting language="json"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json"/></programlisting>
</section>
</section>