Chapter 4. designate

backdoor_port = None

string value

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

string value

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.

backlog = 4096

integer value

Number of backlog requests to configure the socket with

central-topic = central

string value

Central Topic

conn_pool_min_size = 2

integer value

The pool size limit for connections expiration policy

conn_pool_ttl = 1200

integer value

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

control_exchange = designate

string value

The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.

debug = False

boolean value

If set to true, the logging level will be set to DEBUG instead of the default INFO level.

default-soa-expire = 86400

integer value

SOA expire

default-soa-minimum = 3600

integer value

SOA minimum value

default-soa-refresh-max = 3600

integer value

SOA max value

default-soa-refresh-min = 3500

integer value

SOA refresh-min value

default-soa-retry = 600

integer value

SOA retry

default-ttl = 3600

integer value

TTL Value

default_log_levels = [u'amqplib=WARN', u'amqp=WARN', u'boto=WARN', u'eventlet.wsgi.server=WARN', u'iso8601=WARN', u'kazoo.client=WARN', u'keystone=INFO', u'keystonemiddleware.auth_token=INFO', u'oslo_messaging=WARN', u'oslo.messaging=INFO', u'oslo_service.loopingcall=WARN', u'sqlalchemy=WARN', u'stevedore=WARN', u'suds=INFO']

list value

List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

executor_thread_pool_size = 64

integer value

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

fatal_deprecations = False

boolean value

Enables or disables fatal status of deprecations.

graceful_shutdown_timeout = 60

integer value

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

host = ccsosp-undercloud.usersys.redhat.com

string value

Name of this node

`instance_format = [instance: %(uuid)s] `

string value

The format for an instance that is passed with the log message.

`instance_uuid_format = [instance: %(uuid)s] `

string value

The format for an instance UUID that is passed with the log message.

log-config-append = None

string value

The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).

log-date-format = %Y-%m-%d %H:%M:%S

string value

Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.

log-dir = None

string value

(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

log-file = None

string value

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

log_options = True

boolean value

Enables or disables logging values of all registered options when starting a service (at DEBUG level).

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

string value

Format string to use for log messages with context.

logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d

string value

Additional data to append to log message when logging level for the message is DEBUG.

logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

string value

Format string to use for log messages when context is undefined.

logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

string value

Prefix each line of exception output with this format.

logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s

string value

Defines the format string for %(user_identity)s that is used in logging_context_format_string.

mdns-topic = mdns

string value

mDNS Topic

network_api = neutron

string value

Which API to use.

notification-plugin = default

string value

The notification plugin to use

notify_api_faults = False

boolean value

Send notifications if there’s a failure in the API.

pool-manager-topic = pool_manager

string value

Pool Manager Topic

publish_errors = False

boolean value

Enables or disables publication of error events.

pybasedir = /usr/lib/python2.7/site-packages

string value

Directory where the designate python module is installed

quota-api-export-size = 1000

integer value

Number of recordsets allowed in a zone export

quota-driver = storage

string value

Quota driver to use

quota-recordset-records = 20

integer value

Number of records allowed per recordset

quota-zone-records = 500

integer value

Number of records allowed per zone

quota-zone-recordsets = 500

integer value

Number of recordsets allowed per zone

quota-zones = 10

integer value

Number of zones allowed per tenant

rate_limit_burst = 0

integer value

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level = CRITICAL

string value

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.

rate_limit_interval = 0

integer value

Interval, number of seconds, of log rate limiting.

root-helper = sudo designate-rootwrap /etc/designate/rootwrap.conf

string value

designate-rootwrap configuration

rpc_ack_timeout_base = 15

integer value

Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.

rpc_ack_timeout_multiplier = 2

integer value

Number to multiply base ack timeout by after each retry attempt.

rpc_backend = rabbit

string value

The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.

rpc_conn_pool_size = 30

integer value

Size of RPC connection pool.

rpc_message_ttl = 300

integer value

Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.

rpc_poll_timeout = 1

integer value

The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.

rpc_response_timeout = 60

integer value

Seconds to wait for a response from a call.

rpc_retry_attempts = 3

integer value

Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.

rpc_thread_pool_size = 100

integer value

Maximum number of (green) threads to work concurrently.

rpc_use_acks = False

boolean value

Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.

rpc_zmq_bind_address = *

string value

ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.

rpc_zmq_bind_port_retries = 100

integer value

Number of retries to find free port number before fail with ZMQBindError.

rpc_zmq_contexts = 1

integer value

Number of ZeroMQ contexts, defaults to 1.

rpc_zmq_host = ccsosp-undercloud.usersys.redhat.com

string value

Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.

rpc_zmq_ipc_dir = /var/run/openstack

string value

Directory for holding IPC sockets.

rpc_zmq_matchmaker = redis

string value

MatchMaker driver.

rpc_zmq_max_port = 65536

integer value

Maximal port number for random ports range.

rpc_zmq_min_port = 49153

port value

Minimal port number for random ports range.

rpc_zmq_serialization = json

string value

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

rpc_zmq_topic_backlog = None

integer value

Maximum number of ingress messages to locally buffer per topic. Default is unlimited.

run_external_periodic_tasks = True

boolean value

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

state-path = /var/lib/designate

string value

Top-level directory for maintaining designate’s state

subscribe_on = []

list value

List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.

supported-record-type = [u'A', u'AAAA', u'CNAME', u'MX', u'SRV', u'TXT', u'SPF', u'NS', u'PTR', u'SSHFP', u'SOA']

list value

Supported record types

syslog-log-facility = LOG_USER

string value

Syslog facility to receive log lines. This option is ignored if log_config_append is set.

tcp_keepidle = 600

integer value

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

transport_url = None

string value

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

use-journal = False

boolean value

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.

use-json = False

boolean value

Use JSON formatting for logging. This option is ignored if log_config_append is set.

use-syslog = False

boolean value

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_dynamic_connections = False

boolean value

This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).

