From 8760986d9fbf06cc34756928f9b9bb13d9ffdfab Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Tue, 14 Jul 2015 23:04:06 +0200 Subject: [PATCH] [config-ref] Updated options for glance Partial-Bug: #1474384 Partial-Bug: #1465316 Partial-Bug: #1430862 Partial-Bug: #1430854 Closes-Bug: #1464591 Closes-Bug: #1403786 Closes-Bug: #1471938 Closes-Bug: #1466586 Closes-Bug: #1415962 Change-Id: I9aed1eb29e3348d451364f34febe9131267b2087 --- doc/common/tables/glance-amqp.xml | 2 +- doc/common/tables/glance-api.xml | 21 +++++- doc/common/tables/glance-auth_token.xml | 6 +- doc/common/tables/glance-common.xml | 4 +- doc/common/tables/glance-cors.xml | 73 +++++++++++++++++++ doc/common/tables/glance-imagecache.xml | 4 +- doc/common/tables/glance-logging.xml | 40 +--------- doc/common/tables/glance-qpid.xml | 4 +- doc/common/tables/glance-rabbitmq.xml | 12 ++- doc/common/tables/glance-rpc.xml | 6 +- doc/common/tables/glance-taskflow.xml | 2 +- doc/config-reference/ch_imageservice.xml | 1 + .../glance.flagmappings | 31 +++++--- .../shared.headers | 1 + 14 files changed, 143 insertions(+), 64 deletions(-) create mode 100644 doc/common/tables/glance-cors.xml diff --git a/doc/common/tables/glance-amqp.xml b/doc/common/tables/glance-amqp.xml index 9e4b6f2c95..db0efc3ed5 100644 --- a/doc/common/tables/glance-amqp.xml +++ b/doc/common/tables/glance-amqp.xml @@ -31,7 +31,7 @@ = [] - (MultiStrOpt) Driver or drivers to handle sending notifications. + (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop = notifications diff --git a/doc/common/tables/glance-api.xml b/doc/common/tables/glance-api.xml index 44466990a2..73b3bb9838 100644 --- a/doc/common/tables/glance-api.xml +++ b/doc/common/tables/glance-api.xml @@ -29,6 +29,10 @@ = (ListOpt) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded. + + = 900 + (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. + = True (BoolOpt) Deploy the v1 OpenStack Images API. @@ -45,6 +49,10 @@ = True (BoolOpt) Deploy the v2 OpenStack Registry API. + + = True + (BoolOpt) Deploy the v3 OpenStack Objects API. + = True (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. @@ -91,7 +99,7 @@ = True - (BoolOpt) Whether to pass through the user token when making requests to the registry. + (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. [glance_store] @@ -108,6 +116,17 @@ = file, http (ListOpt) List of stores enabled + + [oslo_middleware] + + + = 114688 + (IntOpt) The maximum body size for each request, in bytes. + + + = X-Forwarded-Proto + (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. + [paste_deploy] diff --git a/doc/common/tables/glance-auth_token.xml b/doc/common/tables/glance-auth_token.xml index bdcf1208c7..f62163e2ac 100644 --- a/doc/common/tables/glance-auth_token.xml +++ b/doc/common/tables/glance-auth_token.xml @@ -119,7 +119,7 @@ = 10 - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool. + (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. = 300 @@ -131,7 +131,7 @@ = 3 - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server. + (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. = 60 @@ -147,7 +147,7 @@ = False - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x. + (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. = 10 diff --git a/doc/common/tables/glance-common.xml b/doc/common/tables/glance-common.xml index 6b5e89e99b..197292a2f1 100644 --- a/doc/common/tables/glance-common.xml +++ b/doc/common/tables/glance-common.xml @@ -42,8 +42,8 @@ (StrOpt) Python module path of data access API - = sha1 - (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. + = sha256 + (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. = localhost diff --git a/doc/common/tables/glance-cors.xml b/doc/common/tables/glance-cors.xml new file mode 100644 index 0000000000..4bef33ac9a --- /dev/null +++ b/doc/common/tables/glance-cors.xml @@ -0,0 +1,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of CORS configuration options
Configuration option = Default valueDescription
[cors]
= True(BoolOpt) Indicate that the actual request can include user credentials
= Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma(ListOpt) Indicate which header field names may be used during the actual request.
= GET, POST, PUT, DELETE, OPTIONS(ListOpt) Indicate which methods can be used during the actual request.
= None(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
= Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
= 3600(IntOpt) Maximum cache age of CORS preflight requests.
[cors.subdomain]
= True(BoolOpt) Indicate that the actual request can include user credentials
= Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma(ListOpt) Indicate which header field names may be used during the actual request.
= GET, POST, PUT, DELETE, OPTIONS(ListOpt) Indicate which methods can be used during the actual request.
= None(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.
= Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
= 3600(IntOpt) Maximum cache age of CORS preflight requests.
+ diff --git a/doc/common/tables/glance-imagecache.xml b/doc/common/tables/glance-imagecache.xml index 5f776b28c0..d04f33a0eb 100644 --- a/doc/common/tables/glance-imagecache.xml +++ b/doc/common/tables/glance-imagecache.xml @@ -19,11 +19,11 @@ = False - (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. + (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. = 86400 - (IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup. + (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. = False diff --git a/doc/common/tables/glance-logging.xml b/doc/common/tables/glance-logging.xml index 72ee4aff8e..4e3e148e8d 100644 --- a/doc/common/tables/glance-logging.xml +++ b/doc/common/tables/glance-logging.xml @@ -57,26 +57,6 @@ = None (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. - - = None - (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. - - - = %Y-%m-%d %H:%M:%S - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . - - - = None - (StrOpt) (Optional) The base directory used for relative --log-file paths. - - - = None - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. - - - = None - (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. - = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s (StrOpt) Format string to use for log messages with context. @@ -90,7 +70,7 @@ (StrOpt) Format string to use for log messages without context. - = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s + = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s (StrOpt) Prefix each line of exception output with this format. @@ -101,29 +81,17 @@ = LOG_USER (StrOpt) Syslog facility to receive log lines. - - = LOG_USER - (StrOpt) Syslog facility to receive log lines. - - - = False - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. - - - = False - (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. - = True (BoolOpt) Log output to standard error. = False - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. + (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. - = False - (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. + = True + (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. = False diff --git a/doc/common/tables/glance-qpid.xml b/doc/common/tables/glance-qpid.xml index 76398a9be3..947be4e40b 100644 --- a/doc/common/tables/glance-qpid.xml +++ b/doc/common/tables/glance-qpid.xml @@ -70,8 +70,8 @@ (StrOpt) Username for Qpid connection. - = 30 - (IntOpt) Size of RPC connection pool. + = False + (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. diff --git a/doc/common/tables/glance-rabbitmq.xml b/doc/common/tables/glance-rabbitmq.xml index 19712dfab8..53f379a6fe 100644 --- a/doc/common/tables/glance-rabbitmq.xml +++ b/doc/common/tables/glance-rabbitmq.xml @@ -34,13 +34,17 @@ (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. - = 0 - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it. Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL + = 60 + (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL = 1.0 (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + + = 60 + (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + = (StrOpt) SSL certification authority file (valid only if SSL enabled). @@ -106,8 +110,8 @@ (StrOpt) The RabbitMQ virtual host. - = 30 - (IntOpt) Size of RPC connection pool. + = False + (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. diff --git a/doc/common/tables/glance-rpc.xml b/doc/common/tables/glance-rpc.xml index eb574b7500..8f7bd7760e 100644 --- a/doc/common/tables/glance-rpc.xml +++ b/doc/common/tables/glance-rpc.xml @@ -18,7 +18,7 @@ [DEFAULT] - = openstack.common.exception, glance.common.exception, exceptions + = glance.common.exception, exceptions (ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. @@ -37,6 +37,10 @@ = 30 (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + + = 30 + (IntOpt) Size of RPC connection pool. + = 60 (IntOpt) Seconds to wait for a response from a call. diff --git a/doc/common/tables/glance-taskflow.xml b/doc/common/tables/glance-taskflow.xml index 73de96c533..71a8c1f329 100644 --- a/doc/common/tables/glance-taskflow.xml +++ b/doc/common/tables/glance-taskflow.xml @@ -19,7 +19,7 @@ = None - (StrOpt) The format to which images will be automatically converted. Can be 'qcow2' or 'raw'. + (StrOpt) The format to which images will be automatically converted. = parallel diff --git a/doc/config-reference/ch_imageservice.xml b/doc/config-reference/ch_imageservice.xml index 186a3f3c70..070f55a3fb 100644 --- a/doc/config-reference/ch_imageservice.xml +++ b/doc/config-reference/ch_imageservice.xml @@ -25,6 +25,7 @@ The following tables provide a comprehensive list. + diff --git a/tools/autogenerate-config-flagmappings/glance.flagmappings b/tools/autogenerate-config-flagmappings/glance.flagmappings index 11885e0b04..a81864692e 100644 --- a/tools/autogenerate-config-flagmappings/glance.flagmappings +++ b/tools/autogenerate-config-flagmappings/glance.flagmappings @@ -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 diff --git a/tools/autogenerate-config-flagmappings/shared.headers b/tools/autogenerate-config-flagmappings/shared.headers index a648353bf0..bdc6e5e711 100644 --- a/tools/autogenerate-config-flagmappings/shared.headers +++ b/tools/autogenerate-config-flagmappings/shared.headers @@ -10,6 +10,7 @@ common common compute Compute conductor conductor console console +cors CORS database database debug logging ec2 EC2