OpenStack Docs: glance-registry.conf

owner_is_tenant¶

Type:	boolean
Default:	`true`

Set the image owner to tenant or the authenticated user. Assign a boolean value to determine the owner of an image. When set to True, the owner of the image is the tenant. When set to False, the owner of the image will be the authenticated user issuing the request. Setting it to False makes the image private to the associated user and sharing with other users within the same tenant (or “project”) requires explicit image sharing via image membership. Possible values: * True * False Related options: * None

admin_role¶

Type:	string
Default:	`admin`

Role used to identify an authenticated user as administrator. Provide a string value representing a Keystone role to identify an administrative user. Users with this role will be granted administrative privileges. The default value for this option is ‘admin’. Possible values: * A string value which is a valid Keystone role Related options: * None

allow_anonymous_access¶

Type:	boolean
Default:	`false`

Allow limited access to unauthenticated users. Assign a boolean to determine API access for unathenticated users. When set to False, the API cannot be accessed by unauthenticated users. When set to True, unauthenticated users can access the API with read-only privileges. This however only applies when using ContextMiddleware. Possible values: * True * False Related options: * None

max_request_id_length¶

Type:	integer
Default:	`64`
Minimum Value:	0

Limit the request ID length. Provide an integer value to limit the length of the request ID to the specified length. The default value is 64. Users can change this to any ineteger value between 0 and 16384 however keeping in mind that a larger value may flood the logs. Possible values: * Integer value between 0 and 16384 Related options: * None

allow_additional_image_properties¶

Type:	boolean
Default:	`true`

Allow users to add additional/custom properties to images. Glance defines a standard set of properties (in its schema) that appear on every image. These properties are also known as base properties. In addition to these properties, Glance allows users to add custom properties to images. These are known as additional properties. By default, this configuration option is set to True and users are allowed to add additional properties. The number of additional properties that can be added to an image can be controlled via image_property_quota configuration option. Possible values: * True * False Related options: * image_property_quota

image_member_quota¶

Type:	integer
Default:	`128`

Maximum number of image members per image. This limits the maximum of users an image can be shared with. Any negative value is interpreted as unlimited. Related options: * None

image_property_quota¶

Type:	integer
Default:	`128`

Maximum number of properties allowed on an image. This enforces an upper limit on the number of additional properties an image can have. Any negative value is interpreted as unlimited. NOTE: This won’t have any impact if additional properties are disabled. Please refer to allow_additional_image_properties. Related options: * allow_additional_image_properties

image_tag_quota¶

Type:	integer
Default:	`128`

Maximum number of tags allowed on an image. Any negative value is interpreted as unlimited. Related options: * None

image_location_quota¶

Type:	integer
Default:	`10`

Maximum number of locations allowed on an image. Any negative value is interpreted as unlimited. Related options: * None

data_api¶

Type:	string
Default:	`glance.db.sqlalchemy.api`

Python module path of data access API. Specifies the path to the API to use for accessing the data model. This option determines how the image catalog data will be accessed. Possible values: * glance.db.sqlalchemy.api * glance.db.registry.api * glance.db.simple.api If this option is set to glance.db.sqlalchemy.api then the image catalog data is stored in and read from the database via the SQLAlchemy Core and ORM APIs. Setting this option to glance.db.registry.api will force all database access requests to be routed through the Registry service. This avoids data access from the Glance API nodes for an added layer of security, scalability and manageability. NOTE: In v2 OpenStack Images API, the registry service is optional. In order to use the Registry API in v2, the option enable_v2_registry must be set to True. Finally, when this configuration option is set to glance.db.simple.api, image catalog data is stored in and read from an in-memory data structure. This is primarily used for testing. Related options: * enable_v2_api * enable_v2_registry

limit_param_default¶

Type:	integer
Default:	`25`
Minimum Value:	1

The default number of results to return for a request. Responses to certain API requests, like list images, may return multiple items. The number of results returned can be explicitly controlled by specifying the limit parameter in the API request. However, if a limit parameter is not specified, this configuration value will be used as the default number of results to be returned for any API request. NOTES: * The value of this configuration option may not be greater than the value specified by api_limit_max. * Setting this to a very large value may slow down database queries and increase response times. Setting this to a very low value may result in poor user experience. Possible values: * Any positive integer Related options: * api_limit_max

api_limit_max¶

Type:	integer
Default:	`1000`
Minimum Value:	1

Maximum number of results that could be returned by a request. As described in the help text of limit_param_default, some requests may return multiple results. The number of results to be returned are governed either by the limit parameter in the request or the limit_param_default configuration option. The value in either case, can’t be greater than the absolute maximum defined by this configuration option. Anything greater than this value is trimmed down to the maximum value defined here. NOTE: Setting this to a very large value may slow down database queries and increase response times. Setting this to a very low value may result in poor user experience. Possible values: * Any positive integer Related options: * limit_param_default

show_image_direct_url¶

Type:	boolean
Default:	`false`

Show direct image location when returning an image. This configuration option indicates whether to show the direct image location when returning image details to the user. The direct image location is where the image data is stored in backend storage. This image location is shown under the image property direct_url. When multiple image locations exist for an image, the best location is displayed based on the location strategy indicated by the configuration option location_strategy. NOTES: * Revealing image locations can present a GRAVE SECURITY RISK as image locations can sometimes include credentials. Hence, this is set to False by default. Set this to True with EXTREME CAUTION and ONLY IF you know what you are doing! * If an operator wishes to avoid showing any image location(s) to the user, then both this option and show_multiple_locations MUST be set to False. Possible values: * True * False Related options: * show_multiple_locations * location_strategy

show_multiple_locations¶

Type:	boolean
Default:	`false`

Show all image locations when returning an image. This configuration option indicates whether to show all the image locations when returning image details to the user. When multiple image locations exist for an image, the locations are ordered based on the location strategy indicated by the configuration opt location_strategy. The image locations are shown under the image property locations. NOTES: * Revealing image locations can present a GRAVE SECURITY RISK as image locations can sometimes include credentials. Hence, this is set to False by default. Set this to True with EXTREME CAUTION and ONLY IF you know what you are doing! * If an operator wishes to avoid showing any image location(s) to the user, then both this option and show_image_direct_url MUST be set to False. Possible values: * True * False Related options: * show_image_direct_url * location_strategy

Warning

This option is deprecated for removal since Newton. Its value may be silently ignored in the future.

Reason:	This option will be removed in the Pike release or later because the same functionality can be achieved with greater granularity by using policies. Please see the Newton release notes for more information.

image_size_cap¶

Type:	integer
Default:	`1099511627776`
Minimum Value:	1
Maximum Value:	9223372036854775808

