Skip to content

Commit b5d4804

Browse files
committed
doc: Update references to image properties
The 'architecture', 'hypervisor_type', 'hypervisor_version_requires' and 'vm_mode' image metadata properties have had new names for many cycles now. The example for the freshly renamed 'img_hv_requested_version' option has been updated to show a Hyper-V example, since the Xen virt driver is not tested and will likely be removed in the near future. Change-Id: I5684d7d462d3f7cecd887216c5618139787ef5d7 Signed-off-by: Stephen Finucane <[email protected]>
1 parent b3bbcaf commit b5d4804

File tree

1 file changed

+31
-15
lines changed

1 file changed

+31
-15
lines changed

doc/source/admin/configuration/schedulers.rst

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -414,53 +414,69 @@ ImagePropertiesFilter
414414
Filters hosts based on properties defined on the instance's image. It passes
415415
hosts that can support the specified image properties contained in the
416416
instance. Properties include the architecture, hypervisor type, hypervisor
417-
version (for Xen hypervisor type only), and virtual machine mode.
417+
version, and virtual machine mode.
418418

419419
For example, an instance might require a host that runs an ARM-based processor,
420420
and QEMU as the hypervisor. You can decorate an image with these properties by
421421
using:
422422

423423
.. code-block:: console
424424
425-
$ openstack image set --architecture arm --property hypervisor_type=qemu \
425+
$ openstack image set --architecture arm --property img_hv_type=qemu \
426426
img-uuid
427427
428428
The image properties that the filter checks for are:
429429

430-
``architecture``
431-
describes the machine architecture required by the image. Examples are
430+
``hw_architecture``
431+
Describes the machine architecture required by the image. Examples are
432432
``i686``, ``x86_64``, ``arm``, and ``ppc64``.
433433

434-
``hypervisor_type``
435-
describes the hypervisor required by the image. Examples are ``xen``,
436-
``qemu``, and ``xenapi``.
434+
.. versionchanged:: 12.0.0 (Liberty)
435+
436+
This was previously called ``architecture``.
437+
438+
``img_hv_type``
439+
Describes the hypervisor required by the image. Examples are ``qemu``,
440+
``xenapi``, and ``hyperv``.
437441

438442
.. note::
439443

440444
``qemu`` is used for both QEMU and KVM hypervisor types.
441445

442-
``hypervisor_version_requires``
443-
describes the hypervisor version required by the image. The property is
444-
supported for Xen hypervisor type only. It can be used to enable support for
445-
multiple hypervisor versions, and to prevent instances with newer Xen tools
446+
.. versionchanged:: 12.0.0 (Liberty)
447+
448+
This was previously called ``hypervisor_type``.
449+
450+
``img_hv_requested_version``
451+
Describes the hypervisor version required by the image. The property is
452+
supported for HyperV hypervisor type only. It can be used to enable support for
453+
multiple hypervisor versions, and to prevent instances with newer HyperV tools
446454
from being provisioned on an older version of a hypervisor. If available, the
447455
property value is compared to the hypervisor version of the compute host.
448456

449457
To filter the hosts by the hypervisor version, add the
450-
``hypervisor_version_requires`` property on the image as metadata and pass an
458+
``img_hv_requested_version`` property on the image as metadata and pass an
451459
operator and a required hypervisor version as its value:
452460

453461
.. code-block:: console
454462
455-
$ openstack image set --property hypervisor_type=xen --property \
456-
hypervisor_version_requires=">=4.3" img-uuid
463+
$ openstack image set --property hypervisor_type=hyperv --property \
464+
hypervisor_version_requires=">=6000" img-uuid
457465
458-
``vm_mode``
466+
.. versionchanged:: 12.0.0 (Liberty)
467+
468+
This was previously called ``hypervisor_version_requires``.
469+
470+
``hw_vm_mode``
459471
describes the hypervisor application binary interface (ABI) required by the
460472
image. Examples are ``xen`` for Xen 3.0 paravirtual ABI, ``hvm`` for native
461473
ABI, ``uml`` for User Mode Linux paravirtual ABI, ``exe`` for container virt
462474
executable ABI.
463475

476+
.. versionchanged:: 12.0.0 (Liberty)
477+
478+
This was previously called ``vm_mode``.
479+
464480
IsolatedHostsFilter
465481
-------------------
466482

0 commit comments

Comments
 (0)