Chapter 4. heat The following chapter contains information about the configuration options in the heat service. 4.1. heat.conf This section contains options for the /etc/heat/heat.conf file. 4.1.1. DEFAULT The following table outlines the options available under the [DEFAULT] group in the /etc/heat/heat.conf file. . Configuration option = Default value Type Description action_retry_limit = 5 integer value Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries. allow_trusts_redelegation = False boolean value 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. auth_encryption_key = notgood but just long enough i t string value Key used to encrypt authentication info in the database. Length of this key must be 32 characters. backdoor_port = None string value 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 = None string value 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. client_retry_limit = 2 integer value Number of times to retry when a client encounters an expected intermittent error. Set to 0 to disable retries. cloud_backend = heat.engine.clients.OpenStackClients string value Fully qualified class name to use as a client backend. conn_pool_min_size = 2 integer value The pool size limit for connections expiration policy conn_pool_ttl = 1200 integer value The time-to-live in sec of idle connections in the pool control_exchange = openstack string value The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. convergence_engine = True boolean value Enables engine with convergence architecture. All stacks with this option will be created using convergence engine. debug = False boolean value If set to true, the logging level will be set to DEBUG instead of the default INFO level. default_deployment_signal_transport = CFN_SIGNAL string value 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_log_levels = ['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 value List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. default_notification_level = INFO string value Default notification level for outgoing notifications. default_publisher_id = None string value Default publisher_id for outgoing notifications. default_software_config_transport = POLL_SERVER_CFN string value 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_user_data_format = HEAT_CFNTOOLS string value 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. deferred_auth_method = trusts string value Select deferred auth method, stored password or trusts. Deprecated since: 9.0.0 *Reason:*Stored password based deferred auth is broken when used with keystone v3 and is not supported. enable_cloud_watch_lite = False boolean value Enable the legacy OS::Heat::CWLiteAlarm resource. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch Service has been removed. enable_stack_abandon = False boolean value Enable the preview Stack Abandon feature. enable_stack_adopt = False boolean value Enable the preview Stack Adopt feature. encrypt_parameters_and_properties = False boolean value Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database. engine_life_check_timeout = 2 integer value RPC timeout for the engine liveness check that is used for stack locking. environment_dir = /etc/heat/environment.d string value The directory to search for environment files. error_wait_time = 240 integer value The amount of time in seconds after an error has occurred that tasks may continue to run before being cancelled. event_purge_batch_size = 200 integer value 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. executor_thread_pool_size = 64 integer value Size of executor thread pool when executor is threading or eventlet. fatal_deprecations = False boolean value Enables or disables fatal status of deprecations. graceful_shutdown_timeout = 60 integer value Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. heat_metadata_server_url = None string value 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_stack_user_role = heat_stack_user string value Keystone role for heat template-defined users. heat_waitcondition_server_url = None string value URL of the Heat waitcondition server. `heat_watch_server_url = ` string value URL of the Heat CloudWatch server. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch Service has been removed. hidden_stack_tags = ['data-processing-cluster'] list value 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). host = <based on operating system> string value Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. instance_connection_https_validate_certificates = 1 string value Instance connection to CFN/CW API validate certs if SSL is used. instance_connection_is_secure = 0 string value Instance connection to CFN/CW API via https. `instance_format = [instance: %(uuid)s] ` string value The format for an instance that is passed with the log message. `instance_uuid_format = [instance: %(uuid)s] ` string value The format for an instance UUID that is passed with the log message. keystone_backend = heat.engine.clients.os.keystone.heat_keystoneclient.KsClientWrapper string value Fully qualified class name to use as a keystone backend. loadbalancer_template = None string value Custom template for the built-in loadbalancer nested stack. log-config-append = None string value 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). log-date-format = %Y-%m-%d %H:%M:%S string value Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. log-dir = None string value (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. log-file = None string value (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. log_options = True boolean value Enables or disables logging values of all registered options when starting a service (at DEBUG level). log_rotate_interval = 1 integer value The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto "interval". log_rotate_interval_type = days string value Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the rotation. log_rotation_type = none string value Log rotation type. logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s string value Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d string value Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s string value Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s string value Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s string value Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter max_events_per_stack = 1000 integer value 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. max_interface_check_attempts = 10 integer value Number of times to check whether an interface has been attached or detached. max_json_body_size = 1048576 integer value Maximum raw byte size of JSON request body. Should be larger than max_template_size. max_logfile_count = 30 integer value Maximum number of rotated log files. max_logfile_size_mb = 200 integer value Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". max_nested_stack_depth = 5 integer value Maximum depth allowed when using nested stacks. max_nova_api_microversion = None floating point value 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_resources_per_stack = 1000 integer value Maximum resources allowed per top-level stack. -1 stands for unlimited. max_server_name_length = 53 integer value Maximum length of a server name to be used in nova. max_stacks_per_tenant = 100 integer value Maximum number of stacks any one tenant may have active at one time. max_template_size = 524288 integer value Maximum raw byte size of any template. num_engine_workers = None integer value 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. observe_on_update = False boolean value On update, enables heat to collect existing resource properties from reality and converge to updated template. onready = None string value Deprecated. periodic_interval = 60 integer value Seconds between running periodic tasks. plugin_dirs = ['/usr/lib64/heat', '/usr/lib/heat', '/usr/local/lib/heat', '/usr/local/lib64/heat'] list value List of directories to search for plug-ins. publish_errors = False boolean value Enables or disables publication of error events. rate_limit_burst = 0 integer value Maximum number of logged messages per rate_limit_interval. rate_limit_except_level = CRITICAL string value 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. rate_limit_interval = 0 integer value Interval, number of seconds, of log rate limiting. `reauthentication_auth_method = ` string value Allow reauthentication on token expiry, such that long-running tasks may complete. Note this defeats the expiry of any provided user tokens. region_name_for_services = None string value Default region name used to get services endpoints. rpc_conn_pool_size = 30 integer value Size of RPC connection pool. rpc_response_timeout = 60 integer value Seconds to wait for a response from a call. run_external_periodic_tasks = True boolean value Some periodic tasks can be run in a separate process. Should we run them here? `server_keystone_endpoint_type = ` string value 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. stack_action_timeout = 3600 integer value Timeout in seconds for stack action (ie. create or update). stack_domain_admin = None string value Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. stack_domain_admin_password = None string value Keystone password for stack_domain_admin user. stack_scheduler_hints = False boolean value 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. stack_user_domain_id = None string value Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored. stack_user_domain_name = None string value Keystone domain name which contains heat template-defined users. If stack_user_domain_id option is set, this option is ignored. syslog-log-facility = LOG_USER string value Syslog facility to receive log lines. This option is ignored if log_config_append is set. template_dir = /etc/heat/templates string value The directory to search for template files. transport_url = rabbit:// string value 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 trusts_delegated_roles = [] list value 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. use-journal = False boolean value 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. use-json = False boolean value Use JSON formatting for logging. This option is ignored if log_config_append is set. use-syslog = False boolean value 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_eventlog = False boolean value Log output to Windows Event Log. use_stderr = False boolean value Log output to standard error. This option is ignored if log_config_append is set. watch-log-file = False boolean value 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. 4.1.2. auth_password The following table outlines the options available under the [auth_password] group in the /etc/heat/heat.conf file. Table 4.1. auth_password Configuration option = Default value Type Description allowed_auth_uris = [] list value Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. multi_cloud = False boolean value Allow orchestration of multiple clouds. 4.1.3. clients The following table outlines the options available under the [clients] group in the /etc/heat/heat.conf file. Table 4.2. clients Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = publicURL string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = False boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.4. clients_aodh The following table outlines the options available under the [clients_aodh] group in the /etc/heat/heat.conf file. Table 4.3. clients_aodh Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.5. clients_barbican The following table outlines the options available under the [clients_barbican] group in the /etc/heat/heat.conf file. Table 4.4. clients_barbican Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.6. clients_cinder The following table outlines the options available under the [clients_cinder] group in the /etc/heat/heat.conf file. Table 4.5. clients_cinder Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. http_log_debug = False boolean value Allow client's debug log output. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.7. clients_designate The following table outlines the options available under the [clients_designate] group in the /etc/heat/heat.conf file. Table 4.6. clients_designate Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.8. clients_glance The following table outlines the options available under the [clients_glance] group in the /etc/heat/heat.conf file. Table 4.7. clients_glance Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.9. clients_heat The following table outlines the options available under the [clients_heat] group in the /etc/heat/heat.conf file. Table 4.8. clients_heat Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. `url = ` string value Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s . 4.1.10. clients_keystone The following table outlines the options available under the [clients_keystone] group in the /etc/heat/heat.conf file. Table 4.9. clients_keystone Configuration option = Default value Type Description `auth_uri = ` string value Unversioned keystone url in format like http://0.0.0.0:5000 . ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.11. clients_magnum The following table outlines the options available under the [clients_magnum] group in the /etc/heat/heat.conf file. Table 4.10. clients_magnum Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.12. clients_manila The following table outlines the options available under the [clients_manila] group in the /etc/heat/heat.conf file. Table 4.11. clients_manila Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.13. clients_mistral The following table outlines the options available under the [clients_mistral] group in the /etc/heat/heat.conf file. Table 4.12. clients_mistral Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.14. clients_monasca The following table outlines the options available under the [clients_monasca] group in the /etc/heat/heat.conf file. Table 4.13. clients_monasca Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.15. clients_neutron The following table outlines the options available under the [clients_neutron] group in the /etc/heat/heat.conf file. Table 4.14. clients_neutron Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.16. clients_nova The following table outlines the options available under the [clients_nova] group in the /etc/heat/heat.conf file. Table 4.15. clients_nova Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. http_log_debug = False boolean value Allow client's debug log output. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.17. clients_octavia The following table outlines the options available under the [clients_octavia] group in the /etc/heat/heat.conf file. Table 4.16. clients_octavia Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.18. clients_sahara The following table outlines the options available under the [clients_sahara] group in the /etc/heat/heat.conf file. Table 4.17. clients_sahara Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.19. clients_senlin The following table outlines the options available under the [clients_senlin] group in the /etc/heat/heat.conf file. Table 4.18. clients_senlin Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.20. clients_swift The following table outlines the options available under the [clients_swift] group in the /etc/heat/heat.conf file. Table 4.19. clients_swift Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.21. clients_trove The following table outlines the options available under the [clients_trove] group in the /etc/heat/heat.conf file. Table 4.20. clients_trove Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.22. clients_zaqar The following table outlines the options available under the [clients_zaqar] group in the /etc/heat/heat.conf file. Table 4.21. clients_zaqar Configuration option = Default value Type Description ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. endpoint_type = None string value Type of endpoint in Identity service catalog to use for communication with the OpenStack service. insecure = None boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. 4.1.23. cors The following table outlines the options available under the [cors] group in the /etc/heat/heat.conf file. Table 4.22. cors Configuration option = Default value Type Description allow_credentials = True boolean value Indicate that the actual request can include user credentials allow_headers = ['X-Auth-Token', 'X-Identity-Status', 'X-Roles', 'X-Service-Catalog', 'X-User-Id', 'X-Tenant-Id', 'X-OpenStack-Request-ID'] list value Indicate which header field names may be used during the actual request. allow_methods = ['GET', 'PUT', 'POST', 'DELETE', 'PATCH'] list value Indicate which methods can be used during the actual request. allowed_origin = None list value 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 expose_headers = ['X-Auth-Token', 'X-Subject-Token', 'X-Service-Token', 'X-OpenStack-Request-ID'] list value Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. max_age = 3600 integer value Maximum cache age of CORS preflight requests. 4.1.24. database The following table outlines the options available under the [database] group in the /etc/heat/heat.conf file. Table 4.23. database Configuration option = Default value Type Description backend = sqlalchemy string value The back end to use for the database. connection = None string value The SQLAlchemy connection string to use to connect to the database. connection_debug = 0 integer value Verbosity of SQL debugging information: 0=None, 100=Everything. `connection_parameters = ` string value Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=value2&... connection_recycle_time = 3600 integer value Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the time they are checked out from the pool. connection_trace = False boolean value Add Python stack traces to SQL as comment strings. db_inc_retry_interval = True boolean value If True, increases the interval between retries of a database operation up to db_max_retry_interval. db_max_retries = 20 integer value 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 integer value If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. db_retry_interval = 1 integer value Seconds between retries of a database transaction. max_overflow = 50 integer value If set, use this value for max_overflow with SQLAlchemy. max_pool_size = 5 integer value Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. max_retries = 10 integer value Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. mysql_enable_ndb = False boolean value If True, transparently enables support for handling MySQL Cluster (NDB). mysql_sql_mode = TRADITIONAL string value 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 integer value If set, use this value for pool_timeout with SQLAlchemy. retry_interval = 10 integer value Interval between retries of opening a SQL connection. slave_connection = None string value The SQLAlchemy connection string to use to connect to the slave database. sqlite_synchronous = True boolean value If True, SQLite uses synchronous mode. use_db_reconnect = False boolean value Enable the experimental use of database reconnect on connection lost. 4.1.25. ec2authtoken The following table outlines the options available under the [ec2authtoken] group in the /etc/heat/heat.conf file. Table 4.24. ec2authtoken Configuration option = Default value Type Description allowed_auth_uris = [] list value Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. auth_uri = None string value Authentication Endpoint URI. ca_file = None string value Optional CA cert file to use in SSL connections. cert_file = None string value Optional PEM-formatted certificate chain file. insecure = False boolean value If set, then the server's certificate will not be verified. key_file = None string value Optional PEM-formatted file that contains the private key. multi_cloud = False boolean value Allow orchestration of multiple clouds. 4.1.26. eventlet_opts The following table outlines the options available under the [eventlet_opts] group in the /etc/heat/heat.conf file. Table 4.25. eventlet_opts Configuration option = Default value Type Description client_socket_timeout = 900 integer value 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. wsgi_keep_alive = True boolean value If False, closes the client socket connection explicitly. 4.1.27. healthcheck The following table outlines the options available under the [healthcheck] group in the /etc/heat/heat.conf file. Table 4.26. healthcheck Configuration option = Default value Type Description backends = [] list value Additional backends that can perform health checks and report that information back as part of a request. detailed = False boolean value 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. disable_by_file_path = None string value Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. disable_by_file_paths = [] list value 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. path = /healthcheck string value The path to respond to healtcheck requests on. 4.1.28. heat_api The following table outlines the options available under the [heat_api] group in the /etc/heat/heat.conf file. Table 4.27. heat_api Configuration option = Default value Type Description backlog = 4096 integer value Number of backlog requests to configure the socket with. bind_host = 0.0.0.0 IP address value Address to bind the server. Useful when selecting a particular network interface. bind_port = 8004 port value The port on which the server will listen. cert_file = None string value Location of the SSL certificate file to use for SSL mode. key_file = None string value Location of the SSL key file to use for enabling SSL mode. max_header_line = 16384 integer value 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 = 600 integer value 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. workers = 0 integer value Number of workers for Heat service. Default value 0 means, that service will start number of workers equal number of cores on server. 4.1.29. heat_api_cfn The following table outlines the options available under the [heat_api_cfn] group in the /etc/heat/heat.conf file. Table 4.28. heat_api_cfn Configuration option = Default value Type Description backlog = 4096 integer value Number of backlog requests to configure the socket with. bind_host = 0.0.0.0 IP address value Address to bind the server. Useful when selecting a particular network interface. bind_port = 8000 port value The port on which the server will listen. cert_file = None string value Location of the SSL certificate file to use for SSL mode. key_file = None string value Location of the SSL key file to use for enabling SSL mode. max_header_line = 16384 integer value 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 = 600 integer value 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. workers = 1 integer value Number of workers for Heat service. 4.1.30. heat_api_cloudwatch The following table outlines the options available under the [heat_api_cloudwatch] group in the /etc/heat/heat.conf file. Table 4.29. heat_api_cloudwatch Configuration option = Default value Type Description backlog = 4096 integer value Number of backlog requests to configure the socket with. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been removed. bind_host = 0.0.0.0 IP address value Address to bind the server. Useful when selecting a particular network interface. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been removed. bind_port = 8003 port value The port on which the server will listen. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been removed. cert_file = None string value Location of the SSL certificate file to use for SSL mode. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been Removed. key_file = None string value Location of the SSL key file to use for enabling SSL mode. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been Removed. max_header_line = 16384 integer value 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.) Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been Removed. tcp_keepidle = 600 integer value 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. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been Removed. workers = 1 integer value Number of workers for Heat service. Deprecated since: 10.0.0 *Reason:*Heat CloudWatch API has been Removed. 4.1.31. keystone_authtoken The following table outlines the options available under the [keystone_authtoken] group in the /etc/heat/heat.conf file. Table 4.30. keystone_authtoken Configuration option = Default value Type Description auth_section = None string value Config Section from which to load plugin specific options auth_type = None string value Authentication type to load auth_uri = None string value 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. Deprecated since: Queens *Reason:*The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release. auth_version = None string value API version of the Identity API endpoint. cache = None string value 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. cafile = None string value A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. certfile = None string value Required if identity server requires client certificate delay_auth_decision = False boolean value Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. enforce_token_bind = permissive string value 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. http_connect_timeout = None integer value Request timeout value for communicating with Identity API server. http_request_max_retries = 3 integer value How many times are we trying to reconnect when communicating with Identity API Server. include_service_catalog = True boolean value (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 boolean value Verify HTTPS connections. interface = admin string value Interface to use for the Identity API endpoint. Valid values are "public", "internal" or "admin"(default). keyfile = None string value Required if identity server requires client certificate memcache_pool_conn_get_timeout = 10 integer value (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. memcache_pool_dead_retry = 300 integer value (Optional) Number of seconds memcached server is considered dead before it is tried again. memcache_pool_maxsize = 10 integer value (Optional) Maximum total number of open connections to every memcached server. memcache_pool_socket_timeout = 3 integer value (Optional) Socket timeout in seconds for communicating with a memcached server. memcache_pool_unused_timeout = 60 integer value (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. memcache_secret_key = None string value (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. memcache_security_strategy = None string value (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_use_advanced_pool = False boolean value (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. memcached_servers = None list value 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 string value The region in which the identity server can be found. service_token_roles = ['service'] list value 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 = False boolean value 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 = None string value 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. token_cache_time = 300 integer value 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. www_authenticate_uri = None string value 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. 4.1.32. noauth The following table outlines the options available under the [noauth] group in the /etc/heat/heat.conf file. Table 4.31. noauth Configuration option = Default value Type Description `token_response = ` string value JSON file containing the content returned by the noauth middleware. 4.1.33. oslo_messaging_amqp The following table outlines the options available under the [oslo_messaging_amqp] group in the /etc/heat/heat.conf file. Table 4.32. oslo_messaging_amqp Configuration option = Default value Type Description addressing_mode = dynamic string value 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 anycast_address = anycast string value 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. broadcast_prefix = broadcast string value address prefix used when broadcasting to all servers connection_retry_backoff = 2 integer value Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. connection_retry_interval = 1 integer value Seconds to pause before attempting to re-connect. connection_retry_interval_max = 30 integer value Maximum limit for connection_retry_interval + connection_retry_backoff container_name = None string value Name for the AMQP container. must be globally unique. Defaults to a generated UUID default_notification_exchange = None string value 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_notify_timeout = 30 integer value The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. default_reply_retry = 0 integer value The maximum number of attempts to re-send a reply message which failed due to a recoverable error. default_reply_timeout = 30 integer value The deadline for an rpc reply message delivery. default_rpc_exchange = None string value 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 default_send_timeout = 30 integer value The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. default_sender_link_timeout = 600 integer value The duration to schedule a purge of idle sender links. Detach link after expiry. group_request_prefix = unicast string value address prefix when sending to any server in group idle_timeout = 0 integer value Timeout for inactive connections (in seconds) link_retry_delay = 10 integer value Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. multicast_address = multicast string value Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. notify_address_prefix = openstack.org/om/notify string value Address prefix for all generated Notification addresses notify_server_credit = 100 integer value Window size for incoming Notification messages pre_settled = ['rpc-cast', 'rpc-reply'] multi valued 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 pseudo_vhost = True boolean value 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. reply_link_credit = 200 integer value Window size for incoming RPC Reply messages. rpc_address_prefix = openstack.org/om/rpc string value Address prefix for all generated RPC addresses rpc_server_credit = 100 integer value Window size for incoming RPC Request messages `sasl_config_dir = ` string value Path to directory that contains the SASL configuration `sasl_config_name = ` string value Name of configuration file (without .conf suffix) `sasl_default_realm = ` string value SASL realm to use if no realm present in username `sasl_mechanisms = ` string value Space separated list of acceptable SASL mechanisms server_request_prefix = exclusive string value address prefix used when sending to a specific server ssl = False boolean value 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 = ` string value CA certificate PEM file used to verify the server's certificate `ssl_cert_file = ` string value Self-identifying certificate PEM file for client authentication `ssl_key_file = ` string value Private key PEM file used to sign ssl_cert_file certificate (optional) ssl_key_password = None string value Password for decrypting ssl_key_file (if encrypted) ssl_verify_vhost = False boolean value 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. trace = False boolean value Debug: dump AMQP frames to stdout unicast_address = unicast string value 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. 4.1.34. oslo_messaging_kafka The following table outlines the options available under the [oslo_messaging_kafka] group in the /etc/heat/heat.conf file. Table 4.33. oslo_messaging_kafka Configuration option = Default value Type Description compression_codec = none string value 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 conn_pool_min_size = 2 integer value The pool size limit for connections expiration policy conn_pool_ttl = 1200 integer value The time-to-live in sec of idle connections in the pool consumer_group = oslo_messaging_consumer string value Group id for Kafka consumer. Consumers in one group will coordinate message consumption enable_auto_commit = False boolean value Enable asynchronous consumer commits kafka_consumer_timeout = 1.0 floating point value Default timeout(s) for Kafka consumers kafka_max_fetch_bytes = 1048576 integer value Max fetch bytes of Kafka consumer max_poll_records = 500 integer value The maximum number of records returned in a poll call pool_size = 10 integer value Pool Size for Kafka Consumers producer_batch_size = 16384 integer value Size of batch for the producer async send producer_batch_timeout = 0.0 floating point value Upper bound on the delay for KafkaProducer batching in seconds sasl_mechanism = PLAIN string value Mechanism when security protocol is SASL security_protocol = PLAINTEXT string value Protocol used to communicate with brokers `ssl_cafile = ` string value CA certificate PEM file used to verify the server certificate 4.1.35. oslo_messaging_notifications The following table outlines the options available under the [oslo_messaging_notifications] group in the /etc/heat/heat.conf file. Table 4.34. oslo_messaging_notifications Configuration option = Default value Type Description driver = [] multi valued The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop retry = -1 integer value 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 topics = ['notifications'] list value AMQP topic used for OpenStack notifications. transport_url = None string value A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. 4.1.36. oslo_messaging_rabbit The following table outlines the options available under the [oslo_messaging_rabbit] group in the /etc/heat/heat.conf file. Table 4.35. oslo_messaging_rabbit Configuration option = Default value Type Description amqp_auto_delete = False boolean value Auto-delete queues in AMQP. amqp_durable_queues = False boolean value Use durable queues in AMQP. direct_mandatory_flag = True boolean value (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 enable_cancel_on_failover = False boolean value Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down heartbeat_in_pthread = False boolean value EXPERIMENTAL: Run the health check heartbeat threadthrough a native python thread. By default if thisoption isn't provided the health check heartbeat willinherit the execution model from the parent process. Byexample if the parent process have monkey patched thestdlib by using eventlet/greenlet then the heartbeatwill be run through a green thread. heartbeat_rate = 2 integer value How often times during the heartbeat_timeout_threshold we check the heartbeat. heartbeat_timeout_threshold = 60 integer value Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables heartbeat). kombu_compression = None string value EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. kombu_failover_strategy = round-robin string value Determines how the 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. kombu_missing_consumer_retry_timeout = 60 integer value How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. kombu_reconnect_delay = 1.0 floating point value How long to wait before reconnecting in response to an AMQP consumer cancel notification. rabbit_ha_queues = False boolean value Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA ^(?!amq\.).* {"ha-mode": "all"} " rabbit_interval_max = 30 integer value Maximum interval of RabbitMQ connection retries. Default is 30 seconds. rabbit_login_method = AMQPLAIN string value The RabbitMQ login method. rabbit_qos_prefetch_count = 0 integer value Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. rabbit_retry_backoff = 2 integer value How long to backoff for between retries when connecting to RabbitMQ. rabbit_retry_interval = 1 integer value How frequently to retry connecting with RabbitMQ. rabbit_transient_queues_ttl = 1800 integer value 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. ssl = False boolean value Connect over SSL. `ssl_ca_file = ` string value SSL certification authority file (valid only if SSL enabled). `ssl_cert_file = ` string value SSL cert file (valid only if SSL enabled). `ssl_key_file = ` string value SSL key file (valid only if SSL enabled). `ssl_version = ` string value 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. 4.1.37. oslo_middleware The following table outlines the options available under the [oslo_middleware] group in the /etc/heat/heat.conf file. Table 4.36. oslo_middleware Configuration option = Default value Type Description enable_proxy_headers_parsing = False boolean value Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. max_request_body_size = 114688 integer value The maximum body size for each request, in bytes. secure_proxy_ssl_header = X-Forwarded-Proto string value 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. 4.1.38. oslo_policy The following table outlines the options available under the [oslo_policy] group in the /etc/heat/heat.conf file. Table 4.37. oslo_policy Configuration option = Default value Type Description enforce_scope = False boolean value 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. policy_default_rule = default string value Default rule. Enforced when a requested rule is not found. policy_dirs = ['policy.d'] multi valued 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. policy_file = policy.json string value 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. remote_content_type = application/x-www-form-urlencoded string value Content Type to send and receive data for REST based policy check remote_ssl_ca_crt_file = None string value Absolute path to ca cert file for REST based policy check remote_ssl_client_crt_file = None string value Absolute path to client cert for REST based policy check remote_ssl_client_key_file = None string value Absolute path client key file REST based policy check remote_ssl_verify_server_crt = False boolean value server identity verification for REST based policy check 4.1.39. paste_deploy The following table outlines the options available under the [paste_deploy] group in the /etc/heat/heat.conf file. Table 4.38. paste_deploy Configuration option = Default value Type Description api_paste_config = api-paste.ini string value The API paste config file to use. flavor = None string value The flavor to use. 4.1.40. profiler The following table outlines the options available under the [profiler] group in the /etc/heat/heat.conf file. Table 4.39. profiler Configuration option = Default value Type Description connection_string = messaging:// string value 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. enabled = False boolean value 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. es_doc_type = notification string value Document type for notification indexing in elasticsearch. es_scroll_size = 10000 integer value Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). es_scroll_time = 2m string value 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. filter_error_trace = False boolean value 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. hmac_keys = SECRET_KEY string value 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. sentinel_service_name = mymaster string value Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: sentinal_service_name=mymaster ). socket_timeout = 0.1 floating point value Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). trace_sqlalchemy = False boolean value 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. 4.1.41. revision The following table outlines the options available under the [revision] group in the /etc/heat/heat.conf file. Table 4.40. revision Configuration option = Default value Type Description heat_revision = unknown string value 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. 4.1.42. ssl The following table outlines the options available under the [ssl] group in the /etc/heat/heat.conf file. Table 4.41. ssl Configuration option = Default value Type Description ca_file = None string value CA certificate file to use to verify connecting clients. cert_file = None string value Certificate file to use when starting the server securely. ciphers = None string value Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. key_file = None string value Private key file to use when starting the server securely. version = None string value 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. 4.1.43. trustee The following table outlines the options available under the [trustee] group in the /etc/heat/heat.conf file. Table 4.42. trustee Configuration option = Default value Type Description auth-url = None string value Authentication URL auth_section = None string value Config Section from which to load plugin specific options auth_type = None string value Authentication type to load default-domain-id = None string value 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 = None string value 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. domain-id = None string value Domain ID to scope to domain-name = None string value Domain name to scope to password = None string value User's password project-domain-id = None string value Domain ID containing project project-domain-name = None string value Domain name containing project project-id = None string value Project ID to scope to project-name = None string value Project name to scope to system-scope = None string value Scope for system operations trust-id = None string value Trust ID user-domain-id = None string value User's domain id user-domain-name = None string value User's domain name user-id = None string value User id username = None string value Username 4.1.44. volumes The following table outlines the options available under the [volumes] group in the /etc/heat/heat.conf file. Table 4.43. volumes Configuration option = Default value Type Description backups_enabled = True boolean value Indicate if cinder-backup service is enabled. This is a temporary workaround until cinder-backup service becomes discoverable, see LP#1334856.

Commands: