274 lines
13 KiB
XML
274 lines
13 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="heat-conf-changes-liberty">
|
|
<!-- 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 Liberty 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] encrypt_parameters_and_properties = False</td>
|
|
<td>(BoolOpt) Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] executor_thread_pool_size = 64</td>
|
|
<td>(IntOpt) Size of executor thread pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] hidden_stack_tags = </td>
|
|
<td>(ListOpt) 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).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] rpc_conn_pool_size = 30</td>
|
|
<td>(IntOpt) Size of RPC connection pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] backend = dogpile.cache.null</td>
|
|
<td>(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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] backend_argument = []</td>
|
|
<td>(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>".</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] config_prefix = cache.oslo</td>
|
|
<td>(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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] debug_cache_backend = False</td>
|
|
<td>(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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] enabled = False</td>
|
|
<td>(BoolOpt) Global toggle for caching.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] expiration_time = 600</td>
|
|
<td>(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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] memcache_dead_retry = 300</td>
|
|
<td>(IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] memcache_pool_connection_get_timeout = 10</td>
|
|
<td>(IntOpt) Number of seconds that an operation will wait to get a memcache client connection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] memcache_pool_maxsize = 10</td>
|
|
<td>(IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] memcache_pool_unused_timeout = 60</td>
|
|
<td>(IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] memcache_servers = localhost:11211</td>
|
|
<td>(ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] memcache_socket_timeout = 3</td>
|
|
<td>(IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cache] proxies = </td>
|
|
<td>(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[constraint_validation_cache] caching = True</td>
|
|
<td>(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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[constraint_validation_cache] expiration_time = 60</td>
|
|
<td>(IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors] allow_credentials = True</td>
|
|
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
|
|
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors] allow_methods = GET, POST, PUT, DELETE, OPTIONS</td>
|
|
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors] allowed_origin = None</td>
|
|
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
|
|
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors] max_age = 3600</td>
|
|
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors.subdomain] allow_credentials = True</td>
|
|
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors.subdomain] allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
|
|
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors.subdomain] allow_methods = GET, POST, PUT, DELETE, OPTIONS</td>
|
|
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors.subdomain] allowed_origin = None</td>
|
|
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors.subdomain] expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</td>
|
|
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[cors.subdomain] max_age = 3600</td>
|
|
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[eventlet_opts] client_socket_timeout = 900</td>
|
|
<td>(IntOpt) 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[eventlet_opts] wsgi_keep_alive = True</td>
|
|
<td>(BoolOpt) If False, closes the client socket connection explicitly.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[heat_api] tcp_keepidle = 600</td>
|
|
<td>(IntOpt) 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[heat_api_cfn] tcp_keepidle = 600</td>
|
|
<td>(IntOpt) 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[heat_api_cloudwatch] tcp_keepidle = 600</td>
|
|
<td>(IntOpt) 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_qpid] send_single_reply = False</td>
|
|
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] kombu_reconnect_timeout = 60</td>
|
|
<td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] send_single_reply = False</td>
|
|
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_middleware] secure_proxy_ssl_header = X-Forwarded-Proto</td>
|
|
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_policy] policy_default_rule = default</td>
|
|
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_policy] 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. Missing or empty directories are ignored.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_policy] policy_file = policy.json</td>
|
|
<td>(StrOpt) The JSON file that defines policies.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_versionedobjects] fatal_exception_format_errors = False</td>
|
|
<td>(BoolOpt) Make exception message format errors fatal</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] 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, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=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, taskflow=WARN</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] enable_cloud_watch_lite</td>
|
|
<td>True</td>
|
|
<td>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] heat_waitcondition_server_url</td>
|
|
<td></td>
|
|
<td>None</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] instance_user</td>
|
|
<td>ec2-user</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] logging_exception_prefix</td>
|
|
<td>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
|
|
<td>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] use_syslog_rfc_format</td>
|
|
<td>False</td>
|
|
<td>True</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] verbose</td>
|
|
<td>False</td>
|
|
<td>True</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[heat_api] workers</td>
|
|
<td>0</td>
|
|
<td>4</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[oslo_messaging_rabbit] heartbeat_timeout_threshold</td>
|
|
<td>0</td>
|
|
<td>60</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] use_syslog</td>
|
|
<td>None</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] rpc_thread_pool_size</td>
|
|
<td>[DEFAULT] executor_thread_pool_size</td>
|
|
</tr>
|
|
<tr>
|
|
<td>[DEFAULT] log_format</td>
|
|
<td>None</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|