nova/releasenotes/notes/xenapi-image-handler-7628a7221b7323e2.yaml
jianghua wang f7593ded8f XenAPI: define a new image handler to use vdi streaming
With the new image handler, it creates an image proxy which
will use the vdi streaming function from os-xenapi to
remotely export VHD from XenServer(image upload) or import
VHD to Xenerver(image download).
The existing GlanceStore uses custom functionality to directly
manipulate files on-disk, so it has the restriction that SR's
type must be file system based: e.g. ext or nfs. The new
image handler invokes APIs formally supported by XenServer
to export/import VDI remotely, it can support other SR
types also e.g. lvm, iscsi, etc.

Note:
vdi streaming would be supported by XenServer 6.5 or above.
The function of image handler depends on os-xenapi 0.3.3 or
above, so bump os-xenapi's version to 0.3.3 and also declare
depends on the patch which bump version in openstack/requirements.

Blueprint: xenapi-image-handler-option-improvement
Change-Id: I0ad8e34808401ace9b85e1b937a542f4c4e61690
Depends-On: Ib8bc0f837c55839dc85df1d1f0c76b320b9d97b8
2018-06-13 01:59:07 +00:00

49 lines
2.0 KiB
YAML

---
features:
- |
Add a new option of ``image_handler`` in the ``xenapi`` section for
configuring the image handler plugin which will be used by XenServer
to download or upload images. The value for this option should be a
short name representing a supported handler.
The following are the short names and description of the plugins which
they represent:
* ``direct_vhd``
This plugin directly processes the VHD files in XenServer SR(Storage
Repository). So this plugin only works when the host's SR type is
file system based e.g. ext, nfs. This is the default plugin.
* ``vdi_local_dev``
This plugin implements an image upload method which attaches the VDI
as a local disk in the VM in which the OpenStack Compute service runs.
It uploads the raw disk to glance when creating an image; When booting
an instance from a glance image, it downloads the image and streams it
into the disk which is attached to the compute VM.
* ``vdi_remote_stream``
This plugin implements an image proxy in nova compute service.
For image upload, the proxy will export a data stream for a VDI from
XenServer via the remote API supplied by XAPI; convert the stream
to the image format supported by glance; and upload the image to glance.
For image download, the proxy downloads an image stream from glance;
extracts the data stream from the image stream; and then remotely
imports the data stream to XenServer's VDI via the remote API supplied
by XAPI.
Note: Under this implementation, the image data may reside in one or
more pieces of storage of various formats on the host, but the import
and export operations interact with a single, proxied VDI object
independent of the underlying structure.
deprecations:
- |
The ``image_upload_handler`` option in the ``xenserver`` conf section
has been deprecated. Please use the new option of ``image_handler`` to
configure the image handler which is used to download or upload images.