Liberty - Liberty - Liberty - Liberty - Liberty - Liberty - Liberty - Liberty -
Contents
The Orchestration service is designed to manage the lifecycle of
infrastructure and applications within OpenStack clouds. Its
various agents and services are configured in the
/etc/heat/heat.conf file.
To install Orchestration, see the OpenStack Installation Guide for your distribution (docs.openstack.org).
The following tables provide a comprehensive list of the Orchestration configuration options.
| Configuration option = Default value | Description |
|---|---|
| [keystone_authtoken] | |
admin_password = None |
(StrOpt) Service user password. |
admin_tenant_name = admin |
(StrOpt) Service tenant name. |
admin_token = None |
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. |
admin_user = None |
(StrOpt) Service username. |
auth_admin_prefix = |
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. |
auth_host = 127.0.0.1 |
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. |
auth_plugin = None |
(StrOpt) Name of the plugin to load |
auth_port = 35357 |
(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. |
auth_protocol = https |
(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. |
auth_section = None |
(StrOpt) Config Section from which to load plugin specific options |
auth_uri = None |
(StrOpt) Complete public Identity API endpoint. |
auth_version = None |
(StrOpt) API version of the admin Identity API endpoint. |
cache = None |
(StrOpt) Env key for the swift cache. |
cafile = None |
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
certfile = None |
(StrOpt) Required if identity server requires client certificate |
check_revocations_for_cached = False |
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. |
delay_auth_decision = False |
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
enforce_token_bind = permissive |
(StrOpt) 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. |
hash_algorithms = md5 |
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. |
http_connect_timeout = None |
(IntOpt) Request timeout value for communicating with Identity API server. |
http_request_max_retries = 3 |
(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. |
identity_uri = None |
(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ |
include_service_catalog = True |
(BoolOpt) (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. |
insecure = False |
(BoolOpt) Verify HTTPS connections. |
keyfile = None |
(StrOpt) Required if identity server requires client certificate |
memcache_pool_conn_get_timeout = 10 |
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
memcache_pool_dead_retry = 300 |
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. |
memcache_pool_maxsize = 10 |
(IntOpt) (Optional) Maximum total number of open connections to every memcached server. |
memcache_pool_socket_timeout = 3 |
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. |
memcache_pool_unused_timeout = 60 |
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
memcache_secret_key = None |
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
memcache_security_strategy = None |
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. 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_use_advanced_pool = False |
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
memcached_servers = None |
(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
region_name = None |
(StrOpt) The region in which the identity server can be found. |
revocation_cache_time = 10 |
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. |
signing_dir = None |
(StrOpt) Directory used to cache files related to PKI tokens. |
token_cache_time = 300 |
(IntOpt) 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. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
convergence_engine = False |
(BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine . |
default_deployment_signal_transport = CFN_SIGNAL |
(StrOpt) 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_software_config_transport = POLL_SERVER_CFN |
(StrOpt) 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. |
deferred_auth_method = trusts |
(StrOpt) Select deferred auth method, stored password or trusts. |
environment_dir = /etc/heat/environment.d |
(StrOpt) The directory to search for environment files. |
error_wait_time = 240 |
(IntOpt) Error wait time in seconds for stack action (ie. create or update). |
event_purge_batch_size = 10 |
(IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges. |
executor_thread_pool_size = 64 |
(IntOpt) Size of executor thread pool. |
host = localhost |
(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. |
keystone_backend = heat.common.heat_keystoneclient.KeystoneClientV3 |
(StrOpt) Fully qualified class name to use as a keystone backend. |
memcached_servers = None |
(ListOpt) Memcached servers or None for in process cache. |
password = |
(StrOpt) Password for Redis server (optional). |
periodic_interval = 60 |
(IntOpt) Seconds between running periodic tasks. |
plugin_dirs = /usr/lib64/heat, /usr/lib/heat, /usr/local/lib/heat, /usr/local/lib64/heat |
(ListOpt) List of directories to search for plug-ins. |
port = 6379 |
(IntOpt) Use this port to connect to redis host. |
watch_log_file = False |
(BoolOpt) (Optional) 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. |
| [cache] | |
backend = dogpile.cache.null |
(StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. |
backend_argument = [] |
(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>". |
config_prefix = cache.oslo |
(StrOpt) 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. |
debug_cache_backend = False |
(BoolOpt) 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. |
enabled = False |
(BoolOpt) Global toggle for caching. |
expiration_time = 600 |
(IntOpt) 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. |
memcache_dead_retry = 300 |
(IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
memcache_pool_connection_get_timeout = 10 |
(IntOpt) Number of seconds that an operation will wait to get a memcache client connection. |
memcache_pool_maxsize = 10 |
(IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). |
memcache_pool_unused_timeout = 60 |
(IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). |
memcache_servers = localhost:11211 |
(ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
memcache_socket_timeout = 3 |
(IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). |
proxies = |
(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. |
| [constraint_validation_cache] | |
caching = True |
(BoolOpt) Toggle to enable/disable caching when Orchestration Engine validates property constraints of stack.During property validation with constraints Orchestration Engine caches requests to other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. |
expiration_time = 60 |
(IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints. |
| [revision] | |
heat_revision = unknown |
(StrOpt) 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. |
| Configuration option = Default value | Description |
|---|---|
| [cors] | |
allow_credentials = True |
(BoolOpt) Indicate that the actual request can include user credentials |
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which header field names may be used during the actual request. |
allow_methods = GET, POST, PUT, DELETE, OPTIONS |
(ListOpt) Indicate which methods can be used during the actual request. |
allowed_origin = None |
(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. |
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
max_age = 3600 |
(IntOpt) Maximum cache age of CORS preflight requests. |
| [cors.subdomain] | |
allow_credentials = True |
(BoolOpt) Indicate that the actual request can include user credentials |
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which header field names may be used during the actual request. |
allow_methods = GET, POST, PUT, DELETE, OPTIONS |
(ListOpt) Indicate which methods can be used during the actual request. |
allowed_origin = None |
(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. |
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
max_age = 3600 |
(IntOpt) Maximum cache age of CORS preflight requests. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
auth_encryption_key = notgood but just long enough i t |
(StrOpt) Key used to encrypt authentication info in the database. Length of this key must be 32 characters. |
| Configuration option = Default value | Description |
|---|---|
| [database] | |
backend = sqlalchemy |
(StrOpt) The back end to use for the database. |
connection = None |
(StrOpt) The SQLAlchemy connection string to use to connect to the database. |
connection_debug = 0 |
(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. |
connection_trace = False |
(BoolOpt) Add Python stack traces to SQL as comment strings. |
db_inc_retry_interval = True |
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
db_max_retries = 20 |
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
db_max_retry_interval = 10 |
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
db_retry_interval = 1 |
(IntOpt) Seconds between retries of a database transaction. |
idle_timeout = 3600 |
(IntOpt) Timeout before idle SQL connections are reaped. |
max_overflow = None |
(IntOpt) If set, use this value for max_overflow with SQLAlchemy. |
max_pool_size = None |
(IntOpt) Maximum number of SQL connections to keep open in a pool. |
max_retries = 10 |
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
min_pool_size = 1 |
(IntOpt) Minimum number of SQL connections to keep open in a pool. |
mysql_sql_mode = TRADITIONAL |
(StrOpt) 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= |
pool_timeout = None |
(IntOpt) If set, use this value for pool_timeout with SQLAlchemy. |
retry_interval = 10 |
(IntOpt) Interval between retries of opening a SQL connection. |
slave_connection = None |
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database. |
sqlite_db = oslo.sqlite |
(StrOpt) The file name to use with SQLite. |
sqlite_synchronous = True |
(BoolOpt) If True, SQLite uses synchronous mode. |
use_db_reconnect = False |
(BoolOpt) Enable the experimental use of database reconnect on connection lost. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
loadbalancer_template = None |
(StrOpt) Custom template for the built-in loadbalancer nested stack. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
debug = False |
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). |
default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=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 |
(ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. |
fatal_deprecations = False |
(BoolOpt) Enables or disables fatal status of deprecations. |
instance_format = "[instance: %(uuid)s] " |
(StrOpt) The format for an instance that is passed with the log message. |
instance_uuid_format = "[instance: %(uuid)s] " |
(StrOpt) The format for an instance UUID that is passed with the log message. |
log_config_append = None |
(StrOpt) 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_format). |
log_date_format = %Y-%m-%d %H:%M:%S |
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
log_dir = None |
(StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. |
log_file = None |
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. |
log_format = None |
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. |
logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s |
(StrOpt) Format string to use for log messages with context. |
logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d |
(StrOpt) Data to append to log format when level is DEBUG. |
logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s |
(StrOpt) Format string to use for log messages without context. |
logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s |
(StrOpt) Prefix each line of exception output with this format. |
publish_errors = False |
(BoolOpt) Enables or disables publication of error events. |
syslog_log_facility = LOG_USER |
(StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
use_stderr = True |
(BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. |
use_syslog = False |
(BoolOpt) 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_syslog_rfc_format = True |
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. |
verbose = True |
(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
max_events_per_stack = 1000 |
(IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack. |
max_nested_stack_depth = 5 |
(IntOpt) Maximum depth allowed when using nested stacks. |
max_resources_per_stack = 1000 |
(IntOpt) Maximum resources allowed per top-level stack. -1 stands for unlimited. |
max_stacks_per_tenant = 100 |
(IntOpt) Maximum number of stacks any one tenant may have active at one time. |
max_template_size = 524288 |
(IntOpt) Maximum raw byte size of any template. |
| Configuration option = Default value | Description |
|---|---|
| [matchmaker_redis] | |
host = 127.0.0.1 |
(StrOpt) Host to locate redis. |
password = |
(StrOpt) Password for Redis server (optional). |
port = 6379 |
(IntOpt) Use this port to connect to redis host. |
| Configuration option = Default value | Description |
|---|---|
| [profiler] | |
profiler_enabled = False |
(BoolOpt) If False fully disable profiling feature. |
trace_sqlalchemy = False |
(BoolOpt) If False do not trace SQL requests. |
| Configuration option = Default value | Description |
|---|---|
| [trustee] | |
auth_plugin = None |
(StrOpt) Name of the plugin to load |
auth_section = None |
(StrOpt) Config Section from which to load plugin specific options |
