openstack/openstack-manuals
Code Issues Proposed changes

Update Config Reference for ironic

Browse Source 
Updates for Liberty Release

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

Change-Id: I3b0058fc38cdb5546bfd976c5526608daffb3882
This commit is contained in:
Atsushi SAKAI 2015-10-14 17:57:17 +09:00
parent 52be53d4fe
commit 0af044eecf
14 changed files with 153 additions and 46 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,14 +21,6 @@
<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>
</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>
@ -45,6 +37,10 @@
<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>

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

@ -29,6 +29,10 @@
<td><option>port</option> = <replaceable>6385</replaceable></td>
<td>(IntOpt) The TCP port on which ironic-api listens.</td>
</tr>
<tr>
<td><option>public_endpoint</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None.</td>
</tr>
<tr>
<th colspan="2">[cors]</th>
</tr>

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

@ -153,6 +153,10 @@
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>

11
doc/common/tables/ironic-cisco_ucs.xml
View File

@ -14,6 +14,17 @@
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[cimc]</th>
</tr>
<tr>
<td><option>action_interval</option> = <replaceable>10</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>
<tr>
<th colspan="2">[cisco_ucs]</th>
</tr>

8
doc/common/tables/ironic-deploy.xml
View File

@ -25,6 +25,14 @@
<td><option>efi_system_partition_size</option> = <replaceable>200</replaceable></td>
<td>(IntOpt) Size of EFI system partition in MiB when configuring UEFI systems for local boot.</td>
</tr>
<tr>
<td><option>erase_devices_iterations</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of iterations to be run for erasing devices.</td>
</tr>
<tr>
<td><option>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>
</tr>
<tr>
<td><option>http_root</option> = <replaceable>/httpboot</replaceable></td>
<td>(StrOpt) ironic-conductor node's HTTP root path.</td>

30
doc/common/tables/ironic-iboot.xml Normal file
View 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_iboot">
<caption>Description of iBoot Web Power Switch 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">[iboot]</th>
</tr>
<tr>
<td><option>max_retry</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Maximum retries for iBoot operations</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Time between retry attempts for iBoot operations</td>
</tr>
</tbody>
</table>
</para>

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

@ -65,6 +65,10 @@
<td><option>swift_object_expiry_timeout</option> = <replaceable>900</replaceable></td>
<td>(IntOpt) Amount of time in seconds for Swift objects to auto-expire.</td>
</tr>
<tr>
<td><option>use_web_server_for_images</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso.</td>
</tr>
</tbody>
</table>
</para>

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

