nova/releasenotes/notes/microversion-2-88-7063636ed9c11a5d.yaml
Stephen Finucane 1f67ce2496 api: Drop statistics-style fields from os-hypervisors
Introduce API microversion 2.88, which makes the following changes to
a number of 'os-hypervisors'. Specifically, the following fields are
dropped from both the '/os-hypervisors/detail' (detailed list) and
'/os-hypervisors/{hypervisor_id}' (show) APIs:

- current_workload
- cpu_info
- vcpus
- vcpus_used
- free_disk_gb
- local_gb
- local_gb_used
- disk_available_least
- free_ram_mb
- memory_mb
- memory_mb_used
- running_vms

In addition, the '/os-hypervisors/statistics' API, which provided a
summary of the above stats but for all hypervisors in the deployment, is
dropped entirely.

Finally, the '/os-hypervisors/{hypervisor}/uptime' API, which provided a
similar response to the '/os-hypervisors/{hypervisor}' API but with an
additional 'uptime' field, has been removed in favour of including this
field in the primary '/os-hypervisors/{hypervisor}' API.

A small tweak to 'tox.ini' that allows us to share some venvs is
included.

Part of blueprint modernize-os-hypervisors-api

Change-Id: I515e484ade6c6455f82a3067940a418a0d7d965a
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-01-08 10:10:21 +00:00

34 lines
1.2 KiB
YAML

---
deprecations:
- |
The 2.88 API microversion has been added. This microversion removes a
number of fields have been removed from the ``GET /os-hypervisors/detail``
(detailed list) and ``GET /os-hypervisors/{hypervisor_id}`` (show) APIs::
- ``current_workload``
- ``cpu_info``
- ``vcpus``
- ``vcpus_used``
- ``free_disk_gb``
- ``local_gb``
- ``local_gb_used``
- ``disk_available_least``
- ``free_ram_mb``
- ``memory_mb``
- ``memory_mb_used``
- ``running_vms``
The fields have been removed as the information they provided was
frequently misleading or outright wrong, and more accurate information can
now be queried from placement.
In addition, the ``GET /os-hypervisors/statistics`` API, which provided a
summary view with just the fields listed above, has been removed entirely
and will now raise a HTTP 404 with microversion 2.88 or greater.
Finally, the ``GET /os-hypervisors/{hypervisor}/uptime`` API, which
provided a similar response to the ``GET /os-hypervisors/{hypervisor}`` API
but with an additional ``uptime`` field, has been removed in favour of
including this field in the primary ``GET /os-hypervisors/{hypervisor}``
API.