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.
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: local MatchMaker driver.
rpc_zmq_port
Type: integer Default: 9501 ZeroMQ receiver listening port.
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: 30 Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.
matchmaker_heartbeat_freq
Type: integer Default: 300 Heartbeat frequency.
matchmaker_heartbeat_ttl
Type: integer Default: 600 Heartbeat time-to-live.
executor_thread_pool_size
Type: integer Default: 64 Size of executor thread pool.
Deprecated Variations Group Name DEFAULT rpc_thread_pool_size
notification_driver
Type: multi-valued Default: The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
notification_topics
Type: list Default: notifications AMQP topic used for OpenStack notifications.
Deprecated Variations Group Name rpc_notifier2 topics
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 qpid 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.
host
Type: string Default: 127.0.0.1 Host to locate redis.
port
Type: integer Default: 6379 Use this port to connect to redis host.
password
Type: string Default: <None> Password for Redis server (optional).
ringfile
Type: string Default: /etc/oslo/matchmaker_ring.json Matchmaker ring file (JSON).
Deprecated Variations Group Name DEFAULT matchmaker_ringfile
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
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
send_single_reply
Type: boolean Default: false Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.
qpid_hostname
Type: string Default: localhost Qpid broker hostname.
Deprecated Variations Group Name DEFAULT qpid_hostname
qpid_port
Type: integer Default: 5672 Qpid broker port.
Deprecated Variations Group Name DEFAULT qpid_port
qpid_hosts
Type: list Default: $qpid_hostname:$qpid_port Qpid HA cluster host:port pairs.
Deprecated Variations Group Name DEFAULT qpid_hosts
qpid_username
Type: string Default: Username for Qpid connection.
Deprecated Variations Group Name DEFAULT qpid_username
qpid_password
Type: string Default: Password for Qpid connection.
Deprecated Variations Group Name DEFAULT qpid_password
qpid_sasl_mechanisms
Type: string Default: Space separated list of SASL mechanisms to use for auth.
Deprecated Variations Group Name DEFAULT qpid_sasl_mechanisms
qpid_heartbeat
Type: integer Default: 60 Seconds between connection keepalive heartbeats.
Deprecated Variations Group Name DEFAULT qpid_heartbeat
qpid_protocol
Type: string Default: tcp Transport to use, either ‘tcp’ or ‘ssl’.
Deprecated Variations Group Name DEFAULT qpid_protocol
qpid_tcp_nodelay
Type: boolean Default: true Whether to disable the Nagle algorithm.
Deprecated Variations Group Name DEFAULT qpid_tcp_nodelay
qpid_receiver_capacity
Type: integer Default: 1 The number of prefetched messages held by receiver.
Deprecated Variations Group Name DEFAULT qpid_receiver_capacity
qpid_topology_version
Type: integer Default: 1 The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
Deprecated Variations Group Name DEFAULT qpid_topology_version
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
send_single_reply
Type: boolean Default: false Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.
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_reconnect_timeout
Type: integer Default: 60 How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_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: integer Default: 5672 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_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 Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.
Deprecated Variations Group Name DEFAULT rabbit_ha_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.
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.
fake_rabbit
Type: boolean Default: false Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
Deprecated Variations Group Name DEFAULT fake_rabbit
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 |
---|