Config Documentation

The following is an overview of all available configuration in Designate. For a sample configuration file, refer to designate.conf.

DEFAULT

rpc_conn_pool_size
Type:

integer

Default:

30

Minimum Value:

1

Size of RPC connection pool.

Deprecated Variations

Group

Name

DEFAULT

rpc_conn_pool_size

conn_pool_min_size
Type:

integer

Default:

2

The pool size limit for connections expiration policy

conn_pool_ttl
Type:

integer

Default:

1200

The time-to-live in sec of idle connections in the pool

executor_thread_pool_size
Type:

integer

Default:

64

Size of executor thread pool when executor is threading or eventlet.

Deprecated Variations

Group

Name

DEFAULT

rpc_thread_pool_size

rpc_response_timeout
Type:

integer

Default:

60

Seconds to wait for a response from a call.

transport_url
Type:

string

Default:

rabbit://

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

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.

rpc_ping_enabled
Type:

boolean

Default:

False

Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping

host
Type:

string

Default:

current_hostname

This option has a sample default set, which means that its actual default value may vary from the one documented above.

Name of this node

pybasedir
Type:

string

Default:

<Path>

This option has a sample default set, which means that its actual default value may vary from the one documented above.

Directory where the designate python module is installed

state_path
Type:

string

Default:

/var/lib/designate

Top-level directory for maintaining designate’s state

allowed_remote_exmods
Type:

list

Default:

[]

Additional modules that contains allowed RPC exceptions.

Deprecated Variations

Group

Name

DEFAULT

allowed_rpc_exception_modules

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_soa_refresh_max
Type:

integer

Default:

3600

SOA max value

default_soa_retry
Type:

integer

Default:

600

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', 'NAPTR', 'CAA', 'CERT']

Supported record types

backlog
Type:

integer

Default:

4096

Number of backlog requests to configure the socket with

tcp_keepidle
Type:

integer

Default:

600

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

root_helper
Type:

string

Default:

sudo designate-rootwrap /etc/designate/rootwrap.conf

designate-rootwrap configuration

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

integer

Default:

10

Number of zones allowed per tenant

quota_zone_recordsets
Type:

integer

Default:

500

Number of recordsets allowed per zone

quota_zone_records
Type:

integer

Default:

500

Number of records allowed per zone

quota_recordset_records
Type:

integer

Default:

20

Number of records allowed per recordset

quota_api_export_size
Type:

integer

Default:

1000

Number of recordsets allowed in a zone export

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, log-date-format).

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.

use_eventlog
Type:

boolean

Default:

False

Log output to Windows Event Log.

log_rotate_interval
Type:

integer

Default:

1

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.

log_rotate_interval_type
Type:

string

Default:

days

Valid Values:

Seconds, Minutes, Hours, Days, Weekday, Midnight

Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.

max_logfile_count
Type:

integer

Default:

30

Maximum number of rotated log files.

max_logfile_size_mb
Type:

integer

Default:

200

Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.

log_rotation_type
Type:

string

Default:

none

Valid Values:

interval, size, none

Log rotation type.

Possible values

interval

Rotate logs at predefined time intervals.

size

Rotate logs once they reach a predefined size.

none

Do not rotate log files.

logging_context_format_string
Type:

string

Default:

%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

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. Used by oslo_log.formatters.ContextFormatter

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. Used by oslo_log.formatters.ContextFormatter

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. Used by oslo_log.formatters.ContextFormatter

logging_user_identity_format
Type:

string

Default:

%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

default_log_levels
Type:

list

Default:

