# Configuration Options

The following is an overview of all available configuration options in Masakari.

For a sample configuration file, refer to Masakari Configuration Options.

## DEFAULT

auth_strategy
  Type:

    string

  Default:

    `keystone`

  Valid Values:

    keystone, noauth2

  This determines the strategy to use for authentication: keystone or noauth2. ‘noauth2’ is designed for testing only, as it does no actual credential checking. ‘noauth2’ provides administrative credentials only if ‘admin’ is specified as the username.

  - Possible values:

    Either ‘keystone’ (default) or ‘noauth2’.

  - Services that use this:

    `masakari-api`

  - Related options:

    None

use_forwarded_for
  Type:

    boolean

  Default:

    `False`

  When True, the ‘X-Forwarded-For’ header is treated as the canonical remote address. When False (the default), the ‘remote_address’ header is used.

  You should only enable this if you have an HTML sanitizing proxy.

  - Possible values:

    True, False (default)

  - Services that use this:

    `masakari-api`

  - Related options:

    None

  Warning

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

  Reason:

    This feature is duplicate of the HTTPProxyToWSGI middleware in oslo.middleware

osapi_max_limit
  Type:

    integer

  Default:

    `1000`

  As a query can potentially return many thousands of items, you can limit the maximum number of items in a single response by setting this option.

  - Possible values:

    Any positive integer. Default is 1000.

  - Services that use this:

    `masakari-api`

  - Related options:

    None

osapi_masakari_link_prefix
  Type:

    string

  Default:

    `<None>`

  This string is prepended to the normal URL that is returned in links to the OpenStack Masakari API. If it is empty (the default), the URLs are returned unchanged.

  - Possible values:

    Any string, including an empty string (the default).

  - Services that use this:

    `masakari-api`

  - Related options:

    None

notification_delay_max
  Type:

    integer

  Default:

    `5`

  Minimum Value:

    0

  Maximum random delay, in seconds, applied before creating a notification when the coordination backend is not configured.

  This is an interim workaround to reduce the chance of duplicate notifications being created concurrently by multiple HA API workers.

  Set to 0 to disable the workaround.

  When coordination is configured, this option is ignored and no delay is added.

  - Possible values:

    Any positive integer. Default is 5. 0 to disable.

  - Services that use this:

    `masakari-api`

  - Related options:

    None

tempdir
  Type:

    string

  Default:

    `<None>`

  Explicitly specify the temporary working directory.

monkey_patch
  Type:

    boolean

  Default:

    `False`

  Determine if monkey patching should be applied.

  Related options:

  - `monkey_patch_modules`: This must have values set for this option to have any effect

monkey_patch_modules
  Type:

    list

  Default:

    `['masakari.api:masakari.cmd']`

  List of modules/decorators to monkey patch.

  This option allows you to patch a decorator for all functions in specified modules.

  Related options:

  - `monkey_patch`: This must be set to `True` for this option to have any effect

masakari_topic
  Type:

    string

  Default:

    `ha_engine`

  This is the message queue topic that the masakari engine ‘listens’ on. It is used when the masakari engine is started up to configure the queue, and whenever an RPC call to the masakari engine is made.

  - Possible values:

    Any string, but there is almost never any reason to ever change this value from its default of ‘engine’.

  - Services that use this:

    `masakari-engine`

  - Related options:

    None

  Warning

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

  Reason:

    Configurable RPC topic provides little value and it can easily break Masakari if operator configures it to the same topic used by other OpenStack services.

duplicate_notification_detection_interval
  Type:

    integer

  Default:

    `180`

  Minimum Value:

    0

  Interval in seconds for identifying duplicate notifications. If the notification received is identical to the previous ones whose status is either new or running and if it’s created_timestamp and the current timestamp is less than this config option value, then the notification will be considered as duplicate and it will be ignored.

wait_period_after_service_update
  Type:

    integer

  Default:

    `180`

  Number of seconds to wait after a service is enabled or disabled.

wait_period_after_evacuation
  Type:

    integer

  Default:

    `90`

  Wait until instance is evacuated

verify_interval
  Type:

    integer

  Default:

    `1`

  The monitoring interval for looping

wait_period_after_power_off
  Type:

    integer

  Default:

    `180`

  Number of seconds to wait for instance to shut down

wait_period_after_power_on
  Type:

    integer

  Default:

    `60`

  Number of seconds to wait for instance to start

process_unfinished_notifications_interval
  Type:

    integer

  Default:

    `120`

  Interval in seconds for processing notifications which are in error or new state.

retry_notification_new_status_interval
  Type:

    integer

  Default:

    `60`

  Mutable:

    This option can be changed without restarting.

  Interval in seconds for identifying notifications which are in new state. If the notification is in new state till this config option value after it’s generated_time, then it is considered that notification is ignored by the messaging queue and will be processed by ‘process_unfinished_notifications’ periodic task.

check_expired_notifications_interval
  Type:

    integer

  Default:

    `600`

  Interval in seconds for checking running notifications.

notifications_expired_interval
  Type:

    integer

  Default:

    `86400`

  Interval in seconds for identifying running notifications expired.

