openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] Ironic option tables update

Browse Source 
Change-Id: I2e8f86f799a34398b2c222d6467eab1ad3e2ffa1
This commit is contained in:
Gauvain Pocentek 2015-07-19 16:41:14 +02:00
parent afa9c38f44
commit 7a31597e38
13 changed files with 87 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/common/tables/ironic-agent.xml
View File

@ -21,6 +21,10 @@
<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_erase_devices_iterations</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of iterations to be run for erasing devices.</td>
</tr>
<tr>
<td><option>agent_erase_devices_priority</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning.</td>
@ -45,6 +49,14 @@
<td><option>manage_tftp</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether Ironic will manage TFTP files for the deploy ramdisks. If set to False, you will need to configure your own TFTP server that allows booting the deploy ramdisks.</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>

2
doc/common/tables/ironic-amqp.xml
View File

@ -23,7 +23,7 @@
</tr>
<tr>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>

7
doc/common/tables/ironic-api.xml
View File

@ -29,6 +29,13 @@
<td><option>port</option> = <replaceable>6385</replaceable></td>
<td>(IntOpt) The TCP port on which ironic-api listens.</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>
</tbody>
</table>
</para>

6
doc/common/tables/ironic-auth_token.xml
View File

@ -119,7 +119,7 @@
</tr>
<tr>
<td><option>memcache_pool_conn_get_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.</td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.</td>
</tr>
<tr>
<td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
@ -131,7 +131,7 @@
</tr>
<tr>
<td><option>memcache_pool_socket_timeout</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.</td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.</td>
</tr>
<tr>
<td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
@ -147,7 +147,7 @@
</tr>
<tr>
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.</td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>

14
doc/common/tables/ironic-common.xml
View File

@ -43,11 +43,11 @@
</tr>
<tr>
<td><option>hash_partition_exponent</option> = <replaceable>5</replaceable></td>
<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>
<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>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>
<td><option>host</option> = <replaceable>sd-52009.dedibox.fr</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>
<td><option>isolinux_bin</option> = <replaceable>/usr/lib/syslinux/isolinux.bin</replaceable></td>
@ -81,17 +81,13 @@
<td><option>rootwrap_config</option> = <replaceable>/etc/ironic/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root.</td>
</tr>
<tr>
<td><option>run_external_periodic_tasks</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td><option>state_path</option> = <replaceable>$pybasedir</replaceable></td>
<td>(StrOpt) Top-level directory for maintaining ironic's state.</td>
</tr>
<tr>
<td><option>tempdir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Explicitly specify the temporary working directory.</td>
<td><option>tempdir</option> = <replaceable>/tmp</replaceable></td>
<td>(StrOpt) Temporary working directory, default is Python temp dir.</td>
</tr>
</tbody>
</table>

4
doc/common/tables/ironic-debug.xml
View File

@ -17,10 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>backdoor_port</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</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 a production environment.</td>

2
doc/common/tables/ironic-ilo.xml
View File

@ -39,7 +39,7 @@
</tr>
<tr>
<td><option>clean_priority_reset_secure_boot_keys_to_default</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults.</td>
<td>(IntOpt) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults.</td>
</tr>
<tr>
<td><option>client_port</option> = <replaceable>443</replaceable></td>

28
doc/common/tables/ironic-irmc.xml
View File

@ -29,6 +29,34 @@
<td><option>port</option> = <replaceable>443</replaceable></td>
<td>(IntOpt) Port to be used for iRMC operations, either 80 or 443</td>
</tr>
<tr>
<td><option>remote_image_server</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP of remote image server</td>
</tr>
<tr>
<td><option>remote_image_share_name</option> = <replaceable>share</replaceable></td>
<td>(StrOpt) share name of remote_image_server</td>
</tr>
<tr>
<td><option>remote_image_share_root</option> = <replaceable>/remote_image_share_root</replaceable></td>
<td>(StrOpt) Ironic conductor node's "NFS" or "CIFS" root path</td>
</tr>
<tr>
<td><option>remote_image_share_type</option> = <replaceable>CIFS</replaceable></td>
<td>(StrOpt) Share type of virtual media, either "NFS" or "CIFS"</td>
</tr>
<tr>
<td><option>remote_image_user_domain</option> = <replaceable></replaceable></td>
<td>(StrOpt) Domain name of remote_image_user_name</td>
</tr>
<tr>
<td><option>remote_image_user_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) User name of remote_image_server</td>
</tr>
<tr>
<td><option>remote_image_user_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password of remote_image_user_name</td>
</tr>
<tr>
<td><option>sensor_method</option> = <replaceable>ipmitool</replaceable></td>
<td>(StrOpt) Sensor data retrieval method, either "ipmitool" or "scci"</td>

