231 lines
12 KiB
XML
231 lines
12 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 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>action_retry_limit</option> = <replaceable>5</replaceable></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><option>enable_stack_abandon</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Enable the preview Stack Abandon feature.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>enable_stack_adopt</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Enable the preview Stack Adopt feature.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>encrypt_parameters_and_properties</option> = <replaceable>False</replaceable></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><option>heat_metadata_server_url</option> = <replaceable></replaceable></td>
|
|
<td>(StrOpt) URL of the Heat metadata server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>heat_stack_user_role</option> = <replaceable>heat_stack_user</replaceable></td>
|
|
<td>(StrOpt) Keystone role for heat template-defined users.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>heat_waitcondition_server_url</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) URL of the Heat waitcondition server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>heat_watch_server_url</option> = <replaceable></replaceable></td>
|
|
<td>(StrOpt) URL of the Heat CloudWatch server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>hidden_stack_tags</option> = <replaceable></replaceable></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><option>max_json_body_size</option> = <replaceable>1048576</replaceable></td>
|
|
<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>2</replaceable></td>
|
|
<td>(IntOpt) Number of heat-engine processes to fork and run.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></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><option>stack_action_timeout</option> = <replaceable>3600</replaceable></td>
|
|
<td>(IntOpt) Timeout in seconds for stack action (ie. create or update).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>stack_domain_admin</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>stack_domain_admin_password</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Keystone password for stack_domain_admin user.</td>
|
|
</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 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>
|
|
<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><option>stack_user_domain_name</option> = <replaceable>None</replaceable></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><option>trusts_delegated_roles</option> = <replaceable></replaceable></td>
|
|
<td>(ListOpt) Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[auth_password]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>allowed_auth_uris</option> = <replaceable></replaceable></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><option>multi_cloud</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Allow orchestration of multiple clouds.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[ec2authtoken]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>allowed_auth_uris</option> = <replaceable></replaceable></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><option>auth_uri</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Authentication Endpoint URI.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>cert_file</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>insecure</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>key_file</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>multi_cloud</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Allow orchestration of multiple clouds.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[eventlet_opts]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>client_socket_timeout</option> = <replaceable>900</replaceable></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><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) If False, closes the client socket connection explicitly.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[heat_api]</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>8004</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>2</replaceable></td>
|
|
<td>(IntOpt) Number of workers for Heat service.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[oslo_middleware]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
|
|
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></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>
|
|
<th colspan="2">[oslo_policy]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
|
|
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></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><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
|
|
<td>(StrOpt) The JSON file that defines policies.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[oslo_versionedobjects]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Make exception message format errors fatal</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[paste_deploy]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
|
|
<td>(StrOpt) The API paste config file to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>flavor</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) The flavor to use.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|