use_pub_sub = False

boolean value

Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.

use_router_proxy = False

boolean value

Use ROUTER remote proxy.

use_stderr = False

boolean value

Log output to standard error. This option is ignored if log_config_append is set.

watch-log-file = False

boolean value

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.

worker-topic = worker

string value

Worker Topic

xfr_timeout = 10

integer value

Timeout in seconds for XFR’s.

zmq_failover_connections = 2

integer value

How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.

zmq_immediate = True

boolean value

This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.

zmq_linger = -1

integer value

Number of seconds to wait before all pending messages will be sent after closing a socket. The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Positive values specify an upper bound for the linger period.

zmq_target_expire = 300

integer value

Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

zmq_target_update = 180

integer value

Update period in seconds of a name service record about existing target.

zmq_tcp_keepalive = -1

integer value

Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.

zmq_tcp_keepalive_cnt = -1

integer value

The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_idle = -1

integer value

The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_intvl = -1

integer value

The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

query-destination = 127.0.0.1

string value

Host to query when finding zones

rndc-config-file = None

string value

RNDC Config File

rndc-host = 127.0.0.1

string value

RNDC Host

rndc-key-file = None

string value

RNDC Key File

rndc-port = 953

integer value

RNDC Port

zone-file-path = $state_path/zones

string value

Path where zone files are stored

config_file = /etc/denominator.conf

string value

Path to Denominator configuration file

name = fake

string value

Name of the affected provider

axfr-get-cmd-name = axfr-get

string value

axfr-get executable path or rootwrap command name

query-destination = 127.0.0.1

string value

Host to query when finding zones

tcpclient-cmd-name = tcpclient

string value

tcpclient executable path or rootwrap command name

tinydns-data-cmd-name = tinydns-data

string value

tinydns-data executable path or rootwrap command name

tinydns-datadir = /var/lib/djbdns

string value

TinyDNS data directory

confdir-path = /etc/gdnsd

string value

gdnsd configuration directory path

gdnsd-cmd-name = gdnsd

string value

gdnsd executable path or rootwrap command name

query-destination = 127.0.0.1

string value

Host to query when finding zones

knotc-cmd-name = knotc

string value

knotc executable path or rootwrap command name

query-destination = 127.0.0.1

string value

Host to query when finding zones

backend_url = None

string value

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

floating point value

Number of seconds between heartbeats for distributed coordination.

run_watchers_interval = 10.0

floating point value

Number of seconds between checks to see if group membership has changed

allow_credentials = True

boolean value

Indicate that the actual request can include user credentials

allow_headers = [u'X-Auth-Token', u'X-Auth-Sudo-Tenant-ID', u'X-Auth-Sudo-Project-ID', u'X-Auth-All-Projects', u'X-Designate-Edit-Managed-Records', u'OpenStack-DNS-Hide-Counts']

list value

Indicate which header field names may be used during the actual request.

allow_methods = [u'GET', u'PUT', u'POST', u'DELETE', u'PATCH', u'HEAD']

list value

Indicate which methods can be used during the actual request.

allowed_origin = None

list value

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

expose_headers = [u'X-OpenStack-Request-ID', u'Host']

list value

Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.

max_age = 3600

integer value

Maximum cache age of CORS preflight requests.

backend = sqlalchemy

string value

The back end to use for the database.

connection = None

string value

The SQLAlchemy connection string to use to connect to the database.

connection_debug = 0

integer value

Verbosity of SQL debugging information: 0=None, 100=Everything.

connection_recycle_time = 3600

integer value

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.

connection_trace = False

boolean value

Add Python stack traces to SQL as comment strings.

db_inc_retry_interval = True

boolean value

If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retries = 20

integer value

Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

db_max_retry_interval = 10

integer value

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

db_retry_interval = 1

integer value

Seconds between retries of a database transaction.

max_overflow = 50

integer value

If set, use this value for max_overflow with SQLAlchemy.

max_pool_size = 5

integer value

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

max_retries = 10

integer value

Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

min_pool_size = 1

integer value

Minimum number of SQL connections to keep open in a pool.

mysql_enable_ndb = False

boolean value

If True, transparently enables support for handling MySQL Cluster (NDB).

mysql_sql_mode = TRADITIONAL

string value

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=

pool_timeout = None

integer value

If set, use this value for pool_timeout with SQLAlchemy.

retry_interval = 10

integer value

Interval between retries of opening a SQL connection.

slave_connection = None

string value

The SQLAlchemy connection string to use to connect to the slave database.

sqlite_synchronous = True

boolean value

If True, SQLite uses synchronous mode.

use_db_reconnect = False

boolean value

Enable the experimental use of database reconnect on connection lost.

control-exchange = neutron

string value

control-exchange for neutron notification

format = None

multi valued

format which replaced by formatv4/formatv6

formatv4 = None

multi valued

IPv4 format

formatv6 = None

multi valued

IPv6 format

notification-topics = [u'notifications']

list value

notification any events from neutron

zone-id = None

string value

Zone ID with each notification

control-exchange = nova

string value

control-exchange for nova notification

format = None

multi valued

format which replaced by formatv4/formatv6

formatv4 = None

multi valued

IPv4 format

formatv6 = None

multi valued

IPv6 format

notification-topics = [u'notifications']

list value

notification any events from nova

zone-id = None

string value

Zone ID with each notification

backends = []

list value

Additional backends that can perform health checks and report that information back as part of a request.

detailed = False

boolean value

Show more detailed information as part of the response

disable_by_file_path = None

string value

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 value

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.

path = /healthcheck

string value

The path to respond to healtcheck requests on.

emitter_type = rpc

string value

Emitter to use

heartbeat_interval = 5.0

floating point value

Number of seconds between heartbeats for reporting state

auth_section = None

string value

Config Section from which to load plugin specific options

auth_type = None

string value

Authentication type to load

auth_uri = None

string value

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.

auth_version = None

string value

API version of the admin Identity API endpoint.

cache = None

string value

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.

cafile = None

string value

A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.

certfile = None

string value

Required if identity server requires client certificate

check_revocations_for_cached = False

boolean value

If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.

delay_auth_decision = False

boolean value

Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.

enforce_token_bind = permissive

string value

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.

hash_algorithms = [u'md5']

list value

Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.

http_connect_timeout = None

integer value

Request timeout value for communicating with Identity API server.

http_request_max_retries = 3

integer value

How many times are we trying to reconnect when communicating with Identity API Server.

include_service_catalog = True

boolean value

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

insecure = False

boolean value

Verify HTTPS connections.

keyfile = None

string value

Required if identity server requires client certificate

memcache_pool_conn_get_timeout = 10

integer value

(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.

memcache_pool_dead_retry = 300

integer value

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

memcache_pool_maxsize = 10

integer value

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

memcache_pool_socket_timeout = 3

integer value

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

memcache_pool_unused_timeout = 60

integer value

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

memcache_secret_key = None

string value

(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.

memcache_security_strategy = None

string value

(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_use_advanced_pool = False

boolean value

(Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.

memcached_servers = None

list value

Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

region_name = None

string value

The region in which the identity server can be found.

revocation_cache_time = 10

integer value

Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. Only valid for PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release.

service_token_roles = [u'service']

list value

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

boolean value

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.

signing_dir = None

string value

Directory used to cache files related to PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release.

token_cache_time = 300

integer value

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.

www_authenticate_uri = None

string value

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.

check_timeout = 20000

integer value

Time in ms to wait before the transaction is killed.

host = 127.0.0.1

string value

Host to locate redis.

`password = `

string value

Password for Redis server (optional).

port = 6379

port value

Use this port to connect to redis host.

sentinel_group_name = oslo-messaging-zeromq

string value

Redis replica set name.

sentinel_hosts = []

list value

List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port …​ ]

socket_timeout = 10000

integer value

Timeout in ms on blocking socket operations.

wait_timeout = 2000

integer value

Time in ms to wait between connection attempts.

enabled = False

boolean value

enable

hostname = 127.0.0.1

string value

hostname

port = 8125

integer value

UDP port

admin_password = None

string value

password for connecting to neutron in admin context

admin_tenant_name = None

string value

tenant name for connecting to neutron in admin context

admin_username = None

string value

username for connecting to neutron in admin context

auth_strategy = keystone

string value

auth strategy for connecting to neutron in admin context

auth_url = None

string value

auth url for connecting to neutron in admin context

ca_certificates_file = None

string value

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

endpoint_type = publicURL

string value

Endpoint type to use

endpoints = None

list value

URL to use if None in the ServiceCatalog that is passed by the request context. Format: <region>|<url>

insecure = False

boolean value

if set, ignore any SSL validation issues

timeout = 30

integer value

timeout value for connecting to neutron in seconds

disable_process_locking = False

boolean value

Enables or disables inter-process locks.

lock_path = $state_path

string value

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.

addressing_mode = dynamic

string value

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

allow_insecure_clients = False

boolean value

Accept clients using either SSL or plain TCP

anycast_address = anycast

string value

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.

broadcast_prefix = broadcast

string value

address prefix used when broadcasting to all servers

connection_retry_backoff = 2

integer value

Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.

connection_retry_interval = 1

integer value

Seconds to pause before attempting to re-connect.

connection_retry_interval_max = 30

integer value

Maximum limit for connection_retry_interval + connection_retry_backoff

container_name = None

string value

Name for the AMQP container. must be globally unique. Defaults to a generated UUID

default_notification_exchange = None

string value

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_notify_timeout = 30

integer value

The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.

default_reply_retry = 0

integer value

The maximum number of attempts to re-send a reply message which failed due to a recoverable error.

default_reply_timeout = 30

integer value

The deadline for an rpc reply message delivery.

default_rpc_exchange = None

string value

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

default_send_timeout = 30

integer value

The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.

default_sender_link_timeout = 600

integer value

The duration to schedule a purge of idle sender links. Detach link after expiry.

group_request_prefix = unicast

string value

address prefix when sending to any server in group

idle_timeout = 0

integer value

Timeout for inactive connections (in seconds)

link_retry_delay = 10

integer value

Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.

multicast_address = multicast

string value

Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.

notify_address_prefix = openstack.org/om/notify

string value

Address prefix for all generated Notification addresses

notify_server_credit = 100

integer value

Window size for incoming Notification messages

`password = `

string value

Password for message broker authentication

pre_settled = [u'rpc-cast', u'rpc-reply']

multi valued

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

pseudo_vhost = True

boolean value

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.

reply_link_credit = 200

integer value

Window size for incoming RPC Reply messages.

rpc_address_prefix = openstack.org/om/rpc

string value

Address prefix for all generated RPC addresses

rpc_server_credit = 100

integer value

Window size for incoming RPC Request messages

`sasl_config_dir = `

string value

Path to directory that contains the SASL configuration

`sasl_config_name = `

string value

Name of configuration file (without .conf suffix)

`sasl_default_realm = `

string value

SASL realm to use if no realm present in username

`sasl_mechanisms = `

string value

Space separated list of acceptable SASL mechanisms

server_request_prefix = exclusive

string value

address prefix used when sending to a specific server

ssl = False

boolean value

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 value

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

`ssl_cert_file = `

string value

Self-identifying certificate PEM file for client authentication

`ssl_key_file = `

string value

Private key PEM file used to sign ssl_cert_file certificate (optional)

ssl_key_password = None

string value

Password for decrypting ssl_key_file (if encrypted)

ssl_verify_vhost = False

boolean value

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.

trace = False

boolean value

Debug: dump AMQP frames to stdout

unicast_address = unicast

string value

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.

`username = `

string value

User name for message broker authentication

conn_pool_min_size = 2

integer value

The pool size limit for connections expiration policy

conn_pool_ttl = 1200

integer value

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

consumer_group = oslo_messaging_consumer

string value

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

kafka_consumer_timeout = 1.0

floating point value

Default timeout(s) for Kafka consumers

kafka_default_host = localhost

string value

Default Kafka broker Host

kafka_default_port = 9092

port value

Default Kafka broker Port

kafka_max_fetch_bytes = 1048576

integer value

Max fetch bytes of Kafka consumer

pool_size = 10

integer value

Pool Size for Kafka Consumers

producer_batch_size = 16384

integer value

Size of batch for the producer async send

producer_batch_timeout = 0.0

floating point value

Upper bound on the delay for KafkaProducer batching in seconds

driver = []

multi valued

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

retry = -1

integer value

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

topics = [u'notifications']

list value

AMQP topic used for OpenStack notifications.

transport_url = None

string value

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

amqp_auto_delete = False

boolean value

Auto-delete queues in AMQP.

amqp_durable_queues = False

boolean value

Use durable queues in AMQP.

channel_max = None

integer value

Maximum number of channels to allow

connection_factory = single

string value

Connection factory implementation

default_notification_exchange = ${control_exchange}_notification

string value

Exchange name for sending notifications

default_notification_retry_attempts = -1

integer value

Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.

default_rpc_exchange = ${control_exchange}_rpc

string value

Exchange name for sending RPC messages

default_rpc_retry_attempts = -1

integer value

Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more than one time

default_serializer_type = json

string value

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

fake_rabbit = False

boolean value

Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake

frame_max = None

integer value

The maximum byte size for an AMQP frame

heartbeat_interval = 3

integer value

How often to send heartbeats for consumer’s connections

heartbeat_rate = 2

integer value

How often times during the heartbeat_timeout_threshold we check the heartbeat.

heartbeat_timeout_threshold = 60

integer value

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

host_connection_reconnect_delay = 0.25

floating point value

Set delay for reconnection to some host which has connection error

kombu_compression = None

string value

EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.

kombu_failover_strategy = round-robin

string value

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.

kombu_missing_consumer_retry_timeout = 60

integer value

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

kombu_reconnect_delay = 1.0

floating point value

How long to wait before reconnecting in response to an AMQP consumer cancel notification.

notification_listener_prefetch_count = 100

integer value

Max number of not acknowledged message which RabbitMQ can send to notification listener.

notification_persistence = False

boolean value

Persist notification messages.

notification_retry_delay = 0.25

floating point value

Reconnecting retry delay in case of connectivity problem during sending notification message

pool_max_overflow = 0

integer value

Maximum number of connections to create above pool_max_size.

pool_max_size = 30

integer value

Maximum number of connections to keep queued.

pool_recycle = 600

integer value

Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.

pool_stale = 60

integer value

Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire.

pool_timeout = 30

integer value

Default number of seconds to wait for a connections to available

rabbit_ha_queues = False

boolean value

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

rabbit_host = localhost

string value

The RabbitMQ broker address where a single node is used.

rabbit_hosts = [u'$rabbit_host:$rabbit_port']

list value

RabbitMQ HA cluster host:port pairs.

rabbit_interval_max = 30

integer value

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

rabbit_login_method = AMQPLAIN

string value

The RabbitMQ login method.

rabbit_max_retries = 0

integer value

Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).

rabbit_password = guest

string value

The RabbitMQ password.

rabbit_port = 5672

port value

The RabbitMQ broker port where a single node is used.

rabbit_qos_prefetch_count = 0

integer value

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

rabbit_retry_backoff = 2

integer value

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

rabbit_retry_interval = 1

integer value

How frequently to retry connecting with RabbitMQ.

rabbit_transient_queues_ttl = 1800

integer value

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_userid = guest

string value

The RabbitMQ userid.

rabbit_virtual_host = /

string value

The RabbitMQ virtual host.

rpc_listener_prefetch_count = 100

integer value

Max number of not acknowledged message which RabbitMQ can send to rpc listener.

rpc_queue_expiration = 60

integer value

Time to live for rpc queues without consumers in seconds.

rpc_reply_exchange = ${control_exchange}_rpc_reply

string value

Exchange name for receiving RPC replies

rpc_reply_listener_prefetch_count = 100

integer value

Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.

rpc_reply_retry_attempts = -1

integer value

Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout

rpc_reply_retry_delay = 0.25

floating point value

Reconnecting retry delay in case of connectivity problem during sending reply.

rpc_retry_delay = 0.25

floating point value

Reconnecting retry delay in case of connectivity problem during sending RPC message

socket_timeout = 0.25

floating point value

Set socket timeout in seconds for connection’s socket

ssl = None

boolean value

Enable SSL

`ssl_ca_file = `

string value

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

`ssl_cert_file = `

string value

SSL cert file (valid only if SSL enabled).

`ssl_key_file = `

string value

SSL key file (valid only if SSL enabled).

ssl_options = None

dict value

Arguments passed to ssl.wrap_socket

`ssl_version = `

string value

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.

tcp_user_timeout = 0.25

floating point value

Set TCP_USER_TIMEOUT in seconds for connection’s socket

rpc_ack_timeout_base = 15

integer value

Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.

rpc_ack_timeout_multiplier = 2

integer value

Number to multiply base ack timeout by after each retry attempt.

rpc_message_ttl = 300

integer value

Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.

rpc_poll_timeout = 1

integer value

The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.

rpc_retry_attempts = 3

integer value

Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.

rpc_thread_pool_size = 100

integer value

Maximum number of (green) threads to work concurrently.

rpc_use_acks = False

boolean value

Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.

rpc_zmq_bind_address = *

string value

ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.

rpc_zmq_bind_port_retries = 100

integer value

Number of retries to find free port number before fail with ZMQBindError.

rpc_zmq_contexts = 1

integer value

Number of ZeroMQ contexts, defaults to 1.

rpc_zmq_host = ccsosp-undercloud.usersys.redhat.com

string value

Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.

rpc_zmq_ipc_dir = /var/run/openstack

string value

Directory for holding IPC sockets.

rpc_zmq_matchmaker = redis

string value

MatchMaker driver.

rpc_zmq_max_port = 65536

integer value

Maximal port number for random ports range.

rpc_zmq_min_port = 49153

port value

Minimal port number for random ports range.

rpc_zmq_serialization = json

string value

Default serialization mechanism for serializing/deserializing outgoing/incoming messages

rpc_zmq_topic_backlog = None

integer value

Maximum number of ingress messages to locally buffer per topic. Default is unlimited.

subscribe_on = []

list value

List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.

use_dynamic_connections = False

boolean value

This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).

use_pub_sub = False

boolean value

Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.

use_router_proxy = False

boolean value

Use ROUTER remote proxy.

zmq_failover_connections = 2

integer value

How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.

zmq_immediate = True

boolean value

This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.

zmq_linger = -1

integer value

Number of seconds to wait before all pending messages will be sent after closing a socket. The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Positive values specify an upper bound for the linger period.

zmq_target_expire = 300

integer value

Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).

zmq_target_update = 180

integer value

Update period in seconds of a name service record about existing target.

zmq_tcp_keepalive = -1

integer value

Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.

zmq_tcp_keepalive_cnt = -1

integer value

The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_idle = -1

integer value

The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

zmq_tcp_keepalive_intvl = -1

integer value

The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.

enable_proxy_headers_parsing = False

boolean value

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

max_request_body_size = 114688

integer value

The maximum body size for each request, in bytes.

secure_proxy_ssl_header = X-Forwarded-Proto

string value

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.

enforce_scope = False

boolean value

This option controls whether or not to enforce scope when evaluating policies. If True, the scope of the token used in the request is compared to the scope_types of the policy being enforced. If the scopes do not match, an InvalidScope exception will be raised. If False, a message will be logged informing operators that policies are being invoked with mismatching scope.

policy_default_rule = default

string value

Default rule. Enforced when a requested rule is not found.

policy_dirs = [u'policy.d']

multi valued

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.

policy_file = policy.json

string value

The file that defines policies.

remote_content_type = application/x-www-form-urlencoded

string value

Content Type to send and receive data for REST based policy check

remote_ssl_ca_crt_file = None

string value

Absolute path to ca cert file for REST based policy check

remote_ssl_client_crt_file = None

string value

Absolute path to client cert for REST based policy check

remote_ssl_client_key_file = None

string value

Absolute path client key file REST based policy check

remote_ssl_verify_server_crt = False

boolean value

server identity verification for REST based policy check

expiration = 3600

integer value

Time in seconds to expire cache.

memcached_servers = None

list value

Memcached servers or None for in process cache.

backend = sqlalchemy

string value

The back end to use for the database.

connection = None

string value

The SQLAlchemy connection string to use to connect to the database.

connection_debug = 0

integer value

Verbosity of SQL debugging information: 0=None, 100=Everything.

connection_recycle_time = 3600

integer value

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.

connection_trace = False

boolean value

Add Python stack traces to SQL as comment strings.

db_inc_retry_interval = True

boolean value

If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retries = 20

integer value

Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

db_max_retry_interval = 10

integer value

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

db_retry_interval = 1

integer value

Seconds between retries of a database transaction.

max_overflow = 50

integer value

If set, use this value for max_overflow with SQLAlchemy.

max_pool_size = 5

integer value

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

max_retries = 10

integer value

Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

min_pool_size = 1

integer value

Minimum number of SQL connections to keep open in a pool.

mysql_enable_ndb = False

boolean value

If True, transparently enables support for handling MySQL Cluster (NDB).

mysql_sql_mode = TRADITIONAL

string value

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=

pool_timeout = None

integer value

If set, use this value for pool_timeout with SQLAlchemy.

retry_interval = 10

integer value

Interval between retries of opening a SQL connection.

slave_connection = None

string value

The SQLAlchemy connection string to use to connect to the slave database.

sqlite_synchronous = True

boolean value

If True, SQLite uses synchronous mode.

use_db_reconnect = False

boolean value

Enable the experimental use of database reconnect on connection lost.

batch_size = 100

integer value

How many zones to receive NOTIFY on each run

interval = 5

integer value

Run interval in seconds

per_page = 100

integer value

Default amount of results returned per page

interval = 3600

integer value

Run interval in seconds

per_page = 100

integer value

Default amount of results returned per page

interval = 3600

integer value

Run interval in seconds

per_page = 100

integer value

Default amount of results returned per page

interval = 120

integer value

Run interval in seconds

