Configuration Options¶

The following is an overview of all available configuration options in Placement. For a sample configuration file, refer to Sample Configuration File.

DEFAULT¶

tempdir¶

Type: string
Default: <None>

Explicitly specify the temporary working directory.

pybasedir¶

Type: string
Default: <Path>

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

The directory where the Placement python modules are installed.

This is the default path for other config options which need to persist Placement internal data. It is very unlikely that you need to change this option from its default value.

Possible values:

The full path to a directory.

Related options:

state_path

state_path¶

Type: string
Default: $pybasedir

The top-level directory for maintaining state used in Placement.

This directory is used to store Placement’s internal state. It is used by some tests that have behaviors carried over from Nova.

Possible values:

The full path to a directory. Defaults to value provided in pybasedir.

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.

api¶

Options under this group are used to define Placement API.

auth_strategy¶

Type: string
Default: keystone
Valid Values: keystone, noauth2

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

Deprecated Variations¶
Group	Name
DEFAULT	auth_strategy

cors¶

allowed_origin¶

Type: list
Default: <None>

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

allow_credentials¶

Type: boolean
Default: True

Indicate that the actual request can include user credentials

expose_headers¶

Type: list
Default: []

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

max_age¶

Type: integer
Default: 3600

Maximum cache age of CORS preflight requests.

allow_methods¶

Type: list
Default: ['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'PATCH']

Indicate which methods can be used during the actual request.

allow_headers¶

Type: list
Default: []

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

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>

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.

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

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

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

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 the enforce_scope flag so that you can get the benefits of new defaults and scope_type together. If False, the deprecated policy check string is logically OR’d with the new policy check string, allowing for a graceful upgrade experience between releases with new policies, which is the default behavior.

policy_file¶

Type: string
Default: policy.json

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

placement¶

randomize_allocation_candidates¶

Type: boolean
Default: False

If True, when limiting allocation candidate results, the results will be a random sampling of the full result set. If False, allocation candidates are returned in a deterministic but undefined order. That is, all things being equal, two requests for allocation candidates will return the same results in the same order; but no guarantees are made as to how that order is determined.

incomplete_consumer_project_id¶

Type: string
Default: 00000000-0000-0000-0000-000000000000

Early API microversions (<1.8) allowed creating allocations and not specifying a project or user identifier for the consumer. In cleaning up the data modeling, we no longer allow missing project and user information. If an older client makes an allocation, we’ll use this in place of the information it doesn’t provide.

incomplete_consumer_user_id¶

Type: string
Default: 00000000-0000-0000-0000-000000000000

allocation_conflict_retry_count¶

Type: integer
Default: 10

The number of times to retry, server-side, writing allocations when there is a resource provider generation conflict. Raising this value may be useful when many concurrent allocations to the same resource provider are expected.

placement_database¶

The Placement API Database is a the database used with the placement service. If the connection option is not set, the placement service will not start.

connection¶

Type: string
Default: <None>

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

connection_parameters¶

Type: string
Default: ''

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

sqlite_synchronous¶

Type: boolean
Default: True

If True, SQLite uses synchronous mode.

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=

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

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

If set, use this value for max_overflow with SQLAlchemy.

connection_debug¶

Type: integer
Default: 0

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.

sync_on_startup¶

Type: boolean
Default: False

If True, database schema migrations will be attempted when the web service starts.

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.

Configuration Options

Configuration Options¶

DEFAULT¶

api¶

cors¶

keystone_authtoken¶

oslo_middleware¶

oslo_policy¶

placement¶

placement_database¶

profiler¶

openstack-placement 8.0.0.0rc2.dev2

Page Contents