Octavia Configuration Options¶

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:	octavia

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.

log_options¶

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

Enables or disables logging values of all registered options when starting a service (at DEBUG level).

graceful_shutdown_timeout¶

Type:	integer
Default:	60
Mutable:	This option can be changed without restarting.

Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

host¶

Type:	hostname
Default:	ubuntu-xenial-rax-dfw-0016504823

The hostname Octavia is running on

octavia_plugins¶

Type:	string
Default:	hot_plug_plugin

Name of the controller plugin to use

bind_host¶

Type:	ip address
Default:	<None>

The host IP to bind to

Warning

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

Reason:	This setting has moved to the [api_settings] section.

bind_port¶

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

The port to bind to

Warning

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

Reason:	This setting has moved to the [api_settings] section.

auth_strategy¶

Type:	string
Default:	<None>
Valid Values:	noauth, keystone, testing

The auth strategy for API requests.

Warning

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

Reason:	This setting has moved to the [api_settings] section.

api_handler¶

Type:	string
Default:	<None>

The handler that the API communicates with

Warning

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

Reason:	This setting has moved to the [api_settings] section.

agent_server_ca¶

Type:	string
Default:	/etc/octavia/certs/client_ca.pem

The ca which signed the client certificates

agent_server_cert¶

Type:	string
Default:	/etc/octavia/certs/server.pem

The server certificate for the agent.py server to use

agent_server_network_dir¶

Type:	string
Default:	<None>

The directory where new network interfaces are located

agent_server_network_file¶

Type:	string
Default:	<None>

The file where the network interfaces are located. Specifying this will override any value set for agent_server_network_dir.

agent_request_read_timeout¶

Type:	integer
Default:	180

The time in seconds to allow a request from the controller to run before terminating the socket.

amphora_id¶

Type:	string
Default:	<None>

The amphora ID.

amphora_udp_driver¶

Type:	string
Default:	keepalived_lvs

The UDP API backend for amphora agent.

url¶

Type:	string
Default:	http://localhost:9999/v1/sign/default

Anchor URL

username¶

Type:	string
Default:	<None>

Anchor username

password¶

Type:	string
Default:	<None>

Anchor password

bind_host¶

Type:	ip address
Default:	127.0.0.1

The host IP to bind to

bind_port¶

Type:	port number
Default:	9876
Minimum Value:	0
Maximum Value:	65535

The port to bind to

auth_strategy¶

Type:	string
Default:	keystone
Valid Values:	noauth, keystone, testing

The auth strategy for API requests.

api_handler¶

Type:	string
Default:	queue_producer

The handler that the API communicates with

allow_pagination¶

Type:	boolean
Default:	true

Allow the usage of pagination

allow_sorting¶

Type:	boolean
Default:	true

Allow the usage of sorting

allow_filtering¶

Type:	boolean
Default:	true

Allow the usage of filtering

allow_field_selection¶

Type:	boolean
Default:	true

Allow the usage of field selection

pagination_max_limit¶

Type:	string
Default:	1000

The maximum number of items returned in a single response. The string ‘infinite’ or a negative integer value means ‘no limit’

api_base_uri¶

Type:	string
Default:	<None>

Base URI for the API for use in pagination links. This will be autodetected from the request if not overridden here.

api_v1_enabled¶

Type:	boolean
Default:	true

Expose the v1 API?

api_v2_enabled¶

Type:	boolean
Default:	true

Expose the v2 API?

allow_tls_terminated_listeners¶

Type:	boolean
Default:	true

Allow users to create TLS Terminated listeners?

allow_ping_health_monitors¶

Type:	boolean
Default:	true

Allow users to create PING type Health Monitors?

enabled_provider_drivers¶

Type:	dict
Default:	amphora:The Octavia Amphora driver.,octavia:Deprecated alias of the Octavia Amphora driver.

List of enabled provider drivers and description dictionaries. Must match the driver name in the octavia.api.drivers entrypoint. Example: {‘amphora’: ‘The Octavia Amphora driver.’, ‘octavia’: ‘Deprecated alias of the Octavia Amphora driver.’}

default_provider_driver¶

Type:	string
Default:	amphora

Default provider driver.

udp_connect_min_interval_health_monitor¶

Type:	integer
Default:	3

The minimum health monitor delay interval for the UDP-CONNECT Health Monitor type. A negative integer value means ‘no limit’.

