openstack/nova
Code Issues Proposed changes

Fix up force live migration completion docs

Browse Source 
This change does a few things:

* Links live_migration_completion_timeout to the config
  option guide.

* Links the force complete API reference to the feature support
  matrix to see which drivers support the operation.

* Fixes the server status mentioned in the troubleshooting for
  the force complete API reference (a live migrating server
  status is MIGRATING, not ACTIVE). The same text is copied to the
  abort live migration API reference troubleshooting for
  consistency (and since using the server status is more natural than
  the task_state).

* Links to the admin guide for troubleshooting live migration
  timeouts.

Change-Id: I496d3f4b99e3d7e978c7ecb13ab3b67023fcb919
Closes-Bug: #1808579
This commit is contained in:
Matt Riedemann
2018-12-14 15:13:59 -05:00
parent 4c3698c0b6
commit 18fbee57b4
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
api-ref/source/server-migrations.inc
View File

@@ -124,9 +124,11 @@ Specify the ``force_complete`` action in the request body.
.. note:: Microversion 2.22 or greater is required for this API. .. note:: Microversion 2.22 or greater is required for this API.
.. note:: Not all compute back ends support forcefully completing an .. note:: Not all `compute back ends`_ support forcefully completing an
in-progress live migration. in-progress live migration.
.. _compute back ends: https://docs.openstack.org/nova/latest/user/support-matrix.html#operation_force_live_migration_to_complete
Policy defaults enable only users with the administrative role to perform Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the this operation. Cloud providers can change these permissions through the
``policy.json`` file. ``policy.json`` file.
@@ -148,9 +150,11 @@ to determine whether the request succeeded.
**Troubleshooting** **Troubleshooting**
If the server status remains ``ACTIVE`` for an inordinate amount of time, the If the server status remains ``MIGRATING`` for an inordinate amount of time,
request may have failed. Ensure you meet the preconditions and run the request the request may have failed. Ensure you meet the preconditions and run the
again. If the request fails again, investigate the compute back end. request again. If the request fails again, investigate the compute back end.
More details can be found in the
`admin guide <https://docs.openstack.org/nova/latest/admin/live-migration-usage.html#what-to-do-when-the-migration-times-out>`_.
Normal response codes: 202 Normal response codes: 202
@@ -215,7 +219,7 @@ using::
**Troubleshooting** **Troubleshooting**
If the server task_state remains ``migrating`` for an inordinate amount of If the server status remains ``MIGRATING`` for an inordinate amount of
time, the request may have failed. Ensure you meet the preconditions and run time, the request may have failed. Ensure you meet the preconditions and run
the request again. If the request fails again, investigate the compute back the request again. If the request fails again, investigate the compute back
end. end.

6
doc/source/admin/configuring-migrations.rst
View File

@@ -227,9 +227,9 @@ memory-intensive instances succeed.
ephemeral storage in GiB is added. ephemeral storage in GiB is added.
The timeout in seconds is the instance size multiplied by the configurable The timeout in seconds is the instance size multiplied by the configurable
parameter ``live_migration_completion_timeout``, whose default is 800. For parameter :oslo.config:option:`libvirt.live_migration_completion_timeout`,
example, shared-storage live migration of an instance with 8GiB memory will whose default is 800. For example, shared-storage live migration of an
time out after 6400 seconds. instance with 8GiB memory will time out after 6400 seconds.
#. **Instance downtime** #. **Instance downtime**