openstack-manuals/doc/common/tables/glance-swift.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_swift">
    <caption>Description of swift 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">[DEFAULT]</th>
      </tr>
      <tr>
        <td><option>default_swift_reference</option> = <replaceable>ref1</replaceable></td>
        <td>(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.</td>
      </tr>
      <tr>
        <td><option>swift_store_auth_address</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The address where the Swift authentication service is listening.(deprecated)</td>
      </tr>
      <tr>
        <td><option>swift_store_config_file</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The config file that has the swift account(s)configs.</td>
      </tr>
      <tr>
        <td><option>swift_store_key</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated)</td>
      </tr>
      <tr>
        <td><option>swift_store_user</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The user to authenticate against the Swift authentication service (deprecated)</td>
      </tr>
      <tr>
        <th colspan="2">[glance_store]</th>
      </tr>
      <tr>
        <td><option>default_swift_reference</option> = <replaceable>ref1</replaceable></td>
        <td>(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.</td>
      </tr>
      <tr>
        <td><option>swift_store_admin_tenants</option> = <replaceable></replaceable></td>
        <td>(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.</td>
      </tr>
      <tr>
        <td><option>swift_store_auth_address</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The address where the Swift authentication service is listening.(deprecated)</td>
      </tr>
      <tr>
        <td><option>swift_store_auth_insecure</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating.</td>
      </tr>
      <tr>
        <td><option>swift_store_auth_version</option> = <replaceable>2</replaceable></td>
        <td>(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace. (deprecated)</td>
      </tr>
      <tr>
        <td><option>swift_store_cacert</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) A string giving the CA certificate file to use in SSL connections for verifying certs.</td>
      </tr>
      <tr>
        <td><option>swift_store_config_file</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The config file that has the swift account(s)configs.</td>
      </tr>
      <tr>
        <td><option>swift_store_container</option> = <replaceable>glance</replaceable></td>
        <td>(StrOpt) Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers.</td>
      </tr>
      <tr>
        <td><option>swift_store_create_container_on_put</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) A boolean value that determines if we create the container if it does not exist.</td>
      </tr>
      <tr>
        <td><option>swift_store_endpoint</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) If set, the configured endpoint will be used. If None, the storage url from the auth response will be used.</td>
      </tr>
      <tr>
        <td><option>swift_store_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
        <td>(StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.</td>
      </tr>
      <tr>
        <td><option>swift_store_key</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated)</td>
      </tr>
      <tr>
        <td><option>swift_store_large_object_chunk_size</option> = <replaceable>200</replaceable></td>
        <td>(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file.</td>
      </tr>
      <tr>
        <td><option>swift_store_large_object_size</option> = <replaceable>5120</replaceable></td>
        <td>(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.</td>
      </tr>
      <tr>
        <td><option>swift_store_multi_tenant</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.</td>
      </tr>
      <tr>
        <td><option>swift_store_multiple_containers_seed</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images.</td>
      </tr>
      <tr>
        <td><option>swift_store_region</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.</td>
      </tr>
      <tr>
        <td><option>swift_store_retry_get_count</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) The number of times a Swift download will be retried before the request fails.</td>
      </tr>
      <tr>
        <td><option>swift_store_service_type</option> = <replaceable>object-store</replaceable></td>
        <td>(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.</td>
      </tr>
      <tr>
        <td><option>swift_store_ssl_compression</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2.</td>
      </tr>
      <tr>
        <td><option>swift_store_user</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The user to authenticate against the Swift authentication service (deprecated)</td>
      </tr>
    </tbody>
  </table>
</para>