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
-
Size of RPC connection pool.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rpc_conn_pool_size |
-
conn_pool_min_size
-
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
-
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, dummy |
|---|
MatchMaker driver.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rpc_zmq_matchmaker |
-
rpc_zmq_contexts
-
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 |
-
rpc_cast_timeout
-
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.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rpc_cast_timeout |
-
rpc_poll_timeout
-
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
-
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
-
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: | true |
|---|
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: | true |
|---|
Use ROUTER remote proxy.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
use_router_proxy |
-
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
-
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: | false |
|---|
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.
-
executor_thread_pool_size
-
Size of executor thread pool.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rpc_thread_pool_size |
-
rpc_response_timeout
-
Seconds to wait for a response from a call.
-
transport_url
| Type: | string |
|---|
| Default: | <None> |
|---|
A URL representing the messaging driver to use and its full configuration.
-
rpc_backend
| Type: | string |
|---|
| Default: | rabbit |
|---|
The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
| Reason: | Replaced by [DEFAULT]/transport_url |
|---|
-
control_exchange
| Type: | string |
|---|
| Default: | openstack |
|---|
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
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
-
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
-
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
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
container_name |
-
idle_timeout
-
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
-
CA certificate PEM file to verify server certificate
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
ssl_ca_file |
-
ssl_cert_file
-
Identifying certificate PEM file to present to clients
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
ssl_cert_file |
-
ssl_key_file
-
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
-
Space separated list of acceptable SASL mechanisms
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
sasl_mechanisms |
-
sasl_config_dir
-
Path to directory that contains the SASL configuration
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
sasl_config_dir |
-
sasl_config_name
-
Name of configuration file (without .conf suffix)
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
sasl_config_name |
-
username
-
User name for message broker authentication
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
username |
-
password
-
Password for message broker authentication
Deprecated Variations
| Group |
Name |
|---|
| amqp1 |
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_timeout
| Type: | integer |
|---|
| Default: | 30 |
|---|
| Minimum Value: | 5 |
|---|
The deadline for an rpc reply message delivery. Only used when caller does not provide a timeout expiry.
-
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.
-
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
-
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
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
-
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
-
SSL key file (valid only if SSL enabled).
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
kombu_ssl_keyfile |
-
kombu_ssl_certfile
-
SSL cert file (valid only if SSL enabled).
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
kombu_ssl_certfile |
-
kombu_ssl_ca_certs
-
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 not be available in future versions.
-
kombu_missing_consumer_retry_timeout
-
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_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 |
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 |
|---|
The RabbitMQ login method.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rabbit_login_method |
-
rabbit_virtual_host
-
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
-
How frequently to retry connecting with RabbitMQ.
-
rabbit_retry_backoff
-
How long to backoff for between retries when connecting to RabbitMQ.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rabbit_retry_backoff |
-
rabbit_interval_max
-
Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
-
rabbit_max_retries
-
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
-
Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
-
heartbeat_timeout_threshold
-
Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
-
heartbeat_rate
-
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
-
How often to send heartbeats for consumer’s connections
-
ssl
| Type: | boolean |
|---|
| Default: | <None> |
|---|
Enable SSL
-
ssl_options
-
Arguments passed to ssl.wrap_socket
-
socket_timeout
| Type: | floating point |
|---|
| Default: | 0.25 |
|---|
Set socket timeout in seconds for connection’s socket
-
tcp_user_timeout
| Type: | floating point |
|---|
| Default: | 0.25 |
|---|
Set TCP_USER_TIMEOUT in seconds for connection’s socket
-
host_connection_reconnect_delay
| Type: | floating point |
|---|
| Default: | 0.25 |
|---|
Set delay for reconnection to some host which has connection error
-
connection_factory
| Type: | string |
|---|
| Default: | single |
|---|
| Valid Values: | new, single, read_write |
|---|
Connection factory implementation
-
pool_max_size
-
Maximum number of connections to keep queued.
-
pool_max_overflow
-
Maximum number of connections to create above pool_max_size.
-
pool_timeout
-
Default number of seconds to wait for a connections to available
-
pool_recycle
-
Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.
-
pool_stale
-
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 sending notifications
-
notification_listener_prefetch_count
-
Max number of not acknowledged message which RabbitMQ can send to notification listener.
-
default_notification_retry_attempts
-
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
-
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
-
Max number of not acknowledged message which RabbitMQ can send to rpc listener.
-
rpc_reply_listener_prefetch_count
-
Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.
-
rpc_reply_retry_attempts
-
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
-
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
oslo_messaging_zmq
-
rpc_zmq_bind_address
-
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, dummy |
|---|
MatchMaker driver.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rpc_zmq_matchmaker |
-
rpc_zmq_contexts
-
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 |
-
rpc_cast_timeout
-
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.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
rpc_cast_timeout |
-
rpc_poll_timeout
-
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
-
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
-
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: | true |
|---|
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: | true |
|---|
Use ROUTER remote proxy.
Deprecated Variations
| Group |
Name |
|---|
| DEFAULT |
use_router_proxy |
-
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
-
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: | false |
|---|
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.
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 |
|---|