OpenStack Docs: glance-api.conf

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>`

The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html

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_json¶

Type:	boolean
Default:	`false`

Use JSON formatting for logging. 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.

allowed_origin¶

Type:	list
Default:	`<None>`

Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com

allow_credentials¶

Type:	boolean
Default:	`true`

Indicate that the actual request can include user credentials

expose_headers¶

Type:	list
Default:

Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.

max_age¶

Type:	integer
Default:	`3600`

Maximum cache age of CORS preflight requests.

allow_methods¶

Type:	list
Default:	`OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,PATCH`

Indicate which methods can be used during the actual request.

allow_headers¶

Type:	list
Default:

Indicate which header field names may be used during the actual request.

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).

connection_recycle_time¶

Type:	integer
Default:	`3600`

Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.

Deprecated Variations¶
Group	Name
DATABASE	idle_timeout
database	idle_timeout
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

stores¶

Type:	list
Default:	`file,http`

List of enabled Glance stores. Register the storage backends to use for storing disk images as a comma separated list. The default stores enabled for storing disk images with Glance are file and http. Possible values: * A comma separated list that could include: * file * http * swift * rbd * sheepdog * cinder * vmware Related Options: * default_store

default_store¶

Type:	string
Default:	`file`
Valid Values:	file, filesystem, http, https, swift, swift+http, swift+https, swift+config, rbd, sheepdog, cinder, vsphere

The default scheme to use for storing images. Provide a string value representing the default scheme to use for storing images. If not set, Glance uses file as the default scheme to store images with the file store. NOTE: The value given for this configuration option must be a valid scheme for a store registered with the stores configuration option. Possible values: * file * filesystem * http * https * swift * swift+http * swift+https * swift+config * rbd * sheepdog * cinder * vsphere Related Options: * stores

store_capabilities_update_min_interval¶

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

Minimum interval in seconds to execute updating dynamic storage capabilities based on current backend status. Provide an integer value representing time in seconds to set the minimum interval before an update of dynamic storage capabilities for a storage backend can be attempted. Setting store_capabilities_update_min_interval does not mean updates occur periodically based on the set interval. Rather, the update is performed at the elapse of this interval set, if an operation of the store is triggered. By default, this option is set to zero and is disabled. Provide an integer value greater than zero to enable this option. NOTE: For more information on store capabilities and their updates, please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo/store-capabilities.html For more information on setting up a particular store in your deployment and help with the usage of this feature, please contact the storage driver maintainers listed here: http://docs.openstack.org/developer/glance_store/drivers/index.html Possible values: * Zero * Positive integer Related Options: * None

cinder_catalog_info¶

Type:	string
Default:	`volumev2::publicURL`

Information to match when looking for cinder in the service catalog. When the cinder_endpoint_template is not set and any of cinder_store_auth_address, cinder_store_user_name, cinder_store_project_name, cinder_store_password is not set, cinder store uses this information to lookup cinder endpoint from the service catalog in the current context. cinder_os_region_name, if set, is taken into consideration to fetch the appropriate endpoint. The service catalog can be listed by the openstack catalog list command. Possible values: * A string of of the following form: <service_type>:<service_name>:<interface> At least service_type and interface should be specified. service_name can be omitted. Related options: * cinder_os_region_name * cinder_endpoint_template * cinder_store_auth_address * cinder_store_user_name * cinder_store_project_name * cinder_store_password

cinder_endpoint_template¶

Type:	string
Default:	`<None>`

Override service catalog lookup with template for cinder endpoint. When this option is set, this value is used to generate cinder endpoint, instead of looking up from the service catalog. This value is ignored if cinder_store_auth_address, cinder_store_user_name, cinder_store_project_name, and cinder_store_password are specified. If this configuration option is set, cinder_catalog_info will be ignored. Possible values: * URL template string for cinder endpoint, where %(tenant)s is replaced with the current tenant (project) name. For example: http://cinder.openstack.example.org/v2/%(tenant)s Related options: * cinder_store_auth_address * cinder_store_user_name * cinder_store_project_name * cinder_store_password * cinder_catalog_info

cinder_os_region_name¶

Type:	string
Default:	`<None>`

Region name to lookup cinder service from the service catalog. This is used only when cinder_catalog_info is used for determining the endpoint. If set, the lookup for cinder endpoint by this node is filtered to the specified region. It is useful when multiple regions are listed in the catalog. If this is not set, the endpoint is looked up from every region. Possible values: * A string that is a valid region name. Related options: * cinder_catalog_info

Deprecated Variations¶
Group	Name
glance_store	os_region_name

cinder_ca_certificates_file¶

Type:	string
Default:	`<None>`

Location of a CA certificates file used for cinder client requests. The specified CA certificates file, if set, is used to verify cinder connections via HTTPS endpoint. If the endpoint is HTTP, this value is ignored. cinder_api_insecure must be set to True to enable the verification. Possible values: * Path to a ca certificates file Related options: * cinder_api_insecure

cinder_http_retries¶

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

Number of cinderclient retries on failed http calls. When a call failed by any errors, cinderclient will retry the call up to the specified times after sleeping a few seconds. Possible values: * A positive integer Related options: * None

cinder_state_transition_timeout¶

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

Time period, in seconds, to wait for a cinder volume transition to complete. When the cinder volume is created, deleted, or attached to the glance node to read/write the volume data, the volume’s state is changed. For example, the newly created volume status changes from creating to available after the creation process is completed. This specifies the maximum time to wait for the status change. If a timeout occurs while waiting, or the status is changed to an unexpected value (e.g. error`), the image creation fails. Possible values: * A positive integer Related options: * None

