The following is an overview of all available configuration in Designate. For a sample configuration file, refer to designate.conf.
host
¶string
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
¶string
<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
¶string
/var/lib/designate
Top-level directory for maintaining designate’s state
allowed_remote_exmods
¶list
[]
Additional modules that contains allowed RPC exceptions.
Group |
Name |
---|---|
DEFAULT |
allowed_rpc_exception_modules |
default_ttl
¶integer
3600
TTL Value
default_soa_refresh_min
¶integer
3500
SOA refresh-min value
Group |
Name |
---|---|
DEFAULT |
default_soa_refresh |
default_soa_refresh_max
¶integer
3600
SOA max value
default_soa_retry
¶integer
600
SOA retry
default_soa_expire
¶integer
86400
SOA expire
default_soa_minimum
¶integer
3600
SOA minimum value
supported_record_type
¶list
['A', 'AAAA', 'CNAME', 'MX', 'SRV', 'TXT', 'SPF', 'NS', 'PTR', 'SSHFP', 'SOA', 'NAPTR', 'CAA']
Supported record types
backlog
¶integer
4096
Number of backlog requests to configure the socket with
tcp_keepidle
¶integer
600
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
root_helper
¶string
sudo designate-rootwrap /etc/designate/rootwrap.conf
designate-rootwrap configuration
network_api
¶string
neutron
Which API to use.
notify_api_faults
¶boolean
False
Send notifications if there’s a failure in the API.
notification_plugin
¶string
default
The notification plugin to use
quota_driver
¶string
storage
Quota driver to use
quota_zones
¶integer
10
Number of zones allowed per tenant
quota_zone_recordsets
¶integer
500
Number of recordsets allowed per zone
quota_zone_records
¶integer
500
Number of records allowed per zone
quota_recordset_records
¶integer
20
Number of records allowed per recordset
quota_api_export_size
¶integer
1000
Number of recordsets allowed in a zone export
rpc_conn_pool_size
¶integer
30
1
Size of RPC connection pool.
Group |
Name |
---|---|
DEFAULT |
rpc_conn_pool_size |
conn_pool_min_size
¶integer
2
The pool size limit for connections expiration policy
conn_pool_ttl
¶integer
1200
The time-to-live in sec of idle connections in the pool
executor_thread_pool_size
¶integer
64
Size of executor thread pool when executor is threading or eventlet.
Group |
Name |
---|---|
DEFAULT |
rpc_thread_pool_size |
rpc_response_timeout
¶integer
60
Seconds to wait for a response from a call.
transport_url
¶string
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
¶string
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
¶boolean
False
Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping
run_external_periodic_tasks
¶boolean
True
Some periodic tasks can be run in a separate process. Should we run them here?
backdoor_port
¶string
<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
¶string
<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
¶boolean
True
Enables or disables logging values of all registered options when starting a service (at DEBUG level).
graceful_shutdown_timeout
¶integer
60
Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.
api_paste_config
¶string
api-paste.ini
File name for the paste.deploy config for api service
wsgi_log_format
¶string
%(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
¶integer
600
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
wsgi_default_pool_size
¶integer
100
Size of the pool of greenthreads used by wsgi
max_header_line
¶integer
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
¶boolean
True
If False, closes the client socket connection explicitly.
client_socket_timeout
¶integer
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.
debug
¶boolean
False
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
¶string
<None>
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).
Group |
Name |
---|---|
DEFAULT |
log-config |
DEFAULT |
log_config |
log_date_format
¶string
%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
¶string
<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.
Group |
Name |
---|---|
DEFAULT |
logfile |
log_dir
¶string
<None>
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Group |
Name |
---|---|
DEFAULT |
logdir |
watch_log_file
¶boolean
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
¶boolean
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
¶boolean
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
¶string
LOG_USER
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
use_json
¶boolean
False
Use JSON formatting for logging. This option is ignored if log_config_append is set.
use_stderr
¶boolean
False
Log output to standard error. This option is ignored if log_config_append is set.
use_eventlog
¶boolean
False
Log output to Windows Event Log.
log_rotate_interval
¶integer
1
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto “interval”.
log_rotate_interval_type
¶string
days
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
¶integer
30
Maximum number of rotated log files.
max_logfile_size_mb
¶integer
200
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
log_rotation_type
¶string
none
interval, size, none
Log rotation type.
Possible values
Rotate logs at predefined time intervals.
Rotate logs once they reach a predefined size.
Do not rotate log files.
logging_context_format_string
¶string
%(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. Used by oslo_log.formatters.ContextFormatter
logging_default_format_string
¶string
%(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
¶string
%(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
¶string
%(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
¶string
%(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. Used by oslo_log.formatters.ContextFormatter
default_log_levels
¶list
['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
¶boolean
False
Enables or disables publication of error events.
instance_format
¶string
"[instance: %(uuid)s] "
The format for an instance that is passed with the log message.
instance_uuid_format
¶string
"[instance: %(uuid)s] "
The format for an instance UUID that is passed with the log message.
rate_limit_interval
¶integer
0
Interval, number of seconds, of log rate limiting.
rate_limit_burst
¶integer
0
Maximum number of logged messages per rate_limit_interval.
rate_limit_except_level
¶string
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
¶boolean
False
Enables or disables fatal status of deprecations.
rndc_host
¶string
127.0.0.1
RNDC Host
rndc_port
¶integer
953
RNDC Port
rndc_config_file
¶string
<None>
RNDC Config File
rndc_key_file
¶string
<None>
RNDC Key File
rndc_timeout
¶integer
0
0
RNDC command timeout
zone_file_path
¶string
$state_path/zones
Path where zone files are stored
query_destination
¶string
127.0.0.1
Host to query when finding zones
name
¶string
fake
Name of the affected provider
config_file
¶string
/etc/denominator.conf
Path to Denominator configuration file
tcpclient_cmd_name
¶string
tcpclient
tcpclient executable path or rootwrap command name
axfr_get_cmd_name
¶string
axfr-get
axfr-get executable path or rootwrap command name
tinydns_data_cmd_name
¶string
tinydns-data
tinydns-data executable path or rootwrap command name
tinydns_datadir
¶string
/var/lib/djbdns
TinyDNS data directory
query_destination
¶string
127.0.0.1
Host to query when finding zones
gdnsd_cmd_name
¶string
gdnsd
gdnsd executable path or rootwrap command name
confdir_path
¶string
/etc/gdnsd
gdnsd configuration directory path
query_destination
¶string
127.0.0.1
Host to query when finding zones
knotc_cmd_name
¶string
knotc
knotc executable path or rootwrap command name
query_destination
¶string
127.0.0.1
Host to query when finding zones
enhanceddns_wsdl
¶string
/path/to/EnhancedDNS.xml
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Akamai EnhancedDNS WSDL URL
job_timeout
¶integer
30
Timeout in seconds for pulling a job in DynECT.
timeout
¶integer
10
Timeout in seconds for API Requests.
timings
¶boolean
False
Measure requests timings.
wapi_url
¶string
<None>
DEPRECATED: wapi_url
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
username
¶string
<None>
DEPRECATED: username
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
password
¶string
<None>
DEPRECATED: password
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
sslverify
¶boolean
True
DEPRECATED: sslverify
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
multi_tenant
¶boolean
False
DEPRECATED: multi_tenant
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
http_pool_connections
¶integer
100
DEPRECATED: http_pool_connections
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
http_pool_maxsize
¶integer
100
DEPRECATED: http_pool_maxsize
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
dns_view
¶string
default
DEPRECATED: dns_view
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
network_view
¶string
default
DEPRECATED: network_view
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
ns_group
¶string
<None>
DEPRECATED: ns_group
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
All backend options have been migrated to options in the pools.yaml file
backend_url
¶string
<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
¶floating point
5.0
Number of seconds between heartbeats for distributed coordination.
run_watchers_interval
¶floating point
10.0
Number of seconds between checks to see if group membership has changed
allowed_origin
¶list
<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
¶boolean
True
Indicate that the actual request can include user credentials
expose_headers
¶list
['X-OpenStack-Request-ID', 'Host']
Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
max_age
¶integer
3600
Maximum cache age of CORS preflight requests.
allow_methods
¶list
['GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD']
Indicate which methods can be used during the actual request.
allow_headers
¶list
['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.
sqlite_synchronous
¶boolean
True
If True, SQLite uses synchronous mode.
Group |
Name |
---|---|
DEFAULT |
sqlite_synchronous |
backend
¶string
sqlalchemy
The back end to use for the database.
Group |
Name |
---|---|
DEFAULT |
db_backend |
connection
¶string
<None>
The SQLAlchemy connection string to use to connect to the database.
Group |
Name |
---|---|
DEFAULT |
sql_connection |
DATABASE |
sql_connection |
sql |
connection |
slave_connection
¶string
<None>
The SQLAlchemy connection string to use to connect to the slave database.
mysql_sql_mode
¶string
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
¶boolean
False
If True, transparently enables support for handling MySQL Cluster (NDB).
connection_recycle_time
¶integer
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.
Group |
Name |
---|---|
DATABASE |
idle_timeout |
database |
idle_timeout |
DEFAULT |
sql_idle_timeout |
DATABASE |
sql_idle_timeout |
sql |
idle_timeout |
max_pool_size
¶integer
5
Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.
Group |
Name |
---|---|
DEFAULT |
sql_max_pool_size |
DATABASE |
sql_max_pool_size |
max_retries
¶integer
10
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
Group |
Name |
---|---|
DEFAULT |
sql_max_retries |
DATABASE |
sql_max_retries |
retry_interval
¶integer
10
Interval between retries of opening a SQL connection.
Group |
Name |
---|---|
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
max_overflow
¶integer
50
If set, use this value for max_overflow with SQLAlchemy.
Group |
Name |
---|---|
DEFAULT |
sql_max_overflow |
DATABASE |
sqlalchemy_max_overflow |
connection_debug
¶integer
0
0
100
Verbosity of SQL debugging information: 0=None, 100=Everything.
Group |
Name |
---|---|
DEFAULT |
sql_connection_debug |
connection_trace
¶boolean
False
Add Python stack traces to SQL as comment strings.
Group |
Name |
---|---|
DEFAULT |
sql_connection_trace |
pool_timeout
¶integer
<None>
If set, use this value for pool_timeout with SQLAlchemy.
Group |
Name |
---|---|
DATABASE |
sqlalchemy_pool_timeout |
use_db_reconnect
¶boolean
False
Enable the experimental use of database reconnect on connection lost.
db_retry_interval
¶integer
1
Seconds between retries of a database transaction.
db_inc_retry_interval
¶boolean
True
If True, increases the interval between retries of a database operation up to db_max_retry_interval.
db_max_retry_interval
¶integer
10
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
db_max_retries
¶integer
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
¶string
''
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…
notification_topics
¶list
['notifications']
notification any events from neutron
control_exchange
¶string
neutron
control-exchange for neutron notification
zone_id
¶string
<None>
Zone ID with each notification
formatv4
¶multi-valued
''
IPv4 format
format
¶multi-valued
''
format which replaced by formatv4/formatv6
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Replaced by ‘formatv4/formatv6’
formatv6
¶multi-valued
''
IPv6 format
notification_topics
¶list
['notifications']
notification any events from nova
control_exchange
¶string
nova
control-exchange for nova notification
zone_id
¶string
<None>
Zone ID with each notification
formatv4
¶multi-valued
''
IPv4 format
format
¶multi-valued
''
format which replaced by formatv4/formatv6
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Replaced by ‘formatv4/formatv6’
formatv6
¶multi-valued
''
IPv6 format
path
¶string
/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
¶boolean
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
¶list
[]
Additional backends that can perform health checks and report that information back as part of a request.
disable_by_file_path
¶string
<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
¶list
[]
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_interval
¶floating point
10.0
Number of seconds between heartbeats for reporting state
emitter_type
¶string
rpc
Emitter to use
service_type
¶string
<None>
The default service_type for endpoint URL discovery.
service_name
¶string
<None>
The default service_name for endpoint URL discovery.
valid_interfaces
¶list
<None>
List of interfaces, in order of preference, for endpoint URL.
region_name
¶string
<None>
The default region_name for endpoint URL discovery.
endpoint_override
¶string
<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
¶string
<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
¶string
<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
¶string
<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
¶integer
<None>
The maximum number of retries that should be attempted for connection errors.
connect_retry_delay
¶floating point
<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
¶integer
<None>
The maximum number of retries that should be attempted for retriable HTTP status codes.
status_code_retry_delay
¶floating point
<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
¶string
<None>
The default interface for endpoint URL discovery.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Using valid-interfaces is preferrable because it is capable of accepting a list of possible interfaces.
cafile
¶string
<None>
PEM encoded Certificate Authority to use when verifying HTTPs connections.
certfile
¶string
<None>
PEM encoded client certificate cert file
keyfile
¶string
<None>
PEM encoded client certificate key file
insecure
¶boolean
False
Verify HTTPS connections.
timeout
¶integer
<None>
Timeout value for http requests
collect_timing
¶boolean
False
Collect per-API call timing information.
split_loggers
¶boolean
False
Log requests to multiple loggers.
www_authenticate_uri
¶string
<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.
Group |
Name |
---|---|
keystone_authtoken |
auth_uri |
auth_uri
¶string
<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.
The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
auth_version
¶string
<None>
API version of the Identity API endpoint.
interface
¶string
internal
Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.
delay_auth_decision
¶boolean
False
Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
http_connect_timeout
¶integer
<None>
Request timeout value for communicating with Identity API server.
http_request_max_retries
¶integer
3
How many times are we trying to reconnect when communicating with Identity API Server.
cache
¶string
<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
¶string
<None>
Required if identity server requires client certificate
keyfile
¶string
<None>
Required if identity server requires client certificate
cafile
¶string
<None>
A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
insecure
¶boolean
False
Verify HTTPS connections.
region_name
¶string
<None>
The region in which the identity server can be found.
memcached_servers
¶list
<None>
Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Group |
Name |
---|---|
keystone_authtoken |
memcache_servers |
token_cache_time
¶integer
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
¶string
None
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
¶string
<None>
(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
memcache_pool_dead_retry
¶integer
300
(Optional) Number of seconds memcached server is considered dead before it is tried again.
memcache_pool_maxsize
¶integer
10
(Optional) Maximum total number of open connections to every memcached server.
memcache_pool_socket_timeout
¶integer
3
(Optional) Socket timeout in seconds for communicating with a memcached server.
memcache_pool_unused_timeout
¶integer
60
(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
memcache_pool_conn_get_timeout
¶integer
10
(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
memcache_use_advanced_pool
¶boolean
False
(Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
include_service_catalog
¶boolean
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
¶string
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
¶list
['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
¶boolean
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
¶string
<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
¶unknown type
<None>
Authentication type to load
Group |
Name |
---|---|
keystone_authtoken |
auth_plugin |
auth_section
¶unknown type
<None>
Config Section from which to load plugin specific options
enabled
¶boolean
False
enable
port
¶integer
8125
UDP port
hostname
¶string
127.0.0.1
hostname
endpoints
¶list
<None>
URL to use if None in the ServiceCatalog that is passed by the request context. Format: <region>|<url>
endpoint_type
¶string
publicURL
Endpoint type to use
timeout
¶integer
30
timeout value for connecting to neutron in seconds
admin_username
¶string
<None>
username for connecting to neutron in admin context
admin_password
¶string
<None>
password for connecting to neutron in admin context
admin_tenant_name
¶string
<None>
tenant name for connecting to neutron in admin context
auth_url
¶string
<None>
auth url for connecting to neutron in admin context
insecure
¶boolean
False
if set, ignore any SSL validation issues
auth_strategy
¶string
keystone
auth strategy for connecting to neutron in admin context
ca_certificates_file
¶string
<None>
Location of ca certificates file to use for neutron client requests.
disable_process_locking
¶boolean
False
Enables or disables inter-process locks.
Group |
Name |
---|---|
DEFAULT |
disable_process_locking |
lock_path
¶string
$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.
Group |
Name |
---|---|
DEFAULT |
lock_path |
container_name
¶string
<None>
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
Group |
Name |
---|---|
amqp1 |
container_name |
idle_timeout
¶integer
0
Timeout for inactive connections (in seconds)
Group |
Name |
---|---|
amqp1 |
idle_timeout |
trace
¶boolean
False
Debug: dump AMQP frames to stdout
Group |
Name |
---|---|
amqp1 |
trace |
ssl
¶boolean
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
¶string
''
CA certificate PEM file used to verify the server’s certificate
Group |
Name |
---|---|
amqp1 |
ssl_ca_file |
ssl_cert_file
¶string
''
Self-identifying certificate PEM file for client authentication
Group |
Name |
---|---|
amqp1 |
ssl_cert_file |
ssl_key_file
¶string
''
Private key PEM file used to sign ssl_cert_file certificate (optional)
Group |
Name |
---|---|
amqp1 |
ssl_key_file |
ssl_key_password
¶string
<None>
Password for decrypting ssl_key_file (if encrypted)
Group |
Name |
---|---|
amqp1 |
ssl_key_password |
ssl_verify_vhost
¶boolean
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
¶string
''
Space separated list of acceptable SASL mechanisms
Group |
Name |
---|---|
amqp1 |
sasl_mechanisms |
sasl_config_dir
¶string
''
Path to directory that contains the SASL configuration
Group |
Name |
---|---|
amqp1 |
sasl_config_dir |
sasl_config_name
¶string
''
Name of configuration file (without .conf suffix)
Group |
Name |
---|---|
amqp1 |
sasl_config_name |
sasl_default_realm
¶string
''
SASL realm to use if no realm present in username
connection_retry_interval
¶integer
1
1
Seconds to pause before attempting to re-connect.
connection_retry_backoff
¶integer
2
0
Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
connection_retry_interval_max
¶integer
30
1
Maximum limit for connection_retry_interval + connection_retry_backoff
link_retry_delay
¶integer
10
1
Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
default_reply_retry
¶integer
0
-1
The maximum number of attempts to re-send a reply message which failed due to a recoverable error.
default_reply_timeout
¶integer
30
5
The deadline for an rpc reply message delivery.
default_send_timeout
¶integer
30
5
The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
default_notify_timeout
¶integer
30
5
The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
default_sender_link_timeout
¶integer
600
1
The duration to schedule a purge of idle sender links. Detach link after expiry.
addressing_mode
¶string
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
¶boolean
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
¶string
exclusive
address prefix used when sending to a specific server
Group |
Name |
---|---|
amqp1 |
server_request_prefix |
broadcast_prefix
¶string
broadcast
address prefix used when broadcasting to all servers
Group |
Name |
---|---|
amqp1 |
broadcast_prefix |
group_request_prefix
¶string
unicast
address prefix when sending to any server in group
Group |
Name |
---|---|
amqp1 |
group_request_prefix |
rpc_address_prefix
¶string
openstack.org/om/rpc
Address prefix for all generated RPC addresses
notify_address_prefix
¶string
openstack.org/om/notify
Address prefix for all generated Notification addresses
multicast_address
¶string
multicast
Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
unicast_address
¶string
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
¶string
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
¶string
<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
¶string
<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
¶integer
200
1
Window size for incoming RPC Reply messages.
rpc_server_credit
¶integer
100
1
Window size for incoming RPC Request messages
notify_server_credit
¶integer
100
1
Window size for incoming Notification messages
pre_settled
¶multi-valued
rpc-cast
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
kafka_max_fetch_bytes
¶integer
1048576
Max fetch bytes of Kafka consumer
kafka_consumer_timeout
¶floating point
1.0
Default timeout(s) for Kafka consumers
pool_size
¶integer
10
Pool Size for Kafka Consumers
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Driver no longer uses connection pool.
conn_pool_min_size
¶integer
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.
Driver no longer uses connection pool.
conn_pool_ttl
¶integer
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.
Driver no longer uses connection pool.
consumer_group
¶string
oslo_messaging_consumer
Group id for Kafka consumer. Consumers in one group will coordinate message consumption
producer_batch_timeout
¶floating point
0.0
Upper bound on the delay for KafkaProducer batching in seconds
producer_batch_size
¶integer
16384
Size of batch for the producer async send
compression_codec
¶string
none
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
¶boolean
False
Enable asynchronous consumer commits
max_poll_records
¶integer
500
The maximum number of records returned in a poll call
security_protocol
¶string
PLAINTEXT
PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL
Protocol used to communicate with brokers
sasl_mechanism
¶string
PLAIN
Mechanism when security protocol is SASL
ssl_cafile
¶string
''
CA certificate PEM file used to verify the server certificate
ssl_client_cert_file
¶string
''
Client certificate PEM file used for authentication.
ssl_client_key_file
¶string
''
Client key PEM file used for authentication.
ssl_client_key_password
¶string
''
Client key password file used for authentication.
driver
¶multi-valued
''
The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
Group |
Name |
---|---|
DEFAULT |
notification_driver |
transport_url
¶string
<None>
A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
Group |
Name |
---|---|
DEFAULT |
notification_transport_url |
topics
¶list
['notifications']
AMQP topic used for OpenStack notifications.
Group |
Name |
---|---|
rpc_notifier2 |
topics |
DEFAULT |
notification_topics |
retry
¶integer
-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
amqp_durable_queues
¶boolean
False
Use durable queues in AMQP.
amqp_auto_delete
¶boolean
False
Auto-delete queues in AMQP.
Group |
Name |
---|---|
DEFAULT |
amqp_auto_delete |
ssl
¶boolean
False
Connect over SSL.
Group |
Name |
---|---|
oslo_messaging_rabbit |
rabbit_use_ssl |
ssl_version
¶string
''
SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_version |
ssl_key_file
¶string
''
SSL key file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_keyfile |
ssl_cert_file
¶string
''
SSL cert file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_certfile |
ssl_ca_file
¶string
''
SSL certification authority file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_ca_certs |
heartbeat_in_pthread
¶boolean
True
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.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
kombu_reconnect_delay
¶floating point
1.0
How long to wait before reconnecting in response to an AMQP consumer cancel notification.
Group |
Name |
---|---|
DEFAULT |
kombu_reconnect_delay |
kombu_compression
¶string
<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
¶integer
60
How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_reconnect_timeout |
kombu_failover_strategy
¶string
round-robin
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
¶string
AMQPLAIN
PLAIN, AMQPLAIN, RABBIT-CR-DEMO
The RabbitMQ login method.
Group |
Name |
---|---|
DEFAULT |
rabbit_login_method |
rabbit_retry_interval
¶integer
1
How frequently to retry connecting with RabbitMQ.
rabbit_retry_backoff
¶integer
2
How long to backoff for between retries when connecting to RabbitMQ.
Group |
Name |
---|---|
DEFAULT |
rabbit_retry_backoff |
rabbit_interval_max
¶integer
30
Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
rabbit_ha_queues
¶boolean
False
Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “
Group |
Name |
---|---|
DEFAULT |
rabbit_ha_queues |
rabbit_transient_queues_ttl
¶integer
1800
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
¶integer
0
Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
heartbeat_timeout_threshold
¶integer
60
Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).
heartbeat_rate
¶integer
2
How often times during the heartbeat_timeout_threshold we check the heartbeat.
direct_mandatory_flag
¶boolean
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.
Mandatory flag no longer deactivable.
enable_cancel_on_failover
¶boolean
False
Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down
max_request_body_size
¶integer
114688
The maximum body size for each request, in bytes.
Group |
Name |
---|---|
DEFAULT |
osapi_max_request_body_size |
DEFAULT |
max_request_body_size |
secure_proxy_ssl_header
¶string
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
¶boolean
False
Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
enforce_scope
¶boolean
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
¶boolean
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
policy_file
¶string
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.
Group |
Name |
---|---|
DEFAULT |
policy_file |
policy_default_rule
¶string
default
Default rule. Enforced when a requested rule is not found.
Group |
Name |
---|---|
DEFAULT |
policy_default_rule |
policy_dirs
¶multi-valued
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.
Group |
Name |
---|---|
DEFAULT |
policy_dirs |
remote_content_type
¶string
application/x-www-form-urlencoded
application/x-www-form-urlencoded, application/json
Content Type to send and receive data for REST based policy check
remote_ssl_verify_server_crt
¶boolean
False
server identity verification for REST based policy check
remote_ssl_ca_crt_file
¶string
<None>
Absolute path to ca cert file for REST based policy check
remote_ssl_client_crt_file
¶string
<None>
Absolute path to client cert for REST based policy check
remote_ssl_client_key_file
¶string
<None>
Absolute path client key file REST based policy check
interval
¶integer
5
Run interval in seconds
per_page
¶integer
100
Default amount of results returned per page
batch_size
¶integer
100
How many zones to receive NOTIFY on each run
interval
¶integer
3600
Run interval in seconds
per_page
¶integer
100
Default amount of results returned per page
interval
¶integer
3600
Run interval in seconds
per_page
¶integer
100
Default amount of results returned per page
interval
¶integer
120
Run interval in seconds
per_page
¶integer
100
Default amount of results returned per page
interval
¶integer
3600
Run interval in seconds
per_page
¶integer
100
Default amount of results returned per page
time_threshold
¶integer
604800
How old deleted zones should be (deleted_at) to be purged, in seconds
batch_size
¶integer
100
How many zones to be purged on each run
http_proxy
¶string
<None>
Proxy HTTP requests via this proxy.
https_proxy
¶string
<None>
Proxy HTTPS requests via this proxy
no_proxy
¶list
[]
These addresses should not be proxied
workers
¶integer
<None>
Number of agent worker processes to spawn
threads
¶integer
1000
Number of agent greenthreads to spawn
listen
¶list
['0.0.0.0:5358']
Agent host:port pairs to listen on
tcp_backlog
¶integer
100
The Agent TCP Backlog
tcp_recv_timeout
¶floating point
0.5
Agent TCP Receive Timeout
allow_notify
¶list
[]
List of IP addresses allowed to NOTIFY The Agent
masters
¶list
[]
List of masters for the Agent, format ip:port
backend_driver
¶string
bind9
The backend driver to use, e.g. bind9, djbdns, knot2
transfer_source
¶string
<None>
An IP address to be used to fetch zones transferred in
notify_delay
¶floating point
0.0
Delay after a NOTIFY arrives for a zone that the Agent will pause and drop subsequent NOTIFYs for that zone
workers
¶integer
<None>
Number of api worker processes to spawn
threads
¶integer
1000
Number of api greenthreads to spawn
enable_host_header
¶boolean
True
Enable host request headers
api_base_uri
¶string
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
¶list
['0.0.0.0:9001']
API host:port pairs to listen on
api_paste_config
¶string
api-paste.ini
File name for the paste.deploy config for designate-api
auth_strategy
¶string
keystone
The strategy to use for auth. Supports noauth or keystone
enable_api_v2
¶boolean
True
enable-api-v2 which enable in a future
enable_api_admin
¶boolean
False
enable-api-admin
max_header_line
¶integer
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).
pecan_debug
¶boolean
False
Pecan HTML Debug Interface
enabled_extensions_v2
¶list
[]
Enabled API Extensions for the V2 API
default_limit_v2
¶integer
20
Default per-page limit for the V2 API, a value of None means show all results by default
max_limit_v2
¶integer
1000
Max per-page limit for the V2 API
quotas_verify_project_id
¶boolean
False
Verify that the requested Project ID for quota target is a valid project in Keystone.
enabled_extensions_admin
¶list
[]
Enabled Admin API Extensions
default_limit_admin
¶integer
20
Default per-page limit for the Admin API, a value of None means show all results by default
max_limit_admin
¶integer
1000
Max per-page limit for the Admin API
maintenance_mode
¶boolean
False
Enable API Maintenance Mode
maintenance_mode_role
¶string
admin
Role allowed to bypass maintaince mode
secure_proxy_ssl_header
¶string
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
¶string
<None>
A scheme that will be used to override the request protocol scheme, even if it was set by an SSL terminating proxy.
workers
¶integer
<None>
Number of central worker processes to spawn
threads
¶integer
1000
Number of central greenthreads to spawn
storage_driver
¶string
sqlalchemy
The storage driver to use
enabled_notification_handlers
¶list
[]
Enabled Notification Handlers
max_zone_name_len
¶integer
255
Maximum zone name length
max_recordset_name_len
¶integer
255
Maximum recordset name length
Group |
Name |
---|---|
max_record_name_len |
managed_resource_email
¶string
hostmaster@example.com
E-Mail for Managed resources
managed_resource_tenant_id
¶string
00000000-0000-0000-0000-000000000000
The Tenant ID that will own any managed resources.
min_ttl
¶integer
<None>
Minimum TTL allowed
default_pool_id
¶string
794ccc2c-d751-44fe-b57f-8894c9f5c842
The name of the default pool
topic
¶string
central
RPC topic name for central
scheduler_filters
¶list
['default_pool']
Enabled Pool Scheduling filters
workers
¶integer
<None>
Number of mdns worker processes to spawn
threads
¶integer
1000
Number of mdns greenthreads to spawn
listen
¶list
['0.0.0.0:5354']
mDNS host:port pairs to listen on
tcp_backlog
¶integer
100
mDNS TCP Backlog
tcp_recv_timeout
¶floating point
0.5
mDNS TCP Receive Timeout
all_tcp
¶boolean
False
Send all traffic over TCP
query_enforce_tsig
¶boolean
False
Enforce all incoming queries (including AXFR) are TSIG signed
storage_driver
¶string
sqlalchemy
The storage driver to use
max_message_size
¶integer
65535
Maximum message size to emit
topic
¶string
mdns
RPC topic name for mdns
xfr_timeout
¶integer
10
Timeout in seconds for XFR’s.
workers
¶integer
<None>
Number of Producer worker processes to spawn
threads
¶integer
1000
Number of Producer greenthreads to spawn
enabled_tasks
¶list
<None>
Enabled tasks to run
storage_driver
¶string
sqlalchemy
The storage driver to use
export_synchronous
¶boolean
True
Whether to allow synchronous zone exports
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Migrated to designate-worker
topic
¶string
producer
RPC topic name for producer
workers
¶integer
<None>
Number of sink worker processes to spawn
threads
¶integer
1000
Number of sink greenthreads to spawn
enabled_notification_handlers
¶list
[]
Enabled Notification Handlers
listener_pool_name
¶string
<None>
pool name to use for oslo.messaging notification listener. Note that listener pooling is not supported by all oslo.messaging drivers.
workers
¶integer
<None>
Number of Worker worker processes to spawn
threads
¶integer
200
Number of Worker threads to spawn per process
storage_driver
¶string
sqlalchemy
The storage driver to use
threshold_percentage
¶integer
100
The percentage of servers requiring a successful update for a domain change to be considered active
poll_timeout
¶integer
30
The time to wait for a response from a server
poll_retry_interval
¶integer
15
The time between retrying to send a request and waiting for a response from a server
poll_max_retries
¶integer
10
The maximum number of times to retry sending a request and wait for a response from a server
poll_delay
¶integer
5
The time to wait before sending the first request to a server
notify
¶boolean
True
Whether to allow worker to send NOTIFYs, this will noop NOTIFYs in mdns if true
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
This option is being removed to reduce complexity
export_synchronous
¶boolean
True
Whether to allow synchronous zone exports
topic
¶string
worker
RPC topic name for worker
ca_file
¶string
<None>
CA certificate file to use to verify connecting clients.
Group |
Name |
---|---|
DEFAULT |
ssl_ca_file |
cert_file
¶string
<None>
Certificate file to use when starting the server securely.
Group |
Name |
---|---|
DEFAULT |
ssl_cert_file |
key_file
¶string
<None>
Private key file to use when starting the server securely.
Group |
Name |
---|---|
DEFAULT |
ssl_key_file |
version
¶string
<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
¶string
<None>
Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.
sqlite_synchronous
¶boolean
True
If True, SQLite uses synchronous mode.
Group |
Name |
---|---|
DEFAULT |
sqlite_synchronous |
backend
¶string
sqlalchemy
The back end to use for the database.
Group |
Name |
---|---|
DEFAULT |
db_backend |
connection
¶string
<None>
The SQLAlchemy connection string to use to connect to the database.
Group |
Name |
---|---|
DEFAULT |
sql_connection |
DATABASE |
sql_connection |
sql |
connection |
slave_connection
¶string
<None>
The SQLAlchemy connection string to use to connect to the slave database.
mysql_sql_mode
¶string
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
¶boolean
False
If True, transparently enables support for handling MySQL Cluster (NDB).
connection_recycle_time
¶integer
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.
Group |
Name |
---|---|
DATABASE |
idle_timeout |
database |
idle_timeout |
DEFAULT |
sql_idle_timeout |
DATABASE |
sql_idle_timeout |
sql |
idle_timeout |
max_pool_size
¶integer
5
Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.
Group |
Name |
---|---|
DEFAULT |
sql_max_pool_size |
DATABASE |
sql_max_pool_size |
max_retries
¶integer
10
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
Group |
Name |
---|---|
DEFAULT |
sql_max_retries |
DATABASE |
sql_max_retries |
retry_interval
¶integer
10
Interval between retries of opening a SQL connection.
Group |
Name |
---|---|
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
max_overflow
¶integer
50
If set, use this value for max_overflow with SQLAlchemy.
Group |
Name |
---|---|
DEFAULT |
sql_max_overflow |
DATABASE |
sqlalchemy_max_overflow |
connection_debug
¶integer
0
0
100
Verbosity of SQL debugging information: 0=None, 100=Everything.
Group |
Name |
---|---|
DEFAULT |
sql_connection_debug |
connection_trace
¶boolean
False
Add Python stack traces to SQL as comment strings.
Group |
Name |
---|---|
DEFAULT |
sql_connection_trace |
pool_timeout
¶integer
<None>
If set, use this value for pool_timeout with SQLAlchemy.
Group |
Name |
---|---|
DATABASE |
sqlalchemy_pool_timeout |
use_db_reconnect
¶boolean
False
Enable the experimental use of database reconnect on connection lost.
db_retry_interval
¶integer
1
Seconds between retries of a database transaction.
db_inc_retry_interval
¶boolean
True
If True, increases the interval between retries of a database operation up to db_max_retry_interval.
db_max_retry_interval
¶integer
10
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
db_max_retries
¶integer
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
¶string
''
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.