cert_manager¶

Type:	string
Default:	barbican_cert_manager

Name of the cert manager to use

cert_generator¶

Type:	string
Default:	local_cert_generator

Name of the cert generator to use

barbican_auth¶

Type:	string
Default:	barbican_acl_auth

Name of the Barbican authentication method to use

service_name¶

Type:	string
Default:	<None>

The name of the certificate service in the keystonecatalog

endpoint¶

Type:	string
Default:	<None>

A new endpoint to override the endpoint in the keystone catalog.

region_name¶

Type:	string
Default:	<None>

Region in Identity service catalog to use for communication with the barbican service.

endpoint_type¶

Type:	string
Default:	publicURL

The endpoint_type to be used for barbican service.

ca_certificates_file¶

Type:	string
Default:	<None>

CA certificates file path

insecure¶

Type:	boolean
Default:	false

Disable certificate validation on SSL connections

workers¶

Type:	integer
Default:	1
Minimum Value:	1

Number of workers for the controller-worker service.

amp_active_retries¶

Type:	integer
Default:	10

Retry attempts to wait for Amphora to become active

amp_active_wait_sec¶

Type:	integer
Default:	10

Seconds to wait between checks on whether an Amphora has become active

amp_flavor_id¶

Type:	string
Default:	''

Nova instance flavor id for the Amphora

amp_image_tag¶

Type:	string
Default:	''

Glance image tag for the Amphora image to boot. Use this option to be able to update the image without reconfiguring Octavia. Ignored if amp_image_id is defined.

amp_image_id¶

Type:	string
Default:	''

Glance image id for the Amphora image to boot

Warning

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

Reason:	Superseded by amp_image_tag option.

amp_image_owner_id¶

Type:	string
Default:	''

Restrict glance image selection to a specific owner ID. This is a recommended security setting.

amp_ssh_key_name¶

Type:	string
Default:	''

SSH key name used to boot the Amphora

amp_ssh_access_allowed¶

Type:	boolean
Default:	true

Determines whether or not to allow access to the Amphorae

Warning

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

Reason:	This option and amp_ssh_key_name overlap in functionality, and only one is needed. SSH access can be enabled/disabled simply by setting amp_ssh_key_name, or not.

amp_boot_network_list¶

Type:	list
Default:	''

List of networks to attach to the Amphorae. All networks defined in the list will be attached to each amphora.

amp_secgroup_list¶

Type:	list
Default:	''

List of security groups to attach to the Amphora.

client_ca¶

Type:	string
Default:	/etc/octavia/certs/ca_01.pem

Client CA for the amphora agent to use

amphora_driver¶

Type:	string
Default:	amphora_noop_driver

Name of the amphora driver to use

compute_driver¶

Type:	string
Default:	compute_noop_driver

Name of the compute driver to use

network_driver¶

Type:	string
Default:	network_noop_driver

Name of the network driver to use

distributor_driver¶

Type:	string
Default:	distributor_noop_driver

Name of the distributor driver to use

loadbalancer_topology¶

Type:	string
Default:	SINGLE
Valid Values:	ACTIVE_STANDBY, SINGLE

Load balancer topology configuration. SINGLE - One amphora per load balancer. ACTIVE_STANDBY - Two amphora per load balancer.

user_data_config_drive¶

Type:	boolean
Default:	false

If True, build cloud-init user-data that is passed to the config drive on Amphora boot instead of personality files. If False, utilize personality files.

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

Warning

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

Reason:	The option to set the minimum pool size is not supported by sqlalchemy.

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.

connection_parameters¶

Type:	string
Default:	''

Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=value2&…

service_name¶

Type:	string
Default:	<None>

The name of the glance service in the keystone catalog

endpoint¶

Type:	string
Default:	<None>

A new endpoint to override the endpoint in the keystone catalog.

region_name¶

Type:	string
Default:	<None>

Region in Identity service catalog to use for communication with the OpenStack services.

endpoint_type¶

Type:	string
Default:	publicURL

Endpoint interface in identity service to use

ca_certificates_file¶

Type:	string
Default:	<None>

CA certificates file path

insecure¶

Type:	boolean
Default:	false

Disable certificate validation on SSL connections

base_path¶

Type:	string
Default:	/var/lib/octavia

Base directory for amphora files.

base_cert_dir¶

Type:	string
Default:	/var/lib/octavia/certs

Base directory for cert storage.

haproxy_template¶

Type:	string
Default:	<None>

Custom haproxy template.

connection_logging¶

Type:	boolean
Default:	true

Set this to False to disable connection logging.

connection_max_retries¶

Type:	integer
Default:	300

Retry threshold for connecting to amphorae.

connection_retry_interval¶

Type:	integer
Default:	5

Retry timeout between connection attempts in seconds.

active_connection_max_retries¶

Type:	integer
Default:	15

Retry threshold for connecting to active amphorae.

active_connection_rety_interval¶

Type:	integer
Default:	2

Retry timeout between connection attempts in seconds for active amphora.

build_rate_limit¶

Type:	integer
Default:	-1

Number of amphorae that could be built per controllerworker, simultaneously.

build_active_retries¶

Type:	integer
Default:	300

Retry threshold for waiting for a build slot for an amphorae.

build_retry_interval¶

Type:	integer
Default:	5

Retry timeout between build attempts in seconds.

haproxy_stick_size¶

Type:	string
Default:	10k

Size of the HAProxy stick table. Accepts k, m, g suffixes. Example: 10k

bind_host¶

Type:	ip address
Default:	::

The host IP to bind to

bind_port¶

Type:	port number
Default:	9443
Minimum Value:	0
Maximum Value:	65535

The port to bind to

lb_network_interface¶

Type:	string
Default:	o-hm0

Network interface through which to reach amphora, only required if using IPv6 link local addresses.

haproxy_cmd¶

Type:	string
Default:	/usr/sbin/haproxy

The full path to haproxy

respawn_count¶

Type:	integer
Default:	2

The respawn count for haproxy’s upstart script

respawn_interval¶

Type:	integer
Default:	2

The respawn interval for haproxy’s upstart script

rest_request_conn_timeout¶

Type:	floating point
Default:	10

The time in seconds to wait for a REST API to connect.

rest_request_read_timeout¶

Type:	floating point
Default:	60

The time in seconds to wait for a REST API response.

client_cert¶

Type:	string
Default:	/etc/octavia/certs/client.pem

The client certificate to talk to the agent

server_ca¶

Type:	string
Default:	/etc/octavia/certs/server_ca.pem

The ca which signed the server certificates

use_upstart¶

Type:	boolean
Default:	true

If False, use sysvinit.

Warning

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

Reason:	This is now automatically discovered and configured.

bind_ip¶

Type:	ip address
Default:	127.0.0.1

IP address the controller will listen on for heart beats

bind_port¶

Type:	port number
Default:	5555
Minimum Value:	0
Maximum Value:	65535

Port number the controller will listen onfor heart beats

failover_threads¶

Type:	integer
Default:	10

Number of threads performing amphora failovers.

status_update_threads¶

Type:	integer
Default:	<None>

Number of processes for amphora status update.

health_update_threads¶

Type:	integer
Default:	<None>

Number of processes for amphora health update.

stats_update_threads¶

Type:	integer
Default:	<None>

Number of processes for amphora stats update.

heartbeat_key¶

Type:	string
Default:	<None>

key used to validate amphora sendingthe message

heartbeat_timeout¶

Type:	integer
Default:	60

Interval, in seconds, to wait before failing over an amphora.

health_check_interval¶

Type:	integer
Default:	3

Sleep time between health checks in seconds.

sock_rlimit¶

Type:	integer
Default:	0

sets the value of the heartbeat recv buffer

controller_ip_port_list¶

Type:	list
Default:	''

List of controller ip and port pairs for the heartbeat receivers. Example 127.0.0.1:5555, 192.168.0.1:5555

heartbeat_interval¶

Type:	integer
Default:	10

Sleep time between sending heartbeats.

health_update_driver¶

Type:	string
Default:	health_db

Driver for updating amphora health system.

stats_update_driver¶

Type:	string
Default:	stats_db

Driver for updating amphora statistics.

event_streamer_driver¶

Type:	string
Default:	noop_event_streamer

Specifies which driver to use for the event_streamer for syncing the octavia and neutron_lbaas dbs. If you don’t need to sync the database or are running octavia in stand alone mode use the noop_event_streamer

sync_provisioning_status¶

Type:	boolean
Default:	false

Enable provisioning status sync with neutron db

spare_check_interval¶

Type:	integer
Default:	30

Spare check interval in seconds

spare_amphora_pool_size¶

Type:	integer
Default:	0

Number of spare amphorae

cleanup_interval¶

Type:	integer
Default:	30

DB cleanup interval in seconds

amphora_expiry_age¶

Type:	integer
Default:	604800

Amphora expiry age in seconds

load_balancer_expiry_age¶

Type:	integer
Default:	604800

Load balancer expiry age in seconds

cert_interval¶

Type:	integer
Default:	3600

Certificate check interval in seconds

cert_expiry_buffer¶

Type:	integer
Default:	1209600

Seconds until certificate expiration

cert_rotate_threads¶

Type:	integer
Default:	10

Number of threads performing amphora certificate rotation

vrrp_advert_int¶

Type:	integer
Default:	1

Amphora role and priority advertisement interval in seconds.

vrrp_check_interval¶

Type:	integer
Default:	5

VRRP health check script run interval in seconds.

vrrp_fail_count¶

Type:	integer
Default:	2

Number of successive failures before transition to a fail state.

vrrp_success_count¶

Type:	integer
Default:	2

Number of consecutive successes before transition to a success state.

vrrp_garp_refresh_interval¶

Type:	integer
Default:	5

Time in seconds between gratuitous ARP announcements from the MASTER.

vrrp_garp_refresh_count¶

Type:	integer
Default:	2

Number of gratuitous ARP announcements to make on each refresh interval.

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

max_retries¶

Type:	integer
Default:	15

The maximum attempts to retry an action with the networking service.

retry_interval¶

Type:	integer
Default:	1

Seconds to wait before retrying an action with the networking service.

port_detach_timeout¶

Type:	integer
Default:	300

Seconds to wait for a port to detach from an amphora.

allow_vip_network_id¶

Type:	boolean
Default:	true

Can users supply a network_id for their VIP?

allow_vip_subnet_id¶

Type:	boolean
Default:	true

Can users supply a subnet_id for their VIP?

allow_vip_port_id¶

Type:	boolean
Default:	true

Can users supply a port_id for their VIP?

valid_vip_networks¶

Type:	list
Default:	<None>

List of network_ids that are valid for VIP creation. If this field is empty, no validation is performed.

reserved_ips¶

Type:	list
Default:	169.254.169.254

List of IP addresses reserved from being used for member addresses. IPv6 addresses should be in expanded, uppercase form.

allow_invisible_resource_usage¶

Type:	boolean
Default:	false

When True, users can use network resources they cannot normally see as VIP or member subnets. Making this True may allow users to access resources on subnets they do not normally have access to via neutron RBAC policies.

service_name¶

Type:	string
Default:	<None>

The name of the neutron service in the keystone catalog

endpoint¶

Type:	string
Default:	<None>

A new endpoint to override the endpoint in the keystone catalog.

region_name¶

Type:	string
Default:	<None>

Region in Identity service catalog to use for communication with the OpenStack services.

endpoint_type¶

Type:	string
Default:	publicURL

Endpoint interface in identity service to use

ca_certificates_file¶

Type:	string
Default:	<None>

CA certificates file path

insecure¶

Type:	boolean
Default:	false

Disable certificate validation on SSL connections

service_name¶

Type:	string
Default:	<None>

The name of the nova service in the keystone catalog

endpoint¶

Type:	string
Default:	<None>

A new endpoint to override the endpoint in the keystone catalog.

region_name¶

Type:	string
Default:	<None>

Region in Identity service catalog to use for communication with the OpenStack services.

endpoint_type¶

Type:	string
Default:	publicURL

Endpoint interface in identity service to use

ca_certificates_file¶

Type:	string
Default:	<None>

CA certificates file path

insecure¶

Type:	boolean
Default:	false

Disable certificate validation on SSL connections

enable_anti_affinity¶

Type:	boolean
Default:	false

Flag to indicate if nova anti-affinity feature is turned on.

anti_affinity_policy¶

Type:	string
Default:	anti-affinity
Valid Values:	anti-affinity, soft-anti-affinity

Sets the anti-affinity policy for nova

random_amphora_name_length¶

Type:	integer
Default:	0

If non-zero, generate a random name of the length provided for each amphora, in the format “a[A-Z0-9]*”. Otherwise, the default name format will be used: “amphora-{UUID}”.

availability_zone¶

Type:	string
Default:	<None>

Availability zone to use for creating Amphorae

topic¶

Type:	string
Default:	<None>

event_stream_topic¶

Type:	string
Default:	neutron_lbaas_event

topic name for communicating events through a queue

event_stream_transport_url¶

Type:	string
Default:	<None>

Transport URL to use for the neutron-lbaassynchronization event stream when neutron and octaviahave separate queues.

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

enable_auto_commit¶

Type:	boolean
Default:	false

Enable asynchronous consumer commits

max_poll_records¶

Type:	integer
Default:	500

The maximum number of records returned in a poll call

security_protocol¶

Type:	string
Default:	PLAINTEXT
Valid Values:	PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL

Protocol used to communicate with brokers

sasl_mechanism¶

Type:	string
Default:	PLAIN

Mechanism when security protocol is SASL

ssl_cafile¶

Type:	string
Default:	''

CA certificate PEM file used to verify the server certificate

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:	false

Connect over SSL.

Deprecated Variations¶

Group	Name
oslo_messaging_rabbit	rabbit_use_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.

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.

default_load_balancer_quota¶

Type:	integer
Default:	-1

Default per project load balancer quota.

default_listener_quota¶

Type:	integer
Default:	-1

Default per project listener quota.

default_member_quota¶

Type:	integer
Default:	-1

Default per project member quota.

default_pool_quota¶

Type:	integer
Default:	-1

Default per project pool quota.

default_health_monitor_quota¶

Type:	integer
Default:	-1

Default per project health monitor quota.

auth_url¶

Type:	unknown type
Default:	<None>

Authentication URL

auth_type¶

Type:	unknown type
Default:	<None>

Authentication type to load

Deprecated Variations¶

Group	Name
service_auth	auth_plugin

cafile¶

Type:	string
Default:	<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile¶

Type:	string
Default:	<None>

PEM encoded client certificate cert file

collect_timing¶

Type:	boolean
Default:	false

Collect per-API call timing information.

default_domain_id¶

Type:	unknown type
Default:	<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name¶

Type:	unknown type
Default:	<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id¶

Type:	unknown type
Default:	<None>

Domain ID to scope to

domain_name¶

Type:	unknown type
Default:	<None>

Domain name to scope to

insecure¶

Type:	boolean
Default:	false

Verify HTTPS connections.

keyfile¶

Type:	string
Default:	<None>

PEM encoded client certificate key file

password¶

Type:	unknown type
Default:	<None>

User’s password

project_domain_id¶

Type:	unknown type
Default:	<None>

Domain ID containing project

project_domain_name¶

Type:	unknown type
Default:	<None>

Domain name containing project

project_id¶

Type:	unknown type
Default:	<None>

Project ID to scope to

Deprecated Variations¶

Group	Name
service_auth	tenant-id
service_auth	tenant_id

project_name¶

Type:	unknown type
Default:	<None>

Project name to scope to

Deprecated Variations¶

Group	Name
service_auth	tenant-name
service_auth	tenant_name

split_loggers¶

Type:	boolean
Default:	false

Log requests to multiple loggers.

system_scope¶

Type:	unknown type
Default:	<None>

Scope for system operations

tenant_id¶

Type:	unknown type
Default:	<None>

Tenant ID

tenant_name¶

Type:	unknown type
Default:	<None>

Tenant Name

timeout¶

Type:	integer
Default:	<None>

Timeout value for http requests

trust_id¶

Type:	unknown type
Default:	<None>

Trust ID

user_domain_id¶

Type:	unknown type
Default:	<None>

User’s domain id

user_domain_name¶

Type:	unknown type
Default:	<None>

User’s domain name

user_id¶

Type:	unknown type
Default:	<None>

User id

username¶

Type:	unknown type
Default:	<None>

Username

Deprecated Variations¶

Group	Name
service_auth	user-name
service_auth	user_name

engine¶

Type:	string
Default:	serial

TaskFlow engine to use

max_workers¶

Type:	integer
Default:	5

The maximum number of workers

disable_revert¶

Type:	boolean
Default:	false

If True, disables the controller worker taskflow flows from reverting. This will leave resources in an inconsistent state and should only be used for debugging purposes.