Commit Graph

30 Commits

Author SHA1 Message Date
Danylo Vodopianov 66566c3286 Add Packed Virtqueue extra spec and image properties
Virtqueue feature was added to the metadata properties for flavor and
images

- Add the hw:virtio_packed_ring flavor extra spec and corresponding
  hw_virtio_packed_ring image property.

Nova spec: https://review.opendev.org/c/openstack/nova-specs/+/868377

Depends-On: https://review.opendev.org/c/openstack/nova/+/876075

Change-Id: Ia8caf39467a91431ca85b2a56ec93a60c41a8e7d
2023-12-05 10:59:18 +02:00
Neil Hanlon 4fb03af06d
Add rocky linux to useful image properties os_images list
Change-Id: I4921ef709a0aeb411f50d601ef59a2e8d6e7acad
2023-05-04 10:15:44 -04:00
Gonéri Le Bouder b27b26a6a8 doc/useful-image-properties: add missing `` to close a code block
Change-Id: I93301d51fb5f750693abbe07cb587d68ed0bd690
2023-02-09 12:39:13 -05:00
yuqian 475193b11d vmware does't support VirtualSriovEthernetCard
Compute-driver: vmwareapi.VMwareVCDriver does not support
VirtualSriovEthernetCard

Change-Id: I1d4b0dee3c70454c0d595cb4a69606990b96b35a
Partial-Bug: #1779781
2022-11-21 21:57:17 +01:00
Gonéri Le Bouder d883e4fd5b doc: update the kvm kw_vif_model driver list
The kw_vif_model driver list has evolved a bit. This commit adds:
- e1000e: I12a5d28d75bc32a76a4f3765cb4db4cbc46c0c75
- vmxnet3 I95203af4ded9a4dbecfb7981b400f0fb988f2d47

Change-Id: I23fbd227274c89735547322cedda565c5987776d
2022-07-04 22:39:25 +02:00
Zuul f01f31a792 Merge "doc: add aarch64 to list of architecture image properties" 2022-05-18 06:50:32 +00:00
Zuul da3c4a17d6 Merge "add doc about KVM support e1000e vif model" 2022-05-18 06:46:22 +00:00
Thomas Bechtold 25297043e3 doc: add aarch64 to list of architecture image properties
Images for the aarch64 ARM architecture do have the architecture
property set to aarch64.
This is useful to know when trying to filter by properties like:

openstack image list --property architecture=aarch64

Change-Id: Ib4c0130bee302ee886521b74cf5434a0073cecf6
2022-05-17 21:14:53 +02:00
Dmitry Tantsur c158e0f567 Document new properties used by Ironic
* rootfs_uuid (introduced a while ago) specifies which partition of a
  whole-disk image is a root.
* img_type specifies whether the image is a whole-disk or a partition
  image. Currently Ironic uses kernel_id/ramdisk_id to decide that, but
  this logic only makes sense when booting instances from network.

img_type will be introduced by https://review.opendev.org/c/openstack/ironic/+/825305

Change-Id: Idd0d38fc312d08a99b5f5b2072cc991bc4575719
2022-01-27 15:47:50 +01:00
Kashyap Chamarthy bfc7a178e3 Add "bochs" as a possible video model
In Xena, this commit[1] support for the "bochs" video model (the device
is recommended for UEFI guest), but neglected to update Glance
documentation.  Correct that now.

[1] https://opendev.org/openstack/nova/commit/c590843974
    "Allow 'bochs' as a display device option"

Change-Id: I2026a81d3611e069fbcd1a79c2384d18cb5a653d
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
2021-11-15 14:42:49 +01:00
Jeffrey Zhang 8862c84d3f add doc about KVM support e1000e vif model
Nova + KVM support e1000e vif model through[1]

* [1] https://review.opendev.org/q/I12a5d28d75bc32a76a4f3765cb4db4cbc46c0c75

Change-Id: I2d51d05e96959cd299ef347fb47faca6723b61d9
2021-08-22 22:56:24 +08:00
Dan Smith 07951b095b Update docs and renos for os_glance reservation
This adds some words to the api-ref doc, as well as a release note
about the blanket reservation of os_glance* properties.

Change-Id: I0cd6f35296a647fdb1f2cb44a688b34c0382c556
Related-Bug: #1912001
2021-01-25 12:30:50 -08:00
Stephen Finucane d3d9982e66 docs: Convert table of image properties to definition list
This renders much flatter as is similar to what's used nowadays for
config options (via the 'oslo_config.sphinxext' extension)

Change-Id: If204d887ed0d65cfc5e75cc7739b0f8f59ce000f
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-09-17 17:21:51 +01:00
Stephen Finucane e1fe3024bb docs: Remove references to XenAPI driver
The XenAPI driver is dead. Let's hold the tissues and clear out
references from the documentation instead.

Change-Id: I6ec331cf7d2d1ded924893f707ed963027939754
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-09-17 17:09:17 +01:00
Russell Tweed 517ff4fbe4 Document os_admin_user in Useful Image Properties
Add documentation of the os_admin_user property to the Useful Image Properties guide.

