openstack-manuals/doc/common/tables/glance-s3.xml
Tom Fifield dc7c13a659 Regenerate config tables for K1
This patch regenerates the configuration tables using
code from 2014-12-31, or about kilo-1.

It also uses new doc-tools code to mark-up options
and their default values semantically.

Change-Id: Id68a87b69fb80edbc156b9bcb1549cca5e61464b
2015-01-01 19:13:38 +08:00

63 lines
2.8 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_s3">
<caption>Description of S3 configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td><option>s3_store_access_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The S3 query token access key.</td>
</tr>
<tr>
<td><option>s3_store_bucket</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The S3 bucket to be used to store the Glance data.</td>
</tr>
<tr>
<td><option>s3_store_bucket_url_format</option> = <replaceable>subdomain</replaceable></td>
<td>(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used.</td>
</tr>
<tr>
<td><option>s3_store_create_bucket_on_put</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.</td>
</tr>
<tr>
<td><option>s3_store_host</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The host where the S3 server is listening.</td>
</tr>
<tr>
<td><option>s3_store_large_object_chunk_size</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M.</td>
</tr>
<tr>
<td><option>s3_store_large_object_size</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3.</td>
</tr>
<tr>
<td><option>s3_store_object_buffer_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The local directory where uploads will be staged before they are transferred into S3.</td>
</tr>
<tr>
<td><option>s3_store_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The S3 query token secret key.</td>
</tr>
<tr>
<td><option>s3_store_thread_pools</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) The number of thread pools to perform a multipart upload in S3.</td>
</tr>
</tbody>
</table>
</para>