['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=INFO', 'oslo_messaging=INFO', 'iso8601=WARN', 'requests.packages.urllib3.connectionpool=WARN', 'urllib3.connectionpool=WARN', 'websocket=WARN', 'requests.packages.urllib3.util.retry=WARN', 'urllib3.util.retry=WARN', 'keystonemiddleware=WARN', 'routes.middleware=WARN', 'stevedore=WARN', 'taskflow=WARN', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO', 'kazoo.client=WARN', 'keystone=INFO', 'oslo_service.loopingcall=WARN']

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

integer

Default:

0

Interval, number of seconds, of log rate limiting.

rate_limit_burst
Type:

integer

Default:

0

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.

run_external_periodic_tasks
Type:

boolean

Default:

True

Some periodic tasks can be run in a separate process. Should we run them here?

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. Inside the path {pid} will be replaced with the PID of the current process.

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

integer

Default:

60

Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

api_paste_config
Type:

string

Default:

api-paste.ini

File name for the paste.deploy config for api service

wsgi_log_format
Type:

string

Default:

%(client_ip)s "%(request_line)s" status: %(status_code)s  len: %(body_length)s time: %(wall_seconds).7f

A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.

tcp_keepidle
Type:

integer

Default:

600

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

wsgi_default_pool_size
Type:

integer

Default:

100

Size of the pool of greenthreads used by wsgi

max_header_line
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 when keystone is configured to use PKI tokens with big service catalogs).

wsgi_keep_alive
Type:

boolean

Default:

True

If False, closes the client socket connection explicitly.

client_socket_timeout
Type:

integer

Default:

900

Timeout for client connections’ socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of ‘0’ means wait forever.

wsgi_server_debug
Type:

boolean

Default:

False

True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.

backend:agent:bind9

rndc_host
Type:

string

Default:

127.0.0.1

RNDC Host

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

rndc_port
Type:

integer

Default:

953

RNDC Port

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

rndc_config_file
Type:

string

Default:

<None>

RNDC Config File

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

rndc_key_file
Type:

string

Default:

<None>

RNDC Key File

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

rndc_timeout
Type:

integer

Default:

0

Minimum Value:

0

RNDC command timeout

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

zone_file_path
Type:

string

Default:

$state_path/zones

Path where zone files are stored

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

query_destination
Type:

string

Default:

127.0.0.1

Host to query when finding zones

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

backend:agent:denominator

name
Type:

string

Default:

fake

Name of the affected provider

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

config_file
Type:

string

Default:

/etc/denominator.conf

Path to Denominator configuration file

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

backend:agent:djbdns

tcpclient_cmd_name
Type:

string

Default:

tcpclient

tcpclient executable path or rootwrap command name

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

axfr_get_cmd_name
Type:

string

Default:

axfr-get

axfr-get executable path or rootwrap command name

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

tinydns_data_cmd_name
Type:

string

Default:

tinydns-data

tinydns-data executable path or rootwrap command name

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

tinydns_datadir
Type:

string

Default:

/var/lib/djbdns

TinyDNS data directory

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

query_destination
Type:

string

Default:

127.0.0.1

Host to query when finding zones

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

backend:agent:gdnsd

gdnsd_cmd_name
Type:

string

Default:

gdnsd

gdnsd executable path or rootwrap command name

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

confdir_path
Type:

string

Default:

/etc/gdnsd

gdnsd configuration directory path

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

query_destination
Type:

string

Default:

127.0.0.1

Host to query when finding zones

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

backend:agent:knot2

knotc_cmd_name
Type:

string

Default:

knotc

knotc executable path or rootwrap command name

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

query_destination
Type:

string

Default:

127.0.0.1

Host to query when finding zones

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

backend:agent:msdns

backend:dynect

job_timeout
Type:

integer

Default:

30

Timeout in seconds for pulling a job in DynECT.

timeout
Type:

integer

Default:

10

Timeout in seconds for API Requests.

timings
Type:

boolean

Default:

False

Measure requests timings.

backend:infoblox

wapi_url
Type:

string

Default:

<None>

DEPRECATED: wapi_url

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

username
Type:

string

Default:

<None>

DEPRECATED: username

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

password
Type:

string

Default:

<None>

DEPRECATED: password

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

sslverify
Type:

boolean

Default:

True

DEPRECATED: sslverify

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

multi_tenant
Type:

boolean

Default:

False

DEPRECATED: multi_tenant

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

http_pool_connections
Type:

integer

Default:

100

DEPRECATED: http_pool_connections

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

http_pool_maxsize
Type:

integer

Default:

100

DEPRECATED: http_pool_maxsize

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

dns_view
Type:

string

Default:

default

DEPRECATED: dns_view

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

network_view
Type:

string

Default:

default

DEPRECATED: network_view

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

ns_group
Type:

string

Default:

<None>

