openstack/openstack-manuals
Code Issues Proposed changes

Update Config reference for heat

Browse Source 
Change-Id: I30e2c05cbc09aa6280a8d5c7fb97fc5cb5bcdaf5
Partial-Bug: #1407581
This commit is contained in:
Atsushi SAKAI 2015-09-01 15:35:28 +09:00
parent 3ad8bcb295
commit 5d7e055543
8 changed files with 101 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/common/tables/heat-api.xml
View File

@ -58,7 +58,7 @@
<td>(IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size.</td>
</tr>
<tr>
<td><option>num_engine_workers</option> = <replaceable>4</replaceable></td>
<td><option>num_engine_workers</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Number of heat-engine processes to fork and run.</td>
</tr>
<tr>
@ -79,7 +79,7 @@
</tr>
<tr>
<td><option>stack_scheduler_hints</option> = <replaceable>False</replaceable></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>
<td>(BoolOpt) 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 tuples, (stackresourcename, stackname) with list[0] being (None, 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.</td>
</tr>
<tr>
<td><option>stack_user_domain_id</option> = <replaceable>None</replaceable></td>
@ -178,7 +178,7 @@
<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><option>workers</option> = <replaceable>4</replaceable></td>
<td><option>workers</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Number of workers for Heat service.</td>
</tr>
<tr>

4
doc/common/tables/heat-clients_keystone.xml
View File

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[clients_keystone]</th>
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable></replaceable></td>
<td>(StrOpt) Unversioned keystone url in format like http://0.0.0.0:5000.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Optional CA cert file to use in SSL connections.</td>

74
doc/common/tables/heat-common.xml
View File

@ -46,12 +46,12 @@
<td>(IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>instance_user</option> = <replaceable>ec2-user</replaceable></td>
<td>(StrOpt) The default user for new instances. This option is deprecated and will be removed in the Juno release. If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance).</td>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
</tr>
<tr>
<td><option>keystone_backend</option> = <replaceable>heat.common.heat_keystoneclient.KeystoneClientV3</replaceable></td>
@ -69,6 +69,72 @@
<td><option>plugin_dirs</option> = <replaceable>/usr/lib64/heat, /usr/lib/heat, /usr/local/lib/heat, /usr/local/lib64/heat</replaceable></td>
<td>(ListOpt) List of directories to search for plug-ins.</td>
</tr>
<tr>
<th colspan="2">[cache]</th>
</tr>
<tr>
<td><option>backend</option> = <replaceable>dogpile.cache.null</replaceable></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><option>backend_argument</option> = <replaceable>[]</replaceable></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: "&lt;argname&gt;:&lt;value&gt;".</td>
</tr>
<tr>
<td><option>config_prefix</option> = <replaceable>cache.oslo</replaceable></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><option>debug_cache_backend</option> = <replaceable>False</replaceable></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><option>enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Global toggle for caching.</td>
</tr>
<tr>
<td><option>expiration_time</option> = <replaceable>600</replaceable></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><option>memcache_dead_retry</option> = <replaceable>300</replaceable></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><option>memcache_pool_connection_get_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of seconds that an operation will wait to get a memcache client connection.</td>
</tr>
<tr>
<td><option>memcache_pool_maxsize</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only).</td>
</tr>
<tr>
<td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></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><option>memcache_servers</option> = <replaceable>localhost:11211</replaceable></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><option>memcache_socket_timeout</option> = <replaceable>3</replaceable></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><option>proxies</option> = <replaceable></replaceable></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>
<th colspan="2">[constraint_validation_cache]</th>
</tr>
<tr>
<td><option>caching</option> = <replaceable>True</replaceable></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><option>expiration_time</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>

10
doc/common/tables/heat-logging.xml
View File

@ -19,10 +19,10 @@
</tr>
<tr>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>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</replaceable></td>
<td><option>default_log_levels</option> = <replaceable>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</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
@ -91,11 +91,11 @@
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></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 K, and will be removed in M, along with this option.</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 Kilo, and will be removed in Mitaka, along with this option.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/heat-qpid.xml
View File

@ -71,7 +71,7 @@
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></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>
<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 the Mitaka release.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/heat-rabbitmq.xml
View File

@ -111,7 +111,7 @@
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></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>
<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 the Mitaka release.</td>
</tr>
</tbody>
</table>

4
doc/common/tables/heat-rpc.xml
View File

@ -45,10 +45,6 @@
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC thread pool.</td>
</tr>
<tr>
<th colspan="2">[oslo_concurrency]</th>
</tr>

19
tools/autogenerate-config-flagmappings/heat.flagmappings
View File

@ -18,6 +18,7 @@ engine_life_check_timeout rpc
environment_dir common
error_wait_time common
event_purge_batch_size common
executor_thread_pool_size common
fatal_deprecations logging
heat_metadata_server_url api metadata_api
heat_stack_user_role api
@ -28,7 +29,6 @@ host common
instance_connection_https_validate_certificates cfn_api
instance_connection_is_secure cfn_api
instance_format logging
instance_user common
instance_uuid_format logging
keystone_backend common
loadbalancer_template loadbalancer
@ -62,7 +62,6 @@ rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_thread_pool_size rpc
rpc_zmq_bind_address zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
@ -86,6 +85,19 @@ use_syslog_rfc_format logging
verbose logging
auth_password/allowed_auth_uris api
auth_password/multi_cloud api
cache/backend common
cache/backend_argument common
cache/config_prefix common
cache/debug_cache_backend common
cache/enabled common
cache/expiration_time common
cache/memcache_dead_retry common
cache/memcache_pool_connection_get_timeout common
cache/memcache_pool_maxsize common
cache/memcache_pool_unused_timeout common
cache/memcache_servers common
cache/memcache_socket_timeout common
cache/proxies common
clients/ca_file clients
clients/cert_file clients
clients/endpoint_type clients
@ -113,6 +125,7 @@ clients_heat/endpoint_type clients_heat
clients_heat/insecure clients_heat
clients_heat/key_file clients_heat
clients_heat/url clients_heat
clients_keystone/auth_uri clients_keystone
clients_keystone/ca_file clients_keystone
clients_keystone/cert_file clients_keystone
clients_keystone/endpoint_type clients_keystone
@ -144,6 +157,8 @@ clients_trove/cert_file clients_trove
clients_trove/endpoint_type clients_trove
clients_trove/insecure clients_trove
clients_trove/key_file clients_trove
constraint_validation_cache/caching common
constraint_validation_cache/expiration_time common
cors/allow_credentials cors
cors/allow_headers cors
cors/allow_methods cors