259 lines
13 KiB
XML
259 lines
13 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
|
|
<!--
|
|
###################################################################
|
|
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
|
|
###################################################################
|
|
|
|
Warning: Do not edit this file. It is automatically
|
|
generated from the software project's code and your changes
|
|
will be overwritten.
|
|
|
|
The tool to generate this file lives in openstack-doc-tools
|
|
repository.
|
|
|
|
Please make any changes needed in the code, then run the
|
|
autogenerate-config-doc tool from the openstack-doc-tools
|
|
repository, or ask for help on the documentation mailing list,
|
|
IRC channel or meeting.
|
|
|
|
###################################################################
|
|
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
|
|
###################################################################
|
|
-->
|
|
<table rules="all" xml:id="config_table_nova_xen">
|
|
<caption>Description of Xen 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">[DEFAULT]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>console_driver</option> = <replaceable>nova.console.xvp.XVPConsoleProxy</replaceable></td>
|
|
<td>(StrOpt) Driver to use for the console proxy</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>console_xvp_conf</option> = <replaceable>/etc/xvp.conf</replaceable></td>
|
|
<td>(StrOpt) Generated XVP conf file</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>console_xvp_conf_template</option> = <replaceable>$pybasedir/nova/console/xvp.conf.template</replaceable></td>
|
|
<td>(StrOpt) XVP conf template</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>console_xvp_log</option> = <replaceable>/var/log/xvp.log</replaceable></td>
|
|
<td>(StrOpt) XVP log file</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>console_xvp_multiplex_port</option> = <replaceable>5900</replaceable></td>
|
|
<td>(IntOpt) Port for XVP to multiplex VNC connections on</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>console_xvp_pid</option> = <replaceable>/var/run/xvp.pid</replaceable></td>
|
|
<td>(StrOpt) XVP master process pid file</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>stub_compute</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Stub calls to compute worker for tests</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[libvirt]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>xen_hvmloader_path</option> = <replaceable>/usr/lib/xen/boot/hvmloader</replaceable></td>
|
|
<td>(StrOpt) Location where the Xen hvmloader is kept</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[xenserver]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>agent_path</option> = <replaceable>usr/sbin/xe-update-networking</replaceable></td>
|
|
<td>(StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>agent_resetnetwork_timeout</option> = <replaceable>60</replaceable></td>
|
|
<td>(IntOpt) Number of seconds to wait for agent reply to resetnetwork request</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>agent_timeout</option> = <replaceable>30</replaceable></td>
|
|
<td>(IntOpt) Number of seconds to wait for agent reply</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>agent_version_timeout</option> = <replaceable>300</replaceable></td>
|
|
<td>(IntOpt) Number of seconds to wait for agent to be fully operational</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>cache_images</option> = <replaceable>all</replaceable></td>
|
|
<td>(StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>check_host</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) Ensure compute service is running on host XenAPI connects to.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>connection_concurrent</option> = <replaceable>5</replaceable></td>
|
|
<td>(IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>connection_password</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>connection_url</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>connection_username</option> = <replaceable>root</replaceable></td>
|
|
<td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>default_os_type</option> = <replaceable>linux</replaceable></td>
|
|
<td>(StrOpt) Default OS type</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>disable_agent</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>image_compression_level</option> = <replaceable>None</replaceable></td>
|
|
<td>(IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>image_upload_handler</option> = <replaceable>nova.virt.xenapi.image.glance.GlanceStore</replaceable></td>
|
|
<td>(StrOpt) Dom0 plugin driver used to handle image uploads.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>introduce_vdi_retry_wait</option> = <replaceable>20</replaceable></td>
|
|
<td>(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>ipxe_boot_menu_url</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) URL to the iPXE boot menu</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>ipxe_mkisofs_cmd</option> = <replaceable>mkisofs</replaceable></td>
|
|
<td>(StrOpt) Name and optionally path of the tool used for ISO image creation</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>ipxe_network_name</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Name of network to use for booting iPXE ISOs</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>iqn_prefix</option> = <replaceable>iqn.2010-10.org.openstack</replaceable></td>
|
|
<td>(StrOpt) IQN Prefix</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>login_timeout</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Timeout in seconds for XenAPI login.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_kernel_ramdisk_size</option> = <replaceable>16777216</replaceable></td>
|
|
<td>(IntOpt) Maximum size in bytes of kernel or ramdisk images</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>num_vbd_unplug_retries</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Maximum number of retries to unplug VBD. if <=0, should try once and no retry</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>ovs_integration_bridge</option> = <replaceable>xapi1</replaceable></td>
|
|
<td>(StrOpt) Name of Integration Bridge used by Open vSwitch</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>remap_vbd_dev</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>remap_vbd_dev_prefix</option> = <replaceable>sd</replaceable></td>
|
|
<td>(StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>running_timeout</option> = <replaceable>60</replaceable></td>
|
|
<td>(IntOpt) Number of seconds to wait for instance to go to running state</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>sparse_copy</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>sr_base_path</option> = <replaceable>/var/run/sr-mount</replaceable></td>
|
|
<td>(StrOpt) Base path to the storage repository</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>sr_matching_filter</option> = <replaceable>default-sr:true</replaceable></td>
|
|
<td>(StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>target_host</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) The iSCSI Target Host</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>target_port</option> = <replaceable>3260</replaceable></td>
|
|
<td>(StrOpt) The iSCSI Target Port, default is port 3260</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_base_url</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Base URL for torrent files; must contain a slash character (see RFC 1808, step 6)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_download_stall_cutoff</option> = <replaceable>600</replaceable></td>
|
|
<td>(IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_images</option> = <replaceable>none</replaceable></td>
|
|
<td>(StrOpt) Whether or not to download images via Bit Torrent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_listen_port_end</option> = <replaceable>6891</replaceable></td>
|
|
<td>(IntOpt) End of port range to listen on</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_listen_port_start</option> = <replaceable>6881</replaceable></td>
|
|
<td>(IntOpt) Beginning of port range to listen on</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_max_last_accessed</option> = <replaceable>86400</replaceable></td>
|
|
<td>(IntOpt) Cached torrent files not accessed within this number of seconds can be reaped</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_max_seeder_processes_per_host</option> = <replaceable>1</replaceable></td>
|
|
<td>(IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_seed_chance</option> = <replaceable>1.0</replaceable></td>
|
|
<td>(FloatOpt) Probability that peer will become a seeder. (1.0 = 100%)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>torrent_seed_duration</option> = <replaceable>3600</replaceable></td>
|
|
<td>(IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>use_agent_default</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>use_join_force</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) To use for hosts with different CPUs</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>vhd_coalesce_max_attempts</option> = <replaceable>20</replaceable></td>
|
|
<td>(IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>vhd_coalesce_poll_interval</option> = <replaceable>5.0</replaceable></td>
|
|
<td>(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>vif_driver</option> = <replaceable>nova.virt.xenapi.vif.XenAPIBridgeDriver</replaceable></td>
|
|
<td>(StrOpt) The XenAPI VIF driver using XenServer Network APIs.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|