Configuration Options

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.

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

keystone

Configuration options for the identity service

cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

insecure
Type:boolean
Default:false

Verify HTTPS connections.

timeout
Type:integer
Default:<None>

Timeout value for http requests

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

service_type
Type:string
Default:identity

The default service_type for endpoint URL discovery.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

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.

policy_file
Type:string
Default:policy.yaml

The file that defines placement policies. This can be an absolute path or relative to the configuration file.

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

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.

cafile
Type:string
Default:<None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile
Type:string
Default:<None>

PEM encoded client certificate cert file

keyfile
Type:string
Default:<None>

PEM encoded client certificate key file

insecure
Type:boolean
Default:false

Verify HTTPS connections.

timeout
Type:integer
Default:<None>

Timeout value for http requests

collect_timing
Type:boolean
Default:false

Collect per-API call timing information.

split_loggers
Type:boolean
Default:false

Log requests to multiple loggers.

auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
Group Name
placement 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

project_name
Type:unknown type
Default:<None>

Project name to scope to

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>

Trust ID

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
placement user-name
placement 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

tenant_id
Type:unknown type
Default:<None>

Tenant ID

tenant_name
Type:unknown type
Default:<None>

Tenant Name

service_type
Type:string
Default:placement

The default service_type for endpoint URL discovery.

service_name
Type:string
Default:<None>

The default service_name for endpoint URL discovery.

valid_interfaces
Type:list
Default:internal,public

List of interfaces, in order of preference, for endpoint URL.

region_name
Type:string
Default:<None>

The default region_name for endpoint URL discovery.

endpoint_override
Type:string
Default:<None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

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.

Creative Commons Attribution 3.0 License

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