DEPRECATED: ns_group

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

All backend options have been migrated to options in the pools.yaml file

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:

5.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
Type:

list

Default:

<None>

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

expose_headers
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.

allow_headers
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', 'X-Designate-Hard-Delete', '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_wsrep_sync_wait
Type:

integer

Default:

<None>

For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting.

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.

max_pool_size
Type:

integer

Default:

5

Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.

max_retries
Type:

integer

Default:

10

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

integer

Default:

10

Interval between retries of opening a SQL connection.

Deprecated Variations

Group

Name

DEFAULT

sql_retry_interval

DATABASE

reconnect_interval

max_overflow
Type:

integer

Default:

50

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

integer

Default:

1

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

integer

Default:

10

If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.

db_max_retries
Type:

integer

Default:

20

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

string

Default:

''

Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=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:

''

IPv4 format

format
Type:

multi-valued

Default:

''

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:

''

IPv6 format

handler:nova_fixed

notification_topics
Type:

list

Default:

['notifications']

notification any events from nova

control_exchange
Type:

string

Default:

nova

control-exchange for nova notification

zone_id
Type:

string

Default:

<None>

Zone ID with each notification

formatv4
Type:

multi-valued

Default:

''

IPv4 format

format
Type:

multi-valued

Default:

''

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:

''

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. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.

backends
Type:

list

Default:

[]

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

list

Default:

[]

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:

10.0

Number of seconds between heartbeats for reporting state

emitter_type
Type:

string

Default:

rpc

Emitter to use

keystone

service_type
Type:

string

Default:

<None>

The default service_type for endpoint URL discovery.

service_name
Type:

string

Default:

<None>

The default service_name for endpoint URL discovery.

valid_interfaces
Type:

list

Default:

<None>

List of interfaces, in order of preference, for endpoint URL.

region_name
Type:

string

Default:

<None>

The default region_name for endpoint URL discovery.

endpoint_override
Type:

string

Default:

<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

version
Type:

string

Default:

<None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

min_version
Type:

string

Default:

<None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

max_version
Type:

string

Default:

<None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

connect_retries
Type:

integer

Default:

<None>

The maximum number of retries that should be attempted for connection errors.

connect_retry_delay
Type:

floating point

Default:

<None>

Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

status_code_retries
Type:

integer

Default:

<None>

The maximum number of retries that should be attempted for retriable HTTP status codes.

status_code_retry_delay
Type:

floating point

Default:

<None>

Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

interface
Type:

string

Default:

<None>

The default interface for endpoint URL discovery.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Using valid-interfaces is preferrable because it is capable of accepting a list of possible interfaces.

cafile
Type:

string

Default:

<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:

string

Default:

<None>

PEM encoded client certificate cert file

keyfile
Type:

string

Default:

<None>

PEM encoded client certificate key file

insecure
Type:

boolean

Default:

False

Verify HTTPS connections.

timeout
Type:

integer

Default:

<None>

Timeout value for http requests

collect_timing
Type:

boolean

Default:

False

Collect per-API call timing information.

split_loggers
Type:

boolean

Default:

False

Log requests to multiple loggers.

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 Identity API endpoint.

interface
Type:

string

Default:

internal

Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.

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

integer

Default:

3

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.

memcached_servers
Type:

list

Default:

<None>

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

integer

Default:

300

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.

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

integer

Default:

300

(Optional) Number of seconds memcached server is considered dead before it is tried again.

memcache_pool_maxsize
Type:

integer

Default:

10

(Optional) Maximum total number of open connections to every memcached server.

memcache_pool_socket_timeout
Type:

integer

Default:

3

(Optional) Socket timeout in seconds for communicating with a memcached server.

memcache_pool_unused_timeout
Type:

integer

Default:

60

