api-ref: add note about rebuild not replacing volume-backed root disk

We've had several bugs about this over the years, and until we
actually decide to fix it (or not), we should point out the known
limitation that volume-backed root disks are not replaced during
a rebuild.

Like, if you have a volume-backed instance and rebuild with a new
image, the root disk is still the volume with the original image.

Change-Id: I145cab88f782e4b1e630cc432322bc8436413e71
Related-Bug: #1482040
This commit is contained in:
Matt Riedemann 2017-10-03 16:34:26 -04:00
parent ac1449c28e
commit ae9542eb7d
1 changed files with 5 additions and 0 deletions

View File

@ -458,6 +458,11 @@ Rebuilds a server.
Specify the ``rebuild`` action in the request body.
.. note:: There is a `known limitation`_ where the root disk is not
replaced for volume-backed instances during a rebuild.
.. _known limitation: https://bugs.launchpad.net/nova/+bug/1482040
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),