Configuration options for the Orchestration service¶
The following options can be set in the /etc/heat/heat.conf config file.
A sample configuration file is also available.
DEFAULT¶
- host¶
- Type
string
- Default
<Hostname>
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.
- plugin_dirs¶
- Type
list
- Default
['/usr/lib64/heat', '/usr/lib/heat', '/usr/local/lib/heat', '/usr/local/lib64/heat']
List of directories to search for plug-ins.
- environment_dir¶
- Type
string
- Default
/etc/heat/environment.d
The directory to search for environment files.
- template_dir¶
- Type
string
- Default
/etc/heat/templates
The directory to search for template files.
- deferred_auth_method¶
- Type
string
- Default
trusts- Valid Values
password, trusts
Select deferred auth method, stored password or trusts.
Warning
This option is deprecated for removal since 9.0.0. Its value may be silently ignored in the future.
- Reason
Stored password based deferred auth is broken when used with keystone v3 and is not supported.
- reauthentication_auth_method¶
- Type
string
- Default
''- Valid Values
‘’, trusts
Allow reauthentication on token expiry, such that long-running tasks may complete. Note this defeats the expiry of any provided user tokens.
- allow_trusts_redelegation¶
- Type
boolean
- Default
False
Create trusts with redelegation enabled. This option is only used when reauthentication_auth_method is set to “trusts”. Note that enabling this option does have security implications as all trusts created by Heat will use both impersonation and redelegation enabled. Enable it only when there are other services that need to create trusts from tokens Heat uses to access them, examples are Aodh and Heat in another region when configured to use trusts too.
- trusts_delegated_roles¶
- Type
list
- Default
[]
Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack.
- max_resources_per_stack¶
- Type
integer
- Default
1000
Maximum resources allowed per top-level stack. -1 stands for unlimited.
- max_stacks_per_tenant¶
- Type
integer
- Default
512
Maximum number of stacks any one tenant may have active at one time. -1 stands for unlimited.
- action_retry_limit¶
- Type
integer
- Default
5
Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries.
- client_retry_limit¶
- Type
integer
- Default
2
Number of times to retry when a client encounters an expected intermittent error. Set to 0 to disable retries.
- max_server_name_length¶
- Type
integer
- Default
53- Maximum Value
53
Maximum length of a server name to be used in nova.
- max_interface_check_attempts¶
- Type
integer
- Default
10- Minimum Value
1
Number of times to check whether an interface has been attached or detached.
- max_nova_api_microversion¶
- Type
floating point
- Default
<None>
Maximum nova API version for client plugin. With this limitation, any nova feature supported with microversion number above max_nova_api_microversion will not be available.
- max_ironic_api_microversion¶
- Type
floating point
- Default
<None>
Maximum ironic API version for client plugin. With this limitation, any ironic feature supported with microversion number above max_ironic_api_microversion will not be available.
- event_purge_batch_size¶
- Type
integer
- Default
200- Minimum Value
1
Controls how many events will be pruned whenever a stack’s events are purged. Set this lower to keep more events at the expense of more frequent purges.
- max_events_per_stack¶
- Type
integer
- Default
1000
Rough number of maximum events that will be available per stack. Actual number of events can be a bit higher since purge checks take place randomly 200/event_purge_batch_size percent of the time. Older events are deleted when events are purged. Set to 0 for unlimited events per stack.
- stack_action_timeout¶
- Type
integer
- Default
3600
Timeout in seconds for stack action (ie. create or update).
- error_wait_time¶
- Type
integer
- Default
240
The amount of time in seconds after an error has occurred that tasks may continue to run before being cancelled.
- engine_life_check_timeout¶
- Type
integer
- Default
2
RPC timeout for the engine liveness check that is used for stack locking.
- enable_stack_abandon¶
- Type
boolean
- Default
False
Enable the preview Stack Abandon feature.
- enable_stack_adopt¶
- Type
boolean
- Default
False
Enable the preview Stack Adopt feature.
- convergence_engine¶
- Type
boolean
- Default
True
Enables engine with convergence architecture. All stacks with this option will be created using convergence engine.
- observe_on_update¶
- Type
boolean
- Default
False
On update, enables heat to collect existing resource properties from reality and converge to updated template.
- default_software_config_transport¶
- Type
string
- Default
POLL_SERVER_CFN- Valid Values
POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE
Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling.
- default_deployment_signal_transport¶
- Type
string
- Default
CFN_SIGNAL- Valid Values
CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, ZAQAR_SIGNAL
Template default for how the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-api-cfn). TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL). HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials.
- default_user_data_format¶
- Type
string
- Default
HEAT_CFNTOOLS- Valid Values
HEAT_CFNTOOLS, RAW, SOFTWARE_CONFIG
Template default for how the user_data should be formatted for the server. For HEAT_CFNTOOLS, the user_data is bundled as part of the heat-cfntools cloud-init boot configuration data. For RAW the user_data is passed to Nova unmodified. For SOFTWARE_CONFIG user_data is bundled as part of the software config data, and metadata is derived from any associated SoftwareDeployment resources.
- Type
list
- Default
['data-processing-cluster']
Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too).
- onready¶
- Type
string
- Default
<None>
Deprecated.
- stack_scheduler_hints¶
- Type
boolean
- Default
False
When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource’s parent stack, heat_stack_name will be set to the name of the resource’s parent stack, heat_path_in_stack will be set to a list of comma delimited strings of stackresourcename and stackname with list[0] being ‘rootstackname’, heat_resource_name will be set to the resource’s name, and heat_resource_uuid will be set to the resource’s orchestration id.
- encrypt_parameters_and_properties¶
- Type
boolean
- Default
False
Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database.
- periodic_interval¶
- Type
integer
- Default
60
Seconds between running periodic tasks.
- heat_metadata_server_url¶
- Type
string
- Default
<None>
URL of the Heat metadata server. NOTE: Setting this is only needed if you require instances to use a different endpoint than in the keystone catalog
- heat_waitcondition_server_url¶
- Type
string
- Default
<None>
URL of the Heat waitcondition server.
- instance_connection_is_secure¶
- Type
string
- Default
0
Instance connection to CFN/CW API via https.
- instance_connection_https_validate_certificates¶
- Type
string
- Default
1
Instance connection to CFN/CW API validate certs if SSL is used.
- region_name_for_services¶
- Type
string
- Default
<None>
Default region name used to get services endpoints.
- Type
string
- Default
<None>
Region name for shared services endpoints.
- Type
list
- Default
['image', 'volume', 'volumev3']
The shared services located in the other region.Needs region_name_for_shared_services option to be set for this to take effect.
- heat_stack_user_role¶
- Type
string
- Default
heat_stack_user
Keystone role for heat template-defined users.
- stack_user_domain_id¶
- Type
string
- Default
<None>
Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored.
Deprecated Variations¶ Group
Name
DEFAULT
stack_user_domain
- stack_user_domain_name¶
- Type
string
- Default
<None>
Keystone domain name which contains heat template-defined users. If stack_user_domain_id option is set, this option is ignored.
- stack_domain_admin¶
- Type
string
- Default
<None>
Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain.
- stack_domain_admin_password¶
- Type
string
- Default
<None>
Keystone password for stack_domain_admin user.
- max_template_size¶
- Type
integer
- Default
524288
Maximum raw byte size of any template.
- max_nested_stack_depth¶
- Type
integer
- Default
5
Maximum depth allowed when using nested stacks.
- num_engine_workers¶
- Type
integer
- Default
<None>
Number of heat-engine processes to fork and run. Will default to either to 4 or number of CPUs on the host, whichever is greater.
- server_keystone_endpoint_type¶
- Type
string
- Default
''- Valid Values
‘’, public, internal, admin
If set, is used to control which authentication endpoint is used by user-controlled servers to make calls back to Heat. If unset www_authenticate_uri is used.
- auth_encryption_key¶
- Type
string
- Default
notgood but just long enough i t
Key used to encrypt authentication info in the database. Length of this key must be 32 characters.
- max_json_body_size¶
- Type
integer
- Default
1048576
Maximum raw byte size of JSON request body. Should be larger than max_template_size.
- cloud_backend¶
- Type
string
- Default
heat.engine.clients.OpenStackClients
Fully qualified class name to use as a client backend.
- keystone_backend¶
- Type
string
- Default
heat.engine.clients.os.keystone.heat_keystoneclient.KsClientWrapper
Fully qualified class name to use as a keystone backend.
- default_notification_level¶
- Type
string
- Default
INFO
Default notification level for outgoing notifications.
- default_publisher_id¶
- Type
string
- Default
<None>
Default publisher_id for outgoing notifications.
- loadbalancer_template¶
- Type
string
- Default
<None>
Custom template for the built-in loadbalancer nested stack.
- 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.
- 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.
- use_eventlog¶
- Type
boolean
- Default
False
Log output to Windows Event Log.
- 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
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
- fatal_deprecations¶
- Type
boolean
- Default
False
Enables or disables fatal status of deprecations.
- run_external_periodic_tasks¶
- Type
boolean
- Default
True
Some periodic tasks can be run in a separate process. Should we run them here?
- 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.
- 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.
- 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.
- rpc_conn_pool_size¶
- Type
integer
- Default
30- Minimum Value
1
Size of RPC connection pool.
Deprecated Variations¶ Group
Name
DEFAULT
rpc_conn_pool_size
- 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
- 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
auth_password¶
- multi_cloud¶
- Type
boolean
- Default
False
Allow orchestration of multiple clouds.
- allowed_auth_uris¶
- Type
list
- Default
[]
Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.
cache¶
- config_prefix¶
- Type
string
- Default
cache.oslo
Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.
- expiration_time¶
- Type
integer
- Default
600
Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn’t have an explicit cache expiration time defined for it.
- backend¶
- Type
string
- Default
dogpile.cache.null- Valid Values
oslo_cache.memcache_pool, oslo_cache.dict, oslo_cache.mongo, oslo_cache.etcd3gw, dogpile.cache.pymemcache, dogpile.cache.memcached, dogpile.cache.pylibmc, dogpile.cache.bmemcached, dogpile.cache.dbm, dogpile.cache.redis, dogpile.cache.memory, dogpile.cache.memory_pickle, dogpile.cache.null
Cache backend module. For eventlet-based or environments with hundreds of threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For environments with less than 100 threaded servers, Memcached (dogpile.cache.memcached) or Redis (dogpile.cache.redis) is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend.
- backend_argument¶
- Type
multi-valued
- Default
''
Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: “<argname>:<value>”.
- proxies¶
- Type
list
- Default
[]
Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.
- enabled¶
- Type
boolean
- Default
False
Global toggle for caching.
- debug_cache_backend¶
- Type
boolean
- Default
False
Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false.
- memcache_servers¶
- Type
list
- Default
['localhost:11211']
Memcache servers in the format of “host:port”. This is used by backends dependent on Memcached.If
dogpile.cache.memcachedoroslo_cache.memcache_poolis used and a given host refer to an IPv6 or a given domain refer to IPv6 then you should prefix the given address withthe address family (inet6) (e.ginet6[::1]:11211,inet6:[fd12:3456:789a:1::1]:11211,inet6:[controller-0.internalapi]:11211). If the address family is not given then these backends will use the defaultinetaddress family which corresponds to IPv4
- memcache_dead_retry¶
- Type
integer
- Default
300
Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).
- memcache_socket_timeout¶
- Type
floating point
- Default
1.0
Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).
- memcache_pool_maxsize¶
- Type
integer
- Default
10
Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only).
- memcache_pool_unused_timeout¶
- Type
integer
- Default
60
Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only).
- memcache_pool_connection_get_timeout¶
- Type
integer
- Default
10
Number of seconds that an operation will wait to get a memcache client connection.
- memcache_pool_flush_on_reconnect¶
- Type
boolean
- Default
False
Global toggle if memcache will be flushed on reconnect. (oslo_cache.memcache_pool backend only).
- memcache_sasl_enabled¶
- Type
boolean
- Default
False
Enable the SASL(Simple Authentication and SecurityLayer) if the SASL_enable is true, else disable.
- memcache_username¶
- Type
string
- Default
''
the user name for the memcached which SASL enabled
- memcache_password¶
- Type
string
- Default
''
the password for the memcached which SASL enabled
- tls_enabled¶
- Type
boolean
- Default
False
Global toggle for TLS usage when comunicating with the caching servers.
- tls_cafile¶
- Type
string
- Default
<None>
Path to a file of concatenated CA certificates in PEM format necessary to establish the caching servers’ authenticity. If tls_enabled is False, this option is ignored.
- tls_certfile¶
- Type
string
- Default
<None>
Path to a single file in PEM format containing the client’s certificate as well as any number of CA certificates needed to establish the certificate’s authenticity. This file is only required when client side authentication is necessary. If tls_enabled is False, this option is ignored.
- tls_keyfile¶
- Type
string
- Default
<None>
Path to a single file containing the client’s private key in. Otherwise the private key will be taken from the file specified in tls_certfile. If tls_enabled is False, this option is ignored.
- tls_allowed_ciphers¶
- Type
string
- Default
<None>
Set the available ciphers for sockets created with the TLS context. It should be a string in the OpenSSL cipher list format. If not specified, all OpenSSL enabled ciphers will be available.
- enable_socket_keepalive¶
- Type
boolean
- Default
False
Global toggle for the socket keepalive of dogpile’s pymemcache backend
- socket_keepalive_idle¶
- Type
integer
- Default
1- Minimum Value
0
The time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes. Should be a positive integer most greater than zero.
- socket_keepalive_interval¶
- Type
integer
- Default
1- Minimum Value
0
The time (in seconds) between individual keepalive probes. Should be a positive integer greater than zero.
- socket_keepalive_count¶
- Type
integer
- Default
1- Minimum Value
0
The maximum number of keepalive probes TCP should send before dropping the connection. Should be a positive integer greater than zero.
- enable_retry_client¶
- Type
boolean
- Default
False
Enable retry client mechanisms to handle failure. Those mechanisms can be used to wrap all kind of pymemcache clients. The wrapper allows you to define how many attempts to make and how long to wait between attemots.
- retry_attempts¶
- Type
integer
- Default
2- Minimum Value
1
Number of times to attempt an action before failing.
- retry_delay¶
- Type
floating point
- Default
0
Number of seconds to sleep between each attempt.
- hashclient_retry_attempts¶
- Type
integer
- Default
2- Minimum Value
1
Amount of times a client should be tried before it is marked dead and removed from the pool in the HashClient’s internal mechanisms.
- hashclient_retry_delay¶
- Type
floating point
- Default
1
Time in seconds that should pass between retry attempts in the HashClient’s internal mechanisms.
- dead_timeout¶
- Type
floating point
- Default
60
Time in seconds before attempting to add a node back in the pool in the HashClient’s internal mechanisms.
clients¶
- endpoint_type¶
- Type
string
- Default
publicURL
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
False
If set, then the server’s certificate will not be verified.
clients_aodh¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_barbican¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_cinder¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
- http_log_debug¶
- Type
boolean
- Default
False
Allow client’s debug log output.
clients_designate¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_glance¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_heat¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
- url¶
- Type
string
- Default
''
Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s.
clients_keystone¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
- auth_uri¶
- Type
string
- Default
''
Unversioned keystone url in format like http://0.0.0.0:5000.
clients_magnum¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_manila¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_mistral¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_monasca¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_neutron¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_nova¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
- http_log_debug¶
- Type
boolean
- Default
False
Allow client’s debug log output.
clients_octavia¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_sahara¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_senlin¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_swift¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_trove¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_vitrage¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
clients_zaqar¶
- endpoint_type¶
- Type
string
- Default
<None>
Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- insecure¶
- Type
boolean
- Default
<None>
If set, then the server’s certificate will not be verified.
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-OpenStack-Request-ID']
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-OpenStack-Request-ID']
Indicate which header field names may be used during the actual request.
database¶
- sqlite_synchronous¶
- Type
boolean
- Default
True
If True, SQLite uses synchronous mode.
Deprecated Variations¶ Group
Name
DEFAULT
sqlite_synchronous
- backend¶
- Type
string
- Default
sqlalchemy
The back end to use for the database.
Deprecated Variations¶ Group
Name
DEFAULT
db_backend
- connection¶
- Type
string
- Default
<None>
The SQLAlchemy connection string to use to connect to the database.
Deprecated Variations¶ Group
Name
DEFAULT
sql_connection
DATABASE
sql_connection
sql
connection
- slave_connection¶
- Type
string
- Default
<None>
The SQLAlchemy 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_enable_ndb¶
- Type
boolean
- Default
False
If True, transparently enables support for handling MySQL Cluster (NDB).
- 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.
Deprecated Variations¶ Group
Name
DEFAULT
sql_max_retries
DATABASE
sql_max_retries
- retry_interval¶
- Type
integer
- Default
10
Interval between retries of opening a SQL connection.
Deprecated Variations¶ Group
Name
DEFAULT
sql_retry_interval
DATABASE
reconnect_interval
- max_overflow¶
- Type
integer
- Default
50
If set, use this value for max_overflow with SQLAlchemy.
Deprecated Variations¶ Group
Name
DEFAULT
sql_max_overflow
DATABASE
sqlalchemy_max_overflow
- connection_debug¶
- Type
integer
- Default
0- Minimum Value
0
- Maximum Value
100
Verbosity of SQL debugging information: 0=None, 100=Everything.
Deprecated Variations¶ Group
Name
DEFAULT
sql_connection_debug
- connection_trace¶
- Type
boolean
- Default
False
Add Python stack traces to SQL as comment strings.
Deprecated Variations¶ Group
Name
DEFAULT
sql_connection_trace
- pool_timeout¶
- Type
integer
- Default
<None>
If set, use this value for pool_timeout with SQLAlchemy.
Deprecated Variations¶ Group
Name
DATABASE
sqlalchemy_pool_timeout
- 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&…
ec2authtoken¶
- auth_uri¶
- Type
string
- Default
<None>
Authentication Endpoint URI.
- multi_cloud¶
- Type
boolean
- Default
False
Allow orchestration of multiple clouds.
- allowed_auth_uris¶
- Type
list
- Default
[]
Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.
- cert_file¶
- Type
string
- Default
<None>
Optional PEM-formatted certificate chain file.
- key_file¶
- Type
string
- Default
<None>
Optional PEM-formatted file that contains the private key.
- ca_file¶
- Type
string
- Default
<None>
Optional CA cert file to use in SSL connections.
- insecure¶
- Type
boolean
- Default
False
If set, then the server’s certificate will not be verified.
eventlet_opts¶
- wsgi_keep_alive¶
- Type
boolean
- Default
True
If False, closes the client socket connection explicitly.
- client_socket_timeout¶
- Type
integer
- Default
900
Timeout for client connections’ socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of ‘0’ means wait forever.
healthcheck¶
- 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.
- 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.
heat_api¶
- bind_host¶
- Type
ip address
- Default
0.0.0.0
Address to bind the server. Useful when selecting a particular network interface.
Deprecated Variations¶ Group
Name
DEFAULT
bind_host
- bind_port¶
- Type
port number
- Default
8004- Minimum Value
0
- Maximum Value
65535
The port on which the server will listen.
Deprecated Variations¶ Group
Name
DEFAULT
bind_port
- backlog¶
- Type
integer
- Default
4096
Number of backlog requests to configure the socket with.
Deprecated Variations¶ Group
Name
DEFAULT
backlog
- cert_file¶
- Type
string
- Default
<None>
Location of the SSL certificate file to use for SSL mode.
Deprecated Variations¶ Group
Name
DEFAULT
cert_file
- key_file¶
- Type
string
- Default
<None>
Location of the SSL key file to use for enabling SSL mode.
Deprecated Variations¶ Group
Name
DEFAULT
key_file
- workers¶
- Type
integer
- Default
0- Minimum Value
0
Number of workers for Heat service. Default value 0 means, that service will start number of workers equal number of cores on server.
Deprecated Variations¶ Group
Name
DEFAULT
workers
- max_header_line¶
- Type
integer
- Default
16384
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
- tcp_keepidle¶
- Type
integer
- Default
600
The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
heat_api_cfn¶
- bind_host¶
- Type
ip address
- Default
0.0.0.0
Address to bind the server. Useful when selecting a particular network interface.
Deprecated Variations¶ Group
Name
DEFAULT
bind_host
- bind_port¶
- Type
port number
- Default
8000- Minimum Value
0
- Maximum Value
65535
The port on which the server will listen.
Deprecated Variations¶ Group
Name
DEFAULT
bind_port
- backlog¶
- Type
integer
- Default
4096
Number of backlog requests to configure the socket with.
Deprecated Variations¶ Group
Name
DEFAULT
backlog
- cert_file¶
- Type
string
- Default
<None>
Location of the SSL certificate file to use for SSL mode.
Deprecated Variations¶ Group
Name
DEFAULT
cert_file
- key_file¶
- Type
string
- Default
<None>
Location of the SSL key file to use for enabling SSL mode.
Deprecated Variations¶ Group
Name
DEFAULT
key_file
- workers¶
- Type
integer
- Default
1- Minimum Value
0
Number of workers for Heat service.
Deprecated Variations¶ Group
Name
DEFAULT
workers
- max_header_line¶
- Type
integer
- Default
16384
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
- tcp_keepidle¶
- Type
integer
- Default
600
The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
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_serversoption 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.
- 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
noauth¶
- token_response¶
- Type
string
- Default
''
JSON file containing the content returned by the noauth middleware.
oslo_messaging_amqp¶
- container_name¶
- Type
string
- Default
<None>
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
Deprecated Variations¶ Group
Name
amqp1
container_name
- idle_timeout¶
- Type
integer
- Default
0
Timeout for inactive connections (in seconds)
Deprecated Variations¶ Group
Name
amqp1
idle_timeout
- trace¶
- Type
boolean
- Default
False
Debug: dump AMQP frames to stdout
Deprecated Variations¶ Group
Name
amqp1
trace
- ssl¶
- Type
boolean
- Default
False
Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.
- ssl_ca_file¶
- Type
string
- Default
''
CA certificate PEM file used to verify the server’s certificate
Deprecated Variations¶ Group
Name
amqp1
ssl_ca_file
- ssl_cert_file¶
- Type
string
- Default
''
Self-identifying certificate PEM file for client authentication
Deprecated Variations¶ Group
Name
amqp1
ssl_cert_file
- ssl_key_file¶
- Type
string
- Default
''
Private key PEM file used to sign ssl_cert_file certificate (optional)
Deprecated Variations¶ Group
Name
amqp1
ssl_key_file
- ssl_key_password¶
- Type
string
- Default
<None>
Password for decrypting ssl_key_file (if encrypted)
Deprecated Variations¶ Group
Name
amqp1
ssl_key_password
- ssl_verify_vhost¶
- Type
boolean
- Default
False
By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.
- sasl_mechanisms¶
- Type
string
- Default
''
Space separated list of acceptable SASL mechanisms
Deprecated Variations¶ Group
Name
amqp1
sasl_mechanisms
- sasl_config_dir¶
- Type
string
- Default
''
Path to directory that contains the SASL configuration
Deprecated Variations¶ Group
Name
amqp1
sasl_config_dir
- sasl_config_name¶
- Type
string
- Default
''
Name of configuration file (without .conf suffix)
Deprecated Variations¶ Group
Name
amqp1
sasl_config_name
- sasl_default_realm¶
- Type
string
- Default
''
SASL realm to use if no realm present in username
- connection_retry_interval¶
- Type
integer
- Default
1- Minimum Value
1
Seconds to pause before attempting to re-connect.
- connection_retry_backoff¶
- Type
integer
- Default
2- Minimum Value
0
Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
- connection_retry_interval_max¶
- Type
integer
- Default
30- Minimum Value
1
Maximum limit for connection_retry_interval + connection_retry_backoff
- link_retry_delay¶
- Type
integer
- Default
10- Minimum Value
1
Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
- default_reply_retry¶
- Type
integer
- Default
0- Minimum Value
-1
The maximum number of attempts to re-send a reply message which failed due to a recoverable error.
- default_reply_timeout¶
- Type
integer
- Default
30- Minimum Value
5
The deadline for an rpc reply message delivery.
- default_send_timeout¶
- Type
integer
- Default
30- Minimum Value
5
The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
- default_notify_timeout¶
- Type
integer
- Default
30- Minimum Value
5
The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
- default_sender_link_timeout¶
- Type
integer
- Default
600- Minimum Value
1
The duration to schedule a purge of idle sender links. Detach link after expiry.
- addressing_mode¶
- Type
string
- Default
dynamic
Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing
- pseudo_vhost¶
- Type
boolean
- Default
True
Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.
- server_request_prefix¶
- Type
string
- Default
exclusive
address prefix used when sending to a specific server
Deprecated Variations¶ Group
Name
amqp1
server_request_prefix
- broadcast_prefix¶
- Type
string
- Default
broadcast
address prefix used when broadcasting to all servers
Deprecated Variations¶ Group
Name
amqp1
broadcast_prefix
- group_request_prefix¶
- Type
string
- Default
unicast
address prefix when sending to any server in group
Deprecated Variations¶ Group
Name
amqp1
group_request_prefix
- rpc_address_prefix¶
- Type
string
- Default
openstack.org/om/rpc
Address prefix for all generated RPC addresses
- notify_address_prefix¶
- Type
string
- Default
openstack.org/om/notify
Address prefix for all generated Notification addresses
- multicast_address¶
- Type
string
- Default
multicast
Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
- unicast_address¶
- Type
string
- Default
unicast
Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.
- anycast_address¶
- Type
string
- Default
anycast
Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.
- default_notification_exchange¶
- Type
string
- Default
<None>
Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’
- default_rpc_exchange¶
- Type
string
- Default
<None>
Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’
- reply_link_credit¶
- Type
integer
- Default
200- Minimum Value
1
Window size for incoming RPC Reply messages.
- rpc_server_credit¶
- Type
integer
- Default
100- Minimum Value
1
Window size for incoming RPC Request messages
- notify_server_credit¶
- Type
integer
- Default
100- Minimum Value
1
Window size for incoming Notification messages
- pre_settled¶
- Type
multi-valued
- Default
rpc-cast- Default
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
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
- pool_size¶
- Type
integer
- Default
10
Pool Size for Kafka Consumers
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
Driver no longer uses connection pool.
- conn_pool_min_size¶
- Type
integer
- Default
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.
- Reason
Driver no longer uses connection pool.
- conn_pool_ttl¶
- Type
integer
- Default
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.
- Reason
Driver no longer uses connection pool.
- 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
Deprecated Variations¶ Group
Name
DEFAULT
notification_driver
- 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.
Deprecated Variations¶ Group
Name
DEFAULT
notification_transport_url
- topics¶
- Type
list
- Default
['notifications']
AMQP topic used for OpenStack notifications.
Deprecated Variations¶ Group
Name
rpc_notifier2
topics
DEFAULT
notification_topics
- 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.
Deprecated Variations¶ Group
Name
DEFAULT
amqp_auto_delete
- ssl¶
- Type
boolean
- Default
False
Connect over SSL.
Deprecated Variations¶ Group
Name
oslo_messaging_rabbit
rabbit_use_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.
Deprecated Variations¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_version
- ssl_key_file¶
- Type
string
- Default
''
SSL key file (valid only if SSL enabled).
Deprecated Variations¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_keyfile
- ssl_cert_file¶
- Type
string
- Default
''
SSL cert file (valid only if SSL enabled).
Deprecated Variations¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_certfile
- ssl_ca_file¶
- Type
string
- Default
''
SSL certification authority file (valid only if SSL enabled).
Deprecated Variations¶ Group
Name
oslo_messaging_rabbit
kombu_ssl_ca_certs
- 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
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.
- 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.
Deprecated Variations¶ Group
Name
DEFAULT
kombu_reconnect_delay
- 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.
Deprecated Variations¶ Group
Name
DEFAULT
rabbit_login_method
- rabbit_retry_interval¶
- Type
integer
- Default
1
How frequently to retry connecting with RabbitMQ.
- rabbit_retry_backoff¶
- Type
integer
- Default
2
How long to backoff for between retries when connecting to RabbitMQ.
Deprecated Variations¶ Group
Name
DEFAULT
rabbit_retry_backoff
- rabbit_interval_max¶
- Type
integer
- Default
30
Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
- 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”}’ “
Deprecated Variations¶ Group
Name
DEFAULT
rabbit_ha_queues
- 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 durable by default so the amqp_durable_queues opion is ignored when this option enabled.
- 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_quroum_max_memory_length¶
- Type
integer
- Default
0
By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of messages in the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.
- rabbit_quroum_max_memory_bytes¶
- Type
integer
- Default
0
By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.
- rabbit_transient_queues_ttl¶
- Type
integer
- Default
1800- Minimum Value
1
Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.
- rabbit_qos_prefetch_count¶
- 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
2
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
oslo_middleware¶
- max_request_body_size¶
- Type
integer
- Default
114688
The maximum body size for each request, in bytes.
Deprecated Variations¶ Group
Name
DEFAULT
osapi_max_request_body_size
DEFAULT
max_request_body_size
- secure_proxy_ssl_header¶
- Type
string
- Default
X-Forwarded-Proto
The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- enable_proxy_headers_parsing¶
- Type
boolean
- Default
False
Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
- http_basic_auth_user_file¶
- Type
string
- Default
/etc/htpasswd
HTTP basic auth password file.
oslo_policy¶
- enforce_scope¶
- Type
boolean
- Default
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 thescope_typesof the policy being enforced. If the scopes do not match, anInvalidScopeexception will be raised. IfFalse, a message will be logged informing operators that policies are being invoked with mismatching scope.
- enforce_new_defaults¶
- Type
boolean
- Default
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 theenforce_scopeflag so that you can get the benefits of new defaults andscope_typetogether. 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.
Deprecated Variations¶ Group
Name
DEFAULT
policy_file
- policy_default_rule¶
- Type
string
- Default
default
Default rule. Enforced when a requested rule is not found.
Deprecated Variations¶ Group
Name
DEFAULT
policy_default_rule
- 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.
Deprecated Variations¶ Group
Name
DEFAULT
policy_dirs
- 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
oslo_reports¶
- log_dir¶
- Type
string
- Default
<None>
Path to a log directory where to create a file
- file_event_handler¶
- Type
string
- Default
<None>
The path to a file to watch for changes to trigger the reports, instead of signals. Setting this option disables the signal trigger for the reports. If application is running as a WSGI application it is recommended to use this instead of signals.
- file_event_handler_interval¶
- Type
integer
- Default
1
How many seconds to wait between polls when file_event_handler is set
paste_deploy¶
- flavor¶
- Type
string
- Default
<None>
The flavor to use.
- api_paste_config¶
- Type
string
- Default
api-paste.ini
The API paste config file to use.
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.
- 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.
revision¶
- heat_revision¶
- Type
string
- Default
unknown
Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option.
ssl¶
- ca_file¶
- Type
string
- Default
<None>
CA certificate file to use to verify connecting clients.
Deprecated Variations¶ Group
Name
DEFAULT
ssl_ca_file
- cert_file¶
- Type
string
- Default
<None>
Certificate file to use when starting the server securely.
Deprecated Variations¶ Group
Name
DEFAULT
ssl_cert_file
- key_file¶
- Type
string
- Default
<None>
Private key file to use when starting the server securely.
Deprecated Variations¶ Group
Name
DEFAULT
ssl_key_file
- 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.
- ciphers¶
- Type
string
- Default
<None>
Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.
trustee¶
- auth_type¶
- Type
unknown type
- Default
<None>
Authentication type to load
Deprecated Variations¶ Group
Name
trustee
auth_plugin
- auth_section¶
- Type
unknown type
- Default
<None>
Config Section from which to load plugin specific options
- auth_url¶
- Type
unknown type
- Default
<None>
Authentication URL
- system_scope¶
- Type
unknown type
- Default
<None>
Scope for system operations
- domain_id¶
- Type
unknown type
- Default
<None>
Domain ID to scope to
- domain_name¶
- Type
unknown type
- Default
<None>
Domain name to scope to
- project_id¶
- Type
unknown type
- Default
<None>
Project ID to scope to
Deprecated Variations¶ Group
Name
trustee
tenant-id
trustee
tenant_id
- project_name¶
- Type
unknown type
- Default
<None>
Project name to scope to
Deprecated Variations¶ Group
Name
trustee
tenant-name
trustee
tenant_name
- project_domain_id¶
- Type
unknown type
- Default
<None>
Domain ID containing project
- project_domain_name¶
- Type
unknown type
- Default
<None>
Domain name containing project
- trust_id¶
- Type
unknown type
- Default
<None>
ID of the trust to use as a trustee use
- default_domain_id¶
- Type
unknown type
- Default
<None>
Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
- default_domain_name¶
- Type
unknown type
- Default
<None>
Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
- user_id¶
- Type
unknown type
- Default
<None>
User id
- username¶
- Type
unknown type
- Default
<None>
Username
Deprecated Variations¶ Group
Name
trustee
user-name
trustee
user_name
- user_domain_id¶
- Type
unknown type
- Default
<None>
User’s domain id
- user_domain_name¶
- Type
unknown type
- Default
<None>
User’s domain name
- password¶
- Type
unknown type
- Default
<None>
User’s password
volumes¶
- backups_enabled¶
- Type
boolean
- Default
True
Indicate if cinder-backup service is enabled. This is a temporary workaround until cinder-backup service becomes discoverable, see LP#1334856.
