openstack/openstack-manuals
Code Issues Proposed changes

Merge "[config-ref] Updated options for glance"

Browse Source
This commit is contained in:
Jenkins 2015-07-15 08:06:56 +00:00 committed by Gerrit Code Review
commit de96c974ec
14 changed files with 143 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>

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

@ -29,6 +29,10 @@
<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>client_socket_timeout</option> = <replaceable>900</replaceable></td>
<td>(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
</tr>
<tr>
<td><option>enable_v1_api</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>
@ -45,6 +49,10 @@
<td><option>enable_v2_registry</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Deploy the v2 OpenStack Registry API.</td>
</tr>
<tr>
<td><option>enable_v3_api</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Deploy the v3 OpenStack Objects 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>
@ -91,7 +99,7 @@
</tr>
<tr>
<td><option>use_user_token</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified.</td>
</tr>
<tr>
<th colspan="2">[glance_store]</th>
@ -108,6 +116,17 @@
<td><option>stores</option> = <replaceable>file, http</replaceable></td>
<td>(ListOpt) List of stores enabled</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
</tr>
<tr>
<th colspan="2">[paste_deploy]</th>
</tr>

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>

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

@ -42,8 +42,8 @@
<td>(StrOpt) Python module path of data access API</td>
</tr>
<tr>
<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>
<td><option>digest_algorithm</option> = <replaceable>sha256</replaceable></td>
<td>(StrOpt) Digest algorithm which will be used for digital signature. Use the command "openssl list-message-digest-algorithms" to get the available algorithmssupported 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>

73
doc/common/tables/glance-cors.xml Normal file
View File

@ -0,0 +1,73 @@
<?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_cors">
<caption>Description of CORS 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">[cors]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<th colspan="2">[cors.subdomain]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</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>

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

@ -57,26 +57,6 @@
<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>
@ -90,7 +70,7 @@
<td>(StrOpt) Format string to use for log messages without context.</td>
</tr>
<tr>
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
@ -101,29 +81,17 @@
<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>
</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>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later 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>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</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 K, and will be removed in M, along with this option.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>False</replaceable></td>

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

@ -70,8 +70,8 @@
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
</tr>
</tbody>
</table>

12
doc/common/tables/glance-rabbitmq.xml
View File

@ -34,13 +34,17 @@
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, &gt;0 enables it. Enabling heartbeats requires kombu&gt;=3.0.7 and amqp&gt;=1.4.0). EXPERIMENTAL</td>
<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). EXPERIMENTAL</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>
</tr>
<tr>
<td><option>kombu_reconnect_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
</tr>
<tr>
<td><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
@ -106,8 +110,8 @@
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
</tr>
</tbody>
</table>

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

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>allowed_rpc_exception_modules</option> = <replaceable>openstack.common.exception, glance.common.exception, exceptions</replaceable></td>
<td><option>allowed_rpc_exception_modules</option> = <replaceable>glance.common.exception, exceptions</replaceable></td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
@ -37,6 +37,10 @@
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>

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

@ -19,7 +19,7 @@
</tr>
<tr>
<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>
<td>(StrOpt) The format to which images will be automatically converted.</td>
</tr>
<tr>
<td><option>engine_mode</option> = <replaceable>parallel</replaceable></td>

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

@ -25,6 +25,7 @@
The following tables provide a comprehensive list.</para>
<xi:include href="../common/tables/glance-auth_token.xml"/>
<xi:include href="../common/tables/glance-common.xml"/>
<xi:include href="../common/tables/glance-cors.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"/>

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

@ -11,7 +11,6 @@ auth_region registry
auth_strategy registry
auth_url registry
available_plugins api
backdoor_port debug
backlog common
bind_host common
bind_port common
@ -20,6 +19,7 @@ cert_file ca
chunksize replicator
cleanup_scrubber imagecache
cleanup_scrubber_time imagecache
client_socket_timeout api
command replicator
control_exchange amqp
data_api common
@ -35,6 +35,7 @@ enable_v1_api api
enable_v1_registry api
enable_v2_api api
enable_v2_registry api
enable_v3_api api
fatal_deprecations logging
host common
http_keepalive api
@ -56,11 +57,6 @@ 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
@ -97,6 +93,7 @@ registry_host registry
registry_port registry
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_thread_pool_size rpc
rpc_zmq_bind_address zeromq
@ -116,13 +113,10 @@ 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
@ -131,6 +125,18 @@ user_storage_quota common
verbose logging
wakeup_time scrubber
workers common
cors/allow_credentials cors
cors/allow_headers cors
cors/allow_methods cors
cors/allowed_origin cors
cors/expose_headers cors
cors/max_age cors
cors.subdomain/allow_credentials cors
cors.subdomain/allow_headers cors
cors.subdomain/allow_methods cors
cors.subdomain/allowed_origin cors
cors.subdomain/expose_headers cors
cors.subdomain/max_age cors
database/backend database
database/connection database
database/connection_debug database
@ -284,13 +290,14 @@ oslo_messaging_qpid/qpid_sasl_mechanisms qpid
oslo_messaging_qpid/qpid_tcp_nodelay qpid
oslo_messaging_qpid/qpid_topology_version qpid
oslo_messaging_qpid/qpid_username qpid
oslo_messaging_qpid/rpc_conn_pool_size qpid
oslo_messaging_qpid/send_single_reply qpid
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/fake_rabbit rabbitmq
oslo_messaging_rabbit/heartbeat_rate rabbitmq
oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq
oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq
oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq
oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq
oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq
@ -307,7 +314,9 @@ oslo_messaging_rabbit/rabbit_retry_interval rabbitmq
oslo_messaging_rabbit/rabbit_use_ssl rabbitmq
oslo_messaging_rabbit/rabbit_userid rabbitmq
oslo_messaging_rabbit/rabbit_virtual_host rabbitmq
oslo_messaging_rabbit/rpc_conn_pool_size rabbitmq
oslo_messaging_rabbit/send_single_reply rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy

1
tools/autogenerate-config-flagmappings/shared.headers
View File

@ -10,6 +10,7 @@ common common
compute Compute
conductor conductor
console console
cors CORS
database database
debug logging
ec2 EC2