openstack/openstack-manuals
Code Issues Proposed changes

Update ironic config tables

Browse Source 
Updated ironic.headers and ironic.flagmappings. I did this because
we renamed 'discoverd' to 'inspector' but these changes also reflect
additional changes in the configs from the master branch of ironic.

I edited ironic.headers and modified ironic.flagmappings (after it
was updated via './autohelp-wrapper update ironic'). The .xml files
were updated from running './autohelp-wrapper docbook ironic').
ch_baremetalconfigure.xml was edited to reflect the changed tables.

Change-Id: I4329fe706e8fdc3c492b50e511295cf2313cca94
This commit is contained in:
Ruby Loo 2015-06-11 18:00:36 +00:00
parent b295de4c05
commit 79617d400d
14 changed files with 105 additions and 37 deletions

4
doc/common/tables/ironic-api.xml

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>host_ip</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The listen IP for the Ironic API server.</td>
<td>(StrOpt) The IP address on which ironic-api listens.</td>
</tr>
<tr>
<td><option>max_limit</option> = <replaceable>1000</replaceable></td>
@ -27,7 +27,7 @@
</tr>
<tr>
<td><option>port</option> = <replaceable>6385</replaceable></td>
<td>(IntOpt) The port for the Ironic API server.</td>
<td>(IntOpt) The TCP port on which ironic-api listens.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/ironic-auth.xml

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) Method to use for authentication: noauth or keystone.</td>
<td>(StrOpt) Authentication strategy used by ironic-api: one of "keystone" or "noauth". "noauth" should not be used in a production environment because all authentication will be disabled.</td>
</tr>
</tbody>
</table>

30
doc/common/tables/ironic-cisco_ucs.xml Normal file

@ -0,0 +1,30 @@
<?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_cisco_ucs">
<caption>Description of Cisco UCS 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">[cisco_ucs]</th>
</tr>
<tr>
<td><option>action_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Amount of time in seconds to wait in between power operations</td>
</tr>
<tr>
<td><option>max_retry</option> = <replaceable>6</replaceable></td>
<td>(IntOpt) Number of times a power operation needs to be retried</td>
</tr>
</tbody>
</table>
</para>

6
doc/common/tables/ironic-common.xml

@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>force_raw_images</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Force backing images to raw format.</td>
<td>(BoolOpt) If True, convert backing images to "raw" disk image format.</td>
</tr>
<tr>
<td><option>grub_config_template</option> = <replaceable>$pybasedir/common/grub_conf.template</replaceable></td>
@ -46,7 +46,7 @@
<td>(IntOpt) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>sd-52009.dedibox.fr</replaceable></td>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address.</td>
</tr>
<tr>
@ -63,7 +63,7 @@
</tr>
<tr>
<td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
<td>(StrOpt) IP address of this host.</td>
<td>(StrOpt) IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1".</td>
</tr>
<tr>
<td><option>parallel_image_downloads</option> = <replaceable>False</replaceable></td>

6
doc/common/tables/ironic-conductor.xml

@ -39,7 +39,7 @@
</tr>
<tr>
<td><option>deploy_callback_timeout</option> = <replaceable>1800</replaceable></td>
<td>(IntOpt) Timeout (seconds) for waiting callback from deploy ramdisk. 0 - unlimited.</td>
<td>(IntOpt) Timeout (seconds) to wait for a callback from a deploy ramdisk. Set to 0 to disable timeout.</td>
</tr>
<tr>
<td><option>force_power_state_during_sync</option> = <replaceable>True</replaceable></td>
@ -51,7 +51,7 @@
</tr>
<tr>
<td><option>heartbeat_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) since the last check-in of a conductor.</td>
<td>(IntOpt) Maximum time (in seconds) since the last check-in of a conductor. A conductor is considered inactive when this time has been exceeded.</td>
</tr>
<tr>
<td><option>inspect_timeout</option> = <replaceable>1800</replaceable></td>
@ -83,7 +83,7 @@
</tr>
<tr>
<td><option>send_sensor_data_types</option> = <replaceable>ALL</replaceable></td>
<td>(ListOpt) List of comma separated metric types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data.</td>
<td>(ListOpt) List of comma separated meter types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data.</td>
</tr>
<tr>
<td><option>sync_local_state_interval</option> = <replaceable>180</replaceable></td>

2
doc/common/tables/ironic-debug.xml

@ -23,7 +23,7 @@
</tr>
<tr>
<td><option>pecan_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable pecan debug mode. WARNING: this is insecure and should not be used in production.</td>
<td>(BoolOpt) Enable pecan debug mode. WARNING: this is insecure and should not be used in a production environment.</td>
</tr>
</tbody>
</table>