Maximum size of image a user can upload in bytes. An image upload greater than the size mentioned here would result in an image creation failure. This configuration option defaults to 1099511627776 bytes (1 TiB). NOTES: * This value should only be increased after careful consideration and must be set less than or equal to 8 EiB (9223372036854775808). * This value must be set with careful consideration of the backend storage capacity. Setting this to a very low value may result in a large number of image failures. And, setting this to a very large value may result in faster consumption of storage. Hence, this must be set according to the nature of images created and storage capacity available. Possible values: * Any positive number less than or equal to 9223372036854775808

user_storage_quota¶

Type:	string
Default:	`0`

Maximum amount of image storage per tenant. This enforces an upper limit on the cumulative storage consumed by all images of a tenant across all stores. This is a per-tenant limit. The default unit for this configuration option is Bytes. However, storage units can be specified using case-sensitive literals B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. Note that there should not be any space between the value and unit. Value 0 signifies no quota enforcement. Negative values are invalid and result in errors. Possible values: * A string that is a valid concatenation of a non-negative integer representing the storage value and an optional string literal representing storage units as mentioned above. Related options: * None

enable_v1_api¶

Type:	boolean
Default:	`true`

Deploy the v1 OpenStack Images API. When this option is set to True, Glance service will respond to requests on registered endpoints conforming to the v1 OpenStack Images API. NOTES: * If this option is enabled, then enable_v1_registry must also be set to True to enable mandatory usage of Registry service with v1 API. * If this option is disabled, then the enable_v1_registry option, which is enabled by default, is also recommended to be disabled. * This option is separate from enable_v2_api, both v1 and v2 OpenStack Images API can be deployed independent of each other. * If deploying only the v2 Images API, this option, which is enabled by default, should be disabled. Possible values: * True * False Related options: * enable_v1_registry * enable_v2_api

enable_v2_api¶

Type:	boolean
Default:	`true`

Deploy the v2 OpenStack Images API. When this option is set to True, Glance service will respond to requests on registered endpoints conforming to the v2 OpenStack Images API. NOTES: * If this option is disabled, then the enable_v2_registry option, which is enabled by default, is also recommended to be disabled. * This option is separate from enable_v1_api, both v1 and v2 OpenStack Images API can be deployed independent of each other. * If deploying only the v1 Images API, this option, which is enabled by default, should be disabled. Possible values: * True * False Related options: * enable_v2_registry * enable_v1_api

enable_v1_registry¶

Type:	boolean
Default:	`true`

Deploy the v1 API Registry service. When this option is set to True, the Registry service will be enabled in Glance for v1 API requests. NOTES: * Use of Registry is mandatory in v1 API, so this option must be set to True if the enable_v1_api option is enabled. * If deploying only the v2 OpenStack Images API, this option, which is enabled by default, should be disabled. Possible values: * True * False Related options: * enable_v1_api

enable_v2_registry¶

Type:	boolean
Default:	`true`

Deploy the v2 API Registry service. When this option is set to True, the Registry service will be enabled in Glance for v2 API requests. NOTES: * Use of Registry is optional in v2 API, so this option must only be enabled if both enable_v2_api is set to True and the data_api option is set to glance.db.registry.api. * If deploying only the v1 OpenStack Images API, this option, which is enabled by default, should be disabled. Possible values: * True * False Related options: * enable_v2_api * data_api

pydev_worker_debug_host¶

Type:	host address
Default:	`localhost`

Host address of the pydev server. Provide a string value representing the hostname or IP of the pydev server to use for debugging. The pydev server listens for debug connections on this address, facilitating remote debugging in Glance. Possible values: * Valid hostname * Valid IP address Related options: * None

pydev_worker_debug_port¶

Type:	port number
Default:	`5678`
Minimum Value:	0
Maximum Value:	65535

Port number that the pydev server will listen on. Provide a port number to bind the pydev server to. The pydev process accepts debug connections on this port and facilitates remote debugging in Glance. Possible values: * A valid port number Related options: * None

metadata_encryption_key¶

Type:	string
Default:	`<None>`

AES key for encrypting store location metadata. Provide a string value representing the AES cipher to use for encrypting Glance store metadata. NOTE: The AES key to use must be set to a random string of length 16, 24 or 32 bytes. Possible values: * String value representing a valid AES key Related options: * None

digest_algorithm¶

Type:	string
Default:	`sha256`

Digest algorithm to use for digital signature. Provide a string value representing the digest algorithm to use for generating digital signatures. By default, sha256 is used. To get a list of the available algorithms supported by the version of OpenSSL on your platform, run the command: openssl list-message-digest-algorithms. Examples are ‘sha1’, ‘sha256’, and ‘sha512’. NOTE: digest_algorithm is not related to Glance’s image signing and verification. It is only used to sign the universally unique identifier (UUID) as a part of the certificate file and key file validation. Possible values: * An OpenSSL message digest algorithm identifier Relation options: * None

node_staging_uri¶

Type:	string
Default:	`file:///tmp/staging/`

The URL provides location where the temporary data will be stored This option is for Glance internal use only. Glance will save the image data uploaded by the user to ‘staging’ endpoint during the image import process. This option does not change the ‘staging’ API endpoint by any means. NOTE: It is discouraged to use same path as [task]/work_dir NOTE: ‘file://<absolute-directory-path>’ is the only option api_image_import flow will support for now. NOTE: The staging path must be on shared filesystem available to all Glance API nodes. Possible values: * String starting with ‘file://’ followed by absolute FS path Related options: * [task]/work_dir * [DEFAULT]/enable_image_import (deprecated)

enable_image_import¶

Type:	boolean
Default:	`false`

Enables the Image Import workflow introduced in Pike As ‘[DEFAULT]/node_staging_uri’ is required for the Image Import, it’s disabled per default in Pike, enabled per default in Queens and removed in Rocky. This allows Glance to operate with previous version configs upon upgrade. Setting this option to True will enable the endpoints related to Image Import Refactoring work. Related options: * [DEFUALT]/node_staging_uri

Warning

This option is deprecated for removal since Pike. Its value may be silently ignored in the future.

Reason:	This option is deprecated for removal in Rocky. It was introduced to make sure that the API is not enabled before the ‘[DEFAULT]/node_staging_uri’ is defined and is long term redundant.

bind_host¶

Type:	host address
Default:	`0.0.0.0`

IP address to bind the glance servers to. Provide an IP address to bind the glance server to. The default value is 0.0.0.0. Edit this option to enable the server to listen on one particular IP address on the network card. This facilitates selection of a particular network interface for the server. Possible values: * A valid IPv4 address * A valid IPv6 address Related options: * None

