From 18fbee57b47eb9fbbf9efd621be5a6f5ecef4ab6 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Fri, 14 Dec 2018 15:13:59 -0500 Subject: [PATCH] Fix up force live migration completion docs 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 --- api-ref/source/server-migrations.inc | 14 +++++++++----- doc/source/admin/configuring-migrations.rst | 6 +++--- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/api-ref/source/server-migrations.inc b/api-ref/source/server-migrations.inc index f0d45f2d4442..4a2ac97f4e14 100644 --- a/api-ref/source/server-migrations.inc +++ b/api-ref/source/server-migrations.inc @@ -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:: Not all compute back ends support forcefully completing an +.. note:: Not all `compute back ends`_ support forcefully completing an 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 this operation. Cloud providers can change these permissions through the ``policy.json`` file. @@ -148,9 +150,11 @@ to determine whether the request succeeded. **Troubleshooting** -If the server status remains ``ACTIVE`` for an inordinate amount of 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 end. +If the server status remains ``MIGRATING`` for an inordinate amount of 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 end. +More details can be found in the +`admin guide `_. Normal response codes: 202 @@ -215,7 +219,7 @@ using:: **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 the request again. If the request fails again, investigate the compute back end. diff --git a/doc/source/admin/configuring-migrations.rst b/doc/source/admin/configuring-migrations.rst index dc6a9a9832e5..2ba2cb65ac84 100644 --- a/doc/source/admin/configuring-migrations.rst +++ b/doc/source/admin/configuring-migrations.rst @@ -227,9 +227,9 @@ memory-intensive instances succeed. ephemeral storage in GiB is added. The timeout in seconds is the instance size multiplied by the configurable - parameter ``live_migration_completion_timeout``, whose default is 800. For - example, shared-storage live migration of an instance with 8GiB memory will - time out after 6400 seconds. + parameter :oslo.config:option:`libvirt.live_migration_completion_timeout`, + whose default is 800. For example, shared-storage live migration of an + instance with 8GiB memory will time out after 6400 seconds. #. **Instance downtime**