The following is an overview of all available configuration options in Masakari.
For a sample configuration file, refer to Masakari Configuration Options.
string
keystone
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
boolean
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
integer
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
string
<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
string
<None>
Explicitly specify the temporary working directory.
boolean
False
Determine if monkey patching should be applied.
Related options:
monkey_patch_modules
: This must have values set for this option to haveany effect
list
['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 toTrue
for this option to have any effect
string
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.
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.
integer
180
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.
integer
180
Number of seconds to wait after a service is enabled or disabled.
integer
90
Wait until instance is evacuated
integer
1
The monitoring interval for looping
integer
180
Number of seconds to wait for instance to shut down
integer
60
Number of seconds to wait for instance to start
integer
120
Interval in seconds for processing notifications which are in error or new state.
integer
60
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.
integer
600
Interval in seconds for checking running notifications.
integer
86400
Interval in seconds for identifying running notifications expired.
integer
3
1
Number of threads to be used for evacuating and confirming instances during execution of host_failure workflow.
string
taskflow_driver
Defines which driver to use for executing notification workflows.
boolean
False
Make exception message format errors fatal
string
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>
string
<None>
Region name of this node
string
<None>
Location of ca certificates file to use for nova client requests.
boolean
False
Allow to perform insecure SSL requests to nova
string
<None>
OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.
string
<None>
Password associated with the OpenStack privileged account.
string
<None>
Tenant name associated with the OpenStack privileged account.
URI
<None>
Auth URL associated with the OpenStack privileged account.
string
default
User domain name associated with the OpenStack privileged account.
string
default
Project domain name associated with the OpenStack privileged account.
string
<None>
Scope for system operations.
string
/build/reproducible-path/masakari-15.0.0
Directory where the masakari python module is installed
string
/usr/local/bin
Directory where masakari binaries are installed
string
$pybasedir
Top-level directory for maintaining masakari’s state
host address
x86-csail-02
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.
string
masakari.engine.manager.MasakariManager
Full class name for the Manager for masakari engine
integer
10
Seconds between nodes reporting state to datastore
boolean
True
Enable periodic tasks
integer
300
Max interval time between periodic tasks execution in seconds.
integer
60
Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
boolean
False
Use APIs with SSL enabled
host address
0.0.0.0
The IP address on which the Masakari API will listen.
integer
15868
1
65535
The port on which the Masakari API will listen.
integer
<None>
Number of workers for Masakari API service. The default will be the number of CPUs available.
integer
60
Maximum time since last check-in for up service
integer
30
1
Size of RPC connection pool.
Group |
Name |
---|---|
DEFAULT |
rpc_conn_pool_size |
integer
2
The pool size limit for connections expiration policy
integer
1200
The time-to-live in sec of idle connections in the pool
integer
64
Size of executor thread pool when executor is threading or eventlet.
Group |
Name |
---|---|
DEFAULT |
rpc_thread_pool_size |
integer
60
Seconds to wait for a response from a call.
string
rabbit://
The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:
driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
Example: rabbit://rabbitmq:password@127.0.0.1:5672//
For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html
string
openstack
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
boolean
False
Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping
string
<None>
Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.
string
<None>
Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.
boolean
True
Enables or disables logging values of all registered options when starting a service (at DEBUG level).
integer
60
Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.
string
api-paste.ini
File name for the paste.deploy config for api service
string
%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f
A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
integer
600
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
integer
100
Size of the pool of greenthreads used by wsgi
integer
16384
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).
boolean
True
If False, closes the client socket connection explicitly.
integer
900
Timeout for client connections’ socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of ‘0’ means wait forever.
boolean
False
True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.
boolean
False
This option can be changed without restarting.
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
string
<None>
This option can be changed without restarting.
The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).
Group |
Name |
---|---|
DEFAULT |
log-config |
DEFAULT |
log_config |
string
%Y-%m-%d %H:%M:%S
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
string
<None>
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
Group |
Name |
---|---|
DEFAULT |
logfile |
string
<None>
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Group |
Name |
---|---|
DEFAULT |
logdir |
boolean
False
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
boolean
False
Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
boolean
False
Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.
string
LOG_USER
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
boolean
False
Use JSON formatting for logging. This option is ignored if log_config_append is set.
boolean
False
Log output to standard error. This option is ignored if log_config_append is set.
boolean
False
Log output to Windows Event Log.
integer
1
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.
string
days
Seconds, Minutes, Hours, Days, Weekday, Midnight
Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.
integer
30
Maximum number of rotated log files.
integer
200
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
string
none
interval, size, none
Log rotation type.
Possible values
Rotate logs at predefined time intervals.
Rotate logs once they reach a predefined size.
Do not rotate log files.
string
%(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
string
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter
string
%(funcName)s %(pathname)s:%(lineno)d
Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter
string
%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter
string
%(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
list
['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=INFO', 'oslo_messaging=INFO', 'iso8601=WARN', 'requests.packages.urllib3.connectionpool=WARN', 'urllib3.connectionpool=WARN', 'websocket=WARN', 'requests.packages.urllib3.util.retry=WARN', 'urllib3.util.retry=WARN', 'keystonemiddleware=WARN', 'routes.middleware=WARN', 'stevedore=WARN', 'taskflow=WARN', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']
List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
boolean
False
Enables or disables publication of error events.
string
"[instance: %(uuid)s] "
The format for an instance that is passed with the log message.
string
"[instance: %(uuid)s] "
The format for an instance UUID that is passed with the log message.
integer
0
Interval, number of seconds, of log rate limiting.
integer
0
Maximum number of logged messages per rate_limit_interval.
string
CRITICAL
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
boolean
False
Enables or disables fatal status of deprecations.
string
<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.
list
<None>
Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com
boolean
True
Indicate that the actual request can include user credentials
list
[]
Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
integer
3600
Maximum cache age of CORS preflight requests.
list
['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'PATCH']
Indicate which methods can be used during the actual request.
list
[]
Indicate which header field names may be used during the actual request.
boolean
True
If True, SQLite uses synchronous mode.
Group |
Name |
---|---|
DEFAULT |
sqlite_synchronous |
string
sqlalchemy
The back end to use for the database.
Group |
Name |
---|---|
DEFAULT |
db_backend |
string
<None>
The SQLAlchemy connection string to use to connect to the database.
Group |
Name |
---|---|
DEFAULT |
sql_connection |
DATABASE |
sql_connection |
sql |
connection |
string
<None>
The SQLAlchemy connection string to use to connect to the slave database.
string
TRADITIONAL
The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
integer
<None>
For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting.
boolean
False
If True, transparently enables support for handling MySQL Cluster (NDB).
Warning
This option is deprecated for removal since 12.1.0. Its value may be silently ignored in the future.
Support for the MySQL NDB Cluster storage engine has been deprecated and will be removed in a future release.
integer
3600
Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.
integer
5
Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.
integer
10
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
Group |
Name |
---|---|
DEFAULT |
sql_max_retries |
DATABASE |
sql_max_retries |
integer
10
Interval between retries of opening a SQL connection.
Group |
Name |
---|---|
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
integer
50
If set, use this value for max_overflow with SQLAlchemy.
Group |
Name |
---|---|
DEFAULT |
sql_max_overflow |
DATABASE |
sqlalchemy_max_overflow |
integer
0
0
100
Verbosity of SQL debugging information: 0=None, 100=Everything.
Group |
Name |
---|---|
DEFAULT |
sql_connection_debug |
boolean
False
Add Python stack traces to SQL as comment strings.
Group |
Name |
---|---|
DEFAULT |
sql_connection_trace |
integer
<None>
If set, use this value for pool_timeout with SQLAlchemy.
Group |
Name |
---|---|
DATABASE |
sqlalchemy_pool_timeout |
boolean
False
Enable the experimental use of database reconnect on connection lost.
integer
1
Seconds between retries of a database transaction.
boolean
True
If True, increases the interval between retries of a database operation up to db_max_retry_interval.
integer
10
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
integer
20
Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
string
''
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…
boolean
False
Enable the experimental use of thread pooling for all DB API calls
Group |
Name |
---|---|
DEFAULT |
dbapi_use_tpool |
Warning
This option is deprecated for removal since 10.0.0. Its value may be silently ignored in the future.
This feature has never graduated from experimental status and is now being removed due to lack of maintenance and test coverage
string
/healthcheck
The path to respond to healtcheck requests on.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
boolean
False
Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.
list
[]
Additional backends that can perform health checks and report that information back as part of a request.
string
<None>
Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.
list
[]
Check the presence of a file based on a port to determine if an application is running on a port. Expects a “port:path” list of strings. Used by DisableByFilesPortsHealthcheck plugin.
boolean
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
.
string
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.
boolean
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.
boolean
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.
string
Masakari detected host failed.
Compute disable reason in case Masakari detects host failure.
boolean
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
.
string
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.
string
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.
Group |
Name |
---|---|
keystone_authtoken |
auth_uri |
string
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
Warning
This option is deprecated for removal since Queens. Its value may be silently ignored in the future.
The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
string
<None>
API version of the Identity API endpoint.
string
internal
Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.
boolean
False
Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
integer
<None>
Request timeout value for communicating with Identity API server.
integer
3
How many times are we trying to reconnect when communicating with Identity API Server.
string
<None>
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the memcached_servers
option instead.
string
<None>
Required if identity server requires client certificate
string
<None>
Required if identity server requires client certificate
string
<None>
A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
boolean
False
Verify HTTPS connections.
string
<None>
The region in which the identity server can be found.
list
<None>
Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Group |
Name |
---|---|
keystone_authtoken |
memcache_servers |
integer
300
In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
string
None
None, MAC, ENCRYPT
(Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
string
<None>
(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
integer
300
(Optional) Number of seconds memcached server is considered dead before it is tried again.
integer
10
(Optional) Maximum total number of open connections to every memcached server.
integer
3
(Optional) Socket timeout in seconds for communicating with a memcached server.
integer
60
(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
integer
10
(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
boolean
True
(Optional) Use the advanced (eventlet safe) memcached client pool.
boolean
True
(Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
string
permissive
Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
list
['service']
A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.
boolean
False
For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.
string
<None>
The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules.
unknown type
<None>
Authentication type to load
Group |
Name |
---|---|
keystone_authtoken |
auth_plugin |
unknown type
<None>
Config Section from which to load plugin specific options
list
[]
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
Group |
Name |
---|---|
osapi_v1 |
extensions_blacklist |
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
list
[]
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
Group |
Name |
---|---|
osapi_v1 |
extensions_whitelist |
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
string
<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
Group |
Name |
---|---|
osapi_v1 |
project_id_regex |
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
string
<None>
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
Group |
Name |
---|---|
amqp1 |
container_name |
integer
0
Timeout for inactive connections (in seconds)
Group |
Name |
---|---|
amqp1 |
idle_timeout |
boolean
False
Debug: dump AMQP frames to stdout
Group |
Name |
---|---|
amqp1 |
trace |
boolean
False
Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.
string
''
CA certificate PEM file used to verify the server’s certificate
Group |
Name |
---|---|
amqp1 |
ssl_ca_file |
string
''
Self-identifying certificate PEM file for client authentication
Group |
Name |
---|---|
amqp1 |
ssl_cert_file |
string
''
Private key PEM file used to sign ssl_cert_file certificate (optional)
Group |
Name |
---|---|
amqp1 |
ssl_key_file |
string
<None>
Password for decrypting ssl_key_file (if encrypted)
Group |
Name |
---|---|
amqp1 |
ssl_key_password |
boolean
False
By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.
string
''
Space separated list of acceptable SASL mechanisms
Group |
Name |
---|---|
amqp1 |
sasl_mechanisms |
string
''
Path to directory that contains the SASL configuration
Group |
Name |
---|---|
amqp1 |
sasl_config_dir |
string
''
Name of configuration file (without .conf suffix)
Group |
Name |
---|---|
amqp1 |
sasl_config_name |
string
''
SASL realm to use if no realm present in username
integer
1
1
Seconds to pause before attempting to re-connect.
integer
2
0
Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
integer
30
1
Maximum limit for connection_retry_interval + connection_retry_backoff
integer
10
1
Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
integer
0
-1
The maximum number of attempts to re-send a reply message which failed due to a recoverable error.
integer
30
5
The deadline for an rpc reply message delivery.
integer
30
5
The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
integer
30
5
The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
integer
600
1
The duration to schedule a purge of idle sender links. Detach link after expiry.
string
dynamic
Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing
boolean
True
Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.
string
exclusive
address prefix used when sending to a specific server
Group |
Name |
---|---|
amqp1 |
server_request_prefix |
string
broadcast
address prefix used when broadcasting to all servers
Group |
Name |
---|---|
amqp1 |
broadcast_prefix |
string
unicast
address prefix when sending to any server in group
Group |
Name |
---|---|
amqp1 |
group_request_prefix |
string
openstack.org/om/rpc
Address prefix for all generated RPC addresses
string
openstack.org/om/notify
Address prefix for all generated Notification addresses
string
multicast
Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
string
unicast
Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.
string
anycast
Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.
string
<None>
Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’
string
<None>
Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’
integer
200
1
Window size for incoming RPC Reply messages.
integer
100
1
Window size for incoming RPC Request messages
integer
100
1
Window size for incoming Notification messages
multi-valued
rpc-cast
rpc-reply
Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ‘rpc-call’ - send RPC Calls pre-settled ‘rpc-reply’- send RPC Replies pre-settled ‘rpc-cast’ - Send RPC Casts pre-settled ‘notify’ - Send Notifications pre-settled
integer
1048576
Max fetch bytes of Kafka consumer
floating point
1.0
Default timeout(s) for Kafka consumers
integer
10
Pool Size for Kafka Consumers
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Driver no longer uses connection pool.
integer
2
The pool size limit for connections expiration policy
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Driver no longer uses connection pool.
integer
1200
The time-to-live in sec of idle connections in the pool
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Driver no longer uses connection pool.
string
oslo_messaging_consumer
Group id for Kafka consumer. Consumers in one group will coordinate message consumption
floating point
0.0
Upper bound on the delay for KafkaProducer batching in seconds
integer
16384
Size of batch for the producer async send
string
none
none, gzip, snappy, lz4, zstd
The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version
boolean
False
Enable asynchronous consumer commits
integer
500
The maximum number of records returned in a poll call
string
PLAINTEXT
PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL
Protocol used to communicate with brokers
string
PLAIN
Mechanism when security protocol is SASL
string
''
CA certificate PEM file used to verify the server certificate
string
''
Client certificate PEM file used for authentication.
string
''
Client key PEM file used for authentication.
string
''
Client key password file used for authentication.
multi-valued
''
The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
Group |
Name |
---|---|
DEFAULT |
notification_driver |
string
<None>
A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
Group |
Name |
---|---|
DEFAULT |
notification_transport_url |
list
['notifications']
AMQP topic used for OpenStack notifications.
Group |
Name |
---|---|
rpc_notifier2 |
topics |
DEFAULT |
notification_topics |
integer
-1
The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite
boolean
False
Use durable queues in AMQP. If rabbit_quorum_queue is enabled, queues will be durable and this value will be ignored.
boolean
False
Auto-delete queues in AMQP.
Group |
Name |
---|---|
DEFAULT |
amqp_auto_delete |
boolean
False
Connect over SSL.
Group |
Name |
---|---|
oslo_messaging_rabbit |
rabbit_use_ssl |
string
''
SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_version |
string
''
SSL key file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_keyfile |
string
''
SSL cert file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_certfile |
string
''
SSL certification authority file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_ca_certs |
boolean
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.
boolean
False
Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. This option should be set to True only for the wsgi services.
floating point
1.0
How long to wait before reconnecting in response to an AMQP consumer cancel notification.
Group |
Name |
---|---|
DEFAULT |
kombu_reconnect_delay |
string
<None>
EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.
integer
60
How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_reconnect_timeout |
string
round-robin
round-robin, shuffle
Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.
string
AMQPLAIN
PLAIN, AMQPLAIN, EXTERNAL, RABBIT-CR-DEMO
The RabbitMQ login method.
Group |
Name |
---|---|
DEFAULT |
rabbit_login_method |
integer
1
How frequently to retry connecting with RabbitMQ.
integer
2
How long to backoff for between retries when connecting to RabbitMQ.
Group |
Name |
---|---|
DEFAULT |
rabbit_retry_backoff |
integer
30
Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
boolean
False
Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “
Group |
Name |
---|---|
DEFAULT |
rabbit_ha_queues |
boolean
False
Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum queue is a modern queue type for RabbitMQ implementing a durable, replicated FIFO queue based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. If set this option will conflict with the HA queues (rabbit_ha_queues
) aka mirrored queues, in other words the HA queues should be disabled, quorum queues durable by default so the amqp_durable_queues opion is ignored when this option enabled.
integer
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.
integer
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.
integer
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.
integer
1800
1
Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.
integer
0
Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
integer
60
Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).
integer
2
How often times during the heartbeat_timeout_threshold we check the heartbeat.
boolean
True
(DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply, so the MessageUndeliverable exception is raised in case the client queue does not exist.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Mandatory flag no longer deactivable.
boolean
False
Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down
integer
114688
The maximum body size for each request, in bytes.
Group |
Name |
---|---|
DEFAULT |
osapi_max_request_body_size |
DEFAULT |
max_request_body_size |
string
X-Forwarded-Proto
The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
boolean
False
Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
string
/etc/htpasswd
HTTP basic auth password file.
boolean
False
This option controls whether or not to enforce scope when evaluating policies. If True
, the scope of the token used in the request is compared to the scope_types
of the policy being enforced. If the scopes do not match, an InvalidScope
exception will be raised. If False
, a message will be logged informing operators that policies are being invoked with mismatching scope.
boolean
False
This option controls whether or not to use old deprecated defaults when evaluating policies. If True
, the old deprecated defaults are not going to be evaluated. This means if any existing token is allowed for old defaults but is disallowed for new defaults, it will be disallowed. It is encouraged to enable this flag along with the enforce_scope
flag so that you can get the benefits of new defaults and scope_type
together. 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.
string
policy.yaml
The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option.
Group |
Name |
---|---|
DEFAULT |
policy_file |
string
default
Default rule. Enforced when a requested rule is not found.
Group |
Name |
---|---|
DEFAULT |
policy_default_rule |
multi-valued
policy.d
Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
Group |
Name |
---|---|
DEFAULT |
policy_dirs |
string
application/x-www-form-urlencoded
application/x-www-form-urlencoded, application/json
Content Type to send and receive data for REST based policy check
boolean
False
server identity verification for REST based policy check
string
<None>
Absolute path to ca cert file for REST based policy check
string
<None>
Absolute path to client cert for REST based policy check
string
<None>
Absolute path client key file REST based policy check
boolean
False
Make exception message format errors fatal
string
Masakari detected process failed.
Compute disable reason in case Masakari detects process failure.
string
<None>
CA certificate file to use to verify connecting clients.
Group |
Name |
---|---|
DEFAULT |
ssl_ca_file |
string
<None>
Certificate file to use when starting the server securely.
Group |
Name |
---|---|
DEFAULT |
ssl_cert_file |
string
<None>
Private key file to use when starting the server securely.
Group |
Name |
---|---|
DEFAULT |
ssl_key_file |
string
<None>
SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
string
<None>
Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.
string
<None>
The SQLAlchemy connection string to use to connect to the taskflow database.
string
api-paste.ini
File name for the paste.deploy config for masakari-api
Group |
Name |
---|---|
DEFAULT |
api_paste_config |
string
%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f
A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
Group |
Name |
---|---|
DEFAULT |
wsgi_log_format |
string
<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”.
Group |
Name |
---|---|
DEFAULT |
secure_proxy_ssl_header |
string
<None>
CA certificate file to use to verify connecting clients
Group |
Name |
---|---|
DEFAULT |
ssl_ca_file |
string
<None>
SSL certificate of API server
Group |
Name |
---|---|
DEFAULT |
ssl_cert_file |
string
<None>
SSL private key of API server
Group |
Name |
---|---|
DEFAULT |
ssl_key_file |
integer
600
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
Group |
Name |
---|---|
DEFAULT |
tcp_keepidle |
integer
1000
Size of the pool of greenthreads used by wsgi
Group |
Name |
---|---|
DEFAULT |
wsgi_default_pool_size |
integer
16384
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
Group |
Name |
---|---|
DEFAULT |
max_header_line |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.