From 1e8460409f3cdb769cb321b45b6a76eb7c6121bf Mon Sep 17 00:00:00 2001 From: Vipin Balachandran Date: Tue, 29 Oct 2013 04:05:51 +0530 Subject: [PATCH] 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 --- doc/common/tables/cinder-vmware.xml | 56 +++++++++++ .../drivers/vmware-vmdk-driver.xml | 96 +------------------ .../flagmappings/cinder.flagmappings | 9 ++ 3 files changed, 67 insertions(+), 94 deletions(-) create mode 100644 doc/common/tables/cinder-vmware.xml diff --git a/doc/common/tables/cinder-vmware.xml b/doc/common/tables/cinder-vmware.xml new file mode 100644 index 0000000000..bb29170f77 --- /dev/null +++ b/doc/common/tables/cinder-vmware.xml @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for vmware
Configuration option=Default valueDescription
vmware_api_retry_count=10(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.
vmware_host_ip=None(StrOpt) IP address for connecting to VMware ESX/VC server.
vmware_host_password=None(StrOpt) Password for authenticating with VMware ESX/VC server.
vmware_host_username=None(StrOpt) Username for authenticating with VMware ESX/VC server.
vmware_image_transfer_timeout_secs=7200(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.
vmware_max_objects_retrieval=100(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.
vmware_task_poll_interval=5(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server.
vmware_volume_folder=cinder-volumes(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes.
vmware_wsdl_location=None(StrOpt) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.
+ \ No newline at end of file diff --git a/doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml b/doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml index 09a9ef2cea..94127167e7 100644 --- a/doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml +++ b/doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml @@ -45,100 +45,8 @@ - The following are mandatory properties to be specified in the - configuration file: - - - - - - - - - - - - - - - - - - - - - - -
- Mandatory properties -
NameDescription
vmware_host_ip - IP address for connecting to VMware ESX/VC server -
vmware_host_username - Username for authenticating with VMware ESX/VC server -
vmware_host_password - Password for authenticating with VMware ESX/VC server -
- The following are optional properties to be specified in the - configuration file: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Optional properties -
NameDefault valueDescription
vmware_wsdl_locationNoneOptional VIM service WSDL Location e.g - http://server/vimService.wsdl. Optional over-ride to - default location for bug work-arounds. -
vmware_api_retry_count10Number of times VMware ESX/VC server API must be - retried upon connection related issues -
vmware_task_poll_interval5The interval used for polling remote tasks invoked on - VMware ESX/VC server -
vmware_volume_foldercinder-volumesName for the folder in the VC datacenter that will - contain cinder volumes -
vmware_image_transfer_timeout_secs7200Timeout in seconds for VMDK volume transfer between - Cinder and Glance -
vmware_max_objects_retrieval100Max 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. -
+ The following table lists various options that the drivers support: + VMDK disk type diff --git a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings index b2a89edc6c..1c8f3d8da7 100644 --- a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings @@ -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