openstack/openstack-manuals
Code Issues Proposed changes

Update flagmappings for ironic

Browse Source 
Change-Id: I8296aa9fd46a903d5ca62f68fb97baab0e3390a0
This commit is contained in:
Anish Bhatt 2015-02-24 13:22:35 -08:00
parent 83f0325854
commit 3dc7d34cda
30 changed files with 462 additions and 171 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,23 +18,23 @@
<th colspan="2">[agent]</th>
</tr>
<tr>
<td>agent_api_version = v1</td>
<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>agent_pxe_append_params = nofb nomodeset vga=normal</td>
<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>agent_pxe_bootfile_name = pxelinux.0</td>
<td><option>agent_pxe_bootfile_name</option> = <replaceable>pxelinux.0</replaceable></td>
<td>(StrOpt) Neutron bootfile DHCP parameter.</td>
</tr>
<tr>
<td>agent_pxe_config_template = $pybasedir/drivers/modules/agent_config.template</td>
<td><option>agent_pxe_config_template</option> = <replaceable>$pybasedir/drivers/modules/agent_config.template</replaceable></td>
<td>(StrOpt) Template file for PXE configuration.</td>
</tr>
<tr>
<td>heartbeat_timeout = 300</td>
<td><option>heartbeat_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Maximum interval (in seconds) for agent heartbeats.</td>
</tr>
</tbody>

26
doc/common/tables/ironic-amt.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_amt">
<caption>Description of amt 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">[amt]</th>
</tr>
<tr>
<td><option>protocol</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) Protocol used for AMT endpoint, support http/https</td>
</tr>
</tbody>
</table>
</para>

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

@ -14,25 +14,6 @@
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
<td>(StrOpt) File name for the paste.deploy config for nova-api</td>
</tr>
<tr>
<td><option>api_rate_limit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api.</td>
</tr>
<tr>
<td><option>client_socket_timeout</option> = <replaceable>900</replaceable></td>
<td>(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
</tr>
<tr>
<td><option>use_forwarded_for</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
</tr>
<tr>
<th colspan="2">[api]</th>
</tr>

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

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) The strategy to use for auth: noauth or keystone.</td>
<td>(StrOpt) Method to use for authentication: noauth or keystone.</td>
</tr>
</tbody>
</table>

62
doc/common/tables/ironic-cells.xml Normal file
View File

@ -0,0 +1,62 @@
<?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_cells">
<caption>Description of cells 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">[cells]</th>
</tr>
<tr>
<td><option>bandwidth_update_interval</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Seconds between bandwidth updates for cells.</td>
</tr>
<tr>
<td><option>call_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
</tr>
<tr>
<td><option>capabilities</option> = <replaceable>hypervisor=xenserver;kvm, os=linux;windows</replaceable></td>
<td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
</tr>
<tr>
<td><option>cell_type</option> = <replaceable>compute</replaceable></td>
<td>(StrOpt) Type of cell: api or compute</td>
</tr>
<tr>
<td><option>enable</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable cell functionality</td>
</tr>
<tr>
<td><option>manager</option> = <replaceable>nova.cells.manager.CellsManager</replaceable></td>
<td>(StrOpt) Manager for cells</td>
</tr>
<tr>
<td><option>mute_child_interval</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
</tr>
<tr>
<td><option>name</option> = <replaceable>nova</replaceable></td>
<td>(StrOpt) Name of this cell</td>
</tr>
<tr>
<td><option>reserve_percent</option> = <replaceable>10.0</replaceable></td>
<td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
</tr>
<tr>
<td><option>topic</option> = <replaceable>cells</replaceable></td>
<td>(StrOpt) The topic cells nodes listen on</td>
</tr>
</tbody>
</table>
</para>

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

@ -21,37 +21,61 @@
<td><option>bindir</option> = <replaceable>/usr/local/bin</replaceable></td>
<td>(StrOpt) Directory where ironic binaries are installed.</td>
</tr>
<tr>
<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>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td><option>max_header_line</option> = <replaceable>16384</replaceable></td>
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
<td><option>force_raw_images</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Force backing images to raw format.</td>
</tr>
<tr>
<td><option>hash_distribution_replicas</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated.</td>
</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>
</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>
</tr>
<tr>
<td><option>isolinux_bin</option> = <replaceable>/usr/lib/syslinux/isolinux.bin</replaceable></td>
<td>(StrOpt) Path to isolinux binary file.</td>
</tr>
<tr>
<td><option>isolinux_config_template</option> = <replaceable>$pybasedir/common/isolinux_config.template</replaceable></td>
<td>(StrOpt) Template file for isolinux configuration file.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to log monkey patching</td>
</tr>
<tr>
<td><option>monkey_patch_modules</option> = <replaceable>nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator</replaceable></td>
<td>(ListOpt) List of modules/decorators to monkey patch</td>
</tr>
<tr>
<td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
<td>(StrOpt) IP address of this host.</td>
</tr>
<tr>
<td><option>parallel_image_downloads</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Run image downloads and raw format conversions in parallel.</td>
</tr>
<tr>
<td><option>periodic_interval</option> = <replaceable>60</replaceable></td>
<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>(StrOpt) Directory where the ironic python module is installed.</td>
</tr>
<tr>
<td><option>rootwrap_config</option> = <replaceable>/etc/nova/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
<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>
@ -61,21 +85,9 @@
<td><option>state_path</option> = <replaceable>$pybasedir</replaceable></td>
<td>(StrOpt) Top-level directory for maintaining ironic's state.</td>
</tr>
<tr>
<td><option>tcp_keepidle</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td><option>tempdir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Explicitly specify the temporary working directory</td>
</tr>
<tr>
<td><option>wsgi_default_pool_size</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Size of the pool of greenthreads used by wsgi</td>
</tr>
<tr>
<td><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If False, closes the client socket connection explicitly.</td>
<td>(StrOpt) Explicitly specify the temporary working directory.</td>
</tr>
</tbody>
</table>

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

@ -18,67 +18,75 @@
<th colspan="2">[conductor]</th>
</tr>
<tr>
<td>api_url = None</td>
<td><option>api_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog.</td>
</tr>
<tr>
<td>check_provision_state_interval = 60</td>
<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>deploy_callback_timeout = 1800</td>
<td><option>configdrive_swift_container</option> = <replaceable>ironic_configdrive_container</replaceable></td>
<td>(StrOpt) Name of the Swift container to store config drive data. Used when configdrive_use_swift is True.</td>
</tr>
<tr>
<td><option>configdrive_use_swift</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to upload the config drive to Swift.</td>
</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>
</tr>
<tr>
<td>force_power_state_during_sync = True</td>
<td><option>force_power_state_during_sync</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False).</td>
</tr>
<tr>
<td>heartbeat_interval = 10</td>
<td><option>heartbeat_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Seconds between conductor heart beats.</td>
</tr>
<tr>
<td>heartbeat_timeout = 60</td>
<td><option>heartbeat_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) since the last check-in of a conductor.</td>
</tr>
<tr>
<td>node_locked_retry_attempts = 3</td>
<td><option>node_locked_retry_attempts</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of attempts to grab a node lock.</td>
</tr>
<tr>
<td>node_locked_retry_interval = 1</td>
<td><option>node_locked_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds to sleep between node lock attempts.</td>
</tr>
<tr>
<td>periodic_max_workers = 8</td>
<td><option>periodic_max_workers</option> = <replaceable>8</replaceable></td>
<td>(IntOpt) Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size.</td>
</tr>
<tr>
<td>power_state_sync_max_retries = 3</td>
<td><option>power_state_sync_max_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB</td>
</tr>
<tr>
<td>send_sensor_data = False</td>
<td><option>send_sensor_data</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable sending sensor data message via the notification bus</td>
</tr>
<tr>
<td>send_sensor_data_interval = 600</td>
<td><option>send_sensor_data_interval</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Seconds between conductor sending sensor data message to ceilometer via the notification bus.</td>
</tr>
<tr>
<td>send_sensor_data_types = ALL</td>
<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>
</tr>
<tr>
<td>sync_local_state_interval = 180</td>
<td><option>sync_local_state_interval</option> = <replaceable>180</replaceable></td>
<td>(IntOpt) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely.</td>
</tr>
<tr>
<td>sync_power_state_interval = 60</td>
<td><option>sync_power_state_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Interval between syncing the node power state to the database, in seconds.</td>
</tr>
<tr>
<td>workers_pool_size = 100</td>
<td><option>workers_pool_size</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) The size of the workers greenthread pool.</td>
</tr>
</tbody>

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

