From f7c027db9abb847433df1dbe00d0e5fd9090c5c5 Mon Sep 17 00:00:00 2001 From: Eric Fried Date: Wed, 23 Oct 2019 16:03:59 -0500 Subject: [PATCH] Add image caching to the support matrix Add a section to the support matrix for image caching (``has_imagecache`` virt driver capability). Change-Id: I9147c5ea6b276b4fe18a981f4360844009bd3d95 Partial-Bug: #1847302 --- doc/source/admin/aggregates.rst | 4 +++- doc/source/admin/image-caching.rst | 5 +++-- doc/source/user/support-matrix.ini | 28 ++++++++++++++++++++++++++++ 3 files changed, 34 insertions(+), 3 deletions(-) diff --git a/doc/source/admin/aggregates.rst b/doc/source/admin/aggregates.rst index 140e5444216e..07dfd6a64603 100644 --- a/doc/source/admin/aggregates.rst +++ b/doc/source/admin/aggregates.rst @@ -365,12 +365,14 @@ requesting that images be pre-cached for performance reasons. .. note:: - Some of the virt drivers provide image caching support, which improves performance + `Some of the virt drivers`_ provide image caching support, which improves performance of second-and-later boots of the same image by keeping the base image in an on-disk cache. This avoids the need to re-download the image from Glance, which reduces network utilization and time-to-boot latency. Image pre-caching is the act of priming that cache with images ahead of time to improve performance of the first boot. +.. _Some of the virt drivers: https://docs.openstack.org/nova/latest/user/support-matrix.html#operation_cache_images + Assuming an aggregate called ``my-aggregate`` where two images should be pre-cached, running the following command will initiate the request: diff --git a/doc/source/admin/image-caching.rst b/doc/source/admin/image-caching.rst index 00fa13724d02..a132170b366e 100644 --- a/doc/source/admin/image-caching.rst +++ b/doc/source/admin/image-caching.rst @@ -3,8 +3,9 @@ Image Caching ============= Nova supports caching base images on compute nodes when using a -supported virt driver. As of the Ussuri release, that list includes -``hyperv``, ``libvirt``, and ``vmwareapi``. +`supported virt driver`_. + +.. _supported virt driver: https://docs.openstack.org/nova/latest/user/support-matrix.html#operation_cache_images What is Image Caching? ---------------------- diff --git a/doc/source/user/support-matrix.ini b/doc/source/user/support-matrix.ini index 1d918d3aafb2..eeedcce7fad6 100644 --- a/doc/source/user/support-matrix.ini +++ b/doc/source/user/support-matrix.ini @@ -1692,3 +1692,31 @@ driver.libvirt-vz-vm=missing driver.libvirt-vz-ct=missing driver.powervm=missing driver.zvm=missing + +[operation.cache-images] +title=Cache base images for faster instance boot +status=optional +notes=Drivers supporting this feature cache base images on the compute host so + that subsequent boots need not incur the expense of downloading them. Partial + support entails caching an image after the first boot that uses it. Complete + support allows priming the cache so that the first boot also benefits. Image + caching support is tunable via config options in the [image_cache] group. +cli=openstack server create +driver.xenserver=missing +driver.libvirt-kvm-x86=complete +driver.libvirt-kvm-aarch64=complete +driver.libvirt-kvm-ppc64=complete +driver.libvirt-kvm-s390x=complete +driver.libvirt-qemu-x86=complete +driver.libvirt-lxc=unknown +driver.libvirt-xen=complete +driver.vmware=partial +driver.hyperv=partial +driver.ironic=missing +driver.libvirt-vz-vm=complete +driver.libvirt-vz-ct=complete +driver.powervm=partial +driver-notes.powervm=The PowerVM driver does image caching natively when using + the SSP disk driver. It does not use the config options in the [image_cache] + group. +driver.zvm=missing