(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.

memcache_pool_conn_get_timeout
Type:

integer

Default:

10

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

True

(Optional) Use the advanced (eventlet safe) memcached client pool.

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.

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.

service_type
Type:

string

Default:

<None>

The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules.

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

network_api:neutron

endpoints
Type:

list

Default:

<None>

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

integer

Default:

30

timeout value for connecting to neutron in seconds

insecure
Type:

boolean

Default:

False

if set, ignore any SSL validation issues

ca_certificates_file
Type:

string

Default:

<None>

Location of ca certificates file to use for neutron client requests.

client_certificate_file
Type:

string

Default:

<None>

Location of client certificate file to use for neutron client requests.

admin_username
Type:

string

Default:

<None>

username for connecting to neutron in admin context

Warning

This option is deprecated for removal since 2023.2. Its value may be silently ignored in the future.

Reason:

This parameter is no longer used.

admin_password
Type:

string

Default:

<None>

password for connecting to neutron in admin context

Warning

This option is deprecated for removal since 2023.2. Its value may be silently ignored in the future.

Reason:

This parameter is no longer used.

admin_tenant_name
Type:

string

Default:

<None>

tenant name for connecting to neutron in admin context

Warning

This option is deprecated for removal since 2023.2. Its value may be silently ignored in the future.

Reason:

This parameter is no longer used.

auth_url
Type:

string

Default:

<None>

auth url for connecting to neutron in admin context

Warning

This option is deprecated for removal since 2023.2. Its value may be silently ignored in the future.

Reason:

This parameter is no longer used.

auth_strategy
Type:

string

Default:

keystone

auth strategy for connecting to neutron in admin context

Warning

This option is deprecated for removal since 2023.2. Its value may be silently ignored in the future.

Reason:

This parameter is no longer used.

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

boolean

Default:

False

Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.

ssl_ca_file
Type:

string

Default:

''

CA certificate PEM file used to verify the server’s certificate

Deprecated Variations

Group

Name

amqp1

ssl_ca_file

ssl_cert_file
Type:

string

Default:

''

Self-identifying certificate PEM file for client authentication

Deprecated Variations

Group

Name

amqp1

ssl_cert_file

ssl_key_file
Type:

string

Default:

''

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.

sasl_mechanisms
Type:

string

Default:

''

Space separated list of acceptable SASL mechanisms

Deprecated Variations

Group

Name

amqp1

sasl_mechanisms

sasl_config_dir
Type:

string

Default:

''

Path to directory that contains the SASL configuration

Deprecated Variations

Group

Name

amqp1

sasl_config_dir

sasl_config_name
Type:

string

Default:

''

Name of configuration file (without .conf suffix)

Deprecated Variations

Group

Name

amqp1

sasl_config_name

sasl_default_realm
Type:

string

Default:

''

SASL realm to use if no realm present in username

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

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.

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’

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_max_fetch_bytes
Type:

integer

Default:

1048576

Max fetch bytes of Kafka consumer

kafka_consumer_timeout
Type:

floating point

Default:

1.0

Default timeout(s) for Kafka consumers

pool_size
Type:

integer

Default:

10

Pool Size for Kafka Consumers

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Driver no longer uses connection pool.

conn_pool_min_size
Type:

integer

Default:

2

The pool size limit for connections expiration policy

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Driver no longer uses connection pool.

conn_pool_ttl
Type:

integer

Default:

1200

The time-to-live in sec of idle connections in the pool

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Driver no longer uses connection pool.

consumer_group
Type:

string

Default:

oslo_messaging_consumer

Group id for Kafka consumer. Consumers in one group will coordinate message consumption

producer_batch_timeout
Type:

floating point

Default:

0.0

Upper bound on the delay for KafkaProducer batching in seconds

producer_batch_size
Type:

integer

Default:

16384

Size of batch for the producer async send

compression_codec
Type:

string

Default:

none

Valid Values:

none, gzip, snappy, lz4, zstd

The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version

enable_auto_commit
Type:

boolean

Default:

False

Enable asynchronous consumer commits

max_poll_records
Type:

integer

Default:

500

The maximum number of records returned in a poll call

security_protocol
Type:

string

Default:

PLAINTEXT

Valid Values:

PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL

Protocol used to communicate with brokers

sasl_mechanism
Type:

string

Default:

PLAIN

Mechanism when security protocol is SASL

ssl_cafile
Type:

string

Default:

''

CA certificate PEM file used to verify the server certificate

ssl_client_cert_file
Type:

string

Default:

''

Client certificate PEM file used for authentication.

ssl_client_key_file
Type:

string

Default:

''

Client key PEM file used for authentication.

ssl_client_key_password
Type:

string

Default:

''

Client key password file used for authentication.

oslo_messaging_notifications

driver
Type:

multi-valued

Default:

''

The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop

Deprecated Variations

Group

Name

DEFAULT

notification_driver

transport_url
Type:

string

Default:

<None>

A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

Deprecated Variations

Group

Name

DEFAULT

notification_transport_url

topics
Type:

list

Default:

['notifications']

AMQP topic used for OpenStack notifications.

Deprecated Variations

Group

Name

rpc_notifier2

topics

DEFAULT

notification_topics

retry
Type:

integer

Default:

-1

The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite

oslo_messaging_rabbit

amqp_durable_queues
Type:

boolean

Default:

False

Use durable queues in AMQP. If rabbit_quorum_queue is enabled, queues will be durable and this value will be ignored.

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

oslo_messaging_rabbit

kombu_ssl_version

ssl_key_file
Type:

string

Default:

''

SSL key file (valid only if SSL enabled).

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_ssl_keyfile

ssl_cert_file
Type:

string

Default:

''

SSL cert file (valid only if SSL enabled).

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_ssl_certfile

ssl_ca_file
Type:

string

Default:

''

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

Deprecated Variations

Group

Name

oslo_messaging_rabbit

kombu_ssl_ca_certs

ssl_enforce_fips_mode
Type:

boolean

Default:

False

Global toggle for enforcing the OpenSSL FIPS mode. This feature requires Python support. This is available in Python 3.9 in all environments and may have been backported to older Python versions on select environments. If the Python executable used does not support OpenSSL FIPS mode, an exception will be raised.

heartbeat_in_pthread
Type:

boolean

Default:

False

Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. This option should be set to True only for the wsgi services.

kombu_reconnect_delay
Type:

floating point

Default:

1.0

Minimum Value:

0.0

Maximum Value:

4.5

How long to wait (in seconds) 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
Type:

integer

Default:

60

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

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_login_method
Type:

string

Default:

AMQPLAIN

Valid Values:

PLAIN, AMQPLAIN, EXTERNAL, RABBIT-CR-DEMO

The RabbitMQ login method.

Deprecated Variations

Group

Name

DEFAULT

rabbit_login_method

rabbit_retry_interval
Type:

integer

Default:

1

How frequently to retry connecting with RabbitMQ.

rabbit_retry_backoff
Type:

integer

Default:

2

How long to backoff for between retries when connecting to RabbitMQ.

Deprecated Variations

Group

Name

DEFAULT

rabbit_retry_backoff

rabbit_interval_max
Type:

integer

Default:

30

Maximum interval of RabbitMQ connection retries. Default is 30 seconds.

rabbit_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_quorum_queue
Type:

boolean

Default:

False

Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum queue is a modern queue type for RabbitMQ implementing a durable, replicated FIFO queue based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. If set this option will conflict with the HA queues (rabbit_ha_queues) aka mirrored queues, in other words the HA queues should be disabled, quorum queues durable by default so the amqp_durable_queues opion is ignored when this option enabled.

rabbit_quorum_delivery_limit
Type:

integer

Default:

0

Each time a message is redelivered to a consumer, a counter is incremented. Once the redelivery count exceeds the delivery limit the message gets dropped or dead-lettered (if a DLX exchange has been configured) Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

rabbit_quorum_max_memory_length
Type:

integer

Default:

0

By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of messages in the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

Deprecated Variations

Group

Name

oslo_messaging_rabbit

rabbit_quroum_max_memory_length

rabbit_quorum_max_memory_bytes
Type:

integer

Default:

0

By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

Deprecated Variations

Group

Name

oslo_messaging_rabbit

rabbit_quroum_max_memory_bytes

rabbit_transient_queues_ttl
Type:

integer

Default:

1800

Minimum Value:

1

Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.

rabbit_qos_prefetch_count
Type:

integer

Default:

0

Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.

heartbeat_timeout_threshold
Type:

integer

Default:

60

Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).

heartbeat_rate
Type:

integer

Default:

2

How often times during the heartbeat_timeout_threshold we check the heartbeat.

direct_mandatory_flag
Type:

boolean

Default:

True

(DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply, so the MessageUndeliverable exception is raised in case the client queue does not exist.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Mandatory flag no longer deactivable.

enable_cancel_on_failover
Type:

boolean

Default:

False

Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down

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

secure_proxy_ssl_header
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.

enable_proxy_headers_parsing
Type:

boolean

Default:

False

Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

http_basic_auth_user_file
Type:

string

Default:

/etc/htpasswd

HTTP basic auth password file.

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.

enforce_new_defaults
Type:

boolean

Default:

False

This option controls whether or not to use old deprecated defaults when evaluating policies. If True, the old deprecated defaults are not going to be evaluated. This means if any existing token is allowed for old defaults but is disallowed for new defaults, it will be disallowed. It is encouraged to enable this flag along with the enforce_scope flag so that you can get the benefits of new defaults and scope_type together. If False, the deprecated policy check string is logically OR’d with the new policy check string, allowing for a graceful upgrade experience between releases with new policies, which is the default behavior.

policy_file
Type:

string

Default:

policy.yaml

The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option.

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

oslo_reports

log_dir
Type:

string

Default:

<None>

Path to a log directory where to create a file

file_event_handler
Type:

string

Default:

<None>

The path to a file to watch for changes to trigger the reports, instead of signals. Setting this option disables the signal trigger for the reports. If application is running as a WSGI application it is recommended to use this instead of signals.

file_event_handler_interval
Type:

integer

Default:

1

How many seconds to wait between polls when file_event_handler is set

oslo_versionedobjects

fatal_exception_format_errors
Type:

boolean

Default:

False

Make exception message format errors fatal

producer_task:delayed_notify

interval
Type:

integer

Default:

5

Run interval in seconds

per_page
Type:

integer

Default:

100

Default amount of results returned per page

batch_size
Type:

integer

Default:

100

How many zones to receive NOTIFY on each run

producer_task:periodic_exists

interval
Type:

integer

Default:

3600

Run interval in seconds

per_page
Type:

integer

Default:

100

Default amount of results returned per page

producer_task:periodic_secondary_refresh

interval
Type:

integer

Default:

3600

Run interval in seconds

per_page
Type:

integer

Default:

100

Default amount of results returned per page

producer_task:worker_periodic_recovery

interval
Type:

integer

Default:

120

Run interval in seconds

per_page
Type:

integer

Default:

100

Default amount of results returned per page

producer_task:zone_purge

interval
Type:

integer

Default:

3600

Run interval in seconds

per_page
Type:

integer

Default:

100

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

integer

Default:

100

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

list

Default:

[]

These addresses should not be proxied

service:agent

workers
Type:

integer

Default:

<None>

Number of agent worker processes to spawn

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

threads
Type:

integer

Default:

1000

Number of agent greenthreads to spawn

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

listen
Type:

list

Default:

['0.0.0.0:5358']

Agent host:port pairs to listen on

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

tcp_backlog
Type:

integer

Default:

100

The Agent TCP Backlog

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

tcp_recv_timeout
Type:

floating point

Default:

0.5

Agent TCP Receive Timeout

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

allow_notify
Type:

list

Default:

[]

List of IP addresses allowed to NOTIFY The Agent

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

masters
Type:

list

Default:

[]

List of masters for the Agent, format ip:port

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

backend_driver
Type:

string

Default:

bind9

The backend driver to use, e.g. bind9, djbdns, knot2

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

transfer_source
Type:

string

Default:

<None>

An IP address to be used to fetch zones transferred in

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

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

Warning

This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.

Reason:

The agent framework is deprecated.

service:api

workers
Type:

integer

Default:

<None>

Number of api worker processes to spawn

threads
Type:

integer

Default:

1000

Number of api greenthreads to spawn

enable_host_header
Type:

boolean

Default:

True

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

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 the Designate V2 API

enable_api_admin
Type:

boolean

Default:

False

enable-api-admin

max_header_line
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).

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

