summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorLee Yarwood <lyarwood@redhat.com>2020-05-01 14:20:04 +0100
committerLee Yarwood <lyarwood@redhat.com>2020-07-29 16:05:48 +0000
commit5913bd889f9d3dfc8d154415e666c821054c229d (patch)
treee7743504c155477bdc1d8be6118210ddc6b0a5e5 /api-ref
parent49c3ac7dfa7aca5504f9d19958ff82a40e47f5a1 (diff)
downloadnova-5913bd889f9d3dfc8d154415e666c821054c229d.tar.gz
compute: Validate a BDMs disk_bus when provided
Previously disk_bus values were never validated and could easily end up being ignored by the underlying virt driver and hypervisor. For example, a common mistake made by users is to request a virtio-scsi disk_bus when using the libvirt virt driver. This however isn't a valid bus and is ignored, defaulting back to the virtio (virtio-blk) bus. This change adds a simple validation in the compute API using the potential disk_bus values provided by the DiskBus field class as used when validating the hw_*_bus image properties. Closes-Bug: #1876301 Change-Id: I77b28b9cc8f99b159f628f4655d85ff305a71db8
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/parameters.yaml7
1 files changed, 4 insertions, 3 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 9ed259923e..cc36fcbe8a 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -2515,9 +2515,10 @@ disk_available_least_total:
disk_bus:
description: |
Disk bus type, some hypervisors (currently only libvirt) support
- specify this parameter. Some example disk_bus values can be: `ide`,
- `usb`, `virtio`, `scsi`. This is not an exhaustive list as it depends
- on the virtualization driver, and may change as more support is added.
+ specify this parameter. Some example disk_bus values can be: ``fdc``,
+ ``ide``, ``sata``, ``scsi``, ``usb``, ``virtio``, ``xen``, ``lxc``
+ and ``uml``. Support for each bus type depends on the virtualization driver
+ and underlying hypervisor.
in: body
required: false
type: string