bind_port¶

Type:	port number
Default:	`<None>`
Minimum Value:	0
Maximum Value:	65535

Port number on which the server will listen. Provide a valid port number to bind the server’s socket to. This port is then set to identify processes and forward network messages that arrive at the server. The default bind_port value for the API server is 9292 and for the registry server is 9191. Possible values: * A valid port number (0 to 65535) Related options: * None

backlog¶

Type:	integer
Default:	`4096`
Minimum Value:	1

Set the number of incoming connection requests. Provide a positive integer value to limit the number of requests in the backlog queue. The default queue size is 4096. An incoming connection to a TCP listener socket is queued before a connection can be established with the server. Setting the backlog for a TCP socket ensures a limited queue size for incoming traffic. Possible values: * Positive integer Related options: * None

tcp_keepidle¶

Type:	integer
Default:	`600`
Minimum Value:	1

Set the wait time before a connection recheck. Provide a positive integer value representing time in seconds which is set as the idle wait time before a TCP keep alive packet can be sent to the host. The default value is 600 seconds. Setting tcp_keepidle helps verify at regular intervals that a connection is intact and prevents frequent TCP connection reestablishment. Possible values: * Positive integer value representing time in seconds Related options: * None

ca_file¶

Type:	string
Default:	`/etc/ssl/cafile`

Absolute path to the CA file. Provide a string value representing a valid absolute path to the Certificate Authority file to use for client authentication. A CA file typically contains necessary trusted certificates to use for the client authentication. This is essential to ensure that a secure connection is established to the server via the internet. Possible values: * Valid absolute path to the CA file Related options: * None

cert_file¶

Type:	string
Default:	`/etc/ssl/certs`

Absolute path to the certificate file. Provide a string value representing a valid absolute path to the certificate file which is required to start the API service securely. A certificate file typically is a public key container and includes the server’s public key, server name, server information and the signature which was a result of the verification process using the CA certificate. This is required for a secure connection establishment. Possible values: * Valid absolute path to the certificate file Related options: * None

key_file¶

Type:	string
Default:	`/etc/ssl/key/key-file.pem`

Absolute path to a private key file. Provide a string value representing a valid absolute path to a private key file which is required to establish the client-server connection. Possible values: * Absolute path to the private key file Related options: * None

secure_proxy_ssl_header¶

Type:	string
Default:	`<None>`

The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is “HTTP_X_FORWARDED_PROTO”.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Use the http_proxy_to_wsgi middleware instead.

workers¶

Type:	integer
Default:	`<None>`
Minimum Value:	0

Number of Glance worker processes to start. Provide a non-negative integer value to set the number of child process workers to service requests. By default, the number of CPUs available is set as the value for workers. Each worker process is made to listen on the port set in the configuration file and contains a greenthread pool of size 1000. NOTE: Setting the number of workers to zero, triggers the creation of a single API process with a greenthread pool of size 1000. Possible values: * 0 * Positive integer value (typically equal to the number of CPUs) Related options: * None

max_header_line¶

Type:	integer
Default:	`16384`
Minimum Value:	0

Maximum line size of message headers. Provide an integer value representing a length to limit the size of message headers. The default value is 16384. NOTE: max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). However, it is to be kept in mind that larger values for max_header_line would flood the logs. Setting max_header_line to 0 sets no limit for the line size of message headers. Possible values: * 0 * Positive integer Related options: * None

http_keepalive¶

Type:	boolean
Default:	`true`

Set keep alive option for HTTP over TCP. Provide a boolean value to determine sending of keep alive packets. If set to False, the server returns the header “Connection: close”. If set to True, the server returns a “Connection: Keep-Alive” in its responses. This enables retention of the same TCP connection for HTTP conversations instead of opening a new one with each new request. This option must be set to False if the client socket connection needs to be closed explicitly after the response is received and read successfully by the client. Possible values: * True * False Related options: * None

client_socket_timeout¶

Type:	integer
Default:	`900`
Minimum Value:	0

Timeout for client connections’ socket operations. Provide a valid integer value representing time in seconds to set the period of wait before an incoming connection can be closed. The default value is 900 seconds. The value zero implies wait forever. Possible values: * Zero * Positive integer Related options: * None

rpc_conn_pool_size¶

Type:	integer
Default:	`30`

Size of RPC connection pool.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_conn_pool_size

conn_pool_min_size¶

Type:	integer
Default:	`2`

The pool size limit for connections expiration policy

conn_pool_ttl¶

Type:	integer
Default:	`1200`

The time-to-live in sec of idle connections in the pool

rpc_zmq_bind_address¶

Type:	string
Default:	`*`

ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_bind_address

rpc_zmq_matchmaker¶

Type:	string
Default:	`redis`
Valid Values:	redis, sentinel, dummy

MatchMaker driver.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_matchmaker

rpc_zmq_contexts¶

Type:	integer
Default:	`1`

Number of ZeroMQ contexts, defaults to 1.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_contexts

rpc_zmq_topic_backlog¶

Type:	integer
Default:	`<None>`

Maximum number of ingress messages to locally buffer per topic. Default is unlimited.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_topic_backlog

rpc_zmq_ipc_dir¶

Type:	string
Default:	`/var/run/openstack`

Directory for holding IPC sockets.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_ipc_dir

rpc_zmq_host¶

Type:	string
Default:	`localhost`

Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_host

zmq_linger¶

Type:	integer
Default:	`-1`

Number of seconds to wait before all pending messages will be sent after closing a socket. The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Positive values specify an upper bound for the linger period.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_cast_timeout

rpc_poll_timeout¶

Type:	integer
Default:	`1`

The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_poll_timeout

zmq_target_expire¶

Type:	integer
Default:	`300`

Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

Deprecated Variations¶
Group	Name
DEFAULT	zmq_target_expire

zmq_target_update¶

Type:	integer
Default:	`180`

Update period in seconds of a name service record about existing target.

Deprecated Variations¶
Group	Name
DEFAULT	zmq_target_update

use_pub_sub¶

Type:	boolean
Default:	`false`

Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.

Deprecated Variations¶
Group	Name
DEFAULT	use_pub_sub

use_router_proxy¶

Type:	boolean
Default:	`false`

Use ROUTER remote proxy.

Deprecated Variations¶
Group	Name
DEFAULT	use_router_proxy

use_dynamic_connections¶

Type:	boolean
Default:	`false`

This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).

zmq_failover_connections¶

Type:	integer
Default:	`2`

How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.

rpc_zmq_min_port¶

Type:	port number
Default:	`49153`
Minimum Value:	0
Maximum Value:	65535

Minimal port number for random ports range.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_min_port

