summaryrefslogtreecommitdiff
path: root/api-ref/source/servers-actions.inc
diff options
context:
space:
mode:
authorDan Smith <dansmith@redhat.com>2022-02-24 11:03:39 -0800
committerwhoami-rajat <rajatdhasmana@gmail.com>2022-08-31 18:05:03 +0530
commit45c5b80fd076d0017f957a2150d7496f6d4a4fcf (patch)
tree31e23795b09c20bff4aff8a834d556fbde749244 /api-ref/source/servers-actions.inc
parent6919db561280874d18fdf61b6750e0c765e0f632 (diff)
downloadnova-45c5b80fd076d0017f957a2150d7496f6d4a4fcf.tar.gz
Add API support for rebuilding BFV instances
This adds a microversion and API support for triggering a rebuild of volume-backed instances by leveraging cinder functionality to do so. Implements: blueprint volume-backed-server-rebuild Closes-Bug: #1482040 Co-Authored-By: Rajat Dhasmana <rajatdhasmana@gmail.com> Change-Id: I211ad6b8aa7856eb94bfd40e4fdb7376a7f5c358
Diffstat (limited to 'api-ref/source/servers-actions.inc')
-rw-r--r--api-ref/source/servers-actions.inc14
1 files changed, 11 insertions, 3 deletions
diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc
index f480403a40..3b8b68d4ff 100644
--- a/api-ref/source/servers-actions.inc
+++ b/api-ref/source/servers-actions.inc
@@ -540,7 +540,13 @@ Rebuilds a server.
Specify the ``rebuild`` action in the request body.
This operation recreates the root disk of the server.
-For a volume-backed server, this operation keeps the contents of the volume.
+
+With microversion 2.93, we support rebuilding volume backed
+instances which will reimage the volume with the provided
+image. For microversion < 2.93, this operation keeps the
+contents of the volume given the image provided is same as
+the image with which the volume was created else the opearation
+will error out.
**Preconditions**
@@ -552,8 +558,10 @@ If the server was in status ``SHUTOFF`` before the rebuild, it will be stopped
and in status ``SHUTOFF`` after the rebuild, otherwise it will be ``ACTIVE``
if the rebuild was successful or ``ERROR`` if the rebuild failed.
-.. note:: There is a `known limitation`_ where the root disk is not
- replaced for volume-backed instances during a rebuild.
+.. note:: With microversion 2.93, we support rebuilding volume backed
+ instances. If any microversion < 2.93 is specified, 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