per_page = 100

integer value

Default amount of results returned per page

batch_size = 100

integer value

How many zones to be purged on each run

interval = 3600

integer value

Run interval in seconds

per_page = 100

integer value

Default amount of results returned per page

time_threshold = 604800

integer value

How old deleted zones should be (deleted_at) to be purged, in seconds

http_proxy = None

string value

Proxy HTTP requests via this proxy.

https_proxy = None

string value

Proxy HTTPS requests via this proxy

no_proxy = []

list value

These addresses should not be proxied

allow-notify = []

list value

List of IP addresses allowed to NOTIFY The Agent

backend-driver = bind9

string value

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

host = None

IP address value

Agent Bind Host

listen = [u'0.0.0.0:5358']

list value

Agent host:port pairs to listen on

masters = []

list value

List of masters for the Agent, format ip:port

notify-delay = 0.0

floating point value

Delay after a NOTIFY arrives for a zone that the Agent will pause and drop subsequent NOTIFYs for that zone

port = None

port value

Agent Port Number

tcp-backlog = 100

integer value

The Agent TCP Backlog

tcp-recv-timeout = 0.5

floating point value

Agent TCP Receive Timeout

threads = 1000

integer value

Number of agent greenthreads to spawn

transfer-source = None

string value

An IP address to be used to fetch zones transferred in

workers = None

integer value

Number of agent worker processes to spawn

api-base-uri = http://127.0.0.1:9001/

string value

the url used as the base for all API responses,This should consist of the scheme (http/https),the hostname, port, and any paths that are addedto the base of Designate is URLs,For example http://dns.openstack.example.com/dns

api_host = None

IP address value

API Bind Host

api_paste_config = api-paste.ini

string value

File name for the paste.deploy config for designate-api

api_port = None

port value

API Port Number

auth_strategy = keystone

string value

The strategy to use for auth. Supports noauth or keystone

default-limit-admin = 20

integer value

Default per-page limit for the Admin API, a value of None means show all results by default

default-limit-v2 = 20

integer value

Default per-page limit for the V2 API, a value of None means show all results by default

enable-api-admin = False

boolean value

enable-api-admin

enable-api-v2 = True

boolean value

enable-api-v2 which enable in a future

enable-host-header = False

boolean value

Enable host request headers

enabled-extensions-admin = []

list value

Enabled Admin API Extensions

enabled-extensions-v2 = []

list value

Enabled API Extensions for the V2 API

listen = [u'0.0.0.0:9001']

list value

API host:port pairs to listen on

maintenance-mode = False

boolean value

Enable API Maintenance Mode

maintenance-mode-role = admin

string value

Role allowed to bypass maintaince mode

max-limit-admin = 1000

integer value

Max per-page limit for the Admin API

max-limit-v2 = 1000

integer value

Max per-page limit for the V2 API

max_header_line = 16384

integer value

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

override-proto = None

string value

A scheme that will be used to override the request protocol scheme, even if it was set by an SSL terminating proxy.

secure-proxy-ssl-header = X-Forwarded-Proto

string value

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.

threads = 1000

integer value

Number of api greenthreads to spawn

workers = None

integer value

Number of api worker processes to spawn

central_topic = central

string value

RPC topic name of central service.

default_pool_id = 794ccc2c-d751-44fe-b57f-8894c9f5c842

string value

The name of the default pool

enabled-notification-handlers = []

list value

Enabled Notification Handlers

managed_resource_email = hostmaster@example.com

string value

E-Mail for Managed resources

managed_resource_tenant_id = 00000000-0000-0000-0000-000000000000

string value

The Tenant ID that will own any managed resources.

max_recordset_name_len = 255

integer value

Maximum recordset name length

max_zone_name_len = 255

integer value

Maximum zone name length

min_ttl = None

integer value

Minimum TTL allowed

scheduler_filters = [u'default_pool']

list value

Enabled Pool Scheduling filters

storage-driver = sqlalchemy

string value

The storage driver to use

threads = 1000

integer value

Number of central greenthreads to spawn

workers = None

integer value

Number of central worker processes to spawn

all-tcp = False

boolean value

Send all traffic over TCP

host = None

IP address value

mDNS Bind Host

listen = [u'0.0.0.0:5354']

list value

mDNS host:port pairs to listen on

max-message-size = 65535

integer value

Maximum message size to emit

mdns_topic = mdns

string value

RPC topic name for mini-DNS

port = None

port value

mDNS Port Number

query-enforce-tsig = False

boolean value

Enforce all incoming queries (including AXFR) are TSIG signed

storage-driver = sqlalchemy

string value

The storage driver to use

tcp-backlog = 100

integer value

mDNS TCP Backlog

tcp-recv-timeout = 0.5

