openstack/nova
Code Issues Proposed changes

api-ref: Add descriptions for rebuild

Browse Source 
Add descriptions about specifying a new image and
asynchronous postconditions in the rebuild operation
in the compute API reference.

Change-Id: I0fd136d07dffc2be845b4b9330fae98c7115789b
Closes-Bug: #1784387
This commit is contained in:
Takashi NATSUME 2018-08-05 02:39:47 +09:00 committed by Matt Riedemann
parent f9ad40d35d
commit 330c950908
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/source/parameters.yaml
View File

@ -3626,6 +3626,13 @@ imageRef_rebuild:
description: | description: |
The UUID of the image to rebuild for your server instance. The UUID of the image to rebuild for your server instance.
It must be a valid UUID otherwise API will return 400. It must be a valid UUID otherwise API will return 400.
If rebuilding a volume-backed server with a new image
(an image different from the image used when creating the volume),
the API will return 400.
For non-volume-backed servers, specifying a new image will result
in validating that the image is acceptable for the current compute host
on which the server exists. If the new image is not valid,
the server will go into ``ERROR`` status.
in: body in: body
required: true required: true
type: string type: string

9
api-ref/source/servers-actions.inc
View File

@ -480,10 +480,19 @@ Rebuilds a server.
Specify the ``rebuild`` action in the request body. 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.
**Preconditions** **Preconditions**
The server status must be ``ACTIVE``, ``SHUTOFF`` or ``ERROR``. The server status must be ``ACTIVE``, ``SHUTOFF`` or ``ERROR``.
**Asynchronous Postconditions**
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 .. note:: There is a `known limitation`_ where the root disk is not
replaced for volume-backed instances during a rebuild. replaced for volume-backed instances during a rebuild.