Configuration Reference¶
The following is an overview of all available configuration options in Mistral.
For a sample configuration file, refer to mistral.conf.
DEFAULT¶
-
use_debugger
¶ - Type
boolean
- Default
False
Enables debugger. Note that using this option changes how the eventlet library is used to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk.
-
server
¶ - Type
list
- Default
['all']
Specifies which mistral server to start by the launch script. Valid options are all or any combination of api, engine, and executor.
-
workflow_trace_log_name
¶ - Type
string
- Default
workflow_trace
Logger name for pretty workflow trace output.
-
auth_type
¶ - Type
string
- Default
keystone
Authentication type (valid options: keystone, keycloak-oidc)
-
scheduler_type
¶ - Type
string
- Default
legacy
- Valid Values
legacy, default
The name of the scheduler implementation used in the system.
-
js_implementation
¶ - Type
string
- Default
pyv8
- Valid Values
pyv8, v8eval, py_mini_racer
The JavaScript implementation to be used by the std.javascript action to evaluate scripts.
-
rpc_implementation
¶ - Type
string
- Default
oslo
- Valid Values
oslo, kombu
Specifies RPC implementation for RPC client and server. Support of kombu driver is experimental.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
Kombu driver is deprecated and will be removed in the F release cycle
-
oslo_rpc_executor
¶ - Type
string
- Default
threading
- Valid Values
eventlet, threading
Executor type used by Oslo Messaging framework. Defines how Oslo Messaging based RPC subsystem processes incoming calls.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
This option is going to be removed from oslo.messaging
-
expiration_token_duration
¶ - Type
integer
- Default
30
Window of seconds to determine whether the given token is about to expire.
-
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.
-
debug
¶ - Type
boolean
- Default
False
- Mutable
This option can be changed without restarting.
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
-
log_config_append
¶ - Type
string
- Default
<None>
- Mutable
This option can be changed without restarting.
The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).
Deprecated Variations¶ Group
Name
DEFAULT
log-config
DEFAULT
log_config
-
log_date_format
¶ - Type
string
- Default
%Y-%m-%d %H:%M:%S
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
-
log_file
¶ - Type
string
- Default
<None>
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
Deprecated Variations¶ Group
Name
DEFAULT
logfile
-
log_dir
¶ - Type
string
- Default
<None>
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Deprecated Variations¶ Group
Name
DEFAULT
logdir
-
watch_log_file
¶ - Type
boolean
- Default
False
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
This function is known to have bene broken for long time, and depends on the unmaintained library
-
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', '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.
-
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.
action_heartbeat¶
-
max_missed_heartbeats
¶ - Type
integer
- Default
15
- Minimum Value
0
The maximum amount of missed heartbeats to be allowed. If set to 0 then this feature is disabled. See check_interval for more details.
-
check_interval
¶ - Type
integer
- Default
20
- Minimum Value
0
How often (in seconds) action executions are checked. For example when check_interval is 10, check action executions every 10 seconds. When the checker runs it will transit all running action executions to error if the last heartbeat received is older than 10 * max_missed_heartbeats seconds. If set to 0 then this feature is disabled.
-
batch_size
¶ - Type
integer
- Default
10
- Minimum Value
0
The maximum number of action executions processed during one iteration of action execution heartbeat checker. If set to 0 then there is no limit.
-
first_heartbeat_timeout
¶ - Type
integer
- Default
3600
- Minimum Value
0
The first heartbeat is handled differently, to provide a grace period in case there is no available executor to handle the action execution. For example when first_heartbeat_timeout = 3600, wait 3600 seconds before closing the action executions that never received a heartbeat.
action_logging¶
-
hide_response_body
¶ - Type
boolean
- Default
False
If this value is set to True then HTTP action response body will be hidden in logs.
-
hide_request_body
¶ - Type
boolean
- Default
False
If this value is set to True then HTTP action request body will be hidden in logs.
-
sensitive_headers
¶ - Type
list
- Default
[]
List of sensitive headers that should be hidden in logs.
action_providers¶
-
allowlist
¶ - Type
list
- Default
[]
Allowlist with action providers that is allowed to be loaded from the entry point “mistral.action.providers”, if empty all action providers will be allowed unless denylist is set.
-
denylist
¶ - Type
list
- Default
[]
Denylist with action providers that is not allowed to be loaded from the entry point “mistral.action.providers”, allowlist takes precendence, if empty all action providers will be allowed.
api¶
-
host
¶ - Type
host address
- Default
0.0.0.0
Mistral API server host
-
port
¶ - Type
port number
- Default
8989
- Minimum Value
0
- Maximum Value
65535
Mistral API server port
-
allow_action_execution_deletion
¶ - Type
boolean
- Default
False
Enables the ability to delete action_execution which has no relationship with workflows.
-
enable_ssl_api
¶ - Type
boolean
- Default
False
Enable the integrated stand-alone API to service requests via HTTPS instead of HTTP.
-
api_workers
¶ - Type
integer
- Default
<None>
Number of workers for Mistral API service default is equal to the number of CPUs available if that can be determined, else a default worker count of 1 is returned.
-
validation_mode
¶ - Type
string
- Default
mandatory
- Valid Values
enabled, mandatory, disabled
Defines in what cases Mistral will be validating the syntax of workflow YAML definitions. If ‘enabled’ is set the service will be validating the syntax but only if it’s not explicitly turned off in the API request. ‘disabled’ disables validation for all API requests. ‘mandatory’ enables validation for all API requests.
-
enable_info_endpoint
¶ - Type
boolean
- Default
False
Enable API for exposing info json about current Mistral build.
-
info_json_file_path
¶ - Type
string
- Default
info.json
Specify the path to info json file which will be exposed via /info endpoint.
context_versioning¶
-
enabled
¶ - Type
boolean
- Default
True
If this value is set to True then Mistral will use versioning of context to improve results of context merging. This feature fixes some bugs with context merging but also slows down Mistral performance.
-
hash_version_keys
¶ - Type
boolean
- Default
True
If this value is set to True then Mistral will use md5 hashing for version keys to ensure this keys will be the same size. Disabling hashing could be useful for debug purposes, but avoid this in production, because it leads to excessive memory consumption.
cors¶
-
allowed_origin
¶ - Type
list
- Default
<None>
Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com
-
allow_credentials
¶ - Type
boolean
- Default
True
Indicate that the actual request can include user credentials
-
expose_headers
¶ - Type
list
- Default
['X-Auth-Token', 'X-Subject-Token', 'X-Service-Token', 'X-Project-Id', 'X-User-Name', 'X-Project-Name']
Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
-
max_age
¶ - Type
integer
- Default
3600
Maximum cache age of CORS preflight requests.
-
allow_methods
¶ - Type
list
- Default
['GET', 'PUT', 'POST', 'DELETE', 'PATCH']
Indicate which methods can be used during the actual request.
-
allow_headers
¶ - Type
list
- Default
['X-Auth-Token', 'X-Identity-Status', 'X-Roles', 'X-Service-Catalog', 'X-User-Id', 'X-Tenant-Id', 'X-Project-Id', 'X-User-Name', 'X-Project-Name']
Indicate which header field names may be used during the actual request.
cron_trigger¶
-
enabled
¶ - Type
boolean
- Default
True
If this value is set to False then the subsystem of cron triggers is disabled. Disabling cron triggers increases system performance.
-
execution_interval
¶ - Type
integer
- Default
1
- Minimum Value
1
This setting defines how frequently Mistral checks for cron triggers that need execution. By default this is every second which can lead to high system load. Increasing the number will reduce the load but also limit the minimum freqency. For example, a cron trigger can be configured to run every second but if the execution_interval is set to 60, it will only run once per minute.
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.
-
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¶m2=value2&…
engine¶
-
engine
¶ - Type
string
- Default
default
Mistral engine plugin
-
host
¶ - Type
host address
- Default
0.0.0.0
Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.
-
topic
¶ - Type
string
- Default
mistral_engine
The message topic that the engine listens on.
-
version
¶ - Type
string
- Default
1.0
The version of the engine.
-
execution_field_size_limit_kb
¶ - Type
integer
- Default
1024
The default maximum size in KB of large text fields of runtime execution objects. Use -1 for no limit.
-
execution_integrity_check_delay
¶ - Type
integer
- Default
20
A number of seconds since the last update of a task execution in RUNNING state after which Mistral will start checking its integrity, meaning that if all associated actions/workflows are finished its state will be restored automatically. If this property is set to a negative value Mistral will never be doing this check.
-
execution_integrity_check_batch_size
¶ - Type
integer
- Default
5
- Minimum Value
1
A number of task executions in RUNNING state that the execution integrity checker can process in a single iteration.
-
action_definition_cache_time
¶ - Type
integer
- Default
60
A number of seconds that indicates how long action definitions should be stored in the local cache.
-
start_subworkflows_via_rpc
¶ - Type
boolean
- Default
False
Enables starting subworkflows via RPC. Use “False” to start subworkflow within the same engine instance. Use “True” to start subworkflow via RPC to improve load balancing in case of several engine instances.
-
merge_strategy
¶ - Type
string
- Default
replace
- Valid Values
replace, merge
Merge strategy of data inside workflow execution. (replace, merge)
event_engine¶
-
host
¶ - Type
host address
- Default
0.0.0.0
Name of the event engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.
-
listener_pool_name
¶ - Type
host address
- Default
events
Name of the event engine’s listener pool. This can be an opaque identifier. It is used for identifying the group of event engine listeners in oslo.messaging.
-
topic
¶ - Type
string
- Default
mistral_event_engine
The message topic that the event engine listens on.
-
event_definitions_cfg_file
¶ - Type
string
- Default
/etc/mistral/event_definitions.yaml
Configuration file for event definitions.
execution_expiration_policy¶
-
evaluation_interval
¶ - Type
integer
- Default
<None>
How often will the executions be evaluated (in minutes). For example for value 120 the interval will be 2 hours (every 2 hours). Note that only final state executions will be removed: ( SUCCESS / ERROR / CANCELLED ).
-
older_than
¶ - Type
integer
- Default
<None>
Evaluate from which time remove executions in minutes. For example when older_than = 60, remove all executions that finished a 60 minutes ago or more. Minimum value is 1.
-
max_finished_executions
¶ - Type
integer
- Default
0
The maximum number of finished workflow executions to be stored. For example when max_finished_executions = 100, only the 100 latest finished executions will be preserved. This means that even unexpired executions are eligible for deletion, to decrease the number of executions in the database. The default value is 0. If it is set to 0, this constraint won’t be applied.
-
batch_size
¶ - Type
integer
- Default
0
Size of batch of expired executions to be deleted.The default value is 0. If it is set to 0, size of batch is total number of expired executions that is going to be deleted.
-
ignored_states
¶ - Type
list
- Default
[]
The states that the expiration policy will filter out and will not delete.Valid values are, [[‘CANCELLED’, ‘ERROR’, ‘SUCCESS’]]
executor¶
-
type
¶ - Type
string
- Default
remote
- Valid Values
local, remote
Type of executor. Use local to run the executor within the engine server. Use remote if the executor is launched as a separate server to run action executions.
-
host
¶ - Type
host address
- Default
0.0.0.0
Name of the executor node. This can be an any string name/identifier. It is not necessarily a hostname, FQDN, or IP address. It is also related to the “target” attribute of tasks defined in a workflow text. If “target” is defined for a task then the action of the task will be sent to one of the executors that have the same value in the “host” property.
-
topic
¶ - Type
string
- Default
mistral_executor
The message topic that the executor listens on.
-
version
¶ - Type
string
- Default
1.0
The version of the executor.
healthcheck¶
-
enabled
¶ - Type
boolean
- Default
False
Enable the health check endpoint at /healthcheck. Note that this is unauthenticated. More information is available at https://docs.openstack.org/oslo.middleware/latest/reference/healthcheck_plugins.html.
-
path
¶ - Type
string
- Default
/healthcheck
The path to respond to healtcheck requests on.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
-
detailed
¶ - Type
boolean
- Default
False
Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.
-
backends
¶ - Type
list
- Default
[]
Additional backends that can perform health checks and report that information back as part of a request.
-
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.
keycloak_oidc¶
-
auth_url
¶ - Type
string
- Default
<None>
Keycloak base url (e.g. https://my.keycloak:8443/auth)
-
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
If True, SSL/TLS certificate verification is disabled
-
user_info_endpoint_url
¶ - Type
string
- Default
/realms/%s/protocol/openid-connect/userinfo
Endpoint against which authorization will be performed
-
public_cert_url
¶ - Type
string
- Default
/realms/%s/protocol/openid-connect/certs
URL to get the public key for a particular realm
-
keycloak_iss
¶ - Type
string
- Default
<None>
Keycloak issuer(iss) url. Example: https://ip_add:port/auth/realms/{‘default’: ‘the value above’}
keystone_authtoken¶
-
www_authenticate_uri
¶ - Type
string
- Default
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.
Deprecated Variations¶ Group
Name
keystone_authtoken
auth_uri
-
auth_uri
¶ - Type
string
- Default
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
Warning
This option is deprecated for removal since Queens. Its value may be silently ignored in the future.
- Reason
The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
-
auth_version
¶ - Type
string
- Default
<None>
API version of the Identity API endpoint.
-
interface
¶ - Type
string
- Default
internal
Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.
-
delay_auth_decision
¶ - Type
boolean
- Default
False
Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
-
http_connect_timeout
¶ - Type
integer
- Default
<None>
Request timeout value for communicating with Identity API server.
-
http_request_max_retries
¶ - Type
integer
- Default
3
How many times are we trying to reconnect when communicating with Identity API Server.
-
cache
¶ - Type
string
- Default
<None>
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the
memcached_servers
option instead.
-
certfile
¶ - Type
string
- Default
<None>
Required if identity server requires client certificate
-
keyfile
¶ - Type
string
- Default
<None>
Required if identity server requires client certificate
-
cafile
¶ - Type
string
- Default
<None>
A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
-
insecure
¶ - Type
boolean
- Default
False
Verify HTTPS connections.
-
region_name
¶ - Type
string
- Default
<None>
The region in which the identity server can be found.
-
memcached_servers
¶ - Type
list
- Default
<None>
Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Deprecated Variations¶ Group
Name
keystone_authtoken
memcache_servers
-
token_cache_time
¶ - Type
integer
- Default
300
In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
-
memcache_security_strategy
¶ - Type
string
- Default
None
- Valid Values
None, MAC, ENCRYPT
(Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
-
memcache_secret_key
¶ - Type
string
- Default
<None>
(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
-
memcache_pool_dead_retry
¶ - Type
integer
- Default
300
(Optional) Number of seconds memcached server is considered dead before it is tried again.
-
memcache_pool_maxsize
¶ - Type
integer
- Default
10
(Optional) Maximum total number of open connections to every memcached server.
-
memcache_pool_socket_timeout
¶ - Type
integer
- Default
3
(Optional) Socket timeout in seconds for communicating with a memcached server.
-
memcache_pool_unused_timeout
¶ - Type
integer
- Default
60
(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
-
memcache_pool_conn_get_timeout
¶ - Type
integer
- Default
10
(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
-
memcache_use_advanced_pool
¶ - Type
boolean
- Default
True
(Optional) Use the advanced (eventlet safe) memcached client pool.
-
include_service_catalog
¶ - Type
boolean
- Default
True
(Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
-
enforce_token_bind
¶ - Type
string
- Default
permissive
Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
-
service_token_roles
¶ - Type
list
- Default
['service']
A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.
-
service_token_roles_required
¶ - Type
boolean
- Default
False
For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.
-
service_type
¶ - Type
string
- Default
<None>
The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules.
-
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
legacy_action_provider¶
-
load_action_plugins
¶ - Type
boolean
- Default
True
If True, enables loading actions configured in the entry point “mistral.actions”.
-
load_action_generators
¶ - Type
boolean
- Default
True
If True, enables loading actions from action generators configured in the entry point “mistral.generators”.
-
only_builtin_actions
¶ - Type
boolean
- Default
False
If True, then the legacy action provider loads only the actions delivered by the Mistral project out of the box plugged in with the entry point “mistral.actions”.This property is needed mostly for testing.
-
allowlist
¶ - Type
list
- Default
[]
Allowlist with actions that is allowed to be loaded from the entry point “mistral.actions”, if empty all actions will be allowed.
-
denylist
¶ - Type
list
- Default
[]
Denylist with actions that is not allowed to be loaded from the entry point “mistral.actions”, allowlist takes precedence, if empty all actions will be allowed.
notifier¶
-
type
¶ - Type
string
- Default
remote
- Valid Values
local, remote
Type of notifier. Use local to run the notifier within the engine server. Use remote if the notifier is launched as a separate server to process events.
-
host
¶ - Type
string
- Default
0.0.0.0
Name of the notifier node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.
-
topic
¶ - Type
string
- Default
mistral_notifier
The message topic that the notifier server listens on.
-
notify
¶ - Type
list
- Default
<None>
List of publishers to publish notification.
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_fips_mode
¶ - Type
boolean
- Default
False
Global toggle for enforcing the OpenSSL FIPS mode. This feature requires Python support. This is available in Python 3.9 in all environments and may have been backported to older Python versions on select environments. If the Python executable used does not support OpenSSL FIPS mode, an exception will be raised.
-
heartbeat_in_pthread
¶ - Type
boolean
- Default
False
(DEPRECATED) It is recommend not to use this option anymore. 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.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
The option is related to Eventlet which will be removed. In addition this has never worked as expected with services using eventlet for core service framework.
-
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.
Deprecated Variations¶ Group
Name
oslo_messaging_rabbit
rabbit_quroum_max_memory_length
-
rabbit_quorum_max_memory_bytes
¶ - Type
integer
- Default
0
By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.
Deprecated Variations¶ Group
Name
oslo_messaging_rabbit
rabbit_quroum_max_memory_bytes
-
rabbit_transient_queues_ttl
¶ - Type
integer
- Default
1800
- Minimum Value
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¶
-
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.
oslo_policy¶
-
enforce_scope
¶ - Type
boolean
- Default
True
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 thescope_types
of the policy being enforced. If the scopes do not match, anInvalidScope
exception will be raised. IfFalse
, a message will be logged informing operators that policies are being invoked with mismatching scope.Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
This configuration was added temporarily to facilitate a smooth transition to the new RBAC. OpenStack will always enforce scope checks. This configuration option is deprecated and will be removed in the 2025.2 cycle.
-
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. It is encouraged to enable this flag along with theenforce_scope
flag so that you can get the benefits of new defaults andscope_type
together. IfFalse
, 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
pecan¶
-
root
¶ - Type
string
- Default
mistral.api.controllers.root.RootController
Pecan root controller
-
modules
¶ - Type
list
- Default
['mistral.api']
A list of modules where pecan will search for applications.
-
debug
¶ - Type
boolean
- Default
False
Enables the ability to display tracebacks in the browser and interactively debug during development.
-
auth_enable
¶ - Type
boolean
- Default
True
Enables user authentication in pecan.
profiler¶
-
enabled
¶ - Type
boolean
- Default
False
Enable the profiling for all services on this node.
Default value is False (fully disable the profiling feature).
Possible values:
True: Enables the feature
False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
Deprecated Variations¶ Group
Name
profiler
profiler_enabled
-
trace_sqlalchemy
¶ - Type
boolean
- Default
False
Enable SQL requests profiling in services.
Default value is False (SQL requests won’t be traced).
Possible values:
True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that.
False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.
-
trace_requests
¶ - Type
boolean
- Default
False
Enable python requests package profiling.
Supported drivers: jaeger+otlp
Default value is False.
Possible values:
True: Enables requests profiling.
False: Disables requests profiling.
-
hmac_keys
¶ - Type
string
- Default
SECRET_KEY
Secret key(s) to use for encrypting context data for performance profiling.
This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project.
Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
-
connection_string
¶ - Type
string
- Default
messaging://
Connection string for a notifier backend.
Default value is
messaging://
which sets the notifier to oslo_messaging.Examples of possible values:
messaging://
- use oslo_messaging driver for sending spans.redis://127.0.0.1:6379
- use redis driver for sending spans.mongodb://127.0.0.1:27017
- use mongodb driver for sending spans.elasticsearch://127.0.0.1:9200
- use elasticsearch driver for sending spans.jaeger://127.0.0.1:6831
- use jaeger tracing as driver for sending spans.
-
es_doc_type
¶ - Type
string
- Default
notification
Document type for notification indexing in elasticsearch.
-
es_scroll_time
¶ - Type
string
- Default
2m
This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.
-
es_scroll_size
¶ - Type
integer
- Default
10000
Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).
-
socket_timeout
¶ - Type
floating point
- Default
0.1
Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).
-
sentinel_service_name
¶ - Type
string
- Default
mymaster
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example:
sentinal_service_name=mymaster
).
-
filter_error_trace
¶ - Type
boolean
- Default
False
Enable filter traces that contain error/exception to a separated place.
Default value is set to False.
Possible values:
True: Enable filter traces that contain error/exception.
False: Disable the filter.
-
profiler_log_name
¶ - Type
string
- Default
profiler_trace
Logger name for the osprofiler trace output.
scheduler¶
-
fixed_delay
¶ - Type
floating point
- Default
1
- Minimum Value
0.1
Fixed part of the delay between scheduler iterations, in seconds. Full delay is defined as a sum of “fixed_delay” and a random delay limited by “random_delay”.
-
random_delay
¶ - Type
floating point
- Default
0
- Minimum Value
0
Max value of the random part of the delay between scheduler iterations, in seconds. Full delay is defined as a sum of “fixed_delay” and a random delay limited by this property.
-
batch_size
¶ - Type
integer
- Default
<None>
- Minimum Value
1
The max number of delayed calls will be selected during a scheduler iteration. If this property equals None then there is no restriction on selection.
-
captured_job_timeout
¶ - Type
floating point
- Default
30
- Minimum Value
1
Defines how soon (in seconds) a scheduled job captured for processing becomes eligible for capturing by other schedulers again. This option is needed to prevent situations when a scheduler instance captured a job and failed while processing and so this job can never be processed again because it is marked as captured.
-
pickup_job_after
¶ - Type
floating point
- Default
60
- Minimum Value
1
Time period given to a scheduler to process a scheduled job locally before it becomes eligible for processing by other scheduler instances.For example, a job needs to run at 12:00:00. When a scheduler starts processing it has 60 seconds (or other configured value) to complete the job. If the scheduler did not complete the job within this period it most likely means that the scheduler process crashed. In this case another scheduler instance will pick it up from the Job Store, but not earlier than 12:01:00 and try to process it.
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.
yaql¶
-
limit_iterators
¶ - Type
integer
- Default
-1
- Minimum Value
-1
Limit iterators by the given number of elements. When set, each time any function declares its parameter to be iterator, that iterator is modified to not produce more than a given number of items. If not set (or set to -1) the result data is allowed to contain endless iterators that would cause errors if the result where to be serialized.
-
memory_quota
¶ - Type
integer
- Default
-1
- Minimum Value
-1
The memory usage quota (in bytes) for all data produced by the expression (or any part of it). -1 means no limitation.
-
convert_input_data
¶ - Type
boolean
- Default
True
Enables input data conversion for YAQL expressions. If set to True, YAQL will convert mutable data structures (lists, dicts, sets) into their immutable versions. That will allow them to work with some constructs that require hashable types even if elements are not hashable. For example, it will be possible to put dicts into a set. Although it conflicts with the base principles of such collections (e.g. we cannot put a non-hashable type into a set just because otherwise it will not work correctly) the YAQL library itself allows this. Disabling input data conversion may give significant performance boost if the input data for an expression is large.
-
convert_output_data
¶ - Type
boolean
- Default
True
Enables output data conversion for YAQL expressions.If set to False, it is possible that YAQL will generate an output that will be not JSON-serializable. For example, if an expression has “.toSet()” in the end to convert a list into a set. It does not mean though that such functions cannot be used, they can still be used in expressions but user has to keep in mind of what type a result will be, whereas if the value of ths property is True YAQL will convert the result to a JSON-compatible type.
-
convert_tuples_to_lists
¶ - Type
boolean
- Default
True
When set to True, yaql converts all tuples in the expression result to lists. It works only if “convert_output_data” is set to True.
-
convert_sets_to_lists
¶ - Type
boolean
- Default
False
When set to True, yaql converts all sets in the expression result to lists. Otherwise the produced result may contain sets that are not JSON-serializable. It works only if “convert_output_data” is set to True.
-
iterable_dicts
¶ - Type
boolean
- Default
False
When set to True, dictionaries are considered to be iterable and iteration over dictionaries produces their keys (as in Python and yaql 0.2).
-
keyword_operator
¶ - Type
string
- Default
=>
Allows one to configure keyword/mapping symbol. Ability to pass named arguments can be disabled altogether if empty string is provided.
-
allow_delegates
¶ - Type
boolean
- Default
False
Enables or disables delegate expression parsing.