cinder_api_insecure¶

Type:	boolean
Default:	`false`

Allow to perform insecure SSL requests to cinder. If this option is set to True, HTTPS endpoint connection is verified using the CA certificates file specified by cinder_ca_certificates_file option. Possible values: * True * False Related options: * cinder_ca_certificates_file

cinder_store_auth_address¶

Type:	string
Default:	`<None>`

The address where the cinder authentication service is listening. When all of cinder_store_auth_address, cinder_store_user_name, cinder_store_project_name, and cinder_store_password options are specified, the specified values are always used for the authentication. This is useful to hide the image volumes from users by storing them in a project/tenant specific to the image service. It also enables users to share the image volume among other projects under the control of glance’s ACL. If either of these options are not set, the cinder endpoint is looked up from the service catalog, and current context’s user and project are used. Possible values: * A valid authentication service address, for example: http://openstack.example.org/identity/v2.0 Related options: * cinder_store_user_name * cinder_store_password * cinder_store_project_name

cinder_store_user_name¶

Type:	string
Default:	`<None>`

User name to authenticate against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values: * A valid user name Related options: * cinder_store_auth_address * cinder_store_password * cinder_store_project_name

cinder_store_password¶

Type:	string
Default:	`<None>`

Password for the user authenticating against cinder. This must be used with all the following related options. If any of these are not specified, the user of the current context is used. Possible values: * A valid password for the user specified by cinder_store_user_name Related options: * cinder_store_auth_address * cinder_store_user_name * cinder_store_project_name

cinder_store_project_name¶

Type:	string
Default:	`<None>`

Project name where the image volume is stored in cinder. If this configuration option is not set, the project in current context is used. This must be used with all the following related options. If any of these are not specified, the project of the current context is used. Possible values: * A valid project name Related options: * cinder_store_auth_address * cinder_store_user_name * cinder_store_password

rootwrap_config¶

Type:	string
Default:	`/etc/glance/rootwrap.conf`

Path to the rootwrap configuration file to use for running commands as root. The cinder store requires root privileges to operate the image volumes (for connecting to iSCSI/FC volumes and reading/writing the volume data, etc.). The configuration file should allow the required commands by cinder store and os-brick library. Possible values: * Path to the rootwrap config file Related options: * None

cinder_volume_type¶

Type:	string
Default:	`<None>`

Volume type that will be used for volume creation in cinder. Some cinder backends can have several volume types to optimize storage usage. Adding this option allows an operator to choose a specific volume type in cinder that can be optimized for images. If this is not set, then the default volume type specified in the cinder configuration will be used for volume creation. Possible values: * A valid volume type from cinder Related options: * None

filesystem_store_datadir¶

Type:	string
Default:	`/var/lib/glance/images`

Directory to which the filesystem backend store writes images. Upon start up, Glance creates the directory if it doesn’t already exist and verifies write access to the user under which glance-api runs. If the write access isn’t available, a BadStoreConfiguration exception is raised and the filesystem store may not be available for adding new images. NOTE: This directory is used only when filesystem store is used as a storage backend. Either filesystem_store_datadir or filesystem_store_datadirs option must be specified in glance-api.conf. If both options are specified, a BadStoreConfiguration will be raised and the filesystem store may not be available for adding new images. Possible values: * A valid path to a directory Related options: * filesystem_store_datadirs * filesystem_store_file_perm

