yahoo-eng-team team mailing list archive

[Matt Riedemann <mriedem@xxxxxxxxxx>]

Public bug reported:

The api-ref for the os-migrations API says it's frozen but doesn't
really mention anything about it, at least regarding the 2.23 migration
and what the response behavior is:

https://developer.openstack.org/api-ref/compute/?expanded=list-
migrations-detail#migrations-os-migrations-frozen

Also the GET method description says "Lists in-progress migrations." but
the DB API code used for the API does not actually filter on status, so
by default it's going to return all migrations unless filter parameters
are passed in. The filter parameters used are here:

https://github.com/openstack/nova/blob/a3655c311454c09312f12f413535d83302e1fba4/nova/db/sqlalchemy/api.py#L4843

In microversion 2.23+, the migration_type is returned, that should be
documented. Also, in microversion 2.23+, if the migration is a live
migration and it's in progress, then "links" are in the response to
point to the related instance that's being live migration, and that's
what caused the os-migrations API to be "frozen" so that specific use
case could be replaced with the /servers/id/migrations API, which is
only available in 2.23+ and only lists in-progress live migrations.

Regardless of /servers/id/migrations, we should fully document the os-
migrations API.

** Affects: nova
     Importance: Medium
         Status: Confirmed


** Tags: api-ref

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1668747

Title:
  api-ref: os-migrations is missing response details and information
  about v2.23

Status in OpenStack Compute (nova):
  Confirmed

Bug description:
  The api-ref for the os-migrations API says it's frozen but doesn't
  really mention anything about it, at least regarding the 2.23
  migration and what the response behavior is:

  https://developer.openstack.org/api-ref/compute/?expanded=list-
  migrations-detail#migrations-os-migrations-frozen

  Also the GET method description says "Lists in-progress migrations."
  but the DB API code used for the API does not actually filter on
  status, so by default it's going to return all migrations unless
  filter parameters are passed in. The filter parameters used are here:

  https://github.com/openstack/nova/blob/a3655c311454c09312f12f413535d83302e1fba4/nova/db/sqlalchemy/api.py#L4843

  In microversion 2.23+, the migration_type is returned, that should be
  documented. Also, in microversion 2.23+, if the migration is a live
  migration and it's in progress, then "links" are in the response to
  point to the related instance that's being live migration, and that's
  what caused the os-migrations API to be "frozen" so that specific use
  case could be replaced with the /servers/id/migrations API, which is
  only available in 2.23+ and only lists in-progress live migrations.

  Regardless of /servers/id/migrations, we should fully document the os-
  migrations API.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1668747/+subscriptions