ImagePropertiesFilter docs refer to legacy properties

Bug #1796857 reported by Adam Spiers
14
This bug affects 3 people
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Confirmed
Low
Unassigned

Bug Description

https://docs.openstack.org/nova/latest/admin/configuration/schedulers.html#imagepropertiesfilter refers to the 'architecture', 'hypervisor_type', 'hypervisor_version_requires', and 'vm_mode' properties; however the source code at https://github.com/openstack/nova/blob/05c379173569d2ea91741f3468d531d4edf7ef9d/nova/objects/image_meta.py#L474 shows that these are legacy properties which now have preferred alternatives:

    # The keys are the legacy property names and
    # the values are the current preferred names
    _legacy_property_map = {
        'architecture': 'hw_architecture',
        [... snipped ...]
        'vm_mode': 'hw_vm_mode',
        [... snipped ...]
        'hypervisor_version_requires': 'img_hv_requested_version',
        'hypervisor_type': 'img_hv_type',
    }

Therefore presumably the docs should be updated to refer to the new properties. If someone can confirm this is correct, I'm happy to push the doc fix for review.

Tags: doc
summary: - ImagePropertiesFilter refers to legacy properties
+ ImagePropertiesFilter docs refer to legacy properties
Revision history for this message
Matt Riedemann (mriedem) wrote :

I can confirm those are the properties that the ImagePropertiesFilter are looking at and are aliased for the legacy names, however, the image properties documentation in glance still refers to the "legacy" property names, so if we're going to change the docs, they should be consistent:

https://docs.openstack.org/glance/latest/admin/useful-image-properties.html

Otherwise if I'm looking at the nova docs and don't see those properties in the glance image properties docs, I'd be confused.

Changed in nova:
status: New → Confirmed
importance: Undecided → Low
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.