host_failure_recovery_threads
  Type:

    integer

  Default:

    `3`

  Minimum Value:

    1

  Number of threads to be used for evacuating and confirming instances during execution of host_failure workflow.

notification_driver
  Type:

    string

  Default:

    `taskflow_driver`

  Defines which driver to use for executing notification workflows.

fatal_exception_format_errors
  Type:

    boolean

  Default:

    `False`

  Make exception message format errors fatal

nova_catalog_admin_info
  Type:

    string

  Default:

    `compute:nova:publicURL`

  Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>

os_region_name
  Type:

    string

  Default:

    `<None>`

  Region name of this node

nova_ca_certificates_file
  Type:

    string

  Default:

    `<None>`

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

nova_api_insecure
  Type:

    boolean

  Default:

    `False`

  Allow to perform insecure SSL requests to nova

os_privileged_user_name
  Type:

    string

  Default:

    `<None>`

  OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.

os_privileged_user_password
  Type:

    string

  Default:

    `<None>`

  Password associated with the OpenStack privileged account.

os_privileged_user_tenant
  Type:

    string

  Default:

    `<None>`

  Tenant name associated with the OpenStack privileged account.

os_privileged_user_auth_url
  Type:

    URI

  Default:

    `<None>`

  Auth URL associated with the OpenStack privileged account.

os_user_domain_name
  Type:

    string

  Default:

    `default`

  User domain name associated with the OpenStack privileged account.

os_project_domain_name
  Type:

    string

  Default:

    `default`

  Project domain name associated with the OpenStack privileged account.

os_system_scope
  Type:

    string

  Default:

    `<None>`

  Scope for system operations.

pybasedir
  Type:

    string

  Default:

    `/build/masakari-9nciQj/masakari-21.0.0+git20260810.20.fcafb16`

  Directory where the masakari python module is installed

bindir
  Type:

    string

  Default:

    `/usr/local/bin`

  Directory where masakari binaries are installed

state_path
  Type:

    string

  Default:

    `$pybasedir`

  Top-level directory for maintaining masakari’s state

host
  Type:

    host address

  Default:

    `<HOSTNAME>`

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

  Hostname, FQDN or IP address of this host. Must be valid within AMQP key.

  Possible values:

  - String with hostname, FQDN or IP address. Default is hostname of this host.

engine_manager
  Type:

    string

  Default:

    `masakari.engine.manager.MasakariManager`

  Full class name for the Manager for masakari engine

report_interval
  Type:

    integer

  Default:

    `10`

  Seconds between nodes reporting state to datastore

periodic_enable
  Type:

    boolean

  Default:

    `True`

  Enable periodic tasks

periodic_interval_max
  Type:

    integer

  Default:

    `300`

  Max interval time between periodic tasks execution in seconds.

periodic_fuzzy_delay
  Type:

    integer

  Default:

    `60`

  Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)

use_ssl
  Type:

    boolean

  Default:

    `False`

  Use APIs with SSL enabled

masakari_api_listen
  Type:

    host address

  Default:

    `0.0.0.0`

  The IP address on which the Masakari API will listen.

masakari_api_listen_port
  Type:

    integer

  Default:

    `15868`

  Minimum Value:

    1

  Maximum Value:

    65535

  The port on which the Masakari API will listen.

masakari_api_workers
  Type:

    integer

  Default:

    `<None>`

  Number of workers for Masakari API service. The default will be the number of CPUs available.

service_down_time
  Type:

    integer

  Default:

    `60`

  Maximum time since last check-in for up service

debug
  Type:

    boolean

  Default:

    `False`

  Mutable:

    This option can be changed without restarting.

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

log_config_append
  Type:

    string

  Default:

    `<None>`

  Mutable:

    This option can be changed without restarting.

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

  Deprecated Variations
  Group | Name
  --- | ---
  DEFAULT | log-config
  DEFAULT | log_config

log_date_format
  Type:

    string

  Default:

    `%Y-%m-%d %H:%M:%S`

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