@ -18,23 +18,23 @@
<th colspan="2">[console]</th>
</tr>
<tr>
<td>subprocess_checking_interval = 1</td>
<td><option>subprocess_checking_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Time interval (in seconds) for checking the status of console subprocess.</td>
</tr>
<tr>
<td>subprocess_timeout = 10</td>
<td><option>subprocess_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Time (in seconds) to wait for the console subprocess to start.</td>
</tr>
<tr>
<td>terminal = shellinaboxd</td>
<td><option>terminal</option> = <replaceable>shellinaboxd</replaceable></td>
<td>(StrOpt) Path to serial console terminal program</td>
</tr>
<tr>
<td>terminal_cert_dir = None</td>
<td><option>terminal_cert_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory containing the terminal SSL cert(PEM) for serial console access</td>
</tr>
<tr>
<td>terminal_pid_dir = None</td>
<td><option>terminal_pid_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory for holding terminal pid files. If not specified, the temporary directory will be used.</td>
</tr>
</tbody>

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

@ -101,10 +101,6 @@
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
<tr>
<td><option>use_tpool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody>
</table>
</para>

30
doc/common/tables/ironic-deploy.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_deploy">
<caption>Description of deploy 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">[deploy]</th>
</tr>
<tr>
<td><option>dd_block_size</option> = <replaceable>1M</replaceable></td>
<td>(StrOpt) Block size to use when writing to the nodes disk.</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>
</tr>
</tbody>
</table>
</para>

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

@ -18,7 +18,7 @@
<th colspan="2">[dhcp]</th>
</tr>
<tr>
<td>dhcp_provider = neutron</td>
<td><option>dhcp_provider</option> = <replaceable>neutron</replaceable></td>
<td>(StrOpt) DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider.</td>
</tr>
</tbody>

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

@ -18,11 +18,11 @@
<th colspan="2">[disk_partitioner]</th>
</tr>
<tr>
<td>check_device_interval = 1</td>
<td><option>check_device_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds</td>
</tr>
<tr>
<td>check_device_max_retries = 20</td>
<td><option>check_device_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed.</td>
</tr>
</tbody>

38
doc/common/tables/ironic-glance.xml
View File

