Merge "Update glance autogenerated tables"

doc/common/tables/glance-api.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-cinder.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+        <!-- Warning: Do not edit this file. It is automatically
+             generated and your changes will be overwritten.
+             The tool to do so lives in the tools directory of this
+             repository -->
+        <para xmlns="http://docbook.org/ns/docbook" version="5.0">
+        <table rules="all">
+          <caption>Description of configuration options for cinder</caption>
+           <col width="50%"/>
+           <col width="50%"/>
+           <thead>
+              <tr>
+                  <td>Configuration option=Default value</td>
+                  <td>Description</td>
+              </tr>
+          </thead>
+          <tbody>
+              <tr>
+                       <td>cinder_catalog_info=volume:cinder:publicURL</td>
+                       <td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
+              </tr>
+              <tr>
+                       <td>cinder_ca_certificates_file=None</td>
+                       <td>(StrOpt) Location of ca certicates file to use for cinder client requests.</td>
+              </tr>
+              <tr>
+                       <td>cinder_http_retries=3</td>
+                       <td>(IntOpt) Number of cinderclient retries on failed http calls</td>
+              </tr>
+              <tr>
+                       <td>cinder_endpoint_template=None</td>
+                       <td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s</td>
+              </tr>
+              <tr>
+                       <td>cinder_api_insecure=False</td>
+                       <td>(BoolOpt) Allow to perform insecure SSL requests to cinder</td>
+              </tr>
+       </tbody>
+        </table>
+        </para>

doc/common/tables/glance-common.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>
@@ -39,10 +39,18 @@
                        <td>data_api=glance.db.sqlalchemy.api</td>
                        <td>(StrOpt) Python module path of data access API</td>
               </tr>
+              <tr>
+                       <td>disable_process_locking=False</td>
+                       <td>(BoolOpt) Whether to disable inter-process locks</td>
+              </tr>
               <tr>
                        <td>limit_param_default=25</td>
                        <td>(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request</td>
               </tr>
+              <tr>
+                       <td>lock_path=None</td>
+                       <td>(StrOpt) Directory to use for lock files.</td>
+              </tr>
               <tr>
                        <td>metadata_encryption_key=None</td>
                        <td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
@@ -55,10 +63,22 @@
                        <td>os_region_name=None</td>
                        <td>(StrOpt) Region name of this node</td>
               </tr>
+              <tr>
+                       <td>property_protection_file=None</td>
+                       <td>(StrOpt) The location of the property protection file.</td>
+              </tr>
               <tr>
                        <td>show_image_direct_url=False</td>
                        <td>(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!</td>
               </tr>
+              <tr>
+                       <td>use_tpool=False</td>
+                       <td>(BoolOpt) Enable the use of thread pooling for all DB API calls</td>
+              </tr>
+              <tr>
+                       <td>user_storage_quota=0</td>
+                       <td>(IntOpt) Set a system wide quota for every user.  This value is the total number of bytes that a user can use across all storage systems.  A value of 0 means unlimited.</td>
+              </tr>
               <tr>
                        <td>workers=1</td>
                        <td>(IntOpt) The number of child process workers that will be created to service API requests.</td>

doc/common/tables/glance-db.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-filesystem.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-gridfs.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+        <!-- Warning: Do not edit this file. It is automatically
+             generated and your changes will be overwritten.
+             The tool to do so lives in the tools directory of this
+             repository -->
+        <para xmlns="http://docbook.org/ns/docbook" version="5.0">
+        <table rules="all">
+          <caption>Description of configuration options for gridfs</caption>
+           <col width="50%"/>
+           <col width="50%"/>
+           <thead>
+              <tr>
+                  <td>Configuration option=Default value</td>
+                  <td>Description</td>
+              </tr>
+          </thead>
+          <tbody>
+              <tr>
+                       <td>mongodb_store_uri=None</td>
+                       <td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost)</td>
+              </tr>
+              <tr>
+                       <td>mongodb_store_db=None</td>
+                       <td>(StrOpt) Database to use</td>
+              </tr>
+       </tbody>
+        </table>
+        </para>

doc/common/tables/glance-imagecache.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>
@@ -53,7 +53,7 @@
               </tr>
               <tr>
                        <td>scrubber_datadir=/var/lib/glance/scrubber</td>
-                       <td>(StrOpt) Directory that the scrubber will use to track information about what to delete.  Make sure this is also set in glance-api.conf</td>
+                       <td>(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf</td>
               </tr>
        </tbody>
         </table>

doc/common/tables/glance-logging.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-paste.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-policy.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-qpid.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-rabbitmq.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-rbd.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-registry.xml

@@ -5,14 +5,13 @@
              repository -->
         <para xmlns="http://docbook.org/ns/docbook" version="5.0">
         <table rules="all">
-        <caption>Description of configuration options for
+          <caption>Description of configuration options for registry</caption>
-            registry</caption>
            <col width="50%"/>
            <col width="50%"/>
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>
@@ -22,8 +21,7 @@
               </tr>
               <tr>
                        <td>admin_tenant_name=None</td>
-                <td>(StrOpt) The tenant name of the administrative
+                       <td>(StrOpt) The tenant name of the adminstrative user.</td>
-                    user.</td>
               </tr>
               <tr>
                        <td>admin_user=None</td>
@@ -31,13 +29,11 @@
               </tr>
               <tr>
                        <td>auth_region=None</td>
-                <td>(StrOpt) The region for the authentication
+                       <td>(StrOpt) The region for the authentication service.</td>
-                    service.</td>
               </tr>
               <tr>
                        <td>auth_strategy=noauth</td>
-                <td>(StrOpt) The strategy to use for
+                       <td>(StrOpt) The strategy to use for authentication.</td>
-                    authentication.</td>
               </tr>
               <tr>
                        <td>auth_url=None</td>
@@ -45,37 +41,27 @@
               </tr>
               <tr>
                        <td>registry_client_ca_file=None</td>
-                <td>(StrOpt) The path to the certifying authority cert
+                       <td>(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server.</td>
-                    file to use in SSL connections to the registry
-                    server.</td>
               </tr>
               <tr>
                        <td>registry_client_cert_file=None</td>
-                <td>(StrOpt) The path to the cert file to use in SSL
+                       <td>(StrOpt) The path to the cert file to use in SSL connections to the registry server.</td>
-                    connections to the registry server.</td>
               </tr>
               <tr>
                        <td>registry_client_insecure=False</td>
-                <td>(BoolOpt) When using SSL in connections to the
+                       <td>(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority.</td>
-                    registry server, do not require validation via a
-                    certifying authority.</td>
               </tr>
               <tr>
                        <td>registry_client_key_file=None</td>
-                <td>(StrOpt) The path to the key file to use in SSL
+                       <td>(StrOpt) The path to the key file to use in SSL connections to the registry server.</td>
-                    connections to the registry server.</td>
               </tr>
               <tr>
                        <td>registry_client_protocol=http</td>
-                <td>(StrOpt) The protocol to use for communication
+                       <td>(StrOpt) The protocol to use for communication with the registry server.  Either http or https.</td>
-                    with the registry server. Either http or
-                    https.</td>
               </tr>
               <tr>
                        <td>registry_client_timeout=600</td>
-                <td>(IntOpt) The period of time, in seconds, that the
+                       <td>(IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout.</td>
-                    API server will wait for a registry request to
-                    complete. A value of 0 implies no timeout.</td>
               </tr>
               <tr>
                        <td>registry_host=0.0.0.0</td>
@@ -83,8 +69,7 @@
               </tr>
               <tr>
                        <td>registry_port=9191</td>
-                <td>(IntOpt) Port the registry server is listening
+                       <td>(IntOpt) Port the registry server is listening on.</td>
-                    on.</td>
               </tr>
        </tbody>
         </table>

doc/common/tables/glance-rpc.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+        <!-- Warning: Do not edit this file. It is automatically
+             generated and your changes will be overwritten.
+             The tool to do so lives in the tools directory of this
+             repository -->
+        <para xmlns="http://docbook.org/ns/docbook" version="5.0">
+        <table rules="all">
+          <caption>Description of configuration options for rpc</caption>
+           <col width="50%"/>
+           <col width="50%"/>
+           <thead>
+              <tr>
+                  <td>Configuration option=Default value</td>
+                  <td>Description</td>
+              </tr>
+          </thead>
+          <tbody>
+              <tr>
+                       <td>allowed_rpc_exception_modules=openstack.common.exception,glance.common.exception,exceptions</td>
+                       <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
+              </tr>
+       </tbody>
+        </table>
+        </para>

doc/common/tables/glance-s3.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>
@@ -21,31 +21,23 @@
               </tr>
               <tr>
                        <td>s3_store_bucket=None</td>
-                <td>(StrOpt) The S3 bucket to be used to store the
+                       <td>(StrOpt) The S3 bucket to be used to store the Glance data.</td>
-                    Glance data.</td>
               </tr>
               <tr>
                        <td>s3_store_bucket_url_format=subdomain</td>
-                <td>(StrOpt) The S3 calling format used to determine
+                       <td>(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used.</td>
-                    the bucket. Either subdomain or path can be
-                    used.</td>
               </tr>
               <tr>
                        <td>s3_store_create_bucket_on_put=False</td>
-                <td>(BoolOpt) A boolean to determine if the S3 bucket
+                       <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>
-                    should be created on upload if it does not exist
-                    or if an error should be returned to the
-                    user.</td>
               </tr>
               <tr>
                        <td>s3_store_host=None</td>
-                <td>(StrOpt) The host where the S3 server is
+                       <td>(StrOpt) The host where the S3 server is listening.</td>
-                    listening.</td>
               </tr>
               <tr>
                        <td>s3_store_object_buffer_dir=None</td>
-                <td>(StrOpt) The local directory where uploads will be
+                       <td>(StrOpt) The local directory where uploads will be staged before they are transfered into S3.</td>
-                    staged before they are transferred into S3.</td>
               </tr>
               <tr>
                        <td>s3_store_secret_key=None</td>

doc/common/tables/glance-sheepdog.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+        <!-- Warning: Do not edit this file. It is automatically
+             generated and your changes will be overwritten.
+             The tool to do so lives in the tools directory of this
+             repository -->
+        <para xmlns="http://docbook.org/ns/docbook" version="5.0">
+        <table rules="all">
+          <caption>Description of configuration options for sheepdog</caption>
+           <col width="50%"/>
+           <col width="50%"/>
+           <thead>
+              <tr>
+                  <td>Configuration option=Default value</td>
+                  <td>Description</td>
+              </tr>
+          </thead>
+          <tbody>
+              <tr>
+                       <td>sheepdog_store_chunk_size=64</td>
+                       <td>(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
+              </tr>
+              <tr>
+                       <td>sheepdog_store_address=localhost</td>
+                       <td>(StrOpt) IP address of sheep daemon.</td>
+              </tr>
+              <tr>
+                       <td>sheepdog_store_port=7000</td>
+                       <td>(StrOpt) Port of sheep daemon.</td>
+              </tr>
+       </tbody>
+        </table>
+        </para>

doc/common/tables/glance-ssl.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-swift.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-testing.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

doc/common/tables/glance-wsgi.xml

@@ -11,7 +11,7 @@
            <thead>
               <tr>
                   <td>Configuration option=Default value</td>
-                  <td>(Type) Description</td>
+                  <td>Description</td>
               </tr>
           </thead>
           <tbody>

tools/autogenerate-config-docs/flagmappings/glance.flagmappings

@@ -31,6 +31,7 @@ default_notification_level logging
 default_store api
 default_publisher_id api
 delayed_delete imagecache
+disable_process_locking common
 enable_v1_api api
 enable_v2_api api
 eventlet_hub wsgi
@@ -49,6 +50,7 @@ instance_uuid_format logging
 key_file ssl
 known_stores api
 limit_param_default common
+lock_path common
 log_config logging
 log_date_format logging
 log_dir logging
@@ -67,6 +69,7 @@ os_region_name common
 policy_default_rule policy
 mongodb_store_db gridfs
 policy_file policy
+property_protection_file common
 publish_errors logging
 pydev_worker_debug_host testing
 pydev_worker_debug_port testing
@@ -148,6 +151,8 @@ syslog_log_facility logging
 tcp_keepidle wsgi
 use_stderr logging
 use_syslog logging
+use_tpool common
 use_user_token api
+user_storage_quota common
 verbose logging
 workers common