Change-Id: I10e1e738aeacc708350993f05d373eaa1293fd27
Closes-Bug: 1850412
2020-02-21 11:22:44 +00:00
Zuul 4e8afee0be Merge "useful-image-properties: Update note on machine types" 2019-12-13 22:21:26 +00:00
Kashyap Chamarthy 52127a692a useful-image-properties: Update note on machine types
For ARMv7 and AArch64, Nova uses the 'virt' machine type as the default.
Update the docs to reflect that.

Refer to this commit in Nova:

    https://opendev.org/openstack/nova/commit/e155baefb0
    (libvirt: Use 'virt' as the default machine type for ARMv7,
    2018-09-14)

Change-Id: I13793dded976fdf872ca0ea779a7f6cbee98118f
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
2019-09-13 10:12:30 +02:00
Adam Spiers 3a281b9bc6 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
2019-09-12 19:58:27 +01:00
Zuul ca00b48e59 Merge "add metadef vlaues for new video models" 2019-09-06 12:03:03 +00:00
Zuul 1b6ae384af Merge "add hw_pmu metadef" 2019-09-06 03:13:48 +00:00
Sean Mooney 5bdefff5cd add metadef vlaues for new video models
- This change adds the newly supported libvirt
  video models, virtio, gop and none.
- This change updates the train metadefs changes
  release note.

Change-Id: I440a038b53825b5f92fc977566edcf3cabfba673
2019-08-21 01:18:07 +01:00
Sean Mooney 2998c795ed add hw_pmu metadef
This change adds a new hw_pmu metadef property to the
OS::Compute::LibvirtImage namespace and extends the train
metadef changes releasenote.

Depends-on: https://review.opendev.org/#/c/671338/
Change-Id: I2f4e7ef4f816afbd0524a6265d5605afa1da5f86
2019-08-21 01:06:04 +01:00
Brian Rosmaita 90bffdc361 Update hw_rng_model image property doc
This property requires configuration on the Nova side for it
to have an effect; make that clear in the documentation.

Change-Id: I9a1902eefcb3a2ed1334f24a5d3335e17ab0aad2
Closes-bug: #1805679
2019-06-06 09:39:46 -04:00
Zuul f9a568f235 Merge "Document os_shutdown_timeout image property" 2019-04-09 17:25:06 +00:00
Jack Ding 59a5994a18 Add definition for hw_time_hpet image property
Depends-On: https://review.openstack.org/605902
Change-Id: Ia7358ce658878d1341026af3dc1459f450557cac
Signed-off-by: Jack Ding <jack.ding@windriver.com>
2018-11-20 22:45:51 +00:00
Matt Riedemann 3f18940d80 Document os_shutdown_timeout image property
This adds an entry to the "Useful image properties" docs for
the os_shutdown_timeout property. The description is copied
from the metadata definition.

Change-Id: I96be4b908f929361c201a8369d2e140bf711c923
Closes-Bug: #1784953
2018-10-24 10:16:27 -04:00
Matt Riedemann d2a5c52680 Document hw_cpu_policy and hw_cpu_thread_policy image properties
These were found in the nova flavor extra specs docs [1] but not
the image properties docs, so they are added here.

[1] https://docs.openstack.org/nova/latest/user/flavors.html

Change-Id: I2225821f859d43b1458174b8b7baa05c50cd0cd7
Closes-Bug: #1784462
2018-07-30 15:26:07 -04:00
Arvind Nadendla b30ed486ae Update glance documentation for trait support
Required traits on the image allow specifying a server to be
built only on compute nodes which express those traits. The
Nova Scheduler has been updated to look at the image trait
properties when selecting compute nodes.

Updating the documentation for glance to explain the same.

Documentation is similar to flavor required traits documentation available
here: https://docs.openstack.org/nova/latest/user/flavors.html#extra-specs

Change-Id: I716821abf44238eecc9c4a1d198d8a31b87dedce
Implements: blueprint glance-image-traits
2018-07-13 11:09:37 -07:00
Kashyap Chamarthy 9a893e80c2 useful-image-properties.rst: Update default RNG source
Nova's libvirt driver has changed[*] the default source from /dev/random
to /dev/urandom:

    "Since libvirt 1.3.4, any RNG (Random Number Generator) device path
    (that returns random numbers when read!) is accepted. However, the
    recommended source of entropy is `/dev/urandom` (it is non-blocking;
    and doesn't have the same limitations of `dev/random`, which is a
    legacy interface)."

Update the relevant Glance documentation to reflect that.

[*] https://git.openstack.org/cgit/openstack/nova/commit/?id=814bfd93

Change-Id: I656b5c244b98202f3c8d019d0bbeddc4e7c0314a
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
2018-07-02 14:41:10 +02:00
Brian Rosmaita d3ccab6435 Add 'useful image properties' document
Move the list of useful image properties from the glanceclient
docs to the Glance Admin Guide.  It makes more sense in the Glance
docs as the only connection they have with the glanceclient is that
you can use the client CLI to set these properties

The table of property keys/values is unchanged; the introductory
section is new.

Change-Id: I0c307a067490c06728b5adf70c91586254e337da
Needed-by: https://review.openstack.org/565782
2018-05-02 10:48:06 -04:00