log_file
  Type:

    string

  Default:

    `<None>`

  (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

  Deprecated Variations
  Group | Name
  --- | ---
  DEFAULT | logfile

log_dir
  Type:

    string

  Default:

    `<None>`

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

  Deprecated Variations
  Group | Name
  --- | ---
  DEFAULT | logdir

use_syslog
  Type:

    boolean

  Default:

    `False`

  Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.

use_journal
  Type:

    boolean

  Default:

    `False`

  Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

syslog_log_facility
  Type:

    string

  Default:

    `LOG_USER`

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

use_json
  Type:

    boolean

  Default:

    `False`

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

use_stderr
  Type:

    boolean

  Default:

    `False`

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

log_color
  Type:

    boolean

  Default:

    `False`

  (Optional) Set the ‘color’ key according to log levels. This option takes effect only when logging to stderr or stdout is used. This option is ignored if log_config_append is set.

log_rotate_interval
  Type:

    integer

  Default:

    `1`

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

log_rotate_interval_type
  Type:

    string

  Default:

    `days`

  Valid Values:

    Seconds, Minutes, Hours, Days, Weekday, Midnight

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

max_logfile_count
  Type:

    integer

  Default:

    `30`

  Maximum number of rotated log files.

max_logfile_size_mb
  Type:

    integer

  Default:

    `200`

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

log_rotation_type
  Type:

    string

  Default:

    `none`

  Valid Values:

    interval, size, none

  Log rotation type.

  Possible values

  interval

    Rotate logs at predefined time intervals.

  size

    Rotate logs once they reach a predefined size.

  none

    Do not rotate log files.

logging_context_format_string
  Type:

    string

  Default:

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

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

logging_default_format_string
  Type:

    string

  Default:

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

  Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

logging_debug_format_suffix
  Type:

    string

  Default:

    `%(funcName)s %(pathname)s:%(lineno)d`

  Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

logging_exception_prefix
  Type:

    string

  Default:

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

  Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

logging_user_identity_format
  Type:

    string

  Default:

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

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

default_log_levels
  Type:

    list

  Default:

    `['amqp=WARN', 'boto=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']`

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

publish_errors
  Type:

    boolean

  Default:

    `False`

  Enables or disables publication of error events.

instance_format
  Type:

    string

  Default:

    `"[instance: %(uuid)s] "`

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

instance_uuid_format
  Type:

    string

  Default:

    `"[instance: %(uuid)s] "`

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

rate_limit_interval
  Type:

    integer

  Default:

    `0`

  Interval, number of seconds, of log rate limiting.

rate_limit_burst
  Type:

    integer

  Default:

    `0`

  Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level
  Type:

    string

  Default:

    `CRITICAL`

  Valid Values:

    CRITICAL, ERROR, INFO, WARNING, DEBUG, ‘’

  Log level name used by rate limiting. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

fatal_deprecations
  Type:

    boolean

  Default:

    `False`

  Enables or disables fatal status of deprecations.

executor_thread_pool_size
  Type:

    integer

  Default:

    `64`

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

  Deprecated Variations
  Group | Name
  --- | ---
  DEFAULT | rpc_thread_pool_size

rpc_response_timeout
  Type:

    integer

  Default:

    `60`

  Seconds to wait for a response from a call.

transport_url
  Type:

    string

  Default:

    `rabbit://`

  The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:

  driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query

  Example: rabbit://rabbitmq:password@127.0.0.1:5672//

  For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html

control_exchange
  Type:

    string

  Default:

    `openstack`

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

rpc_ping_enabled
  Type:

    boolean

  Default:

    `False`

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

backdoor_port
  Type:

    string

  Default:

    `<None>`

  Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.

  Warning

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

  Reason:

    The ‘backdoor_port’ option is deprecated and will be removed in a future release.

backdoor_socket
  Type:

    string

  Default:

    `<None>`

  Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.

  Warning

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

  Reason:

    The ‘backdoor_socket’ option is deprecated and will be removed in a future release.

log_options
  Type:

    boolean

  Default:

    `True`

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

graceful_shutdown_timeout
  Type:

    integer

  Default:

    `60`

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

api_paste_config
  Type:

    string

  Default:

    `api-paste.ini`

  File name for the paste.deploy config for api service

  Warning

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

  Reason:

    The ‘api_paste_config’ option is deprecated and will be removed in a future release.

wsgi_log_format
  Type:

    string

  Default:

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

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

  Warning

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

  Reason:

    The ‘wsgi_log_format’ option is deprecated and will be removed in a future release.

tcp_keepidle
  Type:

    integer

  Default:

    `600`

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

  Warning

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

  Reason:

    The ‘tcp_keepidle’ option is deprecated and will be removed in a future release.

wsgi_default_pool_size
  Type:

    integer

  Default:

    `100`

  Size of the pool of greenthreads used by wsgi

  Warning

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

  Reason:

    The ‘wsgi_default_pool_size’ option is deprecated and will be removed in a future release.

max_header_line
  Type:

    integer

  Default:

    `16384`

  Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).

  Warning

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

  Reason:

    The ‘max_header_line’ option is deprecated and will be removed in a future release.

wsgi_keep_alive
  Type:

    boolean

  Default:

    `True`

  If False, closes the client socket connection explicitly.

  Warning

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

  Reason:

    The ‘wsgi_keep_alive’ option is deprecated and will be removed in a future release.

client_socket_timeout
  Type:

    integer

  Default:

    `900`

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

  Warning

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

  Reason:

    The ‘client_socket_timeout’ option is deprecated and will be removed in a future release.

wsgi_server_debug
  Type:

    boolean

  Default:

    `False`

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

  Warning

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

  Reason:

    The ‘wsgi_server_debug’ option is deprecated and will be removed in a future release.

## coordination

backend_url
  Type:

    string

  Default:

    `<None>`

  The backend URL to use for distributed coordination.By default it’s None which means that coordination is disabled. The coordination is implemented for distributed lock management and was tested with etcd.Coordination doesn’t work for file driver because lock files aren’t removed after lock releasing.

## cors

allowed_origin
  Type:

    list

  Default:

    `<None>`

  Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com

allow_credentials
  Type:

    boolean

  Default:

    `True`

  Indicate that the actual request can include user credentials

expose_headers
  Type:

    list

  Default:

    `[]`

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

max_age
  Type:

    integer

  Default:

    `3600`

  Maximum cache age of CORS preflight requests.

allow_methods
  Type:

    list

  Default:

    `['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'PATCH']`

  Indicate which methods can be used during the actual request.

allow_headers
  Type:

    list

  Default:

    `[]`

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

## database

sqlite_synchronous
  Type:

    boolean

  Default:

    `True`

  If True, SQLite uses synchronous mode.

backend
  Type:

    string

  Default:

    `sqlalchemy`

  The back end to use for the database.

connection
  Type:

    string

  Default:

    `<None>`

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

slave_connection
  Type:

    string

  Default:

    `<None>`

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

asyncio_connection
  Type:

    string

  Default:

    `<None>`

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

asyncio_slave_connection
  Type:

    string

  Default:

    `<None>`

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

synchronous_reader
  Type:

    boolean

  Default:

    `True`

  Whether or not to assume a reader context needs to guarantee it can read data committed by a writer assuming replication lag is present; defaults to True. When False, a reader context works the same as async_reader and will select the slave database if present. When using a galera cluster, this can be set to False only if you set mysql_wsrep_sync_wait to 1 (this will guarantee that the reader will wait until writesets are committed).Note that this may incur a performance degradation within the galera cluster. Note also that this parameter has no effect if you do not set any slave_connection.

mysql_sql_mode
  Type:

    string

  Default:

    `TRADITIONAL`

  The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=

mysql_wsrep_sync_wait
  Type:

    integer

  Default:

    `<None>`

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

connection_recycle_time
  Type:

    integer

  Default:

    `3600`

  Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.

max_pool_size
  Type:

    integer

  Default:

    `5`

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

max_retries
  Type:

    integer

  Default:

    `10`

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

retry_interval
  Type:

    integer

  Default:

    `10`

  Interval between retries of opening a SQL connection.

max_overflow
  Type:

    integer

  Default:

    `50`

  If set, use this value for max_overflow with SQLAlchemy.

connection_debug
  Type:

    integer

  Default:

    `0`

  Minimum Value:

    0

  Maximum Value:

    100

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

connection_trace
  Type:

    boolean

  Default:

    `False`

  Add Python stack traces to SQL as comment strings.

pool_timeout
  Type:

    integer

  Default:

    `<None>`

  If set, use this value for pool_timeout with SQLAlchemy.

use_db_reconnect
  Type:

    boolean

  Default:

    `False`

  Enable the experimental use of database reconnect on connection lost.

db_retry_interval
  Type:

    integer

  Default:

    `1`

  Seconds between retries of a database transaction.

db_inc_retry_interval
  Type:

    boolean

  Default:

    `True`

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

db_max_retry_interval
  Type:

    integer

  Default:

    `10`

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

db_max_retries
  Type:

    integer

  Default:

    `20`

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

connection_parameters
  Type:

    string

  Default:

    `''`

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

## healthcheck

detailed
  Type:

    boolean

  Default:

    `False`

  Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.

backends
  Type:

    list

  Default:

    `[]`

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

allowed_source_ranges
  Type:

    list

  Default:

    `[]`

  A list of network addresses to limit source ip allowed to access healthcheck information. Any request from ip outside of these network addresses are ignored.

ignore_proxied_requests
  Type:

    boolean

  Default:

    `False`

  Ignore requests with proxy headers.

disable_by_file_path
  Type:

    string

  Default:

    `<None>`

  Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths
  Type:

    list

  Default:

    `[]`

  Check the presence of a file based on a port to determine if an application is running on a port. Expects a “port:path” list of strings. Used by DisableByFilesPortsHealthcheck plugin.

enable_by_file_paths
  Type:

    list

  Default:

    `[]`

  Check the presence of files. Used by EnableByFilesHealthcheck plugin.

## host_failure

evacuate_all_instances
  Type:

    boolean

  Default:

    `True`

  Operators can decide whether all instances or only those instances which have `[host_failure]\ha_enabled_instance_metadata_key` set to `True` should be allowed for evacuation from a failed source compute node. When set to True, it will evacuate all instances from a failed source compute node. First preference will be given to those instances which have `[host_failure]\ha_enabled_instance_metadata_key` set to `True`, and then it will evacuate the remaining ones. When set to False, it will evacuate only those instances which have `[host_failure]\ha_enabled_instance_metadata_key` set to `True`.

ha_enabled_instance_metadata_key
  Type:

    string

  Default:

    `HA_Enabled`

  Operators can decide on the instance metadata key naming that affects the per-instance behaviour of `[host_failure]\evacuate_all_instances`. The default is the same for both failure types (host, instance) but the value can be overridden to make the metadata key different per failure type.

ignore_instances_in_error_state
  Type:

    boolean

  Default:

    `False`

  Operators can decide whether error instances should be allowed for evacuation from a failed source compute node or not. When set to True, it will ignore error instances from evacuation from a failed source compute node. When set to False, it will evacuate error instances along with other instances from a failed source compute node.

add_reserved_host_to_aggregate
  Type:

    boolean

  Default:

    `False`

  Operators can decide whether reserved_host should be added to aggregate group of failed compute host. When set to True, reserved host will be added to the aggregate group of failed compute host. When set to False, the reserved_host will not be added to the aggregate group of failed compute host.

service_disable_reason
  Type:

    string

  Default:

    `Masakari detected host failed.`

  Compute disable reason in case Masakari detects host failure.

