From cfbed0920ae19606c5b39db565a6ee51947b5ff4 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 19 Sep 2013 22:35:29 +0200 Subject: [PATCH] Update glance autogenerated tables Change-Id: Ide438e97568314219e941c9085a3fa10516ef732 --- doc/common/tables/glance-api.xml | 2 +- doc/common/tables/glance-cinder.xml | 40 +++++ doc/common/tables/glance-common.xml | 22 ++- doc/common/tables/glance-db.xml | 2 +- doc/common/tables/glance-filesystem.xml | 2 +- doc/common/tables/glance-gridfs.xml | 28 ++++ doc/common/tables/glance-imagecache.xml | 6 +- doc/common/tables/glance-logging.xml | 2 +- doc/common/tables/glance-paste.xml | 2 +- doc/common/tables/glance-policy.xml | 2 +- doc/common/tables/glance-qpid.xml | 2 +- doc/common/tables/glance-rabbitmq.xml | 2 +- doc/common/tables/glance-rbd.xml | 2 +- doc/common/tables/glance-registry.xml | 157 ++++++++---------- doc/common/tables/glance-rpc.xml | 24 +++ doc/common/tables/glance-s3.xml | 94 +++++------ doc/common/tables/glance-sheepdog.xml | 32 ++++ doc/common/tables/glance-ssl.xml | 2 +- doc/common/tables/glance-swift.xml | 2 +- doc/common/tables/glance-testing.xml | 2 +- doc/common/tables/glance-wsgi.xml | 6 +- .../flagmappings/glance.flagmappings | 5 + 22 files changed, 282 insertions(+), 156 deletions(-) create mode 100644 doc/common/tables/glance-cinder.xml create mode 100644 doc/common/tables/glance-gridfs.xml create mode 100644 doc/common/tables/glance-rpc.xml create mode 100644 doc/common/tables/glance-sheepdog.xml diff --git a/doc/common/tables/glance-api.xml b/doc/common/tables/glance-api.xml index f65257a05f..2753ff4c77 100644 --- a/doc/common/tables/glance-api.xml +++ b/doc/common/tables/glance-api.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-cinder.xml b/doc/common/tables/glance-cinder.xml new file mode 100644 index 0000000000..7fce7845e4 --- /dev/null +++ b/doc/common/tables/glance-cinder.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for cinder
Configuration option=Default valueDescription
cinder_catalog_info=volume:cinder:publicURL(StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type>
cinder_ca_certificates_file=None(StrOpt) Location of ca certicates file to use for cinder client requests.
cinder_http_retries=3(IntOpt) Number of cinderclient retries on failed http calls
cinder_endpoint_template=None(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s
cinder_api_insecure=False(BoolOpt) Allow to perform insecure SSL requests to cinder
+ \ No newline at end of file diff --git a/doc/common/tables/glance-common.xml b/doc/common/tables/glance-common.xml index 25c026edfd..4cca7c4e16 100644 --- a/doc/common/tables/glance-common.xml +++ b/doc/common/tables/glance-common.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -39,10 +39,18 @@ data_api=glance.db.sqlalchemy.api (StrOpt) Python module path of data access API + + disable_process_locking=False + (BoolOpt) Whether to disable inter-process locks + limit_param_default=25 (IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request + + lock_path=None + (StrOpt) Directory to use for lock files. + metadata_encryption_key=None (StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database. @@ -55,10 +63,22 @@ os_region_name=None (StrOpt) Region name of this node + + property_protection_file=None + (StrOpt) The location of the property protection file. + show_image_direct_url=False (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! + + use_tpool=False + (BoolOpt) Enable the use of thread pooling for all DB API calls + + + user_storage_quota=0 + (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. + workers=1 (IntOpt) The number of child process workers that will be created to service API requests. diff --git a/doc/common/tables/glance-db.xml b/doc/common/tables/glance-db.xml index 4dd375afe2..6451b76c2a 100644 --- a/doc/common/tables/glance-db.xml +++ b/doc/common/tables/glance-db.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-filesystem.xml b/doc/common/tables/glance-filesystem.xml index 91d2d99a23..8e84dbf434 100644 --- a/doc/common/tables/glance-filesystem.xml +++ b/doc/common/tables/glance-filesystem.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-gridfs.xml b/doc/common/tables/glance-gridfs.xml new file mode 100644 index 0000000000..ec0138b3e0 --- /dev/null +++ b/doc/common/tables/glance-gridfs.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for gridfs
Configuration option=Default valueDescription
mongodb_store_uri=None(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)
mongodb_store_db=None(StrOpt) Database to use
+ \ No newline at end of file diff --git a/doc/common/tables/glance-imagecache.xml b/doc/common/tables/glance-imagecache.xml index b2a6bdb75b..730b23e3bf 100644 --- a/doc/common/tables/glance-imagecache.xml +++ b/doc/common/tables/glance-imagecache.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -53,8 +53,8 @@ scrubber_datadir=/var/lib/glance/scrubber - (StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is also set in glance-api.conf + (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 - + \ No newline at end of file diff --git a/doc/common/tables/glance-logging.xml b/doc/common/tables/glance-logging.xml index ef4963c45e..671499e85f 100644 --- a/doc/common/tables/glance-logging.xml +++ b/doc/common/tables/glance-logging.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-paste.xml b/doc/common/tables/glance-paste.xml index 8f4ce95a62..5176337cf1 100644 --- a/doc/common/tables/glance-paste.xml +++ b/doc/common/tables/glance-paste.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-policy.xml b/doc/common/tables/glance-policy.xml index e4cec1f3bf..799996a651 100644 --- a/doc/common/tables/glance-policy.xml +++ b/doc/common/tables/glance-policy.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-qpid.xml b/doc/common/tables/glance-qpid.xml index 886b144562..10d02966fc 100644 --- a/doc/common/tables/glance-qpid.xml +++ b/doc/common/tables/glance-qpid.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-rabbitmq.xml b/doc/common/tables/glance-rabbitmq.xml index 3ff4b52ac5..26501e54eb 100644 --- a/doc/common/tables/glance-rabbitmq.xml +++ b/doc/common/tables/glance-rabbitmq.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-rbd.xml b/doc/common/tables/glance-rbd.xml index 2f1fdedd76..dabb86fb4c 100644 --- a/doc/common/tables/glance-rbd.xml +++ b/doc/common/tables/glance-rbd.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-registry.xml b/doc/common/tables/glance-registry.xml index b45d9843f7..e7a2749bdf 100644 --- a/doc/common/tables/glance-registry.xml +++ b/doc/common/tables/glance-registry.xml @@ -3,89 +3,74 @@ generated and your changes will be overwritten. The tool to do so lives in the tools directory of this repository --> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Description of configuration options for - registry
Configuration option=Default value(Type) Description
admin_password=None(StrOpt) The administrators password.
admin_tenant_name=None(StrOpt) The tenant name of the administrative - user.
admin_user=None(StrOpt) The administrators user name.
auth_region=None(StrOpt) The region for the authentication - service.
auth_strategy=noauth(StrOpt) The strategy to use for - authentication.
auth_url=None(StrOpt) The URL to the keystone service.
registry_client_ca_file=None(StrOpt) The path to the certifying authority cert - file to use in SSL connections to the registry - server.
registry_client_cert_file=None(StrOpt) The path to the cert file to use in SSL - connections to the registry server.
registry_client_insecure=False(BoolOpt) When using SSL in connections to the - registry server, do not require validation via a - certifying authority.
registry_client_key_file=None(StrOpt) The path to the key file to use in SSL - connections to the registry server.
registry_client_protocol=http(StrOpt) The protocol to use for communication - with the registry server. Either http or - https.
registry_client_timeout=600(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.
registry_host=0.0.0.0(StrOpt) Address to find the registry server.
registry_port=9191(IntOpt) Port the registry server is listening - on.
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for registry
Configuration option=Default valueDescription
admin_password=None(StrOpt) The administrators password.
admin_tenant_name=None(StrOpt) The tenant name of the adminstrative user.
admin_user=None(StrOpt) The administrators user name.
auth_region=None(StrOpt) The region for the authentication service.
auth_strategy=noauth(StrOpt) The strategy to use for authentication.
auth_url=None(StrOpt) The URL to the keystone service.
registry_client_ca_file=None(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server.
registry_client_cert_file=None(StrOpt) The path to the cert file to use in SSL connections to the registry server.
registry_client_insecure=False(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority.
registry_client_key_file=None(StrOpt) The path to the key file to use in SSL connections to the registry server.
registry_client_protocol=http(StrOpt) The protocol to use for communication with the registry server. Either http or https.
registry_client_timeout=600(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.
registry_host=0.0.0.0(StrOpt) Address to find the registry server.
registry_port=9191(IntOpt) Port the registry server is listening on.
+ \ No newline at end of file diff --git a/doc/common/tables/glance-rpc.xml b/doc/common/tables/glance-rpc.xml new file mode 100644 index 0000000000..5dbd930c1c --- /dev/null +++ b/doc/common/tables/glance-rpc.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + +
Description of configuration options for rpc
Configuration option=Default valueDescription
allowed_rpc_exception_modules=openstack.common.exception,glance.common.exception,exceptions(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.
+ \ No newline at end of file diff --git a/doc/common/tables/glance-s3.xml b/doc/common/tables/glance-s3.xml index 4de4e78962..ef2135e8bc 100644 --- a/doc/common/tables/glance-s3.xml +++ b/doc/common/tables/glance-s3.xml @@ -3,54 +3,46 @@ generated and your changes will be overwritten. The tool to do so lives in the tools directory of this repository --> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Description of configuration options for s3
Configuration option=Default value(Type) Description
s3_store_access_key=None(StrOpt) The S3 query token access key.
s3_store_bucket=None(StrOpt) The S3 bucket to be used to store the - Glance data.
s3_store_bucket_url_format=subdomain(StrOpt) The S3 calling format used to determine - the bucket. Either subdomain or path can be - used.
s3_store_create_bucket_on_put=False(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.
s3_store_host=None(StrOpt) The host where the S3 server is - listening.
s3_store_object_buffer_dir=None(StrOpt) The local directory where uploads will be - staged before they are transferred into S3.
s3_store_secret_key=None(StrOpt) The S3 query token secret key.
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for s3
Configuration option=Default valueDescription
s3_store_access_key=None(StrOpt) The S3 query token access key.
s3_store_bucket=None(StrOpt) The S3 bucket to be used to store the Glance data.
s3_store_bucket_url_format=subdomain(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used.
s3_store_create_bucket_on_put=False(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.
s3_store_host=None(StrOpt) The host where the S3 server is listening.
s3_store_object_buffer_dir=None(StrOpt) The local directory where uploads will be staged before they are transfered into S3.
s3_store_secret_key=None(StrOpt) The S3 query token secret key.
+ \ No newline at end of file diff --git a/doc/common/tables/glance-sheepdog.xml b/doc/common/tables/glance-sheepdog.xml new file mode 100644 index 0000000000..efdac67858 --- /dev/null +++ b/doc/common/tables/glance-sheepdog.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for sheepdog
Configuration option=Default valueDescription
sheepdog_store_chunk_size=64(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.
sheepdog_store_address=localhost(StrOpt) IP address of sheep daemon.
sheepdog_store_port=7000(StrOpt) Port of sheep daemon.
+ \ No newline at end of file diff --git a/doc/common/tables/glance-ssl.xml b/doc/common/tables/glance-ssl.xml index b6397c1c6a..e77590841b 100644 --- a/doc/common/tables/glance-ssl.xml +++ b/doc/common/tables/glance-ssl.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-swift.xml b/doc/common/tables/glance-swift.xml index 1d942fa519..1c81702a2f 100644 --- a/doc/common/tables/glance-swift.xml +++ b/doc/common/tables/glance-swift.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-testing.xml b/doc/common/tables/glance-testing.xml index 53878e39f7..2ca907c02c 100644 --- a/doc/common/tables/glance-testing.xml +++ b/doc/common/tables/glance-testing.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/glance-wsgi.xml b/doc/common/tables/glance-wsgi.xml index 54ec567fc4..22697123d4 100644 --- a/doc/common/tables/glance-wsgi.xml +++ b/doc/common/tables/glance-wsgi.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -25,8 +25,8 @@ tcp_keepidle=600 - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. - \ No newline at end of file + diff --git a/tools/autogenerate-config-docs/flagmappings/glance.flagmappings b/tools/autogenerate-config-docs/flagmappings/glance.flagmappings index 586d508bf5..5ba31ed0e0 100644 --- a/tools/autogenerate-config-docs/flagmappings/glance.flagmappings +++ b/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