rpc_zmq_max_port¶

Type:	integer
Default:	`65536`
Minimum Value:	1
Maximum Value:	65536

Maximal port number for random ports range.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_max_port

rpc_zmq_bind_port_retries¶

Type:	integer
Default:	`100`

Number of retries to find free port number before fail with ZMQBindError.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_bind_port_retries

rpc_zmq_serialization¶

Type:	string
Default:	`json`
Valid Values:	json, msgpack

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_serialization

zmq_immediate¶

Type:	boolean
Default:	`true`

This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.

zmq_tcp_keepalive¶

Type:	integer
Default:	`-1`

Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.

zmq_tcp_keepalive_idle¶

Type:	integer
Default:	`-1`

The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_cnt¶

Type:	integer
Default:	`-1`

The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_intvl¶

Type:	integer
Default:	`-1`

The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

rpc_thread_pool_size¶

Type:	integer
Default:	`100`

Maximum number of (green) threads to work concurrently.

rpc_message_ttl¶

Type:	integer
Default:	`300`

Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.

rpc_use_acks¶

Type:	boolean
Default:	`false`

Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.

rpc_ack_timeout_base¶

Type:	integer
Default:	`15`

Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.

rpc_ack_timeout_multiplier¶

Type:	integer
Default:	`2`

Number to multiply base ack timeout by after each retry attempt.

rpc_retry_attempts¶

Type:	integer
Default:	`3`

Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.

subscribe_on¶

Type:	list
Default:

List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.

executor_thread_pool_size¶

Type:	integer
Default:	`64`

Size of executor thread pool when executor is threading or eventlet.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_thread_pool_size

rpc_response_timeout¶

Type:	integer
Default:	`60`

Seconds to wait for a response from a call.

transport_url¶

Type:	string
Default:	`<None>`

A URL representing the messaging driver to use and its full configuration.

rpc_backend¶

Type:	string
Default:	`rabbit`

The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

control_exchange¶

Type:	string
Default:	`openstack`

The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.

debug¶

Type:	boolean
Default:	`false`
Mutable:	This option can be changed without restarting.

If set to true, the logging level will be set to DEBUG instead of the default INFO level.

log_config_append¶

Type:	string
Default:	`<None>`
Mutable:	This option can be changed without restarting.

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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).

Deprecated Variations¶
Group	Name
DEFAULT	log-config
DEFAULT	log_config

log_date_format¶

Type:	string
Default:	`%Y-%m-%d %H:%M:%S`

Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.

log_file¶

Type:	string
Default:	`<None>`

