VMware: Using auto-gen table in cinder driver doc
Currently, the configuration options for VMware VMDK drivers are hard-coded in the reference source xml (doc/config-reference/ block-storage/drivers/vmware-vmdk-driver.xml). This change replaces the hard-coded configuration options with a reference to auto-generated config options file at doc/common/tables/cinder-vmware.xml. Closes-Bug: #1245784 backport: havana Change-Id: I4efb85ef0d1e082eac77daa1722b6bab831ae67d
This commit is contained in:
Vipin Balachandran
parent
a9a9a0267b
commit
1e8460409f
56
doc/common/tables/cinder-vmware.xml
Normal file
56
doc/common/tables/cinder-vmware.xml
Normal file
@ -0,0 +1,56 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- Warning: Do not edit this file. It is automatically
|
||||
generated and your changes will be overwritten.
|
||||
The tool to do so lives in the tools directory of this
|
||||
repository -->
|
||||
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<table rules="all">
|
||||
<caption>Description of configuration options for vmware</caption>
|
||||
<col width="50%"/>
|
||||
<col width="50%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Configuration option=Default value</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>vmware_api_retry_count=10</td>
|
||||
<td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_host_ip=None</td>
|
||||
<td>(StrOpt) IP address for connecting to VMware ESX/VC server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_host_password=None</td>
|
||||
<td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_host_username=None</td>
|
||||
<td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_image_transfer_timeout_secs=7200</td>
|
||||
<td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_max_objects_retrieval=100</td>
|
||||
<td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_task_poll_interval=5</td>
|
||||
<td>(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_volume_folder=cinder-volumes</td>
|
||||
<td>(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_wsdl_location=None</td>
|
||||
<td>(StrOpt) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -45,100 +45,8 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para>The following are mandatory properties to be specified in the
|
||||
configuration file:</para>
|
||||
<table rules="all">
|
||||
<caption>
|
||||
Mandatory properties
|
||||
</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>vmware_host_ip</td>
|
||||
<td>
|
||||
IP address for connecting to VMware ESX/VC server
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_host_username</td>
|
||||
<td>
|
||||
Username for authenticating with VMware ESX/VC server
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_host_password</td>
|
||||
<td>
|
||||
Password for authenticating with VMware ESX/VC server
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para>The following are optional properties to be specified in the
|
||||
configuration file:</para>
|
||||
<table rules="all">
|
||||
<caption>
|
||||
Optional properties
|
||||
</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Default value</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>vmware_wsdl_location</td>
|
||||
<td>None</td>
|
||||
<td>Optional VIM service WSDL Location e.g
|
||||
http://server/vimService.wsdl. Optional over-ride to
|
||||
default location for bug work-arounds.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_api_retry_count</td>
|
||||
<td>10</td>
|
||||
<td>Number of times VMware ESX/VC server API must be
|
||||
retried upon connection related issues
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_task_poll_interval</td>
|
||||
<td>5</td>
|
||||
<td>The interval used for polling remote tasks invoked on
|
||||
VMware ESX/VC server
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_volume_folder</td>
|
||||
<td>cinder-volumes</td>
|
||||
<td>Name for the folder in the VC datacenter that will
|
||||
contain cinder volumes
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_image_transfer_timeout_secs</td>
|
||||
<td>7200</td>
|
||||
<td>Timeout in seconds for VMDK volume transfer between
|
||||
Cinder and Glance
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>vmware_max_objects_retrieval</td>
|
||||
<td>100</td>
|
||||
<td>Max number of objects to be retrieved per batch. Query
|
||||
results will be obtained in batches from the server and not
|
||||
in one shot. Server may still limit the count to something
|
||||
less than the configured value.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para>The following table lists various options that the drivers support:</para>
|
||||
<xi:include href="../../../common/tables/cinder-vmware.xml"/>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>VMDK disk type</title>
|
||||
|
||||
@ -326,6 +326,15 @@ use_stderr common
|
||||
use_syslog common
|
||||
use_tpool common
|
||||
verbose common
|
||||
vmware_api_retry_count vmware
|
||||
vmware_host_ip vmware
|
||||
vmware_host_password vmware
|
||||
vmware_host_username vmware
|
||||
vmware_image_transfer_timeout_secs vmware
|
||||
vmware_max_objects_retrieval vmware
|
||||
vmware_task_poll_interval vmware
|
||||
vmware_volume_folder vmware
|
||||
vmware_wsdl_location vmware
|
||||
volume_api_class api
|
||||
volume_backend_name storage
|
||||
volume_clear_size storage
|
||||
|
||||
Loading…
Reference in New Issue
Block a user