openstack/openstack-manuals
Code Issues Proposed changes

Merge "config-ref: glance tables update"

Browse Source
This commit is contained in:
Jenkins 2015-04-24 15:09:27 +00:00 committed by Gerrit Code Review
commit 2e4d11b97f
19 changed files with 297 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/common/tables/glance-amqp.xml
View File

@ -25,6 +25,10 @@
<td><option>default_publisher_id</option> = <replaceable>image.localhost</replaceable></td>
<td>(StrOpt) Default publisher_id for outgoing notifications.</td>
</tr>
<tr>
<td><option>disabled_notifications</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create", "metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent.</td>
</tr>
<tr>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>

20
doc/common/tables/glance-api.xml
View File

@ -25,6 +25,10 @@
<td><option>allow_anonymous_access</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.</td>
</tr>
<tr>
<td><option>available_plugins</option> = <replaceable></replaceable></td>
<td>(ListOpt) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded.</td>
</tr>
<tr>
<td><option>enable_v1_api</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>
@ -41,9 +45,21 @@
<td><option>enable_v2_registry</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Deploy the v2 OpenStack Registry API.</td>
</tr>
<tr>
<td><option>http_keepalive</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If False, server will return the header "Connection: close", If True, server will return "Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server.</td>
</tr>
<tr>
<td><option>http_timeout</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.</td>
</tr>
<tr>
<td><option>image_size_cap</option> = <replaceable>1099511627776</replaceable></td>
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB (9223372036854775808).</td>
</tr>
<tr>
<td><option>load_enabled</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded.</td>
</tr>
<tr>
<td><option>location_strategy</option> = <replaceable>location_order</replaceable></td>
@ -67,7 +83,7 @@
</tr>
<tr>
<td><option>show_multiple_locations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.</td>
<td>(BoolOpt) Whether to include the backend image locations in image properties. For example, if using the file system store a URL of "file:///path/to/image" will be returned to the user in the 'direct_url' meta-data field. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.</td>
</tr>
<tr>
<td><option>tcp_keepidle</option> = <replaceable>600</replaceable></td>

6
doc/common/tables/glance-auth_token.xml
View File

@ -119,7 +119,7 @@
</tr>
<tr>
<td><option>memcache_pool_conn_get_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.</td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.</td>
</tr>
<tr>
<td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
@ -131,7 +131,7 @@
</tr>
<tr>
<td><option>memcache_pool_socket_timeout</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.</td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.</td>
</tr>
<tr>
<td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
@ -147,7 +147,7 @@
</tr>
<tr>
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.</td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>

63
doc/common/tables/glance-common.xml
View File

