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.
¶ 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.
¶ Group
Name
DEFAULT
rpc_zmq_bind_address
-
rpc_zmq_matchmaker
¶ - Type
string
- Default
redis
- Valid Values
redis, sentinel, dummy
MatchMaker driver.
¶ Group
Name
DEFAULT
rpc_zmq_matchmaker
-
rpc_zmq_contexts
¶ - Type
integer
- Default
1
Number of ZeroMQ contexts, defaults to 1.
¶ 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.
¶ Group
Name
DEFAULT
rpc_zmq_topic_backlog
-
rpc_zmq_ipc_dir
¶ - Type
string
- Default
/var/run/openstack
Directory for holding IPC sockets.
¶ Group
Name
DEFAULT
rpc_zmq_ipc_dir
-
rpc_zmq_host
¶ - Type
string
- Default
localhost
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.
¶ 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.
¶ 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.
¶ 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).
¶ 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.
¶ 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.
¶ Group
Name
DEFAULT
use_pub_sub
-
use_router_proxy
¶ - Type
boolean
- Default
false
Use ROUTER remote proxy.
¶ 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.
¶ 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.
¶ 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.
¶ 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
¶ 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.
¶ 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.
matchmaker_redis¶
-
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.
oslo_messaging_amqp¶
-
container_name
¶ - Type
string
- Default
<None>
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
¶ Group
Name
amqp1
container_name
-
idle_timeout
¶ - Type
integer
- Default
0
Timeout for inactive connections (in seconds)
¶ Group
Name
amqp1
idle_timeout
-
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
¶ Group
Name
amqp1
ssl_ca_file
-
ssl_cert_file
¶ - Type
string
- Default
''
Self-identifying certificate PEM file for client authentication
¶ Group
Name
amqp1
ssl_cert_file
-
ssl_key_file
¶ - Type
string
- Default
''
Private key PEM file used to sign ssl_cert_file certificate (optional)
¶ Group
Name
amqp1
ssl_key_file
-
ssl_key_password
¶ - Type
string
- Default
<None>
Password for decrypting ssl_key_file (if encrypted)
¶ 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
¶ 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
¶ Group
Name
amqp1
sasl_mechanisms
-
sasl_config_dir
¶ - Type
string
- Default
''
Path to directory that contains the SASL configuration
¶ Group
Name
amqp1
sasl_config_dir
-
sasl_config_name
¶ - Type
string
- Default
''
Name of configuration file (without .conf suffix)
¶ 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
¶ 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
¶ 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
¶ Group
Name
amqp1
server_request_prefix
-
broadcast_prefix
¶ - Type
string
- Default
broadcast
address prefix used when broadcasting to all servers
¶ Group
Name
amqp1
broadcast_prefix
-
group_request_prefix
¶ - Type
string
- Default
unicast
address prefix when sending to any server in group
¶ 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
oslo_messaging_kafka¶
-
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
oslo_messaging_notifications¶
-
driver
¶ - Type
multi-valued
- Default
''
The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
¶ 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.
¶ Group
Name
DEFAULT
notification_transport_url
-
topics
¶ - Type
list
- Default
notifications
AMQP topic used for OpenStack notifications.
¶ 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
oslo_messaging_rabbit¶
-
amqp_durable_queues
¶ - Type
boolean
- Default
false
Use durable queues in AMQP.
¶ Group
Name
DEFAULT
amqp_durable_queues
DEFAULT
rabbit_durable_queues
-
amqp_auto_delete
¶ - Type
boolean
- Default
false
Auto-delete queues in AMQP.
¶ Group
Name
DEFAULT
amqp_auto_delete
-
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.
¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_version
-
ssl_key_file
¶ - Type
string
- Default
''
SSL key file (valid only if SSL enabled).
¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_keyfile
-
ssl_cert_file
¶ - Type
string
- Default
''
SSL cert file (valid only if SSL enabled).
¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_certfile
-
ssl_ca_file
¶ - Type
string
- Default
''
SSL certification authority file (valid only if SSL enabled).
¶ 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.
¶ 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.
¶ 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.
¶ 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.
¶ 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.
¶ 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.
¶ 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.
¶ 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.
¶ Group
Name
DEFAULT
rabbit_login_method
-
rabbit_virtual_host
¶ - Type
string
- Default
/
The RabbitMQ virtual host.
¶ 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.
¶ 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).
¶ 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”}’ “
¶ 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.
oslo_messaging_zmq¶
-
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.
¶ Group
Name
DEFAULT
rpc_zmq_bind_address
-
rpc_zmq_matchmaker
¶ - Type
string
- Default
redis
- Valid Values
redis, sentinel, dummy
MatchMaker driver.
¶ Group
Name
DEFAULT
rpc_zmq_matchmaker
-
rpc_zmq_contexts
¶ - Type
integer
- Default
1
Number of ZeroMQ contexts, defaults to 1.
¶ 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.
¶ Group
Name
DEFAULT
rpc_zmq_topic_backlog
-
rpc_zmq_ipc_dir
¶ - Type
string
- Default
/var/run/openstack
Directory for holding IPC sockets.
¶ Group
Name
DEFAULT
rpc_zmq_ipc_dir
-
rpc_zmq_host
¶ - Type
string
- Default
localhost
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.
¶ 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.
¶ 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.
¶ 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).
¶ 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.
¶ 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.
¶ Group
Name
DEFAULT
use_pub_sub
-
use_router_proxy
¶ - Type
boolean
- Default
false
Use ROUTER remote proxy.
¶ 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.
¶ 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.
¶ 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.
¶ 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
¶ 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.
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