filesystem_store_datadirs¶

Type:	multi-valued
Default:

List of directories and their priorities to which the filesystem backend store writes images. The filesystem store can be configured to store images in multiple directories as opposed to using a single directory specified by the filesystem_store_datadir configuration option. When using multiple directories, each directory can be given an optional priority to specify the preference order in which they should be used. Priority is an integer that is concatenated to the directory path with a colon where a higher value indicates higher priority. When two directories have the same priority, the directory with most free space is used. When no priority is specified, it defaults to zero. More information on configuring filesystem store with multiple store directories can be found at http://docs.openstack.org/developer/glance/configuring.html NOTE: This directory is used only when filesystem store is used as a storage backend. Either filesystem_store_datadir or filesystem_store_datadirs option must be specified in glance-api.conf. If both options are specified, a BadStoreConfiguration will be raised and the filesystem store may not be available for adding new images. Possible values: * List of strings of the following form: * <a valid directory path>:<optional integer priority> Related options: * filesystem_store_datadir * filesystem_store_file_perm

filesystem_store_metadata_file¶

Type:	string
Default:	`<None>`

Filesystem store metadata file. The path to a file which contains the metadata to be returned with any location associated with the filesystem store. The file must contain a valid JSON object. The object should contain the keys id and mountpoint. The value for both keys should be a string. Possible values: * A valid path to the store metadata file Related options: * None

filesystem_store_file_perm¶

Type:	integer
Default:	`0`

File access permissions for the image files. Set the intended file access permissions for image data. This provides a way to enable other services, e.g. Nova, to consume images directly from the filesystem store. The users running the services that are intended to be given access to could be made a member of the group that owns the files created. Assigning a value less then or equal to zero for this configuration option signifies that no changes be made to the default permissions. This value will be decoded as an octal digit. For more information, please refer the documentation at http://docs.openstack.org/developer/glance/configuring.html Possible values: * A valid file access permission * Zero * Any negative integer Related options: * None

https_ca_certificates_file¶

Type:	string
Default:	`<None>`

Path to the CA bundle file. This configuration option enables the operator to use a custom Certificate Authority file to verify the remote server certificate. If this option is set, the https_insecure option will be ignored and the CA file specified will be used to authenticate the server certificate and establish a secure connection to the server. Possible values: * A valid path to a CA file Related options: * https_insecure

https_insecure¶

Type:	boolean
Default:	`true`

Set verification of the remote server certificate. This configuration option takes in a boolean value to determine whether or not to verify the remote server certificate. If set to True, the remote server certificate is not verified. If the option is set to False, then the default CA truststore is used for verification. This option is ignored if https_ca_certificates_file is set. The remote server certificate will then be verified using the file specified using the https_ca_certificates_file option. Possible values: * True * False Related options: * https_ca_certificates_file

http_proxy_information¶

Type:	dict
Default:

The http/https proxy information to be used to connect to the remote server. This configuration option specifies the http/https proxy information that should be used to connect to the remote server. The proxy information should be a key value pair of the scheme and proxy, for example, http:10.0.0.1:3128. You can also specify proxies for multiple schemes by separating the key value pairs with a comma, for example, http:10.0.0.1:3128, https:10.0.0.1:1080. Possible values: * A comma separated list of scheme:proxy pairs as described above Related options: * None

rbd_store_chunk_size¶

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

Size, in megabytes, to chunk RADOS images into. Provide an integer value representing the size in megabytes to chunk Glance images into. The default chunk size is 8 megabytes. For optimal performance, the value should be a power of two. When Ceph’s RBD object storage system is used as the storage backend for storing Glance images, the images are chunked into objects of the size set using this option. These chunked objects are then stored across the distributed block data store to use for Glance. Possible Values: * Any positive integer value Related options: * None

rbd_store_pool¶

Type:	string
Default:	`images`

RADOS pool in which images are stored. When RBD is used as the storage backend for storing Glance images, the images are stored by means of logical grouping of the objects (chunks of images) into a pool. Each pool is defined with the number of placement groups it can contain. The default pool that is used is ‘images’. More information on the RBD storage backend can be found here: http://ceph.com/planet/how-data-is-stored-in-ceph-cluster/ Possible Values: * A valid pool name Related options: * None