@ -45,6 +45,10 @@
<td><option>digest_algorithm</option> = <replaceable>sha1</replaceable></td>
<td>(StrOpt) Digest algorithm which will be used for digital signature; the default is sha1 the default in Kilo for a smooth upgrade process, and it will be updated with sha256 in next release(L). Use the command "openssl list-message-digest-algorithms" to get the available algorithms supported by the version of OpenSSL on the platform. Examples are "sha1", "sha256", "sha512", etc.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</tr>
<tr>
<td><option>image_location_quota</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited.</td>
@ -65,13 +69,17 @@
<td><option>limit_param_default</option> = <replaceable>25</replaceable></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><option>listener_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>metadata_encryption_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
<td>(StrOpt) AES key for encrypting store 'location' metadata. This includes, if used, Swift or S3 credentials. Should be set to a random string of length 16, 24 or 32 bytes</td>
</tr>
<tr>
<td><option>metadata_source_path</option> = <replaceable>/etc/glance/metadefs/</replaceable></td>
@ -79,7 +87,7 @@
</tr>
<tr>
<td><option>property_protection_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The location of the property protection file.</td>
<td>(StrOpt) The location of the property protection file.This file contains the rules for property protections and the roles/policies associated with it. If this config value is not specified, by default, property protections won't be enforced. If a value is specified and the file is not found, then the glance-api service will not start.</td>
</tr>
<tr>
<td><option>property_protection_rule_format</option> = <replaceable>roles</replaceable></td>
@ -94,7 +102,7 @@
<td>(StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>8</replaceable></td>
<td><option>workers</option> = <replaceable>4</replaceable></td>
<td>(IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available.</td>
</tr>
<tr>
@ -122,21 +130,60 @@
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<th colspan="2">[service_credentials]</th>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
</tr>
<tr>
<td><option>os_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
<td>(StrOpt) Auth URL to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_cacert</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Certificate chain for SSL validation.</td>
</tr>
<tr>
<td><option>os_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
</tr>
<tr>
<td><option>os_password</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Password to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
</tr>
<tr>
<td><option>os_tenant_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Tenant name to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_username</option> = <replaceable>glance</replaceable></td>
<td>(StrOpt) User name to use for OpenStack service access.</td>
</tr>
<tr>
<th colspan="2">[task]</th>
</tr>
<tr>
<td><option>eventlet_executor_pool_size</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Specifies the maximum number of eventlet threads which can be spun up by the eventlet based task executor to perform execution of Glance tasks.</td>
</tr>
<tr>
<td><option>task_executor</option> = <replaceable>eventlet</replaceable></td>
<td><option>task_executor</option> = <replaceable>taskflow</replaceable></td>
<td>(StrOpt) Specifies which task executor to be used to run the task scripts.</td>
</tr>
<tr>
<td><option>task_time_to_live</option> = <replaceable>48</replaceable></td>
<td>(IntOpt) Time in hours for which a task lives after, either succeeding or failing</td>
</tr>
<tr>
<td><option>work_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Work dir for asynchronous task operations. The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure enough space is provided for concurrent tasks to run efficiently without running out of space. A rough estimation can be done by multiplying the number of `max_workers` - or the N of workers running - by an average image size (e.g 500MB). The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong.</td>
</tr>
</tbody>
</table>
</para>

7
doc/common/tables/glance-database.xml
View File

@ -14,13 +14,6 @@
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>db_enforce_mysql_charset</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) DEPRECATED. TO BE REMOVED IN THE JUNO RELEASE. Whether or not to enforce that all DB tables have charset utf8. If your database tables do not have charset utf8 you will need to convert before this option is removed. This option is only relevant if your database engine is MySQL.</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>

26
doc/common/tables/glance-elasticsearch.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_elasticsearch">
<caption>Description of Elasticsearch 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">[elasticsearch]</th>
</tr>
<tr>
<td><option>hosts</option> = <replaceable>127.0.0.1:9200</replaceable></td>
<td>(ListOpt) List of nodes where Elasticsearch instances are running. A single node should be defined as an IP address and port number.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/glance-imagecache.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>cleanup_scrubber</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host.</td>
<td>(BoolOpt) DEPRECATED. TO BE REMOVED IN THE LIBERTY RELEASE. A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host.</td>
</tr>
<tr>
<td><option>cleanup_scrubber_time</option> = <replaceable>86400</replaceable></td>
<td>(IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup.</td>
<td>(IntOpt) DEPRECATED. TO BE REMOVED IN THE LIBERTY RELEASE. Items must have a modified time that is older than this value in order to be candidates for cleanup.</td>
</tr>
<tr>
<td><option>delayed_delete</option> = <replaceable>False</replaceable></td>

34
doc/common/tables/glance-logging.xml
View File

@ -22,7 +22,7 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</replaceable></td>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
@ -57,6 +57,26 @@
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td><option>log_config_append</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
</tr>
<tr>
<td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
</tr>
<tr>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
<td>(StrOpt) Format string to use for log messages with context.</td>
@ -81,6 +101,18 @@
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>

4
doc/common/tables/glance-policy.xml
View File

@ -15,7 +15,7 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[oslo_policy]</th>
</tr>
<tr>
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
@ -23,7 +23,7 @@
</tr>
<tr>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.</td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.</td>
</tr>
<tr>
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>

2
doc/common/tables/glance-rbd.xml
View File

@ -26,7 +26,7 @@
<td>(IntOpt) RADOS 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><option>rbd_store_pool</option> = <replaceable>images</replaceable></td>
<td><option>rbd_store_pool</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) RADOS pool in which images are stored.</td>
</tr>
<tr>

8
doc/common/tables/glance-registry.xml
View File

@ -43,19 +43,19 @@
</tr>
<tr>
<td><option>registry_client_ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server.</td>
<td>(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CA_FILE environment variable to a filepath of the CA cert file.</td>
</tr>
<tr>
<td><option>registry_client_cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The path to the cert file to use in SSL connections to the registry server.</td>
<td>(StrOpt) The path to the cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CERT_FILE environment variable to a filepath of the CA cert file</td>
</tr>
<tr>
<td><option>registry_client_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority.</td>
<td>(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API.</td>
</tr>
<tr>
<td><option>registry_client_key_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The path to the key file to use in SSL connections to the registry server.</td>
<td>(StrOpt) The path to the key file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_KEY_FILE environment variable to a filepath of the key file</td>
</tr>
<tr>
<td><option>registry_client_protocol</option> = <replaceable>http</replaceable></td>

54
doc/common/tables/glance-replicator.xml Normal file
View File

@ -0,0 +1,54 @@
<?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_replicator">
<caption>Description of replicator 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>args</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Arguments for the command</td>
</tr>
<tr>
<td><option>chunksize</option> = <replaceable>65536</replaceable></td>
<td>(IntOpt) Amount of data to transfer per HTTP write.</td>
</tr>
<tr>
<td><option>command</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Command to be given to replicator</td>
</tr>
<tr>
<td><option>dontreplicate</option> = <replaceable>created_at date deleted_at location updated_at</replaceable></td>
<td>(StrOpt) List of fields to not replicate.</td>
</tr>
<tr>
<td><option>mastertoken</option> = <replaceable></replaceable></td>
<td>(StrOpt) Pass in your authentication token if you have one. This is the token used for the master.</td>
</tr>
<tr>
<td><option>metaonly</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Only replicate metadata, not images.</td>
</tr>
<tr>
<td><option>slavetoken</option> = <replaceable></replaceable></td>
<td>(StrOpt) Pass in your authentication token if you have one. This is the token used for the slave.</td>
</tr>
<tr>
<td><option>token</option> = <replaceable></replaceable></td>
<td>(StrOpt) Pass in your authentication token if you have one. If you use this option the same token is used for both the master and the slave.</td>
</tr>
</tbody>
</table>
</para>

10
doc/common/tables/glance-rpc.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>allowed_rpc_exception_modules</option> = <replaceable>openstack.common.exception, glance.common.exception, exceptions</replaceable></td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
@ -177,6 +177,14 @@
<td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
</tr>
<tr>
<td><option>heartbeat_rate</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat).</td>
</tr>
<tr>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>

26
doc/common/tables/glance-scrubber.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_scrubber">
<caption>Description of scrubber 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>wakeup_time</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Loop time between checking for new items to schedule for delete.</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/glance-taskflow.xml
View File

@ -18,11 +18,15 @@
<th colspan="2">[taskflow_executor]</th>
</tr>
<tr>
<td><option>engine_mode</option> = <replaceable>serial</replaceable></td>
<td><option>conversion_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The format to which images will be automatically converted. Can be 'qcow2' or 'raw'.</td>
</tr>
<tr>
<td><option>engine_mode</option> = <replaceable>parallel</replaceable></td>
<td>(StrOpt) The mode in which the engine will run. Can be 'serial' or 'parallel'.</td>
</tr>
<tr>
<td><option>max_workers</option> = <replaceable>1</replaceable></td>
<td><option>max_workers</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is 'parallel'.</td>
</tr>
</tbody>

8
doc/common/tables/glance-vmware.xml
View File

@ -27,11 +27,15 @@
</tr>
<tr>
<td><option>vmware_datacenter_path</option> = <replaceable>ha-datacenter</replaceable></td>
<td>(StrOpt) Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter".</td>
<td>(StrOpt) DEPRECATED. Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter". This option is deprecated in favor of vmware_datastores and will be removed in the Liberty release.</td>
</tr>
<tr>
<td><option>vmware_datastore_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Datastore associated with the datacenter.</td>
<td>(StrOpt) DEPRECATED. Datastore associated with the datacenter. This option is deprecated in favor of vmware_datastores and will be removed in the Liberty release.</td>
</tr>
<tr>
<td><option>vmware_datastores</option> = <replaceable>None</replaceable></td>
<td>(MultiStrOpt) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores. Either one of vmware_datastore_name or vmware_datastores is required. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":". Thus, the required format becomes &lt;datacenter_path&gt;:&lt;datastore_name&gt;:&lt;optional_weight&gt;. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected.</td>
</tr>
<tr>
<td><option>vmware_server_host</option> = <replaceable>None</replaceable></td>

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

@ -27,12 +27,15 @@
<xi:include href="../common/tables/glance-common.xml"/>
<xi:include href="../common/tables/glance-database.xml"/>
<xi:include href="../common/tables/glance-debug.xml"/>
<xi:include href="../common/tables/glance-elasticsearch.xml"/>
<xi:include href="../common/tables/glance-imagecache.xml"/>
<xi:include href="../common/tables/glance-logging.xml"/>
<xi:include href="../common/tables/glance-policy.xml"/>
<xi:include href="../common/tables/glance-profiler.xml"/>
<xi:include href="../common/tables/glance-redis.xml"/>
<xi:include href="../common/tables/glance-registry.xml"/>
<xi:include href="../common/tables/glance-replicator.xml"/>
<xi:include href="../common/tables/glance-scrubber.xml"/>
<xi:include href="../common/tables/glance-taskflow.xml"/>
<xi:include href="../common/tables/glance-testing.xml"/>
<xi:include href="image-service/section_image-service-api.xml"/>

47
tools/autogenerate-config-flagmappings/glance.flagmappings
View File

@ -6,31 +6,39 @@ allow_additional_image_properties common
allow_anonymous_access api
allowed_rpc_exception_modules rpc
api_limit_max common
args replicator
auth_region registry
auth_strategy registry
auth_url registry
available_plugins api
backdoor_port debug
backlog common
bind_host common
bind_port common
ca_file ca
cert_file ca
chunksize replicator
cleanup_scrubber imagecache
cleanup_scrubber_time imagecache
command replicator
control_exchange amqp
data_api common
db_enforce_mysql_charset database
debug logging
default_log_levels logging
default_publisher_id amqp
default_swift_reference swift
delayed_delete imagecache
digest_algorithm common
disabled_notifications amqp
dontreplicate replicator
enable_v1_api api
enable_v1_registry api
enable_v2_api api
enable_v2_registry api
fatal_deprecations logging
host common
http_keepalive api
http_timeout api
image_cache_dir imagecache
image_cache_driver imagecache
image_cache_max_size imagecache
@ -45,7 +53,14 @@ instance_format logging
instance_uuid_format logging
key_file ca
limit_param_default common
listener_workers common
load_enabled api
location_strategy api
log-config-append logging
log-date-format logging
log-dir logging
log-file logging
log-format logging
log_config_append logging
log_date_format logging
log_dir logging
@ -55,18 +70,17 @@ logging_context_format_string logging
logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
mastertoken replicator
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
max_header_line api
memcached_servers common
metadata_encryption_key common
metadata_source_path common
metaonly replicator
notification_driver amqp
notification_topics amqp
owner_is_tenant api
policy_default_rule policy
policy_dirs policy
policy_file policy
property_protection_file common
property_protection_rule_format common
public_endpoint api
@ -97,19 +111,25 @@ scrubber_datadir imagecache
send_identity_headers api
show_image_direct_url common
show_multiple_locations api
slavetoken replicator
swift_store_auth_address swift
swift_store_config_file swift
swift_store_key swift
swift_store_user swift
syslog-log-facility logging
syslog_log_facility logging
tcp_keepidle api
token replicator
transport_url amqp
use-syslog logging
use-syslog-rfc-format logging
use_stderr logging
use_syslog logging
use_syslog_rfc_format logging
use_user_token api
user_storage_quota common
verbose logging
wakeup_time scrubber
workers common
database/backend database
database/connection database
@ -131,6 +151,7 @@ database/slave_connection database
database/sqlite_db database
database/sqlite_synchronous database
database/use_db_reconnect database
elasticsearch/hosts elasticsearch
glance_store/cinder_api_insecure cinder
glance_store/cinder_ca_certificates_file cinder
glance_store/cinder_catalog_info cinder
@ -188,6 +209,7 @@ glance_store/vmware_api_insecure vmware
glance_store/vmware_api_retry_count vmware
glance_store/vmware_datacenter_path vmware
glance_store/vmware_datastore_name vmware
glance_store/vmware_datastores vmware
glance_store/vmware_server_host vmware
glance_store/vmware_server_password vmware
glance_store/vmware_server_username vmware
@ -266,6 +288,8 @@ oslo_messaging_qpid/rpc_conn_pool_size rpc
oslo_messaging_rabbit/amqp_auto_delete rpc
oslo_messaging_rabbit/amqp_durable_queues rpc
oslo_messaging_rabbit/fake_rabbit rpc
oslo_messaging_rabbit/heartbeat_rate rpc
oslo_messaging_rabbit/heartbeat_timeout_threshold rpc
oslo_messaging_rabbit/kombu_reconnect_delay rpc
oslo_messaging_rabbit/kombu_ssl_ca_certs rpc
oslo_messaging_rabbit/kombu_ssl_certfile rpc
@ -284,13 +308,26 @@ oslo_messaging_rabbit/rabbit_use_ssl rpc
oslo_messaging_rabbit/rabbit_userid rpc
oslo_messaging_rabbit/rabbit_virtual_host rpc
oslo_messaging_rabbit/rpc_conn_pool_size rpc
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
paste_deploy/config_file api
paste_deploy/flavor api
profiler/enabled profiler
profiler/trace_sqlalchemy profiler
service_credentials/insecure common
service_credentials/os_auth_url common
service_credentials/os_cacert common
service_credentials/os_endpoint_type common
service_credentials/os_password common
service_credentials/os_region_name common
service_credentials/os_tenant_id common
service_credentials/os_tenant_name common
service_credentials/os_username common
store_type_location_strategy/store_type_preference api
task/eventlet_executor_pool_size common
task/task_executor common
task/task_time_to_live common
task/work_dir common
taskflow_executor/conversion_format taskflow
taskflow_executor/engine_mode taskflow
taskflow_executor/max_workers taskflow

3
tools/autogenerate-config-flagmappings/glance.headers
View File

@ -1,8 +1,11 @@
elasticsearch Elasticsearch
filesystem filesystem
gridfs GridFS
imagecache flagmappings
matchmaker matchmaker
rbd RBD
registry registry
replicator replicator
scrubber scrubber
sheepdog Sheepdog
taskflow TaskFlow