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 94127167e7..efba185389 100644 --- a/doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml +++ b/doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml @@ -5,27 +5,25 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> VMware VMDK driver - VMware VMDK driver enables management of cinder volume on VMware - vCenter Server or ESX managed datastore. Cinder volume is backed by VMDK - files on the datastore. + The VMware VMDK driver enables management of OpenStack Block Storage volumes on vCenter + managed datastores. Volumes are backed by VMDK files on datastores using any VMware + compatible storage technology. (e.g. NFS, iSCSI, FiberChannel, vSAN) Configuration - Two cinder drivers for VMware vCenter server and ESX are - provided. Appropriate driver must be configured when using VMware - server. For attach/detach operation to an instance, the driver works as - expected only with the VMware driver for nova and it does not work - with other nova drivers. Both nova and cinder drivers must be - configured to the same server. The following table captures the - configuration mapping: + The recommended OpenStack Block Storage volume driver is the VMware vCenter VMDK + driver. An ESX VMDK driver is provided as well, but it has not been extensively tested. + When configuring either driver, you must match it with the appropriate OpenStack Compute + driver from VMware and both drivers must point to the same server. The following table + captures this configuration mapping: - - - + + + @@ -50,13 +48,12 @@ VMDK disk type - VMwareVcVmdkDriver and VMwareEsxVmdkDriver support creating - VMDK disk file of types: thin, - thick and eagerZeroedThick. - VMDK disk file type can be specified via volume type extra specs. By - using any volume type with appropriate extra spec for volume creation, - the driver creates one of the above VMDK disk file type. The following - captures extra spec entry to VMDK disk file type mapping: + The VMware VMDK drivers support creating VMDK disk files of type: + thin, thick and + eagerZeroedThick. The VMDK disk file type is specified using the + vmware:vmdk_type extra spec key with the appropriate value. The + following table captures the mapping between the extra spec entry and the VMDK disk file + type:
Cinder-Nova configuration mapping with VMware server
VMware serverNova driverCinder driverVMware ServerOpenStack Compute DriverOpenStack Block Storage Driver
@@ -84,10 +81,10 @@
Extra spec entry to VMDK disk file type mapping
- When no volume type is used or if none of the above extra spec - entry is found in the volume type, then the default disk file type - used is thin. - Example: creation of thick VMDK volume + If no vmdk_type extra spec entry is specified, the default disk file type is + thin. + The example below shows how to create a thick VMDK volume using the appropriate + vmdk_type: $ cinder type-create thick_volume $ cinder type-key thick_volume set vmware:vmdk_type=thick @@ -96,14 +93,11 @@
Clone type - VMwareVcVmdkDriver supports clone types: full - and linked/fast while creating volume from another - source volume or from a snapshot point. Clone type can be specified via - volume type extra specs. By using volume type with appropriate extra - spec for creating volume from another source volume or from a snapshot - point, the driver creates a full clone or a - linked clone. The following captures extra spec - entry to clone type mapping: + With the VMware VMDK drivers, you can create a volume from another source volume or + from a snapshot point. The VMware vCenter VMDK driver supports clone types + full and linked/fast. The clone type is + specified using the vmware:clone_type extra spec key with the appropriate value. The + following table captures the mapping for clone types: @@ -126,30 +120,27 @@
Extra spec entry to clone type mapping
- When no volume type is used or if none of the above extra spec - entry is found in the volume type, then the default clone type is - full. - Example: linked cloning from another source volume + If not specified, the default clone type is full. + The following is an example of linked cloning from another source volume: $ cinder type-create fast_clone $ cinder type-key fast_clone set vmware:clone_type=linked $ cinder create --volume-type fast_clone --source-volid 25743b9d-3605-462b-b9eb-71459fe2bb35 --display-name volume1 1 - Note: VMwareEsxVmdkDriver ignores the extra spec entry and always - creates a full clone while creating volume from - another source volume or from a snapshot point. + Note: The VMware ESX VMDK driver ignores the extra spec entry and always creates a + full clone.
Supported operations - The following operations are supported by VMwareVcVmdkDriver and - VMwareEsxVmdkDriver: + The following operations are supported by the VMware vCenter and ESX VMDK + drivers: create volume - create volume from another source volume: Supported only - if source volume is not attached to an instance. + create volume from another source volume (Supported only if source volume is + not attached to an instance.) create volume from snapshot @@ -158,35 +149,36 @@ create volume from glance image - attach volume: When a volume is attached to an instance, - a reconfigure operation is performed on the instance to add the - volume's VMDK to it. The user must manually rescan and mount - the device from within the guest operating system. + attach volume (When a volume is attached to an instance, a reconfigure + operation is performed on the instance to add the volume's VMDK to it. The user + must manually rescan and mount the device from within the guest operating + system.) detach volume - create snapshot: Allowed only if volume is not attached - to an instance. + create snapshot (Allowed only if volume is not attached to an + instance.) - delete snapshot: Allowed only if volume is not attached - to an instance. + delete snapshot (Allowed only if volume is not attached to an + instance.) - upload as image to glance: Allowed only if volume is not - attached to an instance. + upload as image to glance (Allowed only if volume is not attached to an + instance.) + Note: Although the VMware ESX VMDK driver supports these operations, it has not been + extensively tested. Datastore selection - The driver chooses datastore that can accommodate for the volume - space and has highest freespace/totalspace metric - value. - When the volume is being attached to an instance, the driver - tries to place the volume under instance's ESX host on a datastore - selected based on the above strategy. + When creating a volume, the driver chooses a datastore that has sufficient free space + and has the highest freespace/totalspace metric value. + When a volume is attached to an instance, the driver attempts to place the volume + under the instance's ESX host on a datastore that is selected using the strategy + above.