openstack/openstack-manuals
Code Issues Proposed changes

Update Config reference for ironic

Browse Source 
Change-Id: I39e5bc772b229767b989a8fcdf5434149dc0c8cf
Partial-Bug: #1407581
This commit is contained in:
Atsushi SAKAI 2015-09-03 14:52:38 +09:00
parent d6d10a5fb7
commit 9345473f62
11 changed files with 113 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -31,23 +31,19 @@
</tr>
<tr>
<td><option>agent_pxe_append_params</option> = <replaceable>nofb nomodeset vga=normal</replaceable></td>
<td>(StrOpt) Additional append parameters for baremetal PXE boot.</td>
</tr>
<tr>
<td><option>agent_pxe_bootfile_name</option> = <replaceable>pxelinux.0</replaceable></td>
<td>(StrOpt) Neutron bootfile DHCP parameter.</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) Template file for PXE configuration.</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_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>
<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>post_deploy_get_power_state_retries</option> = <replaceable>6</replaceable></td>

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

@ -29,6 +29,71 @@
<td><option>port</option> = <replaceable>6385</replaceable></td>
<td>(IntOpt) The TCP port on which ironic-api listens.</td>
</tr>
<tr>
<th colspan="2">[cors]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<th colspan="2">[cors.subdomain]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</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_versionedobjects]</th>
</tr>

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

@ -25,6 +25,10 @@
<td><option>enabled_drivers</option> = <replaceable>pxe_ipmitool</replaceable></td>
<td>(ListOpt) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online.</td>
</tr>
<tr>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
@ -46,7 +50,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>
@ -74,7 +78,7 @@
<td>(IntOpt) Seconds between running periodic tasks.</td>
</tr>
<tr>
<td><option>pybasedir</option> = <replaceable>/usr/lib/python/site-packages/ironic/ironic</replaceable></td>
<td><option>pybasedir</option> = <replaceable>/home/sakaia/work/openstack-doc-tools/autogenerate_config_docs/sources/ironic/ironic</replaceable></td>
<td>(StrOpt) Directory where the ironic python module is installed.</td>
</tr>
<tr>

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

@ -25,6 +25,10 @@
<td><option>check_provision_state_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Interval between checks of provision timeouts, in seconds.</td>
</tr>
<tr>
<td><option>clean_callback_timeout</option> = <replaceable>1800</replaceable></td>
<td>(IntOpt) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout.</td>
</tr>
<tr>
<td><option>clean_nodes</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion, and during the transition from a "managed" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled.</td>

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>http_root</option> = <replaceable>/httpboot</replaceable></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-conductor node's HTTP server URL. Example: http://192.1.2.3:8080</td>
</tr>
<tr>
<td><option>iscsi_verify_attempts</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts.</td>

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

@ -19,10 +19,10 @@
</tr>
<tr>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO 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, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=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, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
@ -91,11 +91,11 @@
</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 K, and will be removed in M, 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.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
<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>
</tbody>
</table>

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

@ -25,14 +25,6 @@
<td><option>disk_devices</option> = <replaceable>cciss/c0d0,sda,hda,vda</replaceable></td>
<td>(StrOpt) The disk devices to scan while doing the deploy.</td>
</tr>
<tr>
<td><option>http_root</option> = <replaceable>/httpboot</replaceable></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-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>
<td>(IntOpt) Maximum size (in MiB) of cache for master images, including those in use.</td>

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

@ -71,7 +71,7 @@
</tr>
<tr>
<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>
<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 the Mitaka release.</td>
</tr>
</tbody>
</table>

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

@ -111,7 +111,7 @@
</tr>
<tr>
<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>
<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 the Mitaka release.</td>
</tr>
</tbody>
</table>

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

@ -41,10 +41,6 @@
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC thread pool.</td>
</tr>
<tr>
<th colspan="2">[oslo_concurrency]</th>
</tr>

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

@ -4,6 +4,7 @@ control_exchange amqp
debug logging
default_log_levels logging
enabled_drivers common
executor_thread_pool_size common
fatal_deprecations common
fatal_exception_format_errors logging
force_raw_images common
@ -40,7 +41,6 @@ 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
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
@ -60,10 +60,9 @@ 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/manage_agent_boot agent
agent/post_deploy_get_power_state_retries agent
agent/post_deploy_get_power_state_retry_interval agent
amt/action_wait amt
@ -76,6 +75,7 @@ cisco_ucs/action_interval cisco_ucs
cisco_ucs/max_retry cisco_ucs
conductor/api_url conductor
conductor/check_provision_state_interval conductor
conductor/clean_callback_timeout conductor
conductor/clean_nodes conductor
conductor/configdrive_swift_container conductor
conductor/configdrive_use_swift conductor
@ -99,6 +99,18 @@ console/subprocess_timeout console
console/terminal console
console/terminal_cert_dir console
console/terminal_pid_dir console
cors/allow_credentials api
cors/allow_headers api
cors/allow_methods api
cors/allowed_origin api
cors/expose_headers api
cors/max_age api
cors.subdomain/allow_credentials api
cors.subdomain/allow_headers api
cors.subdomain/allow_methods api
cors.subdomain/allowed_origin api
cors.subdomain/expose_headers api
cors.subdomain/max_age api
database/backend database
database/connection database
database/connection_debug database
@ -122,6 +134,8 @@ database/sqlite_synchronous database
database/use_db_reconnect database
deploy/dd_block_size deploy
deploy/efi_system_partition_size deploy
deploy/http_root deploy
deploy/http_url deploy
deploy/iscsi_verify_attempts deploy
dhcp/dhcp_provider dhcp
disk_partitioner/check_device_interval disk_partitioner
@ -269,14 +283,14 @@ oslo_messaging_rabbit/rabbit_use_ssl rabbitmq
oslo_messaging_rabbit/rabbit_userid rabbitmq
oslo_messaging_rabbit/rabbit_virtual_host rabbitmq
oslo_messaging_rabbit/send_single_reply rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
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
pxe/http_url pxe
pxe/image_cache_size pxe
pxe/image_cache_ttl pxe
pxe/images_path pxe