This parameter has had no effect since Train. Use [DEFAULT] max_header_line instead.

pecan_debug
Type:

boolean

Default:

False

Pecan HTML Debug Interface

enabled_extensions_v2
Type:

list

Default:

[]

Enabled API Extensions for the V2 API

default_limit_v2
Type:

integer

Default:

20

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

quotas_verify_project_id
Type:

boolean

Default:

False

Verify that the requested Project ID for quota target is a valid project in Keystone.

enabled_extensions_admin
Type:

list

Default:

[]

Enabled Admin API Extensions

default_limit_admin
Type:

integer

Default:

20

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

secure_proxy_ssl_header
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.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

This parameter has had no effect since SSLMiddleware was replaced by http_proxy_to_wsgi

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.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

This parameter has had no effect since SSLMiddleware was replaced by http_proxy_to_wsgi

service:central

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

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:

Alternative storage drivers are no longersupported.

max_zone_name_len
Type:

integer

Default:

255

Maximum zone name length

max_recordset_name_len
Type:

integer

Default:

255

Maximum recordset name length

Deprecated Variations

Group

Name

service:central

max_record_name_len

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

topic
Type:

string

Default:

central

RPC topic name for central

scheduler_filters
Type:

list

Default:

['default_pool']

Enabled Pool Scheduling filters

