openstack-manuals/doc/common/tables/ironic-agent.xml
Atsushi SAKAI 0af044eecf Update Config Reference for ironic
Updates for Liberty Release

  Adds ironic-iboot.xml file
  and other updates are mainly oslo_messaging etc.

Change-Id: I3b0058fc38cdb5546bfd976c5526608daffb3882
2015-10-14 19:15:57 +09:00

55 lines
2.9 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_ironic_agent">
<caption>Description of agent 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">[agent]</th>
</tr>
<tr>
<td><option>agent_api_version</option> = <replaceable>v1</replaceable></td>
<td>(StrOpt) API version to use for communicating with the ramdisk agent.</td>
</tr>
<tr>
<td><option>agent_pxe_append_params</option> = <replaceable>nofb nomodeset vga=normal</replaceable></td>
<td>(StrOpt) DEPRECATED. Additional append parameters for baremetal PXE boot. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_append_params instead.</td>
</tr>
<tr>
<td><option>agent_pxe_config_template</option> = <replaceable>$pybasedir/drivers/modules/agent_config.template</replaceable></td>
<td>(StrOpt) DEPRECATED. Template file for PXE configuration. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_config_template instead.</td>
</tr>
<tr>
<td><option>heartbeat_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Maximum interval (in seconds) for agent heartbeats.</td>
</tr>
<tr>
<td><option>manage_agent_boot</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk.</td>
</tr>
<tr>
<td><option>memory_consumed_by_agent</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image.</td>
</tr>
<tr>
<td><option>post_deploy_get_power_state_retries</option> = <replaceable>6</replaceable></td>
<td>(IntOpt) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off.</td>
</tr>
<tr>
<td><option>post_deploy_get_power_state_retry_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff.</td>
</tr>
</tbody>
</table>
</para>