@ -23,7 +23,7 @@
</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, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
<td>(ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
@ -39,23 +39,23 @@
</tr>
<tr>
<td><option>log_config_append</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format).</td>
</tr>
<tr>
<td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
@ -79,24 +79,28 @@
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
<td>(StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
<td>(BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<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 Kilo, and will be removed in Mitaka, along with this option.</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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
<tr>
<td><option>watch_log_file</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set.</td>
</tr>
</tbody>
</table>
</para>

22
doc/common/tables/ironic-redis.xml
View File

@ -15,14 +15,10 @@
</thead>
<tbody>
<tr>
<th colspan="2">[matchmaker_redis]</th>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td><option>password</option> = <replaceable>None</replaceable></td>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
@ -30,11 +26,19 @@
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>6379</replaceable></td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody>
</table>

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

@ -17,14 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
@ -37,6 +29,10 @@
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_poll_timeout</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.</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>
@ -75,6 +71,22 @@
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
</tr>
<tr>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for message broker authentication</td>
</tr>
<tr>
<td><option>sasl_config_dir</option> = <replaceable></replaceable></td>
<td>(StrOpt) Path to directory that contains the SASL configuration</td>
</tr>
<tr>
<td><option>sasl_config_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Name of configuration file (without .conf suffix)</td>
</tr>
<tr>
<td><option>sasl_mechanisms</option> = <replaceable></replaceable></td>
<td>(StrOpt) Space separated list of acceptable SASL mechanisms</td>
</tr>
<tr>
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
<td>(StrOpt) address prefix used when sending to a specific server</td>
@ -99,6 +111,10 @@
<td><option>trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
</tr>
<tr>
<td><option>username</option> = <replaceable></replaceable></td>
<td>(StrOpt) User name for message broker authentication</td>
</tr>
</tbody>
</table>
</para>

18
doc/common/tables/ironic-zeromq.xml
View File

@ -17,10 +17,18 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>rpc_zmq_all_req_rep</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT.</td>
</tr>
<tr>
<td><option>rpc_zmq_bind_address</option> = <replaceable>*</replaceable></td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td><option>rpc_zmq_concurrency</option> = <replaceable>eventlet</replaceable></td>
<td>(StrOpt) Type of concurrency used. Either "native" or "eventlet"</td>
</tr>
<tr>
<td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
@ -34,17 +42,17 @@
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>local</replaceable></td>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>redis</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td><option>rpc_zmq_topic_backlog</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
<tr>
<td><option>zmq_use_broker</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Shows whether zmq-messaging uses broker or not.</td>
</tr>
</tbody>
</table>
</para>

1
doc/config-reference/ch_baremetalconfigure.xml
View File

@ -28,6 +28,7 @@
<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-iboot.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"/>

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

@ -25,28 +25,30 @@ logging_context_format_string logging
logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
memcached_servers common
my_ip common
notification_driver amqp
notification_topics amqp
parallel_image_downloads common
password redis
pecan_debug debug
periodic_interval common
port redis
publish_errors logging
pybasedir common
rootwrap_config common
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_poll_timeout rpc
rpc_response_timeout rpc
rpc_zmq_all_req_rep zeromq
rpc_zmq_bind_address zeromq
rpc_zmq_concurrency zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
state_path common
syslog_log_facility logging
@ -56,13 +58,14 @@ use_stderr logging
use_syslog logging
use_syslog_rfc_format logging
verbose logging
watch_log_file logging
zmq_use_broker zeromq
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_config_template agent
agent/heartbeat_timeout agent
agent/manage_agent_boot agent
agent/memory_consumed_by_agent agent
agent/post_deploy_get_power_state_retries agent
agent/post_deploy_get_power_state_retry_interval agent
amt/action_wait amt
@ -71,6 +74,9 @@ amt/protocol amt
api/host_ip api
api/max_limit api
api/port api
api/public_endpoint api
cimc/action_interval cisco_ucs
cimc/max_retry cisco_ucs
cisco_ucs/action_interval cisco_ucs
cisco_ucs/max_retry cisco_ucs
conductor/api_url conductor
@ -134,6 +140,8 @@ database/sqlite_synchronous database
database/use_db_reconnect database
deploy/dd_block_size deploy
deploy/efi_system_partition_size deploy
deploy/erase_devices_iterations deploy
deploy/erase_devices_priority deploy
deploy/http_root deploy
deploy/http_url deploy
deploy/iscsi_verify_attempts deploy
@ -157,6 +165,8 @@ glance/swift_endpoint_url glance
glance/swift_store_multiple_containers_seed glance
glance/swift_temp_url_duration glance
glance/swift_temp_url_key glance
iboot/max_retry iboot
iboot/retry_interval iboot
ilo/clean_priority_clear_secure_boot_keys ilo
ilo/clean_priority_erase_devices ilo
ilo/clean_priority_reset_bios_to_default ilo
@ -169,6 +179,7 @@ ilo/power_retry ilo
ilo/power_wait ilo
ilo/swift_ilo_container ilo
ilo/swift_object_expiry_timeout ilo
ilo/use_web_server_for_images ilo
inspector/enabled inspector
inspector/service_url inspector
inspector/status_check_period inspector
@ -220,13 +231,13 @@ keystone_authtoken/memcache_secret_key auth_token
keystone_authtoken/memcache_security_strategy auth_token
keystone_authtoken/memcache_use_advanced_pool auth_token
keystone_authtoken/memcached_servers auth_token
keystone_authtoken/region_name auth_token
keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
neutron/auth_strategy neutron
neutron/cleaning_network_uuid neutron
neutron/retries neutron
@ -239,12 +250,17 @@ oslo_messaging_amqp/broadcast_prefix rpc
oslo_messaging_amqp/container_name rpc
oslo_messaging_amqp/group_request_prefix rpc
oslo_messaging_amqp/idle_timeout rpc
oslo_messaging_amqp/password rpc
oslo_messaging_amqp/sasl_config_dir rpc
oslo_messaging_amqp/sasl_config_name rpc
oslo_messaging_amqp/sasl_mechanisms rpc
oslo_messaging_amqp/server_request_prefix rpc
oslo_messaging_amqp/ssl_ca_file rpc
oslo_messaging_amqp/ssl_cert_file rpc
oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
oslo_messaging_amqp/username rpc
oslo_messaging_qpid/amqp_auto_delete qpid
oslo_messaging_qpid/amqp_durable_queues qpid
oslo_messaging_qpid/qpid_heartbeat qpid

1
tools/autogenerate-config-flagmappings/ironic.headers
View File

@ -4,6 +4,7 @@ deploy deploy
dhcp DHCP
disk_partitioner disk partitioner
drac DRAC
iboot iBoot Web Power Switch
ilo iLO
inspector inspector
irmc iRMC