service:mdns

workers
Type:

integer

Default:

<None>

Number of mdns worker processes to spawn

threads
Type:

integer

Default:

1000

Number of mdns greenthreads to spawn

listen
Type:

list

Default:

['0.0.0.0:5354']

mDNS host:port pairs to listen on

tcp_backlog
Type:

integer

Default:

100

mDNS TCP Backlog

tcp_recv_timeout
Type:

floating point

Default:

0.5

mDNS TCP Receive Timeout

all_tcp
Type:

integer

Default:

<None>

Send all traffic over TCP

Warning

This option is deprecated for removal since Zed. Its value may be silently ignored in the future.

Reason:

This parameter should now be configured inservice:worker instead

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

topic
Type:

string

Default:

mdns

RPC topic name for mdns

xfr_timeout
Type:

integer

Default:

<None>

Timeout in seconds for XFR’s.

Warning

This option is deprecated for removal since Zed. Its value may be silently ignored in the future.

Reason:

This parameter should now be configured inservice:worker instead

service:producer

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

list

Default:

<None>

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

topic
Type:

string

Default:

producer

RPC topic name for producer

service:sink

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

list

Default:

[]

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.

service:worker

workers
Type:

integer

Default:

<None>

Number of Worker worker processes to spawn

threads
Type:

integer

Default:

200

Number of Worker threads to spawn per process

storage_driver
Type:

string

Default:

sqlalchemy

The storage driver to use

threshold_percentage
Type:

integer

Default:

100

The percentage of servers requiring a successful update for a domain change to be considered active

poll_timeout
Type:

integer

Default:

30

The time to wait for a response from a server

poll_retry_interval
Type:

integer

Default:

15

The time between retrying to send a request and waiting for a response from a server

poll_max_retries
Type:

integer

Default:

10

The maximum number of times to retry sending a request and wait for a response from a server

poll_delay
Type:

integer

Default:

5

The time to wait before sending the first request to a server

export_synchronous
Type:

boolean

Default:

True

Whether to allow synchronous zone exports

topic
Type:

string

Default:

worker

RPC topic name for worker

xfr_timeout
Type:

integer

Default:

10

Timeout in seconds for XFR’s.

serial_max_retries
Type:

integer

Default:

3

The maximum number of times to retry fetching a zones serial.

serial_retry_delay
Type:

integer

Default:

1

The time to wait before retrying a zone serial request.

serial_timeout
Type:

integer

Default:

1

Timeout in seconds before giving up on fetching a zones serial.

all_tcp
Type:

boolean

Default:

False

Send all traffic over TCP

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_wsrep_sync_wait
Type:

integer

Default:

<None>

For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting.

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.

max_pool_size
Type:

integer

Default:

5

Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.

max_retries
Type:

integer

Default:

10

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

integer

Default:

10

Interval between retries of opening a SQL connection.

Deprecated Variations

Group

Name

DEFAULT

sql_retry_interval

DATABASE

reconnect_interval

max_overflow
Type:

integer

Default:

50

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

integer

Default:

1

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

integer

Default:

10

If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.

db_max_retries
Type:

integer

Default:

20

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

string

Default:

''

Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=value2&…