8b2016b5d0
Include the new tables in the documentation. Fix the cinder-prophetstor_dpl.xml filename and the xiv category. Manually fix those files for niceness test: - glance-logging.xml (lines 34, 38), fixed in oslo-incubator - trove-logging.xml (lines 26, 30), fixed in oslo-incubator - neutron-openvswitch_agent.xml (line 45), to be fixed in neutron Closes-Bug: #1340858 Closes-Bug: #1344231 Closes-Bug: #1345956 Closes-Bug: #1346711 Closes-Bug: #1347978 Partial-Bug: #1348329 Closes-Bug: #1352074 Partial-Bug: #1353417 Closes-Bug: #1354622 Closes-Bug: #1339754 Closes-Bug: #1358598 Closes-Bug: #1358259 Closes-Bug: #1357865 Partial-Bug: #1357457 Closes-Bug: #1357421 Change-Id: Id2da7d7762ca954bd552dbf89a9ff28b144efb68
170 lines
6.1 KiB
XML
170 lines
6.1 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
|
|
<!-- Warning: Do not edit this file. It is automatically
|
|
generated and your changes will be overwritten.
|
|
The tool to do so lives in openstack-doc-tools repository. -->
|
|
<table rules="all" xml:id="config_table_heat_api">
|
|
<caption>Description of configuration options for api</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>action_retry_limit = 5</td>
|
|
<td>(IntOpt) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>heat_metadata_server_url = </td>
|
|
<td>(StrOpt) URL of the Heat metadata server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>heat_stack_user_role = heat_stack_user</td>
|
|
<td>(StrOpt) Keystone role for heat template-defined users.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>heat_waitcondition_server_url = </td>
|
|
<td>(StrOpt) URL of the Heat waitcondition server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>heat_watch_server_url = </td>
|
|
<td>(StrOpt) URL of the Heat CloudWatch server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>max_json_body_size = 1048576</td>
|
|
<td>(IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>num_engine_workers = 1</td>
|
|
<td>(IntOpt) Number of heat-engine processes to fork and run.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>policy_default_rule = default</td>
|
|
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>policy_file = policy.json</td>
|
|
<td>(StrOpt) The JSON file that defines policies.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>secure_proxy_ssl_header = X-Forwarded-Proto</td>
|
|
<td>(StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>stack_action_timeout = 3600</td>
|
|
<td>(IntOpt) Timeout in seconds for stack action (ie. create or update).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>stack_domain_admin = None</td>
|
|
<td>(StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>stack_domain_admin_password = None</td>
|
|
<td>(StrOpt) Keystone password for stack_domain_admin user.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>stack_user_domain_id = None</td>
|
|
<td>(StrOpt) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>stack_user_domain_name = None</td>
|
|
<td>(StrOpt) Keystone domain name which contains heat template-defined users. If `stack_user_domain_id` option is set, this option is ignored.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>trusts_delegated_roles = heat_stack_owner</td>
|
|
<td>(ListOpt) Subset of trustor roles to be delegated to heat.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[auth_password]</th>
|
|
</tr>
|
|
<tr>
|
|
<td>allowed_auth_uris = </td>
|
|
<td>(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>multi_cloud = False</td>
|
|
<td>(BoolOpt) Allow orchestration of multiple clouds.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[ec2authtoken]</th>
|
|
</tr>
|
|
<tr>
|
|
<td>allowed_auth_uris = </td>
|
|
<td>(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>auth_uri = None</td>
|
|
<td>(StrOpt) Authentication Endpoint URI.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>multi_cloud = False</td>
|
|
<td>(BoolOpt) Allow orchestration of multiple clouds.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[heat_api]</th>
|
|
</tr>
|
|
<tr>
|
|
<td>backlog = 4096</td>
|
|
<td>(IntOpt) Number of backlog requests to configure the socket with.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>bind_host = 0.0.0.0</td>
|
|
<td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>bind_port = 8004</td>
|
|
<td>(IntOpt) The port on which the server will listen.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>cert_file = None</td>
|
|
<td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>key_file = None</td>
|
|
<td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>max_header_line = 16384</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>workers = 0</td>
|
|
<td>(IntOpt) Number of workers for Heat service.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[paste_deploy]</th>
|
|
</tr>
|
|
<tr>
|
|
<td>api_paste_config = api-paste.ini</td>
|
|
<td>(StrOpt) The API paste config file to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flavor = None</td>
|
|
<td>(StrOpt) The flavor to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[ssl]</th>
|
|
</tr>
|
|
<tr>
|
|
<td>ca_file = None</td>
|
|
<td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>cert_file = None</td>
|
|
<td>(StrOpt) Certificate file to use when starting the server securely.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>key_file = None</td>
|
|
<td>(StrOpt) Private key file to use when starting the server securely.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|