2
doc/common/tables/ironic-logging.xml
View File

@ -87,7 +87,7 @@
</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 changed in J to honor RFC5424.</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>

4
doc/common/tables/ironic-qpid.xml
View File

@ -70,8 +70,8 @@
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
</tr>
</tbody>
</table>

12
doc/common/tables/ironic-rabbitmq.xml
View File

@ -34,13 +34,17 @@
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, &gt;0 enables it. Enabling heartbeats requires kombu&gt;=3.0.7 and amqp&gt;=1.4.0). EXPERIMENTAL</td>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL</td>
</tr>
<tr>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td><option>kombu_reconnect_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
</tr>
<tr>
<td><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
@ -106,8 +110,8 @@
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
</tr>
</tbody>
</table>

4
doc/common/tables/ironic-rpc.xml
View File

@ -33,6 +33,10 @@
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>

19
tools/autogenerate-config-flagmappings/ironic.flagmappings
View File

@ -1,5 +1,4 @@
auth_strategy auth
backdoor_port debug
bindir common
control_exchange amqp
debug logging
@ -39,6 +38,7 @@ pybasedir common
rootwrap_config common
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_thread_pool_size rpc
rpc_zmq_bind_address zeromq
@ -48,7 +48,6 @@ rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
run_external_periodic_tasks common
state_path common
syslog_log_facility logging
tempdir common
@ -58,12 +57,15 @@ use_syslog logging
use_syslog_rfc_format logging
verbose logging
agent/agent_api_version agent
agent/agent_erase_devices_iterations agent
agent/agent_erase_devices_priority agent
agent/agent_pxe_append_params agent
agent/agent_pxe_bootfile_name agent
agent/agent_pxe_config_template agent
agent/heartbeat_timeout agent
agent/manage_tftp agent
agent/post_deploy_get_power_state_retries agent
agent/post_deploy_get_power_state_retry_interval agent
amt/action_wait amt
amt/max_attempts amt
amt/protocol amt
@ -161,6 +163,13 @@ ipmi/retry_timeout ipmi
irmc/auth_method irmc
irmc/client_timeout irmc
irmc/port irmc
irmc/remote_image_server irmc
irmc/remote_image_share_name irmc
irmc/remote_image_share_root irmc
irmc/remote_image_share_type irmc
irmc/remote_image_user_domain irmc
irmc/remote_image_user_name irmc
irmc/remote_image_user_password irmc
irmc/sensor_method irmc
keystone/region_name keystone
keystone_authtoken/admin_password auth_token
@ -235,13 +244,14 @@ oslo_messaging_qpid/qpid_sasl_mechanisms qpid
oslo_messaging_qpid/qpid_tcp_nodelay qpid
oslo_messaging_qpid/qpid_topology_version qpid
oslo_messaging_qpid/qpid_username qpid
oslo_messaging_qpid/rpc_conn_pool_size qpid
oslo_messaging_qpid/send_single_reply qpid
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/fake_rabbit rabbitmq
oslo_messaging_rabbit/heartbeat_rate rabbitmq
oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq
oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq
oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq
oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq
oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq
@ -258,10 +268,11 @@ oslo_messaging_rabbit/rabbit_retry_interval rabbitmq
oslo_messaging_rabbit/rabbit_use_ssl rabbitmq
oslo_messaging_rabbit/rabbit_userid rabbitmq
oslo_messaging_rabbit/rabbit_virtual_host rabbitmq
oslo_messaging_rabbit/rpc_conn_pool_size rabbitmq
oslo_messaging_rabbit/send_single_reply rabbitmq
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_versionedobjects/fatal_exception_format_errors api
pxe/default_ephemeral_format pxe
pxe/disk_devices pxe
pxe/http_root pxe