floating point value

mDNS TCP Receive Timeout

threads = 1000

integer value

Number of mdns greenthreads to spawn

workers = None

integer value

Number of mdns worker processes to spawn

cache-driver = memcache

string value

The cache driver to use

enable-recovery-timer = True

boolean value

The flag for the recovery timer

enable-sync-timer = True

boolean value

The flag for the sync timer

periodic-recovery-interval = 120

integer value

The time between recovering from failures

periodic-sync-interval = 1800

integer value

The time between synchronizing the servers with storage

periodic-sync-max-attempts = 3

integer value

Number of attempts to update a zone during sync

periodic-sync-retry-interval = 30

integer value

Interval between zone update attempts during sync

periodic-sync-seconds = 21600

integer value

Zones Updated within last N seconds will be syncd.Use an empty value to sync all zones.

poll-delay = 5

integer value

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

poll-max-retries = 10

integer value

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

poll-retry-interval = 15

integer value

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

poll-timeout = 30

integer value

The time to wait for a response from a server

pool-id = 794ccc2c-d751-44fe-b57f-8894c9f5c842

string value

The ID of the pool managed by this instance of the Pool Manager

pool_manager_topic = pool_manager

string value

RPC topic name for pool-manager

threads = 1000

integer value

Number of Pool Manager greenthreads to spawn

threshold-percentage = 100

integer value

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

workers = None

integer value

Number of Pool Manager worker processes to spawn

enabled_tasks = None

list value

Enabled tasks to run

export-synchronous = True

boolean value

Whether to allow synchronous zone exports

storage-driver = sqlalchemy

string value

The storage driver to use

threads = 1000

integer value

Number of Producer greenthreads to spawn

workers = None

integer value

Number of Producer worker processes to spawn

enabled-notification-handlers = []

list value

Enabled Notification Handlers

threads = 1000

integer value

Number of sink greenthreads to spawn

workers = None

integer value

Number of sink worker processes to spawn

enabled = False

boolean value

Whether to send events to worker instead of Pool Manager

export-synchronous = True

boolean value

Whether to allow synchronous zone exports

notify = True

boolean value

Whether to allow worker to send NOTIFYs, this will noop NOTIFYs in mdns if true

poll-delay = 5

integer value

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

poll-max-retries = 10

integer value

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

poll-retry-interval = 15

integer value

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

poll-timeout = 30

integer value

The time to wait for a response from a server

storage-driver = sqlalchemy

string value

The storage driver to use

threads = 200

integer value

Number of Worker threads to spawn per process

threshold-percentage = 100

integer value

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

worker_topic = worker

string value

RPC topic for worker component

workers = None

integer value

Number of Worker worker processes to spawn

enabled_tasks = None

list value

Enabled tasks to run

export-synchronous = True

boolean value

Whether to allow synchronous zone exports

storage-driver = sqlalchemy

string value

The storage driver to use

threads = 1000

integer value

Number of Zone Manager greenthreads to spawn

workers = None

integer value

Number of Zone Manager worker processes to spawn

ca_file = None

string value

CA certificate file to use to verify connecting clients.

cert_file = None

string value

Certificate file to use when starting the server securely.

ciphers = None

string value

Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.

key_file = None

string value

Private key file to use when starting the server securely.

version = None

string value

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.

backend = sqlalchemy

string value

The back end to use for the database.

connection = None

string value

The SQLAlchemy connection string to use to connect to the database.

connection_debug = 0

integer value

Verbosity of SQL debugging information: 0=None, 100=Everything.

connection_recycle_time = 3600

integer value

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.

connection_trace = False

boolean value

Add Python stack traces to SQL as comment strings.

db_inc_retry_interval = True

boolean value

If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retries = 20

integer value

Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

db_max_retry_interval = 10

integer value

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

db_retry_interval = 1

integer value

Seconds between retries of a database transaction.

max_overflow = 50

integer value

If set, use this value for max_overflow with SQLAlchemy.

max_pool_size = 5

integer value

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

max_retries = 10

integer value

Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

min_pool_size = 1

integer value

Minimum number of SQL connections to keep open in a pool.

mysql_enable_ndb = False

boolean value

If True, transparently enables support for handling MySQL Cluster (NDB).

mysql_sql_mode = TRADITIONAL

string value

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=

pool_timeout = None

integer value

If set, use this value for pool_timeout with SQLAlchemy.

retry_interval = 10

integer value

Interval between retries of opening a SQL connection.

slave_connection = None

string value

The SQLAlchemy connection string to use to connect to the slave database.

sqlite_synchronous = True

boolean value

If True, SQLite uses synchronous mode.

use_db_reconnect = False

boolean value

Enable the experimental use of database reconnect on connection lost.