Glance

Useful image properties in glance - hw_cdrom_bus is not documented

Bug #1808868 reported by Matt Riedemann on 2018-12-17

This bug affects 2 people

Affects		Status	Importance	Assigned to	Milestone
	Glance	Fix Released	Medium	Adam Spiers

Bug Description

- [x] This is a doc addition request.

The useful image properties page does not document the "hw_cdrom_bus" image property, but it's mentioned in a few docs:

https://docs.openstack.org/glance/rocky/admin/manage-images.html

https://docs.openstack.org/security-guide/compute/hardening-the-virtualization-layers.html

Probably the easiest description is "Name of the CDROM bus to use.".

The values for the property are defined in nova:

https://github.com/openstack/nova/blob/48ad73e1faf966badab1f0344baad9f4f4055abf/nova/objects/fields.py#L320

class DiskBus(BaseNovaEnum):

    FDC = "fdc"
    IDE = "ide"
    SATA = "sata"
    SCSI = "scsi"
    USB = "usb"
    VIRTIO = "virtio"
    XEN = "xen"
    LXC = "lxc"
    UML = "uml"

ALL = (FDC, IDE, SATA, SCSI, USB, VIRTIO, XEN, LXC, UML)

However, not all libvirt virt types support all disk bus types, that's defined here:

https://github.com/openstack/nova/blob/48ad73e1faf966badab1f0344baad9f4f4055abf/nova/virt/libvirt/blockinfo.py#L198

The only compute driver that uses hw_cdrom_bus is "libvirt".

-----------------------------------
Release: on 2018-07-30 15:26:07
SHA: 3d52684346f3a7eb56b7d8836b4e0e8efafee647
Source: https://git.openstack.org/cgit/openstack/glance/tree/doc/source/admin/useful-image-properties.rst
URL: https://docs.openstack.org/glance/latest/admin/useful-image-properties.html

Tags:

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2019-09-12: Fix proposed to glance (master)

Fix proposed to branch: master
Review: https://review.opendev.org/681866

Changed in glance:
status:	Confirmed → In Progress

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2019-09-25: Fix merged to glance (master)

Reviewed: https://review.opendev.org/681866
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=3a281b9bc62a1b8b0f1468bc641105a5662f8ecd
Submitter: Zuul
Branch: master

commit 3a281b9bc62a1b8b0f1468bc641105a5662f8ecd
Author: Adam Spiers <email address hidden>
Date: Thu Sep 12 12:02:50 2019 +0100

Add SEV-related extra spec and image properties

    The AMD SEV support recently introduced to nova[0] depends on certain
    metadata properties for flavors and images which were either missing
    or only partially covered by existing glance metadata, so fill the
    missing gaps:

- Add the hw:mem_encryption flavor extra spec and corresponding
hw_mem_encryption image property.

- hw_firmware_type has been supported by nova for quite a while,
so register it as an official metadata property.

    - Add hw_cdrom_bus which was missing as per
      https://bugs.launchpad.net/glance/+bug/1808868. This shares
      values with hw_disk_bus, so document that too.

[0] https://docs.openstack.org/nova/latest/admin/configuration/hypervisor-kvm.html#amd-sev-secure-encrypted-virtualization

Closes-Bug: 1808868
Change-Id: I8116565ad0326d0125b320d840d787edcb086aa9