rbd_store_user¶

Type:	string
Default:	`<None>`

RADOS user to authenticate as. This configuration option takes in the RADOS user to authenticate as. This is only needed when RADOS authentication is enabled and is applicable only if the user is using Cephx authentication. If the value for this option is not set by the user or is set to None, a default value will be chosen, which will be based on the client. section in rbd_store_ceph_conf. Possible Values: * A valid RADOS user Related options: * rbd_store_ceph_conf

rbd_store_ceph_conf¶

Type:	string
Default:	`/etc/ceph/ceph.conf`

Ceph configuration file path. This configuration option takes in the path to the Ceph configuration file to be used. If the value for this option is not set by the user or is set to None, librados will locate the default configuration file which is located at /etc/ceph/ceph.conf. If using Cephx authentication, this file should include a reference to the right keyring in a client.<USER> section Possible Values: * A valid path to a configuration file Related options: * rbd_store_user

rados_connect_timeout¶

Type:	integer
Default:	`0`

Timeout value for connecting to Ceph cluster. This configuration option takes in the timeout value in seconds used when connecting to the Ceph cluster i.e. it sets the time to wait for glance-api before closing the connection. This prevents glance-api hangups during the connection to RBD. If the value for this option is set to less than or equal to 0, no timeout is set and the default librados value is used. Possible Values: * Any integer value Related options: * None

sheepdog_store_chunk_size¶

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

Chunk size for images to be stored in Sheepdog data store. Provide an integer value representing the size in mebibyte (1048576 bytes) to chunk Glance images into. The default chunk size is 64 mebibytes. When using Sheepdog distributed storage system, the images are chunked into objects of this size and then stored across the distributed data store to use for Glance. Chunk sizes, if a power of two, help avoid fragmentation and enable improved performance. Possible values: * Positive integer value representing size in mebibytes. Related Options: * None

sheepdog_store_port¶

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

Port number on which the sheep daemon will listen. Provide an integer value representing a valid port number on which you want the Sheepdog daemon to listen on. The default port is 7000. The Sheepdog daemon, also called ‘sheep’, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages it receives on the port number set using sheepdog_store_port option to store chunks of Glance images. Possible values: * A valid port number (0 to 65535) Related Options: * sheepdog_store_address

sheepdog_store_address¶

Type:	host address
Default:	`127.0.0.1`

Address to bind the Sheepdog daemon to. Provide a string value representing the address to bind the Sheepdog daemon to. The default address set for the ‘sheep’ is 127.0.0.1. The Sheepdog daemon, also called ‘sheep’, manages the storage in the distributed cluster by writing objects across the storage network. It identifies and acts on the messages directed to the address set using sheepdog_store_address option to store chunks of Glance images. Possible values: * A valid IPv4 address * A valid IPv6 address * A valid hostname Related Options: * sheepdog_store_port

swift_store_auth_insecure¶

Type:	boolean
Default:	`false`

Set verification of the server certificate. This boolean determines whether or not to verify the server certificate. If this option is set to True, swiftclient won’t check for a valid SSL certificate when authenticating. If the option is set to False, then the default CA truststore is used for verification. Possible values: * True * False Related options: * swift_store_cacert

swift_store_cacert¶

Type:	string
Default:	`/etc/ssl/certs/ca-certificates.crt`

Path to the CA bundle file. This configuration option enables the operator to specify the path to a custom Certificate Authority file for SSL verification when connecting to Swift. Possible values: * A valid path to a CA file Related options: * swift_store_auth_insecure

swift_store_region¶

Type:	string
Default:	`RegionTwo`

The region of Swift endpoint to use by Glance. Provide a string value representing a Swift region where Glance can connect to for image storage. By default, there is no region set. When Glance uses Swift as the storage backend to store images for a specific tenant that has multiple endpoints, setting of a Swift region with swift_store_region allows Glance to connect to Swift in the specified region as opposed to a single region connectivity. This option can be configured for both single-tenant and multi-tenant storage. NOTE: Setting the region with swift_store_region is tenant-specific and is necessary only if the tenant has multiple endpoints across different regions. Possible values: * A string value representing a valid Swift region. Related Options: * None

swift_store_endpoint¶

Type:	string
Default:	`https://swift.openstack.example.org/v1/path_not_including_container_name`