## instance_failure

process_all_instances
  Type:

    boolean

  Default:

    `False`

  Operators can decide whether all instances or only those instances which have `[instance_failure]\ha_enabled_instance_metadata_key` set to `True` should be taken into account to recover from instance failure events. When set to True, it will execute instance failure recovery actions for an instance irrespective of whether that particular instance has `[instance_failure]\ha_enabled_instance_metadata_key` set to `True`. When set to False, it will only execute instance failure recovery actions for an instance which has `[instance_failure]\ha_enabled_instance_metadata_key` set to `True`.

ha_enabled_instance_metadata_key
  Type:

    string

  Default:

    `HA_Enabled`

  Operators can decide on the instance metadata key naming that affects the per-instance behaviour of `[instance_failure]\process_all_instances`. The default is the same for both failure types (host, instance) but the value can be overridden to make the metadata key different per failure type.

## keystone_authtoken

www_authenticate_uri
  Type:

    string

  Default:

    `<None>`

  Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies.

auth_version
  Type:

    string

  Default:

    `<None>`

  API version of the Identity API endpoint.

interface
  Type:

    string

  Default:

    `internal`

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

delay_auth_decision
  Type:

    boolean

  Default:

    `False`

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

http_connect_timeout
  Type:

    integer

  Default:

    `<None>`

  Request timeout value for communicating with Identity API server.

http_request_max_retries
  Type:

    integer

  Default:

    `3`

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

cache
  Type:

    string

  Default:

    `<None>`

  Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the `memcached_servers` option instead.

certfile
  Type:

    string

  Default:

    `<None>`

  Required if identity server requires client certificate

keyfile
  Type:

    string

  Default:

    `<None>`

  Required if identity server requires client certificate

cafile
  Type:

    string

  Default:

    `<None>`

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

insecure
  Type:

    boolean

  Default:

    `False`

  Verify HTTPS connections.

region_name
  Type:

    string

  Default:

    `<None>`

  The region in which the identity server can be found.

memcached_servers
  Type:

    list

  Default:

    `<None>`

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

  Deprecated Variations
  Group | Name
  --- | ---
  keystone_authtoken | memcache_servers

token_cache_time
  Type:

    integer

  Default:

    `300`

  In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.

