api-ref: add warning about force evacuate for ironic

This adds to the existing warning about forcing a host during
evacuate and mentions how you really really shouldn't be doing
that if the instance is managed by the ironic driver
since those are 1:M with host:node relationships, and since you
can't specify a node when forcing the evacuate, nova will randomly
pick a node from the list for the given host and assign resource
allocations to that node which may already be fully allocated.

Change-Id: I8ae34399d32b2762a67e897807ffa2298e796c4c
This commit is contained in:
Matt Riedemann 2017-10-12 09:26:31 -04:00
parent 783c429057
commit ad1b9360b5

View File

@ -2689,6 +2689,11 @@ force_evacuate:
instance to the specified host. It is recommended to either not specify
a host so that the scheduler will pick one, or specify a host without
``force=True`` set.
Furthermore, this should not be specified when evacuating instances
managed by a clustered hypervisor driver like ironic since you
cannot specify a node, so the compute service will pick a node randomly
which may not be able to accomodate the instance.
in: body
required: false
type: boolean