@ -19,15 +19,7 @@
</tr>
<tr>
<td><option>allowed_direct_url_schemes</option> = <replaceable></replaceable></td>
<td>(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
</tr>
<tr>
<td><option>api_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port)</td>
<td>(ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
@ -58,20 +50,32 @@
<td>(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>$my_ip</replaceable></td>
<td>(StrOpt) Default glance hostname or IP address</td>
<td><option>swift_account</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"</td>
</tr>
<tr>
<td><option>num_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of retries when uploading / downloading an image to / from glance.</td>
<td><option>swift_api_version</option> = <replaceable>v1</replaceable></td>
<td>(StrOpt) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>9292</replaceable></td>
<td>(IntOpt) Default glance port</td>
<td><option>swift_container</option> = <replaceable>glance</replaceable></td>
<td>(StrOpt) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"</td>
</tr>
<tr>
<td><option>protocol</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.</td>
<td><option>swift_endpoint_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/account/container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". Required for temporary URLs.</td>
</tr>
<tr>
<td><option>swift_store_multiple_containers_seed</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) This should match a config by the same name in the Glance configuration file. When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.</td>
</tr>
<tr>
<td><option>swift_temp_url_duration</option> = <replaceable>1200</replaceable></td>
<td>(IntOpt) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration.</td>
</tr>
<tr>
<td><option>swift_temp_url_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs.</td>
</tr>
</tbody>
</table>

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

@ -18,27 +18,27 @@
<th colspan="2">[ilo]</th>
</tr>
<tr>
<td>client_port = 443</td>
<td><option>client_port</option> = <replaceable>443</replaceable></td>
<td>(IntOpt) Port to be used for iLO operations</td>
</tr>
<tr>
<td>client_timeout = 60</td>
<td><option>client_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Timeout (in seconds) for iLO operations</td>
</tr>
<tr>
<td>power_retry = 6</td>
<td><option>power_retry</option> = <replaceable>6</replaceable></td>
<td>(IntOpt) Number of times a power operation needs to be retried</td>
</tr>
<tr>
<td>power_wait = 2</td>
<td><option>power_wait</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Amount of time in seconds to wait in between power operations</td>
</tr>
<tr>
<td>swift_ilo_container = ironic_ilo_container</td>
<td><option>swift_ilo_container</option> = <replaceable>ironic_ilo_container</replaceable></td>
<td>(StrOpt) The Swift iLO container to store data.</td>
</tr>
<tr>
<td>swift_object_expiry_timeout = 900</td>
<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>
</tbody>

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

@ -18,12 +18,12 @@
<th colspan="2">[ipmi]</th>
</tr>
<tr>
<td>min_command_interval = 5</td>
<td><option>min_command_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds.</td>
</tr>
<tr>
<td>retry_timeout = 60</td>
<td>(IntOpt) Maximum time in seconds to retry IPMI operations.</td>
<td><option>retry_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs.</td>
</tr>
</tbody>
</table>

34
doc/common/tables/ironic-irmc.xml Normal file
View File

@ -0,0 +1,34 @@
<?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_irmc">
<caption>Description of irmc 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">[irmc]</th>
</tr>
<tr>
<td><option>auth_method</option> = <replaceable>basic</replaceable></td>
<td>(StrOpt) Authentication method to be used for iRMC operations, either "basic" or "digest"</td>
</tr>
<tr>
<td><option>client_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Timeout (in seconds) for iRMC operations</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>443</replaceable></td>
<td>(IntOpt) Port to be used for iRMC operations, either 80 or 443</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/ironic-keystone.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_keystone">
<caption>Description of keystone 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">[keystone]</th>
</tr>
<tr>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The region used for getting endpoints of OpenStackservices.</td>
</tr>
</tbody>
</table>
</para>

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

@ -27,20 +27,12 @@
</tr>
<tr>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Make exception message format errors fatal</td>
<td>(BoolOpt) Make exception message format errors fatal.</td>
</tr>
<tr>
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr>
<tr>
<td><option>instance_name_template</option> = <replaceable>instance-%08x</replaceable></td>
<td>(StrOpt) Template string to be used to generate instance names</td>
</tr>
<tr>
<td><option>instance_usage_audit_period</option> = <replaceable>month</replaceable></td>
<td>(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year</td>
</tr>
<tr>
<td><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>

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

@ -18,15 +18,19 @@
<th colspan="2">[neutron]</th>
</tr>
<tr>
<td>auth_strategy = keystone</td>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) Default authentication strategy to use when connecting to neutron. Can be either "keystone" or "noauth". Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing.</td>
</tr>
<tr>
<td>url = http://$my_ip:9696</td>
<td><option>retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Client retries in the case of a failed request.</td>
</tr>
<tr>
<td><option>url</option> = <replaceable>http://$my_ip:9696</replaceable></td>
<td>(StrOpt) URL for connecting to neutron.</td>
</tr>
<tr>
<td>url_timeout = 30</td>
<td><option>url_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Timeout value for connecting to neutron in seconds.</td>
</tr>
</tbody>

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

@ -18,75 +18,75 @@
<th colspan="2">[pxe]</th>
</tr>
<tr>
<td>default_ephemeral_format = ext4</td>
<td><option>default_ephemeral_format</option> = <replaceable>ext4</replaceable></td>
<td>(StrOpt) Default file system format for ephemeral partition, if one is created.</td>
</tr>
<tr>
<td>disk_devices = cciss/c0d0,sda,hda,vda</td>
<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>http_root = /httpboot</td>
<td><option>http_root</option> = <replaceable>/httpboot</replaceable></td>
<td>(StrOpt) Ironic compute node's HTTP root path.</td>
</tr>
<tr>
<td>http_url = None</td>
<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>
</tr>
<tr>
<td>image_cache_size = 20480</td>
<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>
</tr>
<tr>
<td>image_cache_ttl = 10080</td>
<td><option>image_cache_ttl</option> = <replaceable>10080</replaceable></td>
<td>(IntOpt) Maximum TTL (in minutes) for old master images in cache.</td>
</tr>
<tr>
<td>images_path = /var/lib/ironic/images/</td>
<td><option>images_path</option> = <replaceable>/var/lib/ironic/images/</replaceable></td>
<td>(StrOpt) Directory where images are stored on disk.</td>
</tr>
<tr>
<td>instance_master_path = /var/lib/ironic/master_images</td>
<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>
</tr>
<tr>
<td>ipxe_boot_script = $pybasedir/drivers/modules/boot.ipxe</td>
<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>
</tr>
<tr>
<td>ipxe_enabled = False</td>
<td><option>ipxe_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable iPXE boot.</td>
</tr>
<tr>
<td>pxe_append_params = nofb nomodeset vga=normal</td>
<td><option>pxe_append_params</option> = <replaceable>nofb nomodeset vga=normal</replaceable></td>
<td>(StrOpt) Additional append parameters for baremetal PXE boot.</td>
</tr>
<tr>
<td>pxe_bootfile_name = pxelinux.0</td>
<td><option>pxe_bootfile_name</option> = <replaceable>pxelinux.0</replaceable></td>
<td>(StrOpt) Bootfile DHCP parameter.</td>
</tr>
<tr>
<td>pxe_config_template = $pybasedir/drivers/modules/pxe_config.template</td>
<td><option>pxe_config_template</option> = <replaceable>$pybasedir/drivers/modules/pxe_config.template</replaceable></td>
<td>(StrOpt) Template file for PXE configuration.</td>
</tr>
<tr>
<td>tftp_master_path = /tftpboot/master_images</td>
<td><option>tftp_master_path</option> = <replaceable>/tftpboot/master_images</replaceable></td>
<td>(StrOpt) Directory where master tftp images are stored on disk.</td>
</tr>
<tr>
<td>tftp_root = /tftpboot</td>
<td><option>tftp_root</option> = <replaceable>/tftpboot</replaceable></td>
<td>(StrOpt) Ironic compute node's tftp root path.</td>
</tr>
<tr>
<td>tftp_server = $my_ip</td>
<td><option>tftp_server</option> = <replaceable>$my_ip</replaceable></td>
<td>(StrOpt) IP address of Ironic compute node's tftp server.</td>
</tr>
<tr>
<td>uefi_pxe_bootfile_name = elilo.efi</td>
<td><option>uefi_pxe_bootfile_name</option> = <replaceable>elilo.efi</replaceable></td>
<td>(StrOpt) Bootfile DHCP parameter for UEFI boot mode.</td>
</tr>
<tr>
<td>uefi_pxe_config_template = $pybasedir/drivers/modules/elilo_efi_pxe_config.template</td>
<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>
</tr>
</tbody>

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

@ -35,7 +35,7 @@
</tr>
<tr>
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
</tr>
<tr>
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>

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

@ -43,7 +43,18 @@
</tr>
<tr>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
<td>(IntOpt) Size of RPC thread pool.</td>
</tr>
<tr>
<th colspan="2">[oslo_concurrency]</th>
</tr>
<tr>
<td><option>disable_process_locking</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td><option>lock_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</td>
</tr>
</tbody>
</table>

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

@ -18,11 +18,11 @@
<th colspan="2">[seamicro]</th>
</tr>
<tr>
<td>action_timeout = 10</td>
<td><option>action_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Seconds to wait for power action to be completed</td>
</tr>
<tr>
<td>max_retry = 3</td>
<td><option>max_retry</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Maximum retries for SeaMicro operations</td>
</tr>
</tbody>

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

@ -18,7 +18,7 @@
<th colspan="2">[snmp]</th>
</tr>
<tr>
<td>power_timeout = 10</td>
<td><option>power_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Seconds to wait for power action to be completed</td>
</tr>
</tbody>

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

@ -18,7 +18,7 @@
<th colspan="2">[ssh]</th>
</tr>
<tr>
<td>libvirt_uri = qemu:///system</td>
<td><option>libvirt_uri</option> = <replaceable>qemu:///system</replaceable></td>
<td>(StrOpt) libvirt uri</td>
</tr>
</tbody>

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

@ -18,7 +18,7 @@
<th colspan="2">[swift]</th>
</tr>
<tr>
<td>swift_max_retries = 2</td>
<td><option>swift_max_retries</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Maximum number of times to retry a Swift request, before failing.</td>
</tr>
</tbody>

26
doc/common/tables/ironic-virtualbox.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_virtualbox">
<caption>Description of virtualbox 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">[virtualbox]</th>
</tr>
<tr>
<td><option>port</option> = <replaceable>18083</replaceable></td>
<td>(IntOpt) Port on which VirtualBox web service is listening.</td>
</tr>
</tbody>
</table>
</para>

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

@ -34,7 +34,7 @@
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo_messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>

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

@ -1,23 +1,23 @@
amqp_auto_delete amqp
amqp_durable_queues amqp
api_paste_config api
api_rate_limit api
auth_strategy auth
backdoor_port debug
baremetal_scheduler_default_filters scheduler
bindir common
client_socket_timeout api
compute_driver compute
control_exchange amqp
debug logging
default_log_levels logging
enabled_drivers common
fake_rabbit testing
fatal_deprecations common
fatal_exception_format_errors logging
force_raw_images common
hash_distribution_replicas common
hash_partition_exponent common
host common
instance_format logging
instance_name_template logging
instance_usage_audit_period logging
instance_uuid_format logging
isolinux_bin common
isolinux_config_template common
kombu_reconnect_delay rabbitmq
kombu_ssl_ca_certs rabbitmq
kombu_ssl_certfile rabbitmq
@ -34,13 +34,12 @@ logging_default_format_string logging
logging_exception_prefix logging
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
max_header_line common
memcached_servers common
monkey_patch common
monkey_patch_modules common
my_ip common
notification_driver amqp
notification_topics amqp
parallel_image_downloads common
periodic_interval common
policy_default_rule policy
policy_dirs policy
policy_file policy
@ -83,28 +82,56 @@ rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
run_external_periodic_tasks common
scheduler_available_filters scheduler
scheduler_default_filters scheduler
scheduler_use_baremetal_filters scheduler
scheduler_weight_classes scheduler
ssl_ca_file ssl
ssl_cert_file ssl
ssl_key_file ssl
state_path common
syslog_log_facility logging
tcp_keepidle common
tempdir common
transport_url amqp
use_forwarded_for api
use_stderr logging
use_syslog logging
use_syslog_rfc_format logging
verbose logging
wsgi_default_pool_size common
wsgi_keep_alive common
agent/agent_api_version agent
agent/agent_pxe_append_params agent
agent/agent_pxe_bootfile_name agent
agent/agent_pxe_config_template agent
agent/heartbeat_timeout agent
amt/protocol amt
api/host_ip api
api/max_limit api
api/port api
cells/bandwidth_update_interval cells
cells/call_timeout cells
cells/capabilities cells
cells/cell_type cells
cells/enable cells
cells/manager cells
cells/mute_child_interval cells
cells/name cells
cells/reserve_percent cells
cells/topic cells
conductor/api_url conductor
conductor/check_provision_state_interval conductor
conductor/configdrive_swift_container conductor
conductor/configdrive_use_swift conductor
conductor/deploy_callback_timeout conductor
conductor/force_power_state_during_sync conductor
conductor/heartbeat_interval conductor
conductor/heartbeat_timeout conductor
conductor/node_locked_retry_attempts conductor
conductor/node_locked_retry_interval conductor
conductor/periodic_max_workers conductor
conductor/power_state_sync_max_retries conductor
conductor/send_sensor_data conductor
conductor/send_sensor_data_interval conductor
conductor/send_sensor_data_types conductor
conductor/sync_local_state_interval conductor
conductor/sync_power_state_interval conductor
conductor/workers_pool_size conductor
console/subprocess_checking_interval console
console/subprocess_timeout console
console/terminal console
console/terminal_cert_dir console
console/terminal_pid_dir console
database/backend database
database/connection database
database/connection_debug database
@ -126,10 +153,12 @@ database/slave_connection database
database/sqlite_db database
database/sqlite_synchronous database
database/use_db_reconnect database
database/use_tpool database
deploy/dd_block_size deploy
deploy/iscsi_verify_attempts deploy
dhcp/dhcp_provider dhcp
disk_partitioner/check_device_interval disk_partitioner
disk_partitioner/check_device_max_retries disk_partitioner
glance/allowed_direct_url_schemes glance
glance/api_insecure glance
glance/api_servers glance
glance/auth_strategy glance
glance/glance_api_insecure glance
glance/glance_api_servers glance
@ -137,10 +166,25 @@ glance/glance_host glance
glance/glance_num_retries glance
glance/glance_port glance
glance/glance_protocol glance
glance/host glance
glance/num_retries glance
glance/port glance
glance/protocol glance
glance/swift_account glance
glance/swift_api_version glance
glance/swift_container glance
glance/swift_endpoint_url glance
glance/swift_store_multiple_containers_seed glance
glance/swift_temp_url_duration glance
glance/swift_temp_url_key glance
ilo/client_port ilo
ilo/client_timeout ilo
ilo/power_retry ilo
ilo/power_wait ilo
ilo/swift_ilo_container ilo
ilo/swift_object_expiry_timeout ilo
ipmi/min_command_interval ipmi
ipmi/retry_timeout ipmi
irmc/auth_method irmc
irmc/client_timeout irmc
irmc/port irmc
keystone/region_name keystone
keystone_authtoken/admin_password auth_token
keystone_authtoken/admin_tenant_name auth_token
keystone_authtoken/admin_token auth_token
@ -182,6 +226,12 @@ matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
neutron/auth_strategy neutron
neutron/retries neutron
neutron/url neutron
neutron/url_timeout neutron
oslo_concurrency/disable_process_locking rpc
oslo_concurrency/lock_path rpc
oslo_messaging_amqp/allow_insecure_clients amqp
oslo_messaging_amqp/broadcast_prefix amqp
oslo_messaging_amqp/container_name amqp
@ -193,4 +243,27 @@ oslo_messaging_amqp/ssl_cert_file ca
oslo_messaging_amqp/ssl_key_file ca
oslo_messaging_amqp/ssl_key_password ca
oslo_messaging_amqp/trace amqp
upgrade_levels/cells upgrades
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
pxe/instance_master_path pxe
pxe/ipxe_boot_script pxe
pxe/ipxe_enabled pxe
pxe/pxe_append_params pxe
pxe/pxe_bootfile_name pxe
pxe/pxe_config_template pxe
pxe/tftp_master_path pxe
pxe/tftp_root pxe
pxe/tftp_server pxe
pxe/uefi_pxe_bootfile_name pxe
pxe/uefi_pxe_config_template pxe
seamicro/action_timeout seamicro
seamicro/max_retry seamicro
snmp/power_timeout snmp
ssh/libvirt_uri ssh
swift/swift_max_retries swift
virtualbox/port virtualbox

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

@ -1,7 +1,13 @@
amt AMT
cells cell
deploy deploy
dhcp DHCP
disk_partitioner disk partitioner
ilo ILO
irmc iRMC
keystone keystone
seamicro SeaMicro
snmp SNMP
ssh SSH
pxe PXE
virtualbox VirtualBox