Config Documentation
The following is an overview of all available configuration in Designate. For a
sample configuration file, refer to designate.conf.
DEFAULT
-
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: | amqplib=WARN,amqp=WARN,boto=WARN,eventlet.wsgi.server=WARN,iso8601=WARN,kazoo.client=WARN,keystone=INFO,keystonemiddleware.auth_token=INFO,oslo_messaging=WARN,oslo.messaging=INFO,oslo_service.loopingcall=WARN,sqlalchemy=WARN,stevedore=WARN,suds=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
-
Interval, number of seconds, of log rate limiting.
-
rate_limit_burst
-
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.
-
host
Type: | string |
Default: | current_hostname |
Name of this node
-
pybasedir
Type: | string |
Default: | <Path> |
Directory where the designate python module is installed
-
state_path
Type: | string |
Default: | /var/lib/designate |
Top-level directory for maintaining designate’s state
-
central_topic
Type: | string |
Default: | central |
Central Topic
-
mdns_topic
-
mDNS Topic
-
pool_manager_topic
Type: | string |
Default: | pool_manager |
Pool Manager Topic
-
worker_topic
Type: | string |
Default: | worker |
Worker Topic
-
default_ttl
Type: | integer |
Default: | 3600 |
TTL Value
-
default_soa_refresh_min
Type: | integer |
Default: | 3500 |
SOA refresh-min value
Deprecated Variations
Group |
Name |
DEFAULT |
default-soa-refresh |
DEFAULT |
default_soa_refresh |
-
default_soa_refresh_max
Type: | integer |
Default: | 3600 |
SOA max value
-
default_soa_retry
-
SOA retry
-
default_soa_expire
Type: | integer |
Default: | 86400 |
SOA expire
-
default_soa_minimum
Type: | integer |
Default: | 3600 |
SOA minimum value
-
supported_record_type
Type: | list |
Default: | A,AAAA,CNAME,MX,SRV,TXT,SPF,NS,PTR,SSHFP,SOA |
Supported record types
-
network_api
Type: | string |
Default: | neutron |
Which API to use.
-
notify_api_faults
Type: | boolean |
Default: | false |
Send notifications if there’s a failure in the API.
-
notification_plugin
Type: | string |
Default: | default |
The notification plugin to use
-
quota_driver
Type: | string |
Default: | storage |
Quota driver to use
-
quota_zones
-
Number of zones allowed per tenant
-
quota_zone_recordsets
-
Number of recordsets allowed per zone
-
quota_zone_records
-
Number of records allowed per zone
-
quota_recordset_records
-
Number of records allowed per recordset
-
quota_api_export_size
Type: | integer |
Default: | 1000 |
Number of recordsets allowed in a zone export
-
xfr_timeout
-
Timeout in seconds for XFR’s.
-
root_helper
Type: | string |
Default: | sudo designate-rootwrap /etc/designate/rootwrap.conf |
designate-rootwrap configuration
-
backlog
Type: | integer |
Default: | 4096 |
Number of backlog requests to configure the socket with
-
tcp_keepidle
-
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
-
backdoor_port
Type: | string |
Default: | <None> |
Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.
-
backdoor_socket
Type: | string |
Default: | <None> |
Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option.
-
log_options
Type: | boolean |
Default: | true |
Enables or disables logging values of all registered options when starting a service (at DEBUG level).
-
graceful_shutdown_timeout
-
Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.
-
run_external_periodic_tasks
Type: | boolean |
Default: | true |
Some periodic tasks can be run in a separate process. Should we run them here?
-
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, sentinel, 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 |
-
zmq_linger
-
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
-
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: | 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
-
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
-
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
-
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
-
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
-
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
-
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
-
Maximum number of (green) threads to work concurrently.
-
rpc_message_ttl
-
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
-
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
-
Number to multiply base ack timeout by after each retry attempt.
-
rpc_retry_attempts
-
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
-
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
-
Size of executor thread pool when executor is threading or eventlet.
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> |
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: | designate |
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
backend:agent:bind9
-
rndc_host
Type: | string |
Default: | 127.0.0.1 |
RNDC Host
-
rndc_port
-
RNDC Port
-
rndc_config_file
Type: | string |
Default: | <None> |
RNDC Config File
-
rndc_key_file
Type: | string |
Default: | <None> |
RNDC Key File
-
zone_file_path
Type: | string |
Default: | $state_path/zones |
Path where zone files are stored
-
query_destination
Type: | string |
Default: | 127.0.0.1 |
Host to query when finding zones
backend:agent:denominator
-
name
-
Name of the affected provider
-
config_file
Type: | string |
Default: | /etc/denominator.conf |
Path to Denominator configuration file
backend:agent:djbdns
-
tcpclient_cmd_name
Type: | string |
Default: | tcpclient |
tcpclient executable path or rootwrap command name
-
axfr_get_cmd_name
Type: | string |
Default: | axfr-get |
axfr-get executable path or rootwrap command name
-
tinydns_data_cmd_name
Type: | string |
Default: | tinydns-data |
tinydns-data executable path or rootwrap command name
-
tinydns_datadir
Type: | string |
Default: | /var/lib/djbdns |
TinyDNS data directory
-
query_destination
Type: | string |
Default: | 127.0.0.1 |
Host to query when finding zones
backend:agent:gdnsd
-
gdnsd_cmd_name
Type: | string |
Default: | gdnsd |
gdnsd executable path or rootwrap command name
-
confdir_path
Type: | string |
Default: | /etc/gdnsd |
gdnsd configuration directory path
-
query_destination
Type: | string |
Default: | 127.0.0.1 |
Host to query when finding zones
backend:agent:knot2
-
knotc_cmd_name
Type: | string |
Default: | knotc |
knotc executable path or rootwrap command name
-
query_destination
Type: | string |
Default: | 127.0.0.1 |
Host to query when finding zones
backend:agent:msdns
coordination
-
backend_url
Type: | string |
Default: | <None> |
The backend URL to use for distributed coordination. If unset services that need coordination will function as a standalone service. This is a tooz url - see https://docs.openstack.org/tooz/latest/user/compatibility.html
-
heartbeat_interval
Type: | floating point |
Default: | 1.0 |
Number of seconds between heartbeats for distributed coordination.
-
run_watchers_interval
Type: | floating point |
Default: | 10.0 |
Number of seconds between checks to see if group membership has changed
cors
-
allowed_origin
-
Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com
-
allow_credentials
Type: | boolean |
Default: | true |
Indicate that the actual request can include user credentials
Type: | list |
Default: | X-OpenStack-Request-ID,Host |
Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
-
max_age
Type: | integer |
Default: | 3600 |
Maximum cache age of CORS preflight requests.
-
allow_methods
Type: | list |
Default: | GET,PUT,POST,DELETE,PATCH,HEAD |
Indicate which methods can be used during the actual request.
Type: | list |
Default: | X-Auth-Token,X-Auth-Sudo-Tenant-ID,X-Auth-Sudo-Project-ID,X-Auth-All-Projects,X-Designate-Edit-Managed-Records,OpenStack-DNS-Hide-Counts |
Indicate which header field names may be used during the actual request.
database
-
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
-
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
-
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
-
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
-
Interval between retries of opening a SQL connection.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
-
max_overflow
-
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
-
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
-
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
-
db_max_retries
-
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
-
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…
handler:neutron_floatingip
-
notification_topics
Type: | list |
Default: | notifications |
notification any events from neutron
-
control_exchange
Type: | string |
Default: | neutron |
control-exchange for neutron notification
-
zone_id
Type: | string |
Default: | <None> |
Zone ID with each notification
-
formatv4
Type: | multi-valued |
Default: | u'' |
IPv4 format
-
format
Type: | multi-valued |
Default: | u'' |
format which replaced by formatv4/formatv6
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘formatv4/formatv6’ |
-
formatv6
Type: | multi-valued |
Default: | u'' |
IPv6 format
handler:nova_fixed
-
notification_topics
Type: | list |
Default: | notifications |
notification any events from nova
-
control_exchange
-
control-exchange for nova notification
-
zone_id
Type: | string |
Default: | <None> |
Zone ID with each notification
-
formatv4
Type: | multi-valued |
Default: | u'' |
IPv4 format
-
format
Type: | multi-valued |
Default: | u'' |
format which replaced by formatv4/formatv6
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘formatv4/formatv6’ |
-
formatv6
Type: | multi-valued |
Default: | u'' |
IPv6 format
healthcheck
-
path
Type: | string |
Default: | /healthcheck |
The path to respond to healtcheck requests on.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
-
detailed
Type: | boolean |
Default: | false |
Show more detailed information as part of the response
-
backends
-
Additional backends that can perform health checks and report that information back as part of a request.
-
disable_by_file_path
Type: | string |
Default: | <None> |
Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.
-
disable_by_file_paths
-
Check the presence of a file based on a port to determine if an application is running on a port. Expects a “port:path” list of strings. Used by DisableByFilesPortsHealthcheck plugin.
heartbeat_emitter
-
heartbeat_interval
Type: | floating point |
Default: | 5.0 |
Number of seconds between heartbeats for reporting state
-
emitter_type
-
Emitter to use
keystone_authtoken
-
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
-
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
-
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
-
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
-
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
-
(Optional) Number of seconds memcached server is considered dead before it is tried again.
-
memcache_pool_maxsize
-
(Optional) Maximum total number of open connections to every memcached server.
-
memcache_pool_socket_timeout
-
(Optional) Socket timeout in seconds for communicating with a memcached server.
-
memcache_pool_unused_timeout
-
(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
-
memcache_pool_conn_get_timeout
-
(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
-
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
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.
monasca:statsd
-
enabled
Type: | boolean |
Default: | false |
enable
-
port
Type: | integer |
Default: | 8125 |
UDP port
-
hostname
Type: | string |
Default: | 127.0.0.1 |
hostname
network_api:neutron
-
endpoints
-
URL to use if None in the ServiceCatalog that is passed by the request context. Format: <region>|<url>
-
endpoint_type
Type: | string |
Default: | publicURL |
Endpoint type to use
-
timeout
-
timeout value for connecting to neutron in seconds
-
admin_username
Type: | string |
Default: | <None> |
username for connecting to neutron in admin context
-
admin_password
Type: | string |
Default: | <None> |
password for connecting to neutron in admin context
-
admin_tenant_name
Type: | string |
Default: | <None> |
tenant name for connecting to neutron in admin context
-
auth_url
Type: | string |
Default: | <None> |
auth url for connecting to neutron in admin context
-
insecure
Type: | boolean |
Default: | false |
if set, ignore any SSL validation issues
-
auth_strategy
Type: | string |
Default: | keystone |
auth strategy for connecting to neutron in admin context
-
ca_certificates_file
Type: | string |
Default: | <None> |
Location of ca certificates file to use for neutron client requests.
oslo_concurrency
-
disable_process_locking
Type: | boolean |
Default: | false |
Enables or disables inter-process locks.
Deprecated Variations
Group |
Name |
DEFAULT |
disable_process_locking |
-
lock_path
Type: | string |
Default: | $state_path |
Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.
Deprecated Variations
Group |
Name |
DEFAULT |
lock_path |
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
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
-
CA certificate PEM file used to verify the server’s certificate
Deprecated Variations
Group |
Name |
amqp1 |
ssl_ca_file |
-
ssl_cert_file
-
Self-identifying certificate PEM file for client authentication
Deprecated Variations
Group |
Name |
amqp1 |
ssl_cert_file |
-
ssl_key_file
-
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
-
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 |
-
sasl_default_realm
-
SASL realm to use if no realm present in username
-
username
-
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
-
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
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
-
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
-
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
-
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
-
CA certificate PEM file used to verify the server certificate
oslo_messaging_notifications
-
driver
Type: | multi-valued |
Default: | u'' |
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
-
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.
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
-
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
-
SSL key file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
kombu_ssl_keyfile |
-
ssl_cert_file
-
SSL cert file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
kombu_ssl_certfile |
-
ssl_ca_file
-
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
-
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
-
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.
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, sentinel, 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 |
-
zmq_linger
-
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
-
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: | 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
-
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
-
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
-
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
-
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
-
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
-
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
-
Maximum number of (green) threads to work concurrently.
-
rpc_message_ttl
-
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
-
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
-
Number to multiply base ack timeout by after each retry attempt.
-
rpc_retry_attempts
-
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
-
List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.
oslo_middleware
-
max_request_body_size
Type: | integer |
Default: | 114688 |
The maximum body size for each request, in bytes.
Deprecated Variations
Group |
Name |
DEFAULT |
osapi_max_request_body_size |
DEFAULT |
max_request_body_size |
Type: | string |
Default: | X-Forwarded-Proto |
The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Type: | boolean |
Default: | false |
Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
oslo_policy
-
enforce_scope
Type: | boolean |
Default: | false |
This option controls whether or not to enforce scope when evaluating policies. If True
, the scope of the token used in the request is compared to the scope_types
of the policy being enforced. If the scopes do not match, an InvalidScope
exception will be raised. If False
, a message will be logged informing operators that policies are being invoked with mismatching scope.
-
policy_file
Type: | string |
Default: | policy.json |
The file that defines policies.
Deprecated Variations
Group |
Name |
DEFAULT |
policy_file |
-
policy_default_rule
Type: | string |
Default: | default |
Default rule. Enforced when a requested rule is not found.
Deprecated Variations
Group |
Name |
DEFAULT |
policy_default_rule |
-
policy_dirs
Type: | multi-valued |
Default: | policy.d |
Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
Deprecated Variations
Group |
Name |
DEFAULT |
policy_dirs |
-
remote_content_type
Type: | string |
Default: | application/x-www-form-urlencoded |
Valid Values: | application/x-www-form-urlencoded, application/json |
Content Type to send and receive data for REST based policy check
-
remote_ssl_verify_server_crt
Type: | boolean |
Default: | false |
server identity verification for REST based policy check
-
remote_ssl_ca_crt_file
Type: | string |
Default: | <None> |
Absolute path to ca cert file for REST based policy check
-
remote_ssl_client_crt_file
Type: | string |
Default: | <None> |
Absolute path to client cert for REST based policy check
-
remote_ssl_client_key_file
Type: | string |
Default: | <None> |
Absolute path client key file REST based policy check
pool_manager_cache:memcache
-
expiration
Type: | integer |
Default: | 3600 |
Time in seconds to expire cache.
-
memcached_servers
-
Memcached servers or None for in process cache.
pool_manager_cache:sqlalchemy
-
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
-
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
-
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
-
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
-
Interval between retries of opening a SQL connection.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
-
max_overflow
-
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
-
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
-
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
-
db_max_retries
-
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
-
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…
producer_task:delayed_notify
-
interval
-
Run interval in seconds
-
per_page
-
Default amount of results returned per page
-
batch_size
-
How many zones to receive NOTIFY on each run
producer_task:periodic_exists
-
interval
Type: | integer |
Default: | 3600 |
Run interval in seconds
-
per_page
-
Default amount of results returned per page
producer_task:periodic_secondary_refresh
-
interval
Type: | integer |
Default: | 3600 |
Run interval in seconds
-
per_page
-
Default amount of results returned per page
producer_task:worker_periodic_recovery
-
interval
-
Run interval in seconds
-
per_page
-
Default amount of results returned per page
producer_task:zone_purge
-
interval
Type: | integer |
Default: | 3600 |
Run interval in seconds
-
per_page
-
Default amount of results returned per page
-
time_threshold
Type: | integer |
Default: | 604800 |
How old deleted zones should be (deleted_at) to be purged, in seconds
-
batch_size
-
How many zones to be purged on each run
proxy
-
http_proxy
Type: | string |
Default: | <None> |
Proxy HTTP requests via this proxy.
-
https_proxy
Type: | string |
Default: | <None> |
Proxy HTTPS requests via this proxy
-
no_proxy
-
These addresses should not be proxied
-
workers
Type: | integer |
Default: | <None> |
Number of agent worker processes to spawn
-
threads
Type: | integer |
Default: | 1000 |
Number of agent greenthreads to spawn
-
host
Type: | ip address |
Default: | <None> |
Agent Bind Host
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘listen’ option |
-
port
Type: | port number |
Default: | <None> |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Agent Port Number
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘listen’ option |
-
listen
Type: | list |
Default: | 0.0.0.0:5358 |
Agent host:port pairs to listen on
-
tcp_backlog
-
The Agent TCP Backlog
-
tcp_recv_timeout
Type: | floating point |
Default: | 0.5 |
Agent TCP Receive Timeout
-
allow_notify
-
List of IP addresses allowed to NOTIFY The Agent
-
masters
-
List of masters for the Agent, format ip:port
-
backend_driver
Type: | string |
Default: | bind9 |
The backend driver to use, e.g. bind9, djbdns, knot2
-
transfer_source
Type: | string |
Default: | <None> |
An IP address to be used to fetch zones transferred in
-
notify_delay
Type: | floating point |
Default: | 0.0 |
Delay after a NOTIFY arrives for a zone that the Agent will pause and drop subsequent NOTIFYs for that zone
-
workers
Type: | integer |
Default: | <None> |
Number of api worker processes to spawn
-
threads
Type: | integer |
Default: | 1000 |
Number of api greenthreads to spawn
Type: | boolean |
Default: | false |
Enable host request headers
-
api_base_uri
Type: | string |
Default: | http://127.0.0.1:9001/ |
the url used as the base for all API responses,This should consist of the scheme (http/https),the hostname, port, and any paths that are addedto the base of Designate is URLs,For example http://dns.openstack.example.com/dns
-
api_host
Type: | ip address |
Default: | <None> |
API Bind Host
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘listen’ option |
-
api_port
Type: | port number |
Default: | <None> |
Minimum Value: | 0 |
Maximum Value: | 65535 |
API Port Number
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘listen’ option |
-
listen
Type: | list |
Default: | 0.0.0.0:9001 |
API host:port pairs to listen on
-
api_paste_config
Type: | string |
Default: | api-paste.ini |
File name for the paste.deploy config for designate-api
-
auth_strategy
Type: | string |
Default: | keystone |
The strategy to use for auth. Supports noauth or keystone
-
enable_api_v2
Type: | boolean |
Default: | true |
enable-api-v2 which enable in a future
-
enable_api_admin
Type: | boolean |
Default: | false |
enable-api-admin
Type: | integer |
Default: | 16384 |
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
-
enabled_extensions_v2
-
Enabled API Extensions for the V2 API
-
default_limit_v2
-
Default per-page limit for the V2 API, a value of None means show all results by default
-
max_limit_v2
Type: | integer |
Default: | 1000 |
Max per-page limit for the V2 API
-
enabled_extensions_admin
-
Enabled Admin API Extensions
-
default_limit_admin
-
Default per-page limit for the Admin API, a value of None means show all results by default
-
max_limit_admin
Type: | integer |
Default: | 1000 |
Max per-page limit for the Admin API
-
maintenance_mode
Type: | boolean |
Default: | false |
Enable API Maintenance Mode
-
maintenance_mode_role
Type: | string |
Default: | admin |
Role allowed to bypass maintaince mode
Type: | string |
Default: | X-Forwarded-Proto |
The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminating proxy.
-
override_proto
Type: | string |
Default: | <None> |
A scheme that will be used to override the request protocol scheme, even if it was set by an SSL terminating proxy.
-
workers
Type: | integer |
Default: | <None> |
Number of central worker processes to spawn
-
threads
Type: | integer |
Default: | 1000 |
Number of central greenthreads to spawn
-
storage_driver
Type: | string |
Default: | sqlalchemy |
The storage driver to use
-
enabled_notification_handlers
-
Enabled Notification Handlers
-
max_zone_name_len
-
Maximum zone name length
-
max_recordset_name_len
-
Maximum recordset name length
-
managed_resource_email
Type: | string |
Default: | hostmaster@example.com |
E-Mail for Managed resources
-
managed_resource_tenant_id
Type: | string |
Default: | 00000000-0000-0000-0000-000000000000 |
The Tenant ID that will own any managed resources.
-
min_ttl
Type: | integer |
Default: | <None> |
Minimum TTL allowed
-
default_pool_id
Type: | string |
Default: | 794ccc2c-d751-44fe-b57f-8894c9f5c842 |
The name of the default pool
-
central_topic
Type: | string |
Default: | central |
RPC topic name of central service.
-
scheduler_filters
Type: | list |
Default: | default_pool |
Enabled Pool Scheduling filters
-
workers
Type: | integer |
Default: | <None> |
Number of mdns worker processes to spawn
-
threads
Type: | integer |
Default: | 1000 |
Number of mdns greenthreads to spawn
-
host
Type: | ip address |
Default: | <None> |
mDNS Bind Host
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘listen’ option |
-
port
Type: | port number |
Default: | <None> |
Minimum Value: | 0 |
Maximum Value: | 65535 |
mDNS Port Number
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by ‘listen’ option |
-
listen
Type: | list |
Default: | 0.0.0.0:5354 |
mDNS host:port pairs to listen on
-
tcp_backlog
-
mDNS TCP Backlog
-
tcp_recv_timeout
Type: | floating point |
Default: | 0.5 |
mDNS TCP Receive Timeout
-
all_tcp
Type: | boolean |
Default: | false |
Send all traffic over TCP
-
query_enforce_tsig
Type: | boolean |
Default: | false |
Enforce all incoming queries (including AXFR) are TSIG signed
-
storage_driver
Type: | string |
Default: | sqlalchemy |
The storage driver to use
-
max_message_size
Type: | integer |
Default: | 65535 |
Maximum message size to emit
-
mdns_topic
-
RPC topic name for mini-DNS
-
workers
Type: | integer |
Default: | <None> |
Number of Pool Manager worker processes to spawn
-
threads
Type: | integer |
Default: | 1000 |
Number of Pool Manager greenthreads to spawn
-
pool_id
Type: | string |
Default: | 794ccc2c-d751-44fe-b57f-8894c9f5c842 |
The ID of the pool managed by this instance of the Pool Manager
-
threshold_percentage
-
The percentage of servers requiring a successful update for a zone change to be considered active
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
poll_timeout
-
The time to wait for a response from a server
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
poll_retry_interval
-
The time between retrying to send a request and waiting for a response from a server
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
poll_max_retries
-
The maximum number of times to retry sending a request and wait for a response from a server
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
poll_delay
-
The time to wait before sending the first request to a server
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
enable_recovery_timer
Type: | boolean |
Default: | true |
The flag for the recovery timer
-
periodic_recovery_interval
-
The time between recovering from failures
-
enable_sync_timer
Type: | boolean |
Default: | true |
The flag for the sync timer
-
periodic_sync_interval
Type: | integer |
Default: | 1800 |
The time between synchronizing the servers with storage
-
periodic_sync_seconds
Type: | integer |
Default: | 21600 |
Zones Updated within last N seconds will be syncd.Use an empty value to sync all zones.
-
periodic_sync_max_attempts
-
Number of attempts to update a zone during sync
-
periodic_sync_retry_interval
-
Interval between zone update attempts during sync
-
cache_driver
Type: | string |
Default: | memcache |
The cache driver to use
-
pool_manager_topic
Type: | string |
Default: | pool_manager |
RPC topic name for pool-manager
-
workers
Type: | integer |
Default: | <None> |
Number of Producer worker processes to spawn
-
threads
Type: | integer |
Default: | 1000 |
Number of Producer greenthreads to spawn
-
enabled_tasks
-
Enabled tasks to run
-
storage_driver
Type: | string |
Default: | sqlalchemy |
The storage driver to use
-
export_synchronous
Type: | boolean |
Default: | true |
Whether to allow synchronous zone exports
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
workers
Type: | integer |
Default: | <None> |
Number of sink worker processes to spawn
-
threads
Type: | integer |
Default: | 1000 |
Number of sink greenthreads to spawn
-
enabled_notification_handlers
-
Enabled Notification Handlers
-
listener_pool_name
Type: | string |
Default: | <None> |
pool name to use for oslo.messaging notification listener. Note that listener pooling is not supported by all oslo.messaging drivers.
-
enabled
Type: | boolean |
Default: | false |
Whether to send events to worker instead of Pool Manager
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | In Rocky, this option will disappear because worker will be enabled by default |
-
workers
Type: | integer |
Default: | <None> |
Number of Worker worker processes to spawn
-
threads
-
Number of Worker threads to spawn per process
-
storage_driver
Type: | string |
Default: | sqlalchemy |
The storage driver to use
-
threshold_percentage
-
The percentage of servers requiring a successful update for a domain change to be considered active
-
poll_timeout
-
The time to wait for a response from a server
-
poll_retry_interval
-
The time between retrying to send a request and waiting for a response from a server
-
poll_max_retries
-
The maximum number of times to retry sending a request and wait for a response from a server
-
poll_delay
-
The time to wait before sending the first request to a server
-
notify
Type: | boolean |
Default: | true |
Whether to allow worker to send NOTIFYs, this will noop NOTIFYs in mdns if true
-
export_synchronous
Type: | boolean |
Default: | true |
Whether to allow synchronous zone exports
-
worker_topic
Type: | string |
Default: | worker |
RPC topic for worker component
-
workers
Type: | integer |
Default: | <None> |
Number of Zone Manager worker processes to spawn
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
threads
Type: | integer |
Default: | 1000 |
Number of Zone Manager greenthreads to spawn
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
enabled_tasks
-
Enabled tasks to run
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
storage_driver
Type: | string |
Default: | sqlalchemy |
The storage driver to use
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
-
export_synchronous
Type: | boolean |
Default: | true |
Whether to allow synchronous zone exports
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Migrated to designate-worker |
ssl
-
ca_file
Type: | string |
Default: | <None> |
CA certificate file to use to verify connecting clients.
Deprecated Variations
Group |
Name |
DEFAULT |
ssl_ca_file |
-
cert_file
Type: | string |
Default: | <None> |
Certificate file to use when starting the server securely.
Deprecated Variations
Group |
Name |
DEFAULT |
ssl_cert_file |
-
key_file
Type: | string |
Default: | <None> |
Private key file to use when starting the server securely.
Deprecated Variations
Group |
Name |
DEFAULT |
ssl_key_file |
-
version
Type: | string |
Default: | <None> |
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.
-
ciphers
Type: | string |
Default: | <None> |
Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.
storage:sqlalchemy
-
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
-
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
-
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
-
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
-
Interval between retries of opening a SQL connection.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
-
max_overflow
-
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
-
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
-
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
-
db_max_retries
-
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
-
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…