(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

Deprecated Variations¶
Group	Name
DEFAULT	logfile

log_dir¶

Type:	string
Default:	`<None>`

(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

Deprecated Variations¶
Group	Name
DEFAULT	logdir

watch_log_file¶

Type:	boolean
Default:	`false`

Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

use_syslog¶

Type:	boolean
Default:	`false`

Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.

use_journal¶

Type:	boolean
Default:	`false`

Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

syslog_log_facility¶

Type:	string
Default:	`LOG_USER`

Syslog facility to receive log lines. This option is ignored if log_config_append is set.

use_stderr¶

Type:	boolean
Default:	`false`

Log output to standard error. This option is ignored if log_config_append is set.

logging_context_format_string¶

Type:	string
Default:	`%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`

Format string to use for log messages with context.

logging_default_format_string¶

Type:	string
Default:	`%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`

Format string to use for log messages when context is undefined.

logging_debug_format_suffix¶

Type:	string
Default:	`%(funcName)s %(pathname)s:%(lineno)d`

Additional data to append to log message when logging level for the message is DEBUG.

logging_exception_prefix¶

Type:	string
Default:	`%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`

Prefix each line of exception output with this format.

logging_user_identity_format¶

Type:	string
Default:	`%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`

Defines the format string for %(user_identity)s that is used in logging_context_format_string.

default_log_levels¶

Type: list

Default: amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=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,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO

List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

publish_errors¶

Type:	boolean
Default:	`false`

Enables or disables publication of error events.

instance_format¶

Type:	string
Default:	`"[instance: %(uuid)s] "`

The format for an instance that is passed with the log message.

instance_uuid_format¶

Type:	string
Default:	`"[instance: %(uuid)s] "`

The format for an instance UUID that is passed with the log message.

rate_limit_interval¶

Type:	integer
Default:	`0`

Interval, number of seconds, of log rate limiting.

rate_limit_burst¶

Type:	integer
Default:	`0`

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level¶

Type:	string
Default:	`CRITICAL`

Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

fatal_deprecations¶

Type:	boolean
Default:	`false`

Enables or disables fatal status of deprecations.

sqlite_synchronous¶

Type:	boolean
Default:	`true`

If True, SQLite uses synchronous mode.

Deprecated Variations¶
Group	Name
DEFAULT	sqlite_synchronous

backend¶

Type:	string
Default:	`sqlalchemy`

The back end to use for the database.

Deprecated Variations¶
Group	Name
DEFAULT	db_backend

connection¶

Type:	string
Default:	`<None>`

The SQLAlchemy connection string to use to connect to the database.

Deprecated Variations¶
Group	Name
DEFAULT	sql_connection
DATABASE	sql_connection
sql	connection

slave_connection¶

Type:	string
Default:	`<None>`

The SQLAlchemy connection string to use to connect to the slave database.

mysql_sql_mode¶

Type:	string
Default:	`TRADITIONAL`

The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=

mysql_enable_ndb¶

Type:	boolean
Default:	`false`

If True, transparently enables support for handling MySQL Cluster (NDB).

idle_timeout¶

Type:	integer
Default:	`3600`

Timeout before idle SQL connections are reaped.

Deprecated Variations¶
Group	Name
DEFAULT	sql_idle_timeout
DATABASE	sql_idle_timeout
sql	idle_timeout

min_pool_size¶

Type:	integer
Default:	`1`

Minimum number of SQL connections to keep open in a pool.

Deprecated Variations¶
Group	Name
DEFAULT	sql_min_pool_size
DATABASE	sql_min_pool_size

max_pool_size¶

Type:	integer
Default:	`5`

Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.

Deprecated Variations¶
Group	Name
DEFAULT	sql_max_pool_size
DATABASE	sql_max_pool_size

max_retries¶

Type:	integer
Default:	`10`

Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

Deprecated Variations¶
Group	Name
DEFAULT	sql_max_retries
DATABASE	sql_max_retries

retry_interval¶

Type:	integer
Default:	`10`

Interval between retries of opening a SQL connection.

Deprecated Variations¶
Group	Name
DEFAULT	sql_retry_interval
DATABASE	reconnect_interval

max_overflow¶

Type:	integer
Default:	`50`

If set, use this value for max_overflow with SQLAlchemy.

Deprecated Variations¶
Group	Name
DEFAULT	sql_max_overflow
DATABASE	sqlalchemy_max_overflow

connection_debug¶

Type:	integer
Default:	`0`
Minimum Value:	0
Maximum Value:	100

Verbosity of SQL debugging information: 0=None, 100=Everything.

Deprecated Variations¶
Group	Name
DEFAULT	sql_connection_debug

connection_trace¶

Type:	boolean
Default:	`false`

Add Python stack traces to SQL as comment strings.

Deprecated Variations¶
Group	Name
DEFAULT	sql_connection_trace

pool_timeout¶

Type:	integer
Default:	`<None>`

If set, use this value for pool_timeout with SQLAlchemy.

Deprecated Variations¶
Group	Name
DATABASE	sqlalchemy_pool_timeout

use_db_reconnect¶

Type:	boolean
Default:	`false`

Enable the experimental use of database reconnect on connection lost.

db_retry_interval¶

Type:	integer
Default:	`1`

Seconds between retries of a database transaction.

db_inc_retry_interval¶

Type:	boolean
Default:	`true`

If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retry_interval¶

Type:	integer
Default:	`10`

If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.

db_max_retries¶

Type:	integer
Default:	`20`

Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

use_tpool¶

Type:	boolean
Default:	`false`

Enable the experimental use of thread pooling for all DB API calls

Deprecated Variations¶
Group	Name
DEFAULT	dbapi_use_tpool

auth_uri¶

Type:	string
Default:	`<None>`

Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.

auth_version¶

Type:	string
Default:	`<None>`

API version of the admin Identity API endpoint.

delay_auth_decision¶

Type:	boolean
Default:	`false`

Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.

http_connect_timeout¶

Type:	integer
Default:	`<None>`

Request timeout value for communicating with Identity API server.

http_request_max_retries¶

Type:	integer
Default:	`3`

How many times are we trying to reconnect when communicating with Identity API Server.

cache¶

Type:	string
Default:	`<None>`

Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the memcached_servers option instead.

certfile¶

Type:	string
Default:	`<None>`

Required if identity server requires client certificate

keyfile¶

Type:	string
Default:	`<None>`

Required if identity server requires client certificate

cafile¶

Type:	string
Default:	`<None>`

A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.

insecure¶

Type:	boolean
Default:	`false`

Verify HTTPS connections.

region_name¶

Type:	string
Default:	`<None>`

The region in which the identity server can be found.

signing_dir¶

Type:	string
Default:	`<None>`

Directory used to cache files related to PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release.

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:	PKI token format is no longer supported.

memcached_servers¶

Type:	list
Default:	`<None>`

Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

Deprecated Variations¶
Group	Name
keystone_authtoken	memcache_servers

token_cache_time¶

Type:	integer
Default:	`300`

In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.

revocation_cache_time¶

Type:	integer
Default:	`10`

Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. Only valid for PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release.

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:	PKI token format is no longer supported.

memcache_security_strategy¶

Type:	string
Default:	`None`
Valid Values:	None, MAC, ENCRYPT

(Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.

memcache_secret_key¶

Type:	string
Default:	`<None>`

(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.

memcache_pool_dead_retry¶

Type:	integer
Default:	`300`

(Optional) Number of seconds memcached server is considered dead before it is tried again.

memcache_pool_maxsize¶

Type:	integer
Default:	`10`

(Optional) Maximum total number of open connections to every memcached server.

memcache_pool_socket_timeout¶

Type:	integer
Default:	`3`

(Optional) Socket timeout in seconds for communicating with a memcached server.

memcache_pool_unused_timeout¶

Type:	integer
Default:	`60`

(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.

memcache_pool_conn_get_timeout¶

Type:	integer
Default:	`10`

(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.

memcache_use_advanced_pool¶

Type:	boolean
Default:	`false`

(Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.

include_service_catalog¶

Type:	boolean
Default:	`true`

(Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.

enforce_token_bind¶

Type:	string
Default:	`permissive`

Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.

check_revocations_for_cached¶

Type:	boolean
Default:	`false`

If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:	PKI token format is no longer supported.

hash_algorithms¶

Type:	list
Default:	`md5`

Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.

Warning

This option is deprecated for removal since Ocata. Its value may be silently ignored in the future.

Reason:	PKI token format is no longer supported.

service_token_roles¶

Type:	list
Default:	`service`

A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.

service_token_roles_required¶

Type:	boolean
Default:	`false`

For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.

auth_type¶

Type:	unknown type
Default:	`<None>`

Authentication type to load

Deprecated Variations¶
Group	Name
keystone_authtoken	auth_plugin

auth_section¶

Type:	unknown type
Default:	`<None>`

Config Section from which to load plugin specific options

host¶

Type:	string
Default:	`127.0.0.1`

Host to locate redis.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

port¶

Type:	port number
Default:	`6379`
Minimum Value:	0
Maximum Value:	65535

Use this port to connect to redis host.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

password¶

Type:	string
Default:

Password for Redis server (optional).

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

sentinel_hosts¶

Type:	list
Default:

List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port … ]

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

sentinel_group_name¶

Type:	string
Default:	`oslo-messaging-zeromq`

Redis replica set name.

wait_timeout¶

Type:	integer
Default:	`2000`

Time in ms to wait between connection attempts.

check_timeout¶

Type:	integer
Default:	`20000`

Time in ms to wait before the transaction is killed.

socket_timeout¶

Type:	integer
Default:	`10000`

Timeout in ms on blocking socket operations.

container_name¶

Type:	string
Default:	`<None>`

Name for the AMQP container. must be globally unique. Defaults to a generated UUID

Deprecated Variations¶
Group	Name
amqp1	container_name

idle_timeout¶

Type:	integer
Default:	`0`

Timeout for inactive connections (in seconds)

Deprecated Variations¶
Group	Name
amqp1	idle_timeout

trace¶

Type:	boolean
Default:	`false`

Debug: dump AMQP frames to stdout

Deprecated Variations¶
Group	Name
amqp1	trace

ssl¶

Type:	boolean
Default:	`false`

Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.

ssl_ca_file¶

Type:	string
Default:

CA certificate PEM file used to verify the server’s certificate

Deprecated Variations¶
Group	Name
amqp1	ssl_ca_file

ssl_cert_file¶

Type:	string
Default:

Self-identifying certificate PEM file for client authentication

Deprecated Variations¶
Group	Name
amqp1	ssl_cert_file

ssl_key_file¶

Type:	string
Default:

Private key PEM file used to sign ssl_cert_file certificate (optional)

Deprecated Variations¶
Group	Name
amqp1	ssl_key_file

ssl_key_password¶

Type:	string
Default:	`<None>`

Password for decrypting ssl_key_file (if encrypted)

Deprecated Variations¶
Group	Name
amqp1	ssl_key_password

ssl_verify_vhost¶

Type:	boolean
Default:	`false`

By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.

allow_insecure_clients¶

Type:	boolean
Default:	`false`

Accept clients using either SSL or plain TCP

Deprecated Variations¶
Group	Name
amqp1	allow_insecure_clients

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Not applicable - not a SSL server

sasl_mechanisms¶

Type:	string
Default:

Space separated list of acceptable SASL mechanisms

Deprecated Variations¶
Group	Name
amqp1	sasl_mechanisms

sasl_config_dir¶

Type:	string
Default:

Path to directory that contains the SASL configuration

Deprecated Variations¶
Group	Name
amqp1	sasl_config_dir

sasl_config_name¶

Type:	string
Default:

Name of configuration file (without .conf suffix)

Deprecated Variations¶
Group	Name
amqp1	sasl_config_name

sasl_default_realm¶

Type:	string
Default:

SASL realm to use if no realm present in username

username¶

Type:	string
Default:

User name for message broker authentication

Deprecated Variations¶
Group	Name
amqp1	username

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Should use configuration option transport_url to provide the username.

password¶

Type:	string
Default:

Password for message broker authentication

Deprecated Variations¶
Group	Name
amqp1	password

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Should use configuration option transport_url to provide the password.

connection_retry_interval¶

Type:	integer
Default:	`1`
Minimum Value:	1

Seconds to pause before attempting to re-connect.

connection_retry_backoff¶

Type:	integer
Default:	`2`
Minimum Value:	0

Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.

connection_retry_interval_max¶

Type:	integer
Default:	`30`
Minimum Value:	1

Maximum limit for connection_retry_interval + connection_retry_backoff

link_retry_delay¶

Type:	integer
Default:	`10`
Minimum Value:	1

Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.

default_reply_retry¶

Type:	integer
Default:	`0`
Minimum Value:	-1

The maximum number of attempts to re-send a reply message which failed due to a recoverable error.

default_reply_timeout¶

Type:	integer
Default:	`30`
Minimum Value:	5

The deadline for an rpc reply message delivery.

default_send_timeout¶

Type:	integer
Default:	`30`
Minimum Value:	5

The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.

default_notify_timeout¶

Type:	integer
Default:	`30`
Minimum Value:	5

The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.

default_sender_link_timeout¶

Type:	integer
Default:	`600`
Minimum Value:	1

The duration to schedule a purge of idle sender links. Detach link after expiry.

addressing_mode¶

Type:	string
Default:	`dynamic`

Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing

pseudo_vhost¶

Type:	boolean
Default:	`true`

Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.

server_request_prefix¶

Type:	string
Default:	`exclusive`

address prefix used when sending to a specific server

Deprecated Variations¶
Group	Name
amqp1	server_request_prefix

broadcast_prefix¶

Type:	string
Default:	`broadcast`

address prefix used when broadcasting to all servers

Deprecated Variations¶
Group	Name
amqp1	broadcast_prefix

group_request_prefix¶

Type:	string
Default:	`unicast`

address prefix when sending to any server in group

Deprecated Variations¶
Group	Name
amqp1	group_request_prefix

rpc_address_prefix¶

Type:	string
Default:	`openstack.org/om/rpc`

Address prefix for all generated RPC addresses

notify_address_prefix¶

Type:	string
Default:	`openstack.org/om/notify`

Address prefix for all generated Notification addresses

multicast_address¶

Type:	string
Default:	`multicast`

Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.

unicast_address¶

Type:	string
Default:	`unicast`

Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.

anycast_address¶

Type:	string
Default:	`anycast`

Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.

default_notification_exchange¶

Type:	string
Default:	`<None>`

Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’

default_rpc_exchange¶

Type:	string
Default:	`<None>`

Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’

reply_link_credit¶

Type:	integer
Default:	`200`
Minimum Value:	1

Window size for incoming RPC Reply messages.

rpc_server_credit¶

Type:	integer
Default:	`100`
Minimum Value:	1

Window size for incoming RPC Request messages

notify_server_credit¶

Type:	integer
Default:	`100`
Minimum Value:	1

Window size for incoming Notification messages

pre_settled¶

Type:	multi-valued
Default:	`rpc-cast`
Default:	`rpc-reply`

Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ‘rpc-call’ - send RPC Calls pre-settled ‘rpc-reply’- send RPC Replies pre-settled ‘rpc-cast’ - Send RPC Casts pre-settled ‘notify’ - Send Notifications pre-settled

kafka_default_host¶

Type:	string
Default:	`localhost`

Default Kafka broker Host

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

kafka_default_port¶

Type:	port number
Default:	`9092`
Minimum Value:	0
Maximum Value:	65535

Default Kafka broker Port

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

kafka_max_fetch_bytes¶

Type:	integer
Default:	`1048576`

Max fetch bytes of Kafka consumer

kafka_consumer_timeout¶

Type:	floating point
Default:	`1.0`

Default timeout(s) for Kafka consumers

pool_size¶

Type:	integer
Default:	`10`

Pool Size for Kafka Consumers

conn_pool_min_size¶

Type:	integer
Default:	`2`

The pool size limit for connections expiration policy

conn_pool_ttl¶

Type:	integer
Default:	`1200`

The time-to-live in sec of idle connections in the pool

consumer_group¶

Type:	string
Default:	`oslo_messaging_consumer`

Group id for Kafka consumer. Consumers in one group will coordinate message consumption

producer_batch_timeout¶

Type:	floating point
Default:	`0.0`

Upper bound on the delay for KafkaProducer batching in seconds

producer_batch_size¶

Type:	integer
Default:	`16384`

Size of batch for the producer async send

driver¶

Type:	multi-valued
Default:

The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop

Deprecated Variations¶
Group	Name
DEFAULT	notification_driver

transport_url¶

Type:	string
Default:	`<None>`

A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

Deprecated Variations¶
Group	Name
DEFAULT	notification_transport_url

topics¶

Type:	list
Default:	`notifications`

AMQP topic used for OpenStack notifications.

Deprecated Variations¶
Group	Name
rpc_notifier2	topics
DEFAULT	notification_topics

retry¶

Type:	integer
Default:	`-1`

The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite

amqp_durable_queues¶

Type:	boolean
Default:	`false`

Use durable queues in AMQP.

Deprecated Variations¶
Group	Name
DEFAULT	amqp_durable_queues
DEFAULT	rabbit_durable_queues

amqp_auto_delete¶

Type:	boolean
Default:	`false`

Auto-delete queues in AMQP.

Deprecated Variations¶
Group	Name
DEFAULT	amqp_auto_delete

ssl¶

Type:	boolean
Default:	`<None>`

Enable SSL

ssl_version¶

Type:	string
Default:

SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_version

ssl_key_file¶

Type:	string
Default:

SSL key file (valid only if SSL enabled).

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_keyfile

ssl_cert_file¶

Type:	string
Default:

SSL cert file (valid only if SSL enabled).

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_certfile

ssl_ca_file¶

Type:	string
Default:

SSL certification authority file (valid only if SSL enabled).

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_ca_certs

kombu_reconnect_delay¶

Type:	floating point
Default:	`1.0`

How long to wait before reconnecting in response to an AMQP consumer cancel notification.

Deprecated Variations¶
Group	Name
DEFAULT	kombu_reconnect_delay

kombu_compression¶

Type:	string
Default:	`<None>`

EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.

kombu_missing_consumer_retry_timeout¶

Type:	integer
Default:	`60`

How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_reconnect_timeout

kombu_failover_strategy¶

Type:	string
Default:	`round-robin`
Valid Values:	round-robin, shuffle

Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.

rabbit_host¶

Type:	string
Default:	`localhost`

The RabbitMQ broker address where a single node is used.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_host

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

rabbit_port¶

Type:	port number
Default:	`5672`
Minimum Value:	0
Maximum Value:	65535

The RabbitMQ broker port where a single node is used.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_port

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

rabbit_hosts¶

Type:	list
Default:	`$rabbit_host:$rabbit_port`

RabbitMQ HA cluster host:port pairs.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_hosts

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

rabbit_userid¶

Type:	string
Default:	`guest`

The RabbitMQ userid.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_userid

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

rabbit_password¶

Type:	string
Default:	`guest`

The RabbitMQ password.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_password

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

rabbit_login_method¶

Type:	string
Default:	`AMQPLAIN`
Valid Values:	PLAIN, AMQPLAIN, RABBIT-CR-DEMO

The RabbitMQ login method.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_login_method

rabbit_virtual_host¶

Type:	string
Default:	`/`

The RabbitMQ virtual host.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_virtual_host

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:	Replaced by [DEFAULT]/transport_url

rabbit_retry_interval¶

Type:	integer
Default:	`1`

How frequently to retry connecting with RabbitMQ.

rabbit_retry_backoff¶

Type:	integer
Default:	`2`

How long to backoff for between retries when connecting to RabbitMQ.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_retry_backoff

rabbit_interval_max¶

Type:	integer
Default:	`30`

Maximum interval of RabbitMQ connection retries. Default is 30 seconds.

rabbit_max_retries¶

Type:	integer
Default:	`0`

Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_max_retries

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

rabbit_ha_queues¶

Type:	boolean
Default:	`false`

Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_ha_queues

rabbit_transient_queues_ttl¶

Type:	integer
Default:	`1800`
Minimum Value:	1

Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.

rabbit_qos_prefetch_count¶

Type:	integer
Default:	`0`

Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.

heartbeat_timeout_threshold¶

Type:	integer
Default:	`60`

Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL

heartbeat_rate¶

Type:	integer
Default:	`2`

How often times during the heartbeat_timeout_threshold we check the heartbeat.

fake_rabbit¶

Type:	boolean
Default:	`false`

Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake

Deprecated Variations¶
Group	Name
DEFAULT	fake_rabbit

channel_max¶

Type:	integer
Default:	`<None>`

Maximum number of channels to allow

frame_max¶

Type:	integer
Default:	`<None>`

The maximum byte size for an AMQP frame

heartbeat_interval¶

Type:	integer
Default:	`3`

How often to send heartbeats for consumer’s connections

ssl_options¶

Type:	dict
Default:	`<None>`

Arguments passed to ssl.wrap_socket

socket_timeout¶

Type:	floating point
Default:	`0.25`

Set socket timeout in seconds for connection’s socket

tcp_user_timeout¶

Type:	floating point
Default:	`0.25`

Set TCP_USER_TIMEOUT in seconds for connection’s socket

host_connection_reconnect_delay¶

Type:	floating point
Default:	`0.25`

Set delay for reconnection to some host which has connection error

connection_factory¶

Type:	string
Default:	`single`
Valid Values:	new, single, read_write

Connection factory implementation

pool_max_size¶

Type:	integer
Default:	`30`

Maximum number of connections to keep queued.

pool_max_overflow¶

Type:	integer
Default:	`0`

Maximum number of connections to create above pool_max_size.

pool_timeout¶

Type:	integer
Default:	`30`

Default number of seconds to wait for a connections to available

pool_recycle¶

Type:	integer
Default:	`600`

Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.

pool_stale¶

Type:	integer
Default:	`60`

Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire.

default_serializer_type¶

Type:	string
Default:	`json`
Valid Values:	json, msgpack

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

notification_persistence¶

Type:	boolean
Default:	`false`

Persist notification messages.

default_notification_exchange¶

Type:	string
Default:	`${control_exchange}_notification`

Exchange name for sending notifications

notification_listener_prefetch_count¶

Type:	integer
Default:	`100`

Max number of not acknowledged message which RabbitMQ can send to notification listener.

default_notification_retry_attempts¶

Type:	integer
Default:	`-1`

Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.

notification_retry_delay¶

Type:	floating point
Default:	`0.25`

Reconnecting retry delay in case of connectivity problem during sending notification message

rpc_queue_expiration¶

Type:	integer
Default:	`60`

Time to live for rpc queues without consumers in seconds.

default_rpc_exchange¶

Type:	string
Default:	`${control_exchange}_rpc`

Exchange name for sending RPC messages

rpc_reply_exchange¶

Type:	string
Default:	`${control_exchange}_rpc_reply`

Exchange name for receiving RPC replies

rpc_listener_prefetch_count¶

Type:	integer
Default:	`100`

Max number of not acknowledged message which RabbitMQ can send to rpc listener.

rpc_reply_listener_prefetch_count¶

Type:	integer
Default:	`100`

Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.

rpc_reply_retry_attempts¶

Type:	integer
Default:	`-1`

Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout

rpc_reply_retry_delay¶

Type:	floating point
Default:	`0.25`

Reconnecting retry delay in case of connectivity problem during sending reply.

default_rpc_retry_attempts¶

Type:	integer
Default:	`-1`

Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more than one time

rpc_retry_delay¶

Type:	floating point
Default:	`0.25`

Reconnecting retry delay in case of connectivity problem during sending RPC message

rpc_zmq_bind_address¶

Type:	string
Default:	`*`

ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_bind_address

rpc_zmq_matchmaker¶

Type:	string
Default:	`redis`
Valid Values:	redis, sentinel, dummy

MatchMaker driver.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_matchmaker

rpc_zmq_contexts¶

Type:	integer
Default:	`1`

Number of ZeroMQ contexts, defaults to 1.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_contexts

rpc_zmq_topic_backlog¶

Type:	integer
Default:	`<None>`

Maximum number of ingress messages to locally buffer per topic. Default is unlimited.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_topic_backlog

rpc_zmq_ipc_dir¶

Type:	string
Default:	`/var/run/openstack`

Directory for holding IPC sockets.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_ipc_dir

rpc_zmq_host¶

Type:	string
Default:	`localhost`

Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_host

zmq_linger¶

Type:	integer
Default:	`-1`

Number of seconds to wait before all pending messages will be sent after closing a socket. The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Positive values specify an upper bound for the linger period.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_cast_timeout

rpc_poll_timeout¶

Type:	integer
Default:	`1`

The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_poll_timeout

zmq_target_expire¶

Type:	integer
Default:	`300`

Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

Deprecated Variations¶
Group	Name
DEFAULT	zmq_target_expire

zmq_target_update¶

Type:	integer
Default:	`180`

Update period in seconds of a name service record about existing target.

Deprecated Variations¶
Group	Name
DEFAULT	zmq_target_update

use_pub_sub¶

Type:	boolean
Default:	`false`

Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.

Deprecated Variations¶
Group	Name
DEFAULT	use_pub_sub

use_router_proxy¶

Type:	boolean
Default:	`false`

Use ROUTER remote proxy.

Deprecated Variations¶
Group	Name
DEFAULT	use_router_proxy

use_dynamic_connections¶

Type:	boolean
Default:	`false`

This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).

zmq_failover_connections¶

Type:	integer
Default:	`2`

How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.

rpc_zmq_min_port¶

Type:	port number
Default:	`49153`
Minimum Value:	0
Maximum Value:	65535

Minimal port number for random ports range.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_min_port

rpc_zmq_max_port¶

Type:	integer
Default:	`65536`
Minimum Value:	1
Maximum Value:	65536

Maximal port number for random ports range.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_max_port

rpc_zmq_bind_port_retries¶

Type:	integer
Default:	`100`

Number of retries to find free port number before fail with ZMQBindError.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_bind_port_retries

rpc_zmq_serialization¶

Type:	string
Default:	`json`
Valid Values:	json, msgpack

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

Deprecated Variations¶
Group	Name
DEFAULT	rpc_zmq_serialization

zmq_immediate¶

Type:	boolean
Default:	`true`

This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.

zmq_tcp_keepalive¶

Type:	integer
Default:	`-1`

Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.

zmq_tcp_keepalive_idle¶

Type:	integer
Default:	`-1`

The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_cnt¶

Type:	integer
Default:	`-1`

The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_intvl¶

Type:	integer
Default:	`-1`

The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

rpc_thread_pool_size¶

Type:	integer
Default:	`100`

Maximum number of (green) threads to work concurrently.

rpc_message_ttl¶

Type:	integer
Default:	`300`

Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.

rpc_use_acks¶

Type:	boolean
Default:	`false`

Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.

rpc_ack_timeout_base¶

Type:	integer
Default:	`15`

Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.

rpc_ack_timeout_multiplier¶

Type:	integer
Default:	`2`

Number to multiply base ack timeout by after each retry attempt.

rpc_retry_attempts¶

Type:	integer
Default:	`3`

Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.

subscribe_on¶

Type:	list
Default:

List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.

policy_file¶

Type:	string
Default:	`policy.json`

The file that defines policies.

Deprecated Variations¶
Group	Name
DEFAULT	policy_file

policy_default_rule¶

Type:	string
Default:	`default`

Default rule. Enforced when a requested rule is not found.

Deprecated Variations¶
Group	Name
DEFAULT	policy_default_rule

policy_dirs¶

Type:	multi-valued
Default:	`policy.d`

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.

Deprecated Variations¶
Group	Name
DEFAULT	policy_dirs

flavor¶

Type:	string
Default:	`keystone`

Deployment flavor to use in the server application pipeline. Provide a string value representing the appropriate deployment flavor used in the server application pipleline. This is typically the partial name of a pipeline in the paste configuration file with the service name removed. For example, if your paste section name in the paste configuration file is [pipeline:glance-api-keystone], set flavor to keystone. Possible values: * String value representing a partial pipeline name. Related Options: * config_file

config_file¶

Type:	string
Default:	`glance-api-paste.ini`

Name of the paste configuration file. Provide a string value representing the name of the paste configuration file to use for configuring piplelines for server application deployments. NOTES: * Provide the name or the path relative to the glance directory for the paste configuration file and not the absolute path. * The sample paste configuration file shipped with Glance need not be edited in most cases as it comes with ready-made pipelines for all common deployment flavors. If no value is specified for this option, the paste.ini file with the prefix of the corresponding Glance service’s configuration file name will be searched for in the known configuration directories. (For example, if this option is missing from or has no value set in glance-api.conf, the service will look for a file named glance-api-paste.ini.) If the paste configuration file is not found, the service will not start. Possible values: * A string value representing the name of the paste configuration file. Related Options: * flavor

enabled¶

Type:	boolean
Default:	`false`

Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.

Deprecated Variations¶
Group	Name
profiler	profiler_enabled

trace_sqlalchemy¶

Type:	boolean
Default:	`false`

Enables SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.

hmac_keys¶

Type:	string
Default:	`SECRET_KEY`

Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.

connection_string¶

Type:	string
Default:	`messaging://`

Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging. Examples of possible values: * messaging://: use oslo_messaging driver for sending notifications. * mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications. * elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending notifications.

es_doc_type¶

Type:	string
Default:	`notification`

Document type for notification indexing in elasticsearch.

es_scroll_time¶

Type:	string
Default:	`2m`

This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.

es_scroll_size¶

Type:	integer
Default:	`10000`

Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).

socket_timeout¶

Type:	floating point
Default:	`0.1`

Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).

sentinel_service_name¶

Type:	string
Default:	`mymaster`

Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: sentinal_service_name=mymaster).

glance-registry.conf

glance-registry.conf¶

DEFAULT¶

database¶

keystone_authtoken¶

matchmaker_redis¶

oslo_messaging_amqp¶

oslo_messaging_kafka¶

oslo_messaging_notifications¶

oslo_messaging_rabbit¶

oslo_messaging_zmq¶

oslo_policy¶

paste_deploy¶

profiler¶

glance 15.0.3.dev3

Page Contents