openstack-manuals/doc/common/tables/heat-cfn_api.xml
Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

84 lines
3.5 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_heat_cfn_api">
<caption>Description of Cloudformation-compatible API configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>instance_connection_https_validate_certificates</option> = <replaceable>1</replaceable></td>
<td>(StrOpt) Instance connection to CFN/CW API validate certs if SSL is used.</td>
</tr>
<tr>
<td><option>instance_connection_is_secure</option> = <replaceable>0</replaceable></td>
<td>(StrOpt) Instance connection to CFN/CW API via https.</td>
</tr>
<tr>
<th colspan="2">[heat_api_cfn]</th>
</tr>
<tr>
<td><option>backlog</option> = <replaceable>4096</replaceable></td>
<td>(IntOpt) Number of backlog requests to configure the socket with.</td>
</tr>
<tr>
<td><option>bind_host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
</tr>
<tr>
<td><option>bind_port</option> = <replaceable>8000</replaceable></td>
<td>(IntOpt) The port on which the server will listen.</td>
</tr>
<tr>
<td><option>cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
</tr>
<tr>
<td><option>key_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
</tr>
<tr>
<td><option>max_header_line</option> = <replaceable>16384</replaceable></td>
<td>(IntOpt) 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).</td>
</tr>
<tr>
<td><option>tcp_keepidle</option> = <replaceable>600</replaceable></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><option>workers</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of workers for Heat service.</td>
</tr>
</tbody>
</table>
</para>