The URL endpoint to use for Swift backend storage. Provide a string value representing the URL endpoint to use for storing Glance images in Swift store. By default, an endpoint is not set and the storage URL returned by auth is used. Setting an endpoint with swift_store_endpoint overrides the storage URL and is used for Glance image storage. NOTE: The URL should include the path up to, but excluding the container. The location of an object is obtained by appending the container and object to the configured URL. Possible values: * String value representing a valid URL path up to a Swift container Related Options: * None

swift_store_endpoint_type¶

Type:	string
Default:	`publicURL`
Valid Values:	publicURL, adminURL, internalURL

Endpoint Type of Swift service. This string value indicates the endpoint type to use to fetch the Swift endpoint. The endpoint type determines the actions the user will be allowed to perform, for instance, reading and writing to the Store. This setting is only used if swift_store_auth_version is greater than 1. Possible values: * publicURL * adminURL * internalURL Related options: * swift_store_endpoint

swift_store_service_type¶

Type:	string
Default:	`object-store`

Type of Swift service to use. Provide a string value representing the service type to use for storing images while using Swift backend storage. The default service type is set to object-store. NOTE: If swift_store_auth_version is set to 2, the value for this configuration option needs to be object-store. If using a higher version of Keystone or a different auth scheme, this option may be modified. Possible values: * A string representing a valid service type for Swift storage. Related Options: * None

swift_store_container¶

Type:	string
Default:	`glance`

Name of single container to store images/name prefix for multiple containers When a single container is being used to store images, this configuration option indicates the container within the Glance account to be used for storing all images. When multiple containers are used to store images, this will be the name prefix for all containers. Usage of single/multiple containers can be controlled using the configuration option swift_store_multiple_containers_seed. When using multiple containers, the containers will be named after the value set for this configuration option with the first N chars of the image UUID as the suffix delimited by an underscore (where N is specified by swift_store_multiple_containers_seed). Example: if the seed is set to 3 and swift_store_container = glance, then an image with UUID fdae39a1-bac5-4238-aba4-69bcc726e848 would be placed in the container glance_fda. All dashes in the UUID are included when creating the container name but do not count toward the character limit, so when N=10 the container name would be glance_fdae39a1-ba. Possible values: * If using single container, this configuration option can be any string that is a valid swift container name in Glance’s Swift account * If using multiple containers, this configuration option can be any string as long as it satisfies the container naming rules enforced by Swift. The value of swift_store_multiple_containers_seed should be taken into account as well. Related options: * swift_store_multiple_containers_seed * swift_store_multi_tenant * swift_store_create_container_on_put

swift_store_large_object_size¶

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

The size threshold, in MB, after which Glance will start segmenting image data. Swift has an upper limit on the size of a single uploaded object. By default, this is 5GB. To upload objects bigger than this limit, objects are segmented into multiple smaller objects that are tied together with a manifest file. For more detail, refer to http://docs.openstack.org/developer/swift/overview_large_objects.html This configuration option specifies the size threshold over which the Swift driver will start segmenting image data into multiple smaller files. Currently, the Swift driver only supports creating Dynamic Large Objects. NOTE: This should be set by taking into account the large object limit enforced by the Swift cluster in consideration. Possible values: * A positive integer that is less than or equal to the large object limit enforced by the Swift cluster in consideration. Related options: * swift_store_large_object_chunk_size

swift_store_large_object_chunk_size¶

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

The maximum size, in MB, of the segments when image data is segmented. When image data is segmented to upload images that are larger than the limit enforced by the Swift cluster, image data is broken into segments that are no bigger than the size specified by this configuration option. Refer to swift_store_large_object_size for more detail. For example: if swift_store_large_object_size is 5GB and swift_store_large_object_chunk_size is 1GB, an image of size 6.2GB will be segmented into 7 segments where the first six segments will be 1GB in size and the seventh segment will be 0.2GB. Possible values: * A positive integer that is less than or equal to the large object limit enforced by Swift cluster in consideration. Related options: * swift_store_large_object_size

swift_store_create_container_on_put¶

Type:	boolean
Default:	`false`

Create container, if it doesn’t already exist, when uploading image. At the time of uploading an image, if the corresponding container doesn’t exist, it will be created provided this configuration option is set to True. By default, it won’t be created. This behavior is applicable for both single and multiple containers mode. Possible values: * True * False Related options: * None

swift_store_multi_tenant¶

Type:	boolean
Default:	`false`

Store images in tenant’s Swift account. This enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. If this is disabled, Glance stores all images in its own account. More details multi-tenant store can be found at https://wiki.openstack.org/wiki/GlanceSwiftTenantSpecificStorage NOTE: If using multi-tenant swift store, please make sure that you do not set a swift configuration file with the ‘swift_store_config_file’ option. Possible values: * True * False Related options: * swift_store_config_file

swift_store_multiple_containers_seed¶

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

Seed indicating the number of containers to use for storing images. When using a single-tenant store, images can be stored in one or more than one containers. When set to 0, all images will be stored in one single container. When set to an integer value between 1 and 32, multiple containers will be used to store images. This configuration option will determine how many containers are created. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images. Please refer to swift_store_container for more detail on the naming convention. More detail about using multiple containers can be found at https://specs.openstack.org/openstack/glance-specs/specs/kilo/swift-store-multiple-containers.html NOTE: This is used only when swift_store_multi_tenant is disabled. Possible values: * A non-negative integer less than or equal to 32 Related options: * swift_store_container * swift_store_multi_tenant * swift_store_create_container_on_put

swift_store_admin_tenants¶

Type:	list
Default:

List of tenants that will be granted admin access. This is a list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. The default value is an empty list. Possible values: * A comma separated list of strings representing UUIDs of Keystone projects/tenants Related options: * None

swift_store_ssl_compression¶

Type:	boolean
Default:	`true`

SSL layer compression for HTTPS Swift requests. Provide a boolean value to determine whether or not to compress HTTPS Swift requests for images at the SSL layer. By default, compression is enabled. When using Swift as the backend store for Glance image storage, SSL layer compression of HTTPS Swift requests can be set using this option. If set to False, SSL layer compression of HTTPS Swift requests is disabled. Disabling this option may improve performance for images which are already in a compressed format, for example, qcow2. Possible values: * True * False Related Options: * None

swift_store_retry_get_count¶

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

The number of times a Swift download will be retried before the request fails. Provide an integer value representing the number of times an image download must be retried before erroring out. The default value is zero (no retry on a failed image download). When set to a positive integer value, swift_store_retry_get_count ensures that the download is attempted this many more times upon a download failure before sending an error message. Possible values: * Zero * Positive integer value Related Options: * None

swift_store_expire_soon_interval¶

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

Time in seconds defining the size of the window in which a new token may be requested before the current token is due to expire. Typically, the Swift storage driver fetches a new token upon the expiration of the current token to ensure continued access to Swift. However, some Swift transactions (like uploading image segments) may not recover well if the token expires on the fly. Hence, by fetching a new token before the current token expiration, we make sure that the token does not expire or is close to expiry before a transaction is attempted. By default, the Swift storage driver requests for a new token 60 seconds or less before the current token expiration. Possible values: * Zero * Positive integer value Related Options: * None

swift_store_use_trusts¶

Type:	boolean
Default:	`true`

Use trusts for multi-tenant Swift store. This option instructs the Swift store to create a trust for each add/get request when the multi-tenant store is in use. Using trusts allows the Swift store to avoid problems that can be caused by an authentication token expiring during the upload or download of data. By default, swift_store_use_trusts is set to True``(use of trusts is enabled). If set to ``False, a user token is used for the Swift connection instead, eliminating the overhead of trust creation. NOTE: This option is considered only when swift_store_multi_tenant is set to True Possible values: * True * False Related options: * swift_store_multi_tenant

swift_buffer_on_upload¶

Type:	boolean
Default:	`false`

Buffer image segments before upload to Swift. Provide a boolean value to indicate whether or not Glance should buffer image data to disk while uploading to swift. This enables Glance to resume uploads on error. NOTES: When enabling this option, one should take great care as this increases disk usage on the API node. Be aware that depending upon how the file system is configured, the disk space used for buffering may decrease the actual disk space available for the glance image cache. Disk utilization will cap according to the following equation: (swift_store_large_object_chunk_size * workers * 1000) Possible values: * True * False Related options: * swift_upload_buffer_dir

default_swift_reference¶

Type:	string
Default:	`ref1`

Reference to default Swift account/backing store parameters. Provide a string value representing a reference to the default set of parameters required for using swift account/backing store for image storage. The default reference value for this configuration option is ‘ref1’. This configuration option dereferences the parameters and facilitates image storage in Swift storage backend every time a new image is added. Possible values: * A valid string value Related options: * None

swift_store_auth_version¶

Type:	string
Default:	`2`

Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace.

Warning

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

Reason:	The option ‘auth_version’ in the Swift back-end configuration file is used instead.

swift_store_auth_address¶

Type:	string
Default:	`<None>`

The address where the Swift authentication service is listening.

Warning

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

Reason:	The option ‘auth_address’ in the Swift back-end configuration file is used instead.

swift_store_user¶

Type:	string
Default:	`<None>`

The user to authenticate against the Swift authentication service.

Warning

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

Reason:	The option ‘user’ in the Swift back-end configuration file is set instead.

swift_store_key¶

Type:	string
Default:	`<None>`

Auth key for the user authenticating against the Swift authentication service.

Warning

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

Reason:	The option ‘key’ in the Swift back-end configuration file is used to set the authentication key instead.

swift_store_config_file¶

Type:	string
Default:	`<None>`

Absolute path to the file containing the swift account(s) configurations. Include a string value representing the path to a configuration file that has references for each of the configured Swift account(s)/backing stores. By default, no file path is specified and customized Swift referencing is disabled. Configuring this option is highly recommended while using Swift storage backend for image storage as it avoids storage of credentials in the database. NOTE: Please do not configure this option if you have set swift_store_multi_tenant to True. Possible values: * String value representing an absolute path on the glance-api node Related options: * swift_store_multi_tenant

swift_upload_buffer_dir¶

Type:	string
Default:	`<None>`

Directory to buffer image segments before upload to Swift. Provide a string value representing the absolute path to the directory on the glance node where image segments will be buffered briefly before they are uploaded to swift. NOTES: * This is required only when the configuration option swift_buffer_on_upload is set to True. * This directory should be provisioned keeping in mind the swift_store_large_object_chunk_size and the maximum number of images that could be uploaded simultaneously by a given glance node. Possible values: * String value representing an absolute directory path Related options: * swift_buffer_on_upload * swift_store_large_object_chunk_size

vmware_server_host¶

Type:	host address
Default:	`127.0.0.1`

Address of the ESX/ESXi or vCenter Server target system. This configuration option sets the address of the ESX/ESXi or vCenter Server target system. This option is required when using the VMware storage backend. The address can contain an IP address (127.0.0.1) or a DNS name (www.my-domain.com). Possible Values: * A valid IPv4 or IPv6 address * A valid DNS name Related options: * vmware_server_username * vmware_server_password

vmware_server_username¶

Type:	string
Default:	`root`

Server username. This configuration option takes the username for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values: * Any string that is the username for a user with appropriate privileges Related options: * vmware_server_host * vmware_server_password

vmware_server_password¶

Type:	string
Default:	`vmware`

Server password. This configuration option takes the password for authenticating with the VMware ESX/ESXi or vCenter Server. This option is required when using the VMware storage backend. Possible Values: * Any string that is a password corresponding to the username specified using the “vmware_server_username” option Related options: * vmware_server_host * vmware_server_username

vmware_api_retry_count¶

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

The number of VMware API retries. This configuration option specifies the number of times the VMware ESX/VC server API must be retried upon connection related issues or server API call overload. It is not possible to specify ‘retry forever’. Possible Values: * Any positive integer value Related options: * None

vmware_task_poll_interval¶

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

Interval in seconds used for polling remote tasks invoked on VMware ESX/VC server. This configuration option takes in the sleep time in seconds for polling an on-going async task as part of the VMWare ESX/VC server API call. Possible Values: * Any positive integer value Related options: * None

vmware_store_image_dir¶

Type:	string
Default:	`/openstack_glance`

The directory where the glance images will be stored in the datastore. This configuration option specifies the path to the directory where the glance images will be stored in the VMware datastore. If this option is not set, the default directory where the glance images are stored is openstack_glance. Possible Values: * Any string that is a valid path to a directory Related options: * None

vmware_insecure¶

Type:	boolean
Default:	`false`

Set verification of the ESX/vCenter server certificate. This configuration option takes a boolean value to determine whether or not to verify the ESX/vCenter server certificate. If this option is set to True, the ESX/vCenter server certificate is not verified. If this option is set to False, then the default CA truststore is used for verification. This option is ignored if the “vmware_ca_file” option is set. In that case, the ESX/vCenter server certificate will then be verified using the file specified using the “vmware_ca_file” option . Possible Values: * True * False Related options: * vmware_ca_file

Deprecated Variations¶
Group	Name
glance_store	vmware_api_insecure

vmware_ca_file¶

Type:	string
Default:	`/etc/ssl/certs/ca-certificates.crt`

Absolute path to the CA bundle file. This configuration option enables the operator to use a custom Cerificate Authority File to verify the ESX/vCenter certificate. If this option is set, the “vmware_insecure” option will be ignored and the CA file specified will be used to authenticate the ESX/vCenter server certificate and establish a secure connection to the server. Possible Values: * Any string that is a valid absolute path to a CA file Related options: * vmware_insecure

vmware_datastores¶

Type:	multi-valued
Default:

The datastores where the image can be stored. This configuration option specifies the datastores where the image can be stored in the VMWare store backend. This option may be specified multiple times for specifying multiple datastores. The datastore name should be specified after its datacenter path, separated by “:”. An optional weight may be given after the datastore name, separated again by “:” to specify the priority. Thus, the required format becomes <datacenter_path>:<datastore_name>:<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. Possible Values: * Any string of the format: <datacenter_path>:<datastore_name>:<optional_weight> Related options: * None

www_authenticate_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.

Deprecated Variations¶
Group	Name
keystone_authtoken	auth_uri

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. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release.

Warning

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

Reason:	The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.

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_admin_prefix¶

Type:	string
Default:

Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.

auth_host¶

Type:	string
Default:	`127.0.0.1`

Host providing the admin Identity API endpoint. Deprecated, use identity_uri.

auth_port¶

Type:	integer
Default:	`35357`

Port of the admin Identity API endpoint. Deprecated, use identity_uri.

auth_protocol¶

Type:	string
Default:	`https`
Valid Values:	http, https

Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.

identity_uri¶

Type:	string
Default:	`<None>`

Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/

admin_token¶

Type:	string
Default:	`<None>`

This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use admin_user and admin_password instead.

admin_user¶

Type:	string
Default:	`<None>`

Service username.

admin_password¶

Type:	string
Default:	`<None>`

Service user password.

admin_tenant_name¶

Type:	string
Default:	`admin`

Service tenant name.

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.

disable_process_locking¶

Type:	boolean
Default:	`false`

Enables or disables inter-process locks.

Deprecated Variations¶
Group	Name
DEFAULT	disable_process_locking

lock_path¶

Type:	string
Default:	`/tmp`

Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If OSLO_LOCK_PATH is not set in the environment, use the Python tempfile.gettempdir function to find a suitable location. If external locks are used, a lock path must be set.

Deprecated Variations¶
Group	Name
DEFAULT	lock_path

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

Warning

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

Reason:	Driver no longer uses connection pool.

conn_pool_min_size¶

Type:	integer
Default:	`2`

The pool size limit for connections expiration policy

Warning

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

Reason:	Driver no longer uses connection pool.

conn_pool_ttl¶

Type:	integer
Default:	`1200`

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

Warning

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

Reason:	Driver no longer uses connection 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.

enable_proxy_headers_parsing¶

Type:	boolean
Default:	`false`

Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

enforce_scope¶

Type:	boolean
Default:	`false`

This option controls whether or not to enforce scope when evaluating policies. If True, the scope of the token used in the request is compared to the scope_types of the policy being enforced. If the scopes do not match, an InvalidScope exception will be raised. If False, a message will be logged informing operators that policies are being invoked with mismatching scope.

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

remote_content_type¶

Type:	string
Default:	`application/x-www-form-urlencoded`
Valid Values:	application/x-www-form-urlencoded, application/json

Content Type to send and receive data for REST based policy check

remote_ssl_verify_server_crt¶

Type:	boolean
Default:	`false`

server identity verification for REST based policy check

remote_ssl_ca_crt_file¶

Type:	string
Default:	`<None>`

Absolute path to ca cert file for REST based policy check

remote_ssl_client_crt_file¶

Type:	string
Default:	`<None>`

Absolute path to client cert for REST based policy check

remote_ssl_client_key_file¶

Type:	string
Default:	`<None>`

Absolute path client key file REST based policy check

glance-api.conf

glance-api.conf¶

DEFAULT¶

cors¶

database¶

glance_store¶

keystone_authtoken¶

matchmaker_redis¶

oslo_concurrency¶

oslo_messaging_amqp¶

oslo_messaging_kafka¶

oslo_messaging_notifications¶

oslo_messaging_rabbit¶

oslo_messaging_zmq¶

oslo_middleware¶

oslo_policy¶

Glance 16.0.1

Page Contents