30
doc/common/tables/ironic-drac.xml Normal file

@ -0,0 +1,30 @@
<?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_drac">
<caption>Description of DRAC 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">[drac]</th>
</tr>
<tr>
<td><option>client_retry_count</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) In case there is a communication failure, the DRAC client is going to resend the request as many times as defined in this setting.</td>
</tr>
<tr>
<td><option>client_retry_delay</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) In case there is a communication failure, the DRAC client is going to wait for as many seconds as defined in this setting before resending the request.</td>
</tr>
</tbody>
</table>
</para>

10
doc/common/tables/ironic-discoverd.xml → doc/common/tables/ironic-inspector.xml

@ -3,8 +3,8 @@
<!-- 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_discoverd">
<caption>Description of discoverd configuration options</caption>
<table rules="all" xml:id="config_table_ironic_inspector">
<caption>Description of inspector configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -15,15 +15,15 @@
</thead>
<tbody>
<tr>
<th colspan="2">[discoverd]</th>
<th colspan="2">[inspector]</th>
</tr>
<tr>
<td><option>enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) whether to enable inspection using ironic-discoverd</td>
<td>(BoolOpt) whether to enable inspection using ironic-inspector</td>
</tr>
<tr>
<td><option>service_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ironic-discoverd HTTP endpoint. If this is not set, the ironic-discoverd client default (http://127.0.0.1:5050) will be used.</td>
<td>(StrOpt) ironic-inspector HTTP endpoint. If this is not set, the ironic-inspector client default (http://127.0.0.1:5050) will be used.</td>
</tr>
<tr>
<td><option>status_check_period</option> = <replaceable>60</replaceable></td>

12
doc/common/tables/ironic-logging.xml

@ -22,12 +22,12 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING 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, 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</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Make exception message format errors fatal.</td>
<td>(BoolOpt) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message.</td>
</tr>
<tr>
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
@ -70,7 +70,7 @@
<td>(StrOpt) Format string to use for log messages without context.</td>
</tr>
<tr>
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
@ -87,11 +87,11 @@
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and changed in J to honor RFC5424.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>False</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 I, and will be removed in J.</td>
<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>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>False</replaceable></td>

20
doc/common/tables/ironic-pxe.xml

@ -27,11 +27,11 @@
</tr>
<tr>
<td><option>http_root</option> = <replaceable>/httpboot</replaceable></td>
<td>(StrOpt) Ironic compute node's HTTP root path.</td>
<td>(StrOpt) ironic-conductor node's HTTP root path.</td>
</tr>
<tr>
<td><option>http_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Ironic compute node's HTTP server URL. Example: http://192.1.2.3:8080</td>
<td>(StrOpt) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080</td>
</tr>
<tr>
<td><option>image_cache_size</option> = <replaceable>20480</replaceable></td>
@ -43,15 +43,15 @@
</tr>
<tr>
<td><option>images_path</option> = <replaceable>/var/lib/ironic/images/</replaceable></td>
<td>(StrOpt) Directory where images are stored on disk.</td>
<td>(StrOpt) On the ironic-conductor node, directory where images are stored on disk.</td>
</tr>
<tr>
<td><option>instance_master_path</option> = <replaceable>/var/lib/ironic/master_images</replaceable></td>
<td>(StrOpt) Directory where master instance images are stored on disk.</td>
<td>(StrOpt) On the ironic-conductor node, directory where master instance images are stored on disk.</td>
</tr>
<tr>
<td><option>ipxe_boot_script</option> = <replaceable>$pybasedir/drivers/modules/boot.ipxe</replaceable></td>
<td>(StrOpt) The path to the main iPXE script file.</td>
<td>(StrOpt) On ironic-conductor node, the path to the main iPXE script file.</td>
</tr>
<tr>
<td><option>ipxe_enabled</option> = <replaceable>False</replaceable></td>
@ -67,19 +67,19 @@
</tr>
<tr>
<td><option>pxe_config_template</option> = <replaceable>$pybasedir/drivers/modules/pxe_config.template</replaceable></td>
<td>(StrOpt) Template file for PXE configuration.</td>
<td>(StrOpt) On ironic-conductor node, template file for PXE configuration.</td>
</tr>
<tr>
<td><option>tftp_master_path</option> = <replaceable>/tftpboot/master_images</replaceable></td>
<td>(StrOpt) Directory where master tftp images are stored on disk.</td>
<td>(StrOpt) On ironic-conductor node, directory where master TFTP images are stored on disk.</td>
</tr>
<tr>
<td><option>tftp_root</option> = <replaceable>/tftpboot</replaceable></td>
<td>(StrOpt) Ironic compute node's tftp root path.</td>
<td>(StrOpt) ironic-conductor node's TFTP root path.</td>
</tr>
<tr>
<td><option>tftp_server</option> = <replaceable>$my_ip</replaceable></td>
<td>(StrOpt) IP address of Ironic compute node's tftp server.</td>
<td>(StrOpt) IP address of ironic-conductor node's TFTP server.</td>
</tr>
<tr>
<td><option>uefi_pxe_bootfile_name</option> = <replaceable>elilo.efi</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>uefi_pxe_config_template</option> = <replaceable>$pybasedir/drivers/modules/elilo_efi_pxe_config.template</replaceable></td>
<td>(StrOpt) Template file for PXE configuration for UEFI boot loader.</td>
<td>(StrOpt) On ironic-conductor node, template file for PXE configuration for UEFI boot loader.</td>
</tr>
</tbody>
</table>

2
doc/common/tables/ironic-ssh.xml

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>libvirt_uri</option> = <replaceable>qemu:///system</replaceable></td>
<td>(StrOpt) libvirt uri</td>
<td>(StrOpt) libvirt URI</td>
</tr>
</tbody>
</table>

4
doc/config-reference/ch_baremetalconfigure.xml

@ -17,6 +17,7 @@
<xi:include href="../common/tables/ironic-api.xml"/>
<xi:include href="../common/tables/ironic-auth_token.xml"/>
<xi:include href="../common/tables/ironic-auth.xml"/>
<xi:include href="../common/tables/ironic-cisco_ucs.xml"/>
<xi:include href="../common/tables/ironic-common.xml"/>
<xi:include href="../common/tables/ironic-conductor.xml"/>
<xi:include href="../common/tables/ironic-console.xml"/>
@ -24,10 +25,11 @@
<xi:include href="../common/tables/ironic-debug.xml"/>
<xi:include href="../common/tables/ironic-deploy.xml"/>
<xi:include href="../common/tables/ironic-dhcp.xml"/>
<xi:include href="../common/tables/ironic-discoverd.xml"/>
<xi:include href="../common/tables/ironic-disk_partitioner.xml"/>
<xi:include href="../common/tables/ironic-drac.xml"/>
<xi:include href="../common/tables/ironic-glance.xml"/>
<xi:include href="../common/tables/ironic-ilo.xml"/>
<xi:include href="../common/tables/ironic-inspector.xml"/>
<xi:include href="../common/tables/ironic-ipmi.xml"/>
<xi:include href="../common/tables/ironic-irmc.xml"/>
<xi:include href="../common/tables/ironic-keystone.xml"/>

10
tools/autogenerate-config-flagmappings/ironic.flagmappings

@ -70,6 +70,8 @@ amt/protocol amt
api/host_ip api
api/max_limit api
api/port api
cisco_ucs/action_interval cisco_ucs
cisco_ucs/max_retry cisco_ucs
conductor/api_url conductor
conductor/check_provision_state_interval conductor
conductor/clean_nodes conductor
@ -120,11 +122,10 @@ deploy/dd_block_size deploy
deploy/efi_system_partition_size deploy
deploy/iscsi_verify_attempts deploy
dhcp/dhcp_provider dhcp
discoverd/enabled discoverd
discoverd/service_url discoverd
discoverd/status_check_period discoverd
disk_partitioner/check_device_interval disk_partitioner
disk_partitioner/check_device_max_retries disk_partitioner
drac/client_retry_count drac
drac/client_retry_delay drac
glance/allowed_direct_url_schemes glance
glance/auth_strategy glance
glance/glance_api_insecure glance
@ -152,6 +153,9 @@ ilo/power_retry ilo
ilo/power_wait ilo
ilo/swift_ilo_container ilo
ilo/swift_object_expiry_timeout ilo
inspector/enabled inspector
inspector/service_url inspector
inspector/status_check_period inspector
ipmi/min_command_interval ipmi
ipmi/retry_timeout ipmi
irmc/auth_method irmc

4
tools/autogenerate-config-flagmappings/ironic.headers

@ -1,9 +1,11 @@
amt AMT
cisco_ucs Cisco UCS
deploy deploy
dhcp DHCP
discoverd discoverd
disk_partitioner disk partitioner
drac DRAC
ilo iLO
inspector inspector
irmc iRMC
keystone keystone
seamicro SeaMicro