summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorLee Yarwood <lyarwood@redhat.com>2020-04-28 10:38:13 +0100
committerLee Yarwood <lyarwood@redhat.com>2020-05-06 10:57:59 +0100
commit40e3366ea35823b43e97bcd27ed25fef222d3989 (patch)
tree5f6dbd033a2dc79a96da5d8ab4b582d40691577e /api-ref
parent6ba06e23bc928e9fa40f706209763af83dd765eb (diff)
downloadnova-40e3366ea35823b43e97bcd27ed25fef222d3989.tar.gz
docs: Add evacuation pre-conditions around the src host
These were previously not listed but are important to re-enforce to avoid corruption of instances during an evacuation. Change-Id: Ia80dba0ade98940a5c4f94a9d2095e3c9ef21f97
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/servers-action-evacuate.inc6
1 files changed, 6 insertions, 0 deletions
diff --git a/api-ref/source/servers-action-evacuate.inc b/api-ref/source/servers-action-evacuate.inc
index 301de999b6..8ae3d22093 100644
--- a/api-ref/source/servers-action-evacuate.inc
+++ b/api-ref/source/servers-action-evacuate.inc
@@ -11,6 +11,12 @@ Evacuates a server from a failed host to a new host.
- In the request body, if ``onSharedStorage`` is set, then do not set ``adminPass``.
- The target host should not be the same as the instance host.
+**Preconditions**
+
+- The failed host must be fenced and no longer running the original server.
+- The failed host must be reported as down or marked as forced down using
+ `Update Forced Down`_.
+
Starting from API version 2.68, the ``force`` parameter is no longer accepted
as this could not be meaningfully supported by servers with complex resource
allocations.