memcache_security_strategy
  Type:

    string

  Default:

    `None`

  Valid Values:

    None, MAC, ENCRYPT

  (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.

memcache_secret_key
  Type:

    string

  Default:

    `<None>`

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

memcache_tls_enabled
  Type:

    boolean

  Default:

    `False`

  (Optional) Global toggle for TLS usage when comunicating with the caching servers.

memcache_tls_cafile
  Type:

    string

  Default:

    `<None>`

  (Optional) Path to a file of concatenated CA certificates in PEM format necessary to establish the caching server’s authenticity. If tls_enabled is False, this option is ignored.

memcache_tls_certfile
  Type:

    string

  Default:

    `<None>`

  (Optional) Path to a single file in PEM format containing the client’s certificate as well as any number of CA certificates needed to establish the certificate’s authenticity. This file is only required when client side authentication is necessary. If tls_enabled is False, this option is ignored.

memcache_tls_keyfile
  Type:

    string

  Default:

    `<None>`

  (Optional) Path to a single file containing the client’s private key in. Otherwhise the private key will be taken from the file specified in tls_certfile. If tls_enabled is False, this option is ignored.

memcache_tls_allowed_ciphers
  Type:

    string

  Default:

    `<None>`

  (Optional) Set the available ciphers for sockets created with the TLS context. It should be a string in the OpenSSL cipher list format. If not specified, all OpenSSL enabled ciphers will be available.

memcache_pool_dead_retry
  Type:

    integer

  Default:

    `300`

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

memcache_pool_maxsize
  Type:

    integer

  Default:

    `10`

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

memcache_pool_socket_timeout
  Type:

    integer

  Default:

    `3`

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

memcache_pool_unused_timeout
  Type:

    integer

  Default:

    `60`

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

memcache_pool_conn_get_timeout
  Type:

    integer

  Default:

    `10`

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

memcache_use_advanced_pool
  Type:

    boolean

  Default:

    `True`

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

include_service_catalog
  Type:

    boolean

  Default:

    `True`

  (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.

enforce_token_bind
  Type:

    string

  Default:

    `permissive`

  Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.

service_token_roles
  Type:

    list

  Default:

    `['service']`

  A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.

service_token_roles_required
  Type:

    boolean

  Default:

    `True`

  When set to True, service tokens must contain a role from the service_token_roles list to be considered valid. This prevents end-user tokens from being used as service tokens and ensures proper service-to-service authentication. Setting this to False is NOT RECOMMENDED as it allows any valid token to be used as a service token, which can bypass access-rule checks and weaken composite-auth protections.

service_type
  Type:

    string

  Default:

    `<None>`

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

memcache_sasl_enabled
  Type:

    boolean

  Default:

    `False`

  Enable the SASL(Simple Authentication and Security Layer) if the SASL_enable is true, else disable.

memcache_username
  Type:

    string

  Default:

    `''`

  the user name for the SASL

memcache_password
  Type:

    string

  Default:

    `''`

  the username password for SASL

auth_type
  Type:

    unknown type

  Default:

    `<None>`

  Authentication type to load

  Deprecated Variations
  Group | Name
  --- | ---
  keystone_authtoken | auth_plugin

auth_section
  Type:

    unknown type

  Default:

    `<None>`

  Config Section from which to load plugin specific options

## osapi_v1

extensions_blacklist
  Type:

    list

  Default:

    `[]`

  DEPRECATED

  This option is a list of all of the v2.1 API extensions to never load. However, it will be removed in the near future, after which the all the functionality that was previously in extensions will be part of the standard API, and thus always accessible.

  - Possible values:

    A list of strings, each being the alias of an extension that you do not wish to load.

  - Services that use this:

    `masakari-api`

  - Related options:

    enabled, extensions_whitelist

  Deprecated Variations
  Group | Name
  --- | ---
  osapi_v1 | extensions_blacklist

  Warning

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

extensions_whitelist
  Type:

    list

  Default:

    `[]`

  DEPRECATED

  This is a list of extensions. If it is empty, then all extensions except those specified in the extensions_blacklist option will be loaded. If it is not empty, then only those extensions in this list will be loaded, provided that they are also not in the extensions_blacklist option. Once this deprecated option is removed, after which the all the functionality that was previously in extensions will be part of the standard API, and thus always accessible.

  - Possible values:

    A list of strings, each being the alias of an extension that you wish to load, or an empty list, which indicates that all extensions are to be run.

  - Services that use this:

    `masakari-api`

  - Related options:

    enabled, extensions_blacklist

  Deprecated Variations
  Group | Name
  --- | ---
  osapi_v1 | extensions_whitelist

  Warning

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

project_id_regex
  Type:

    string

  Default:

    `<None>`

  DEPRECATED

  This option is a string representing a regular expression (regex) that matches the project_id as contained in URLs. If not set, it will match normal UUIDs created by keystone.

  - Possible values:

    A string representing any legal regular expression

  - Services that use this:

    `masakari-api`

  - Related options:

    None

  Deprecated Variations
  Group | Name
  --- | ---
  osapi_v1 | project_id_regex

  Warning

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

## oslo_messaging_kafka

kafka_max_fetch_bytes
  Type:

    integer

  Default:

    `1048576`

  Max fetch bytes of Kafka consumer

kafka_consumer_timeout
  Type:

    floating point

  Default:

    `1.0`

  Default timeout(s) for Kafka consumers

consumer_group
  Type:

    string

  Default:

    `oslo_messaging_consumer`

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

producer_batch_timeout
  Type:

    floating point

  Default:

    `0.0`

  Upper bound on the delay for KafkaProducer batching in seconds

producer_batch_size
  Type:

    integer

  Default:

    `16384`

  Size of batch for the producer async send

compression_codec
  Type:

    string

  Default:

    `none`

  Valid Values:

    none, gzip, snappy, lz4, zstd

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

enable_auto_commit
  Type:

    boolean

  Default:

    `False`

  Enable asynchronous consumer commits

max_poll_records
  Type:

    integer

  Default:

    `500`

  The maximum number of records returned in a poll call

security_protocol
  Type:

    string

  Default:

    `PLAINTEXT`

  Valid Values:

    PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL

  Protocol used to communicate with brokers

sasl_mechanism
  Type:

    string

  Default:

    `PLAIN`

  Mechanism when security protocol is SASL

ssl_cafile
  Type:

    string

  Default:

    `''`

  CA certificate PEM file used to verify the server certificate

ssl_client_cert_file
  Type:

    string

  Default:

    `''`

  Client certificate PEM file used for authentication.

ssl_client_key_file
  Type:

    string

  Default:

    `''`

  Client key PEM file used for authentication.

ssl_client_key_password
  Type:

    string

  Default:

    `''`

  Client key password file used for authentication.

## oslo_messaging_notifications

driver
  Type:

    multi-valued

  Default:

    `''`

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

transport_url
  Type:

    string

  Default:

    `<None>`

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

topics
  Type:

    list

  Default:

    `['notifications']`

  AMQP topic used for OpenStack notifications.

retry
  Type:

    integer

  Default:

    `-1`

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

## oslo_messaging_rabbit

amqp_durable_queues
  Type:

    boolean

  Default:

    `False`

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

amqp_auto_delete
  Type:

    boolean

  Default:

    `False`

  Auto-delete queues in AMQP.

rpc_conn_pool_size
  Type:

    integer

  Default:

    `30`

  Minimum Value:

    1

  Size of RPC connection pool.

conn_pool_min_size
  Type:

    integer

  Default:

    `2`

  The pool size limit for connections expiration policy

conn_pool_ttl
  Type:

    integer

  Default:

    `1200`

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

ssl
  Type:

    boolean

  Default:

    `False`

  Connect over SSL.

ssl_version
  Type:

    string

  Default:

    `''`

  SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.

ssl_key_file
  Type:

    string

  Default:

    `''`

  SSL key file (valid only if SSL enabled).

ssl_cert_file
  Type:

    string

  Default:

    `''`

  SSL cert file (valid only if SSL enabled).

ssl_ca_file
  Type:

    string

  Default:

    `''`

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

ssl_enforce_hostname_verification
  Type:

    boolean

  Default:

    `True`

  When true, verify the broker hostname against the certificate when `ssl_ca_file` is set. When false, `ssl` with `ssl_ca_file` still validates the certificate chain but does not verify the broker hostname. `ssl=true` without `ssl_ca_file` never enables hostname verification.

  Warning

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

  Reason:

    Verification is always enabled now

ssl_enforce_fips_mode
  Type:

    boolean

  Default:

    `False`

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

  Warning

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

  Reason:

    FIPS_mode_set API was removed in OpenSSL 3.0.0. This option has no effect now.

kombu_reconnect_delay
  Type:

    floating point

  Default:

    `1.0`

  Minimum Value:

    0.0

  Maximum Value:

    4.5

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

kombu_reconnect_splay
  Type:

    floating point

  Default:

    `0.0`

  Minimum Value:

    0.0

  Random time to wait for when reconnecting in response to an AMQP consumer cancel notification.

kombu_compression
  Type:

    string

  Default:

    `<None>`

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

kombu_missing_consumer_retry_timeout
  Type:

    integer

  Default:

    `60`

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

  Deprecated Variations
  Group | Name
  --- | ---
  oslo_messaging_rabbit | kombu_reconnect_timeout

kombu_failover_strategy
  Type:

    string

  Default:

    `round-robin`

  Valid Values:

    round-robin, shuffle

  Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.

rabbit_login_method
  Type:

    string

  Default:

    `AMQPLAIN`

  Valid Values:

    PLAIN, AMQPLAIN, EXTERNAL, RABBIT-CR-DEMO

  The RabbitMQ login method.

rabbit_retry_interval
  Type:

    integer

  Default:

    `1`

  Minimum Value:

    1

  How frequently to retry connecting with RabbitMQ.

rabbit_retry_backoff
  Type:

    integer

  Default:

    `2`

  Minimum Value:

    0

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

rabbit_interval_max
  Type:

    integer

  Default:

    `30`

  Minimum Value:

    1

  Maximum interval of RabbitMQ connection retries.

rabbit_ha_queues
  Type:

    boolean

  Default:

    `False`

  Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “

rabbit_quorum_queue
  Type:

    boolean

  Default:

    `False`

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

rabbit_transient_quorum_queue
  Type:

    boolean

  Default:

    `False`

  Use quorum queues for transients queues in RabbitMQ. Enabling this option will then make sure those queues are also using quorum kind of rabbit queues, which are HA by default.

rabbit_quorum_delivery_limit
  Type:

    integer

  Default:

    `0`

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

rabbit_quorum_max_memory_length
  Type:

    integer

  Default:

    `0`

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

rabbit_quorum_max_memory_bytes
  Type:

    integer

  Default:

    `0`

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

rabbit_transient_queues_ttl
  Type:

    integer

  Default:

    `1800`

  Minimum Value:

    0

  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. Setting 0 as value will disable the x-expires. If doing so, make sure you have a rabbitmq policy to delete the queues or you deployment will create an infinite number of queue over time.In case rabbit_stream_fanout is set to True, this option will control data retention policy (x-max-age) for messages in the fanout queue rather then the queue duration itself. So the oldest data in the stream queue will be discarded from it once reaching TTL Setting to 0 will disable x-max-age for stream which make stream grow indefinitely filling up the diskspace

rabbit_qos_prefetch_count
  Type:

    integer

  Default:

    `0`

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

heartbeat_timeout_threshold
  Type:

    integer

  Default:

    `60`

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

heartbeat_rate
  Type:

    integer

  Default:

    `3`

  How often times during the heartbeat_timeout_threshold we check the heartbeat.

direct_mandatory_flag
  Type:

    boolean

  Default:

    `True`

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

  Warning

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

  Reason:

    Mandatory flag no longer deactivable.

enable_cancel_on_failover
  Type:

    boolean

  Default:

    `False`

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

use_queue_manager
  Type:

    boolean

  Default:

    `False`

  Should we use consistant queue names or random ones

hostname
  Type:

    string

  Default:

    `node1.example.com`

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

  Hostname used by queue manager. Defaults to the value returned by socket.gethostname().

processname
  Type:

    string

  Default:

    `nova-api`

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

  Process name used by queue manager

rabbit_stream_fanout
  Type:

    boolean

  Default:

    `False`

  Use stream queues in RabbitMQ (x-queue-type: stream). Streams are a new persistent and replicated data structure (“queue type”) in RabbitMQ which models an append-only log with non-destructive consumer semantics. It is available as of RabbitMQ 3.9.0. If set this option will replace all fanout queues with only one stream queue.

## oslo_middleware

max_request_body_size
  Type:

    integer

  Default:

    `114688`

  The maximum body size for each request, in bytes.

enable_proxy_headers_parsing
  Type:

    boolean

  Default:

    `False`

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

http_basic_auth_user_file
  Type:

    string

  Default:

    `/etc/htpasswd`

  HTTP basic auth password file.

## oslo_middleware_tracing

enabled
  Type:

    boolean

  Default:

    `False`

  Enable OpenTelemetry distributed tracing. When enabled, the service will export trace data via OTLP to a configured backend. This is the primary mechanism to control tracing for services that do not use paste deploy.

otlp_endpoint
  Type:

    URI

  Default:

    `http://localhost:4318`

  OTLP exporter endpoint URL. For HTTP/protobuf protocol, traces are sent to <endpoint>/v1/traces.

otlp_protocol
  Type:

    string

  Default:

    `http/protobuf`

  Valid Values:

    http/protobuf, grpc

  OTLP transport protocol.

  Possible values

  http/protobuf

    OTLP over HTTP with Protocol Buffers

  grpc

    OTLP over gRPC

service_name
  Type:

    string

  Default:

    `<None>`

  OpenTelemetry service name reported in trace data. This must be set when tracing is enabled, either via set_defaults() or in the configuration file.

sampling_rate
  Type:

    floating point

  Default:

    `1.0`

  Minimum Value:

    0.0

  Maximum Value:

    1.0

  Trace sampling rate as a float between 0.0 and 1.0. A value of 1.0 means all traces are sampled.

insecure
  Type:

    boolean

  Default:

    `False`

  Disable TLS verification for the OTLP endpoint. Set to True only in development environments without proper TLS certificates.

## oslo_policy

enforce_new_defaults
  Type:

    boolean

  Default:

    `True`

  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. If `False`, the deprecated policy check string is logically OR’d with the new policy check string, allowing for a graceful upgrade experience between releases with new policies, which is the default behavior.

policy_file
  Type:

    string

  Default:

    `policy.yaml`

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

policy_default_rule
  Type:

    string

  Default:

    `default`

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

policy_dirs
  Type:

    multi-valued

  Default:

    `policy.d`

  Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.

remote_content_type
  Type:

    string

  Default:

    `application/x-www-form-urlencoded`

  Valid Values:

    application/x-www-form-urlencoded, application/json

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

remote_ssl_verify_server_crt
  Type:

    boolean

  Default:

    `False`

  server identity verification for REST based policy check

remote_ssl_ca_crt_file
  Type:

    string

  Default:

    `<None>`

  Absolute path to ca cert file for REST based policy check

remote_ssl_client_crt_file
  Type:

    string

  Default:

    `<None>`

  Absolute path to client cert for REST based policy check

remote_ssl_client_key_file
  Type:

    string

  Default:

    `<None>`

  Absolute path client key file REST based policy check

remote_timeout
  Type:

    floating point

  Default:

    `60`

  Minimum Value:

    0

  Timeout in seconds for REST based policy check

## oslo_versionedobjects

fatal_exception_format_errors
  Type:

    boolean

  Default:

    `False`

  Make exception message format errors fatal

## process_failure

service_disable_reason
  Type:

    string

  Default:

    `Masakari detected process failed.`

  Compute disable reason in case Masakari detects process failure.

## ssl

ca_file
  Type:

    string

  Default:

    `<None>`

  CA certificate file to use to verify connecting clients.

  Warning

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

  Reason:

    The ‘ca_file’ option is deprecated and will be removed in a future release.

cert_file
  Type:

    string

  Default:

    `<None>`

  Certificate file to use when starting the server securely.

  Warning

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

  Reason:

    The ‘cert_file’ option is deprecated and will be removed in a future release.

key_file
  Type:

    string

  Default:

    `<None>`

  Private key file to use when starting the server securely.

  Warning

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

  Reason:

    The ‘key_file’ option is deprecated and will be removed in a future release.

version
  Type:

    string

  Default:

    `<None>`

  SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.

  Warning

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

  Reason:

    The ‘version’ option is deprecated and will be removed in a future release.

ciphers
  Type:

    string

  Default:

    `<None>`

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

  Warning

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

  Reason:

    The ‘ciphers’ option is deprecated and will be removed in a future release.

## taskflow

connection
  Type:

    string

  Default:

    `<None>`

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

## wsgi

api_paste_config
  Type:

    string

  Default:

    `api-paste.ini`

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

wsgi_log_format
  Type:

    string

  Default:

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

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

secure_proxy_ssl_header
  Type:

    string

  Default:

    `<None>`

  The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is “HTTP_X_FORWARDED_PROTO”.

  Warning

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

  Reason:

    The functionality of this parameter is duplicate of the http_proxy_to_wsgi middleware of oslo.middleware and will be completely replaced.

ssl_ca_file
  Type:

    string

  Default:

    `<None>`

  CA certificate file to use to verify connecting clients

ssl_cert_file
  Type:

    string

  Default:

    `<None>`

  SSL certificate of API server

ssl_key_file
  Type:

    string

  Default:

    `<None>`

  SSL private key of API server

tcp_keepidle
  Type:

    integer

  Default:

    `600`

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

default_pool_size
  Type:

    integer

  Default:

    `1000`

  Size of the pool of greenthreads used by wsgi

max_header_line
  Type:

    integer

  Default:

    `16384`

  Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).

keep_alive
  Type:

    boolean

  Default:

    `True`

  If False, closes the client socket connection explicitly.

client_socket_timeout
  Type:

    integer

  Default:

    `900`

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

this page last updated: 2026-08-19 12:48:40

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug