Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update flagmappings for ironic 
Change-Id: I8296aa9fd46a903d5ca62f68fb97baab0e3390a0
  • Loading branch information
@anish
anish committed Feb 24, 2015
1 parent 83f0325 commit 3dc7d34
Show file tree
Hide file tree
Showing 30 changed files with 460 additions and 169 deletions.
10 changes: 5 additions & 5 deletions doc/common/tables/ironic-agent.xml
View file
Expand Up @@ -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>
Expand Down
26 changes: 26 additions & 0 deletions doc/common/tables/ironic-amt.xml
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 changes: 0 additions & 19 deletions doc/common/tables/ironic-api.xml
View file
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion doc/common/tables/ironic-auth.xml
View file
Expand Up @@ -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>
Expand Down
62 changes: 62 additions & 0 deletions doc/common/tables/ironic-cells.xml
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>
58 changes: 35 additions & 23 deletions doc/common/tables/ironic-common.xml
View file
Expand Up @@ -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>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
<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>monkey_patch</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to log monkey patching</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>
<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>
<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>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>
Expand All @@ -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>
Expand Down
40 changes: 24 additions & 16 deletions doc/common/tables/ironic-conductor.xml
View file
Expand Up @@ -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>
Expand Down
10 changes: 5 additions & 5 deletions doc/common/tables/ironic-console.xml
View file
Expand Up @@ -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>
Expand Down
4 changes: 0 additions & 4 deletions doc/common/tables/ironic-database.xml
View file
Expand Up @@ -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>

0 comments on commit 3dc7d34

Please sign in to comment.