393 lines
17 KiB
XML
393 lines
17 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="heat-conf-changes-kilo">
|
|
<!-- Warning: Do not edit this file. It is automatically generated and your changes will be overwritten. The tool to do so lives in the openstack-doc-tools repository. -->
|
|
<title>New, updated and deprecated options in Kilo for Orchestration</title>
|
|
<table>
|
|
<caption>New options</caption>
|
|
<col width="50%"/>
|
|
<col width="50%"/>
|
|
<thead>
|
|
<tr>
|
|
<td>Option = default value</td>
|
|
<td>(Type) Help string</td>
|
|
</tr>
|
|
</thead>
|
|
<tr>
|
|
<td>[DEFAULT] convergence_engine = False</td>
|
|
<td>(BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine .</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] default_deployment_signal_transport = CFN_SIGNAL</td>
|
|
<td>(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</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] default_software_config_transport = POLL_SERVER_CFN</td>
|
|
<td>(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).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] error_wait_time = 240</td>
|
|
<td>(IntOpt) Error wait time in seconds for stack action (ie. create or update).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] fatal_exception_format_errors = False</td>
|
|
<td>(BoolOpt) Make exception message format errors fatal</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-config-append = None</td>
|
|
<td>(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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-date-format = %Y-%m-%d %H:%M:%S</td>
|
|
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-dir = None</td>
|
|
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-file = None</td>
|
|
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log-format = None</td>
|
|
<td>(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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] policy_dirs = ['policy.d']</td>
|
|
<td>(MultiStrOpt) 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] stack_scheduler_hints = False</td>
|
|
<td>(BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server resource are passed to the configured schedulers in nova, for server creates done using heat resource types 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 tuples, (stackresourcename, stackname) with list[0] being (None, rootstackname), and heat_resource_name will be set to the resource's name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] syslog-log-facility = LOG_USER</td>
|
|
<td>(StrOpt) Syslog facility to receive log lines.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use-syslog = False</td>
|
|
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use-syslog-rfc-format = False</td>
|
|
<td>(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 I, and will be removed in J.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[clients_sahara] ca_file = None</td>
|
|
<td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[clients_sahara] cert_file = None</td>
|
|
<td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[clients_sahara] endpoint_type = None</td>
|
|
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[clients_sahara] insecure = None</td>
|
|
<td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[clients_sahara] key_file = None</td>
|
|
<td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[ec2authtoken] ca_file = None</td>
|
|
<td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[ec2authtoken] cert_file = None</td>
|
|
<td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[ec2authtoken] insecure = False</td>
|
|
<td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[ec2authtoken] key_file = None</td>
|
|
<td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] allow_insecure_clients = False</td>
|
|
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] broadcast_prefix = broadcast</td>
|
|
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] container_name = None</td>
|
|
<td>(StrOpt) Name for the AMQP container</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] group_request_prefix = unicast</td>
|
|
<td>(StrOpt) address prefix when sending to any server in group</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] idle_timeout = 0</td>
|
|
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] server_request_prefix = exclusive</td>
|
|
<td>(StrOpt) address prefix used when sending to a specific server</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_ca_file = </td>
|
|
<td>(StrOpt) CA certificate PEM file to verify server certificate</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_cert_file = </td>
|
|
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_key_file = </td>
|
|
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] ssl_key_password = None</td>
|
|
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_amqp] trace = False</td>
|
|
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] amqp_auto_delete = False</td>
|
|
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] amqp_durable_queues = False</td>
|
|
<td>(BoolOpt) Use durable queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_heartbeat = 60</td>
|
|
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_hostname = localhost</td>
|
|
<td>(StrOpt) Qpid broker hostname.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_hosts = $qpid_hostname:$qpid_port</td>
|
|
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_password = </td>
|
|
<td>(StrOpt) Password for Qpid connection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_port = 5672</td>
|
|
<td>(IntOpt) Qpid broker port.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_protocol = tcp</td>
|
|
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_receiver_capacity = 1</td>
|
|
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_sasl_mechanisms = </td>
|
|
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_tcp_nodelay = True</td>
|
|
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_topology_version = 1</td>
|
|
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] qpid_username = </td>
|
|
<td>(StrOpt) Username for Qpid connection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] rpc_conn_pool_size = 30</td>
|
|
<td>(IntOpt) Size of RPC connection pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] amqp_auto_delete = False</td>
|
|
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] amqp_durable_queues = False</td>
|
|
<td>(BoolOpt) Use durable queues in AMQP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] fake_rabbit = False</td>
|
|
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] heartbeat_rate = 2</td>
|
|
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0</td>
|
|
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it. Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_reconnect_delay = 1.0</td>
|
|
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_ca_certs = </td>
|
|
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_certfile = </td>
|
|
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_keyfile = </td>
|
|
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_ssl_version = </td>
|
|
<td>(StrOpt) 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_ha_queues = False</td>
|
|
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_host = localhost</td>
|
|
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_hosts = $rabbit_host:$rabbit_port</td>
|
|
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_login_method = AMQPLAIN</td>
|
|
<td>(StrOpt) The RabbitMQ login method.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_max_retries = 0</td>
|
|
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_password = guest</td>
|
|
<td>(StrOpt) The RabbitMQ password.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_port = 5672</td>
|
|
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_retry_backoff = 2</td>
|
|
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_retry_interval = 1</td>
|
|
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_use_ssl = False</td>
|
|
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_userid = guest</td>
|
|
<td>(StrOpt) The RabbitMQ userid.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rabbit_virtual_host = /</td>
|
|
<td>(StrOpt) The RabbitMQ virtual host.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] rpc_conn_pool_size = 30</td>
|
|
<td>(IntOpt) Size of RPC connection pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_middleware] max_request_body_size = 114688</td>
|
|
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[profiler] profiler_enabled = False</td>
|
|
<td>(BoolOpt) If False fully disable profiling feature.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[profiler] trace_sqlalchemy = False</td>
|
|
<td>(BoolOpt) If False do not trace SQL requests.</td>
|
|
</tr>
|
|
</table>
|
|
<table>
|
|
<caption>New default values</caption>
|
|
<col width="33%"/>
|
|
<col width="33%"/>
|
|
<col width="33%"/>
|
|
<thead>
|
|
<tr>
|
|
<td>Option</td>
|
|
<td>Previous default value</td>
|
|
<td>New default value</td>
|
|
</tr>
|
|
</thead>
|
|
<tr>
|
|
<td>[DEFAULT] auth_encryption_key</td>
|
|
<td>notgood but just long enough i think</td>
|
|
<td>notgood but just long enough i t</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] default_log_levels</td>
|
|
<td>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
|
|
<td>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</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] deferred_auth_method</td>
|
|
<td>password</td>
|
|
<td>trusts</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] max_nested_stack_depth</td>
|
|
<td>3</td>
|
|
<td>5</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] num_engine_workers</td>
|
|
<td>1</td>
|
|
<td>4</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] plugin_dirs</td>
|
|
<td>/usr/lib64/heat, /usr/lib/heat</td>
|
|
<td>/usr/lib64/heat, /usr/lib/heat, /usr/local/lib/heat, /usr/local/lib64/heat</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] rpc_zmq_matchmaker</td>
|
|
<td>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
|
|
<td>local</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] trusts_delegated_roles</td>
|
|
<td>heat_stack_owner</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
<table>
|
|
<caption>Deprecated options</caption>
|
|
<col width="50%"/>
|
|
<col width="50%"/>
|
|
<thead>
|
|
<tr>
|
|
<td>Deprecated option</td>
|
|
<td>New Option</td>
|
|
</tr>
|
|
</thead>
|
|
<tr>
|
|
<td>[DEFAULT] log-format</td>
|
|
<td>None</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use-syslog</td>
|
|
<td>None</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] list_notifier_drivers</td>
|
|
<td>None</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|