Configuration Options

oslo.messaging uses oslo.config to define and manage configuration options to allow the deployer to control how an application uses the underlying messaging system.

DEFAULT

rpc_conn_pool_size

Type:integer Default:30

Size of RPC connection pool.

Deprecated Variations

Group	Name
DEFAULT	rpc_conn_pool_size

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.

rpc_zmq_matchmaker

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

MatchMaker driver.

rpc_zmq_concurrency

Type:string Default:eventlet

Type of concurrency used. Either “native” or “eventlet”

rpc_zmq_contexts

Type:integer Default:1

Number of ZeroMQ contexts, defaults to 1.

rpc_zmq_topic_backlog

Type:integer Default:<None>

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

rpc_zmq_ipc_dir

Type:string Default:/var/run/openstack

Directory for holding IPC sockets.

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.

rpc_cast_timeout

Type:integer Default:-1

Seconds to wait before a cast expires (TTL). 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. Only supported by impl_zmq.

rpc_poll_timeout

Type:integer Default:1

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

zmq_target_expire

Type:integer Default:120

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

use_pub_sub

Type:boolean Default:true

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

rpc_zmq_min_port

Type:unknown type Default:49152 Minimum Value:0 Maximum Value:65535

Minimal port number for random ports range.

rpc_zmq_max_port

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

Maximal port number for random ports range.

rpc_zmq_bind_port_retries

Type:integer Default:100

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

executor_thread_pool_size

Type:integer Default:64

Size of executor thread pool.

Deprecated Variations

Group	Name
DEFAULT	rpc_thread_pool_size

rpc_response_timeout

Type:integer Default:60

Seconds to wait for a response from a call.

transport_url

Type:string Default:<None>

A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.

rpc_backend

Type:string Default:rabbit

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

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.

matchmaker_redis

host

Type:string Default:127.0.0.1

Host to locate redis.

port

Type:unknown type Default:6379 Minimum Value:0 Maximum Value:65535

Use this port to connect to redis host.

password

Type:string Default:

Password for Redis server (optional).

sentinel_hosts

Type:list Default:

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

sentinel_group_name

Type:string Default:oslo-messaging-zeromq

Redis replica set name.

wait_timeout

Type:integer Default:500

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

Timeout in ms on blocking socket operations

oslo_messaging_amqp

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

container_name

Type:string Default:<None>

Name for the AMQP container

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_ca_file

Type:string Default:

CA certificate PEM file to verify server certificate

Deprecated Variations

Group	Name
amqp1	ssl_ca_file

ssl_cert_file

Type:string Default:

Identifying certificate PEM file to present to clients

Deprecated Variations

Group	Name
amqp1	ssl_cert_file

ssl_key_file

Type:string Default:

Private key PEM file used to sign cert_file certificate

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

allow_insecure_clients

Type:boolean Default:false

Accept clients using either SSL or plain TCP

Deprecated Variations

Group	Name
amqp1	allow_insecure_clients

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

username

Type:string Default:

User name for message broker authentication

Deprecated Variations

Group	Name
amqp1	username

password

Type:string Default:

Password for message broker authentication

Deprecated Variations

Group	Name
amqp1	password

oslo_messaging_notifications

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

oslo_messaging_rabbit

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

kombu_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
DEFAULT	kombu_ssl_version

kombu_ssl_keyfile

Type:string Default:

SSL key file (valid only if SSL enabled).

Deprecated Variations

Group	Name
DEFAULT	kombu_ssl_keyfile

kombu_ssl_certfile

Type:string Default:

SSL cert file (valid only if SSL enabled).

Deprecated Variations

Group	Name
DEFAULT	kombu_ssl_certfile

kombu_ssl_ca_certs

Type:string Default:

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

Deprecated Variations

Group	Name
DEFAULT	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 notbe available in future versions.

kombu_missing_consumer_retry_timeout

Type:integer Default:60

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

Deprecated Variations

Group	Name
DEFAULT	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

rabbit_port

Type:unknown type 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

rabbit_hosts

Type:list Default:$rabbit_host:$rabbit_port

RabbitMQ HA cluster host:port pairs.

Deprecated Variations

Group	Name
DEFAULT	rabbit_hosts

rabbit_use_ssl

Type:boolean Default:false

Connect over SSL for RabbitMQ.

Deprecated Variations

Group	Name
DEFAULT	rabbit_use_ssl

rabbit_userid

Type:string Default:guest

The RabbitMQ userid.

Deprecated Variations

Group	Name
DEFAULT	rabbit_userid

rabbit_password

Type:string Default:guest

The RabbitMQ password.

Deprecated Variations

Group	Name
DEFAULT	rabbit_password

rabbit_login_method

Type:string Default:AMQPLAIN

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

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

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:600 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:1

How often to send heartbeats for consumer’s connections

ssl

Type:boolean Default:<None>

Enable SSL

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

pool_max_size

Type:integer Default:10

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.

notification_persistence

Type:boolean Default:false

Persist notification messages.

default_notification_exchange

Type:string Default:${control_exchange}_notification

Exchange name for 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 then one time

rpc_retry_delay

Type:floating point Default:0.25

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

API

oslo_messaging.opts.list_opts()

Return a list of oslo.config options available in the library.

The returned list includes all oslo.config options which may be registered at runtime by the library.

Each element of the list is a tuple. The first element is the name of the group under which the list of elements in the second element will be registered. A group name of None corresponds to the [DEFAULT] group in config files.

This function is also discoverable via the ‘oslo_messaging’ entry point under the ‘oslo.config.opts’ namespace.

The purpose of this is to allow tools like the Oslo sample config file generator to discover the options exposed to users by this library.

Returns:a list of (group_name, opts) tuples