openstack/nova
Code Issues Proposed changes

api-ref: re-work resize action post-conditions

Browse Source 
This change does a few things:

1. Moves the post-condition paragraph into an
   "Asynchronous Postconditions" section like other
   API references.

2. Drops the "RESIZED" VM status wording since what
   that probably meant was the server OS-EXT-STS:vm_state
   value would be "resized" but what was in the reference
   was (a) wrong and (b) redundant with the VERIFY_RESIZE
   status.

3. Re-words and links the resize_confirm_window config
   option wording since saying "if you set" a config option
   in the API reference does not really make sense since
   "you" (the non-admin cloud user) does not have control
   over how the cloud is configured.

Change-Id: I77830dfb738cd78c830dc3ce7ea88216c1eac7ef
This commit is contained in:
Matt Riedemann 2019-10-29 12:56:59 -04:00
parent d3e38143a7
commit e416b19ba1
1 changed files with 9 additions and 6 deletions

15
api-ref/source/servers-actions.inc

@ -800,12 +800,6 @@ Resizes a server.
Specify the ``resize`` action in the request body. Specify the ``resize`` action in the request body.
A successfully resized server shows a ``VERIFY_RESIZE`` status,
``RESIZED`` VM status, and ``finished`` migration status. If you set the
``resize_confirm_window`` option of the Compute service to an integer value,
the Compute service automatically confirms the resize operation after
the set interval in seconds.
**Preconditions** **Preconditions**
You can only resize a server when its status is ``ACTIVE`` or ``SHUTOFF``. You can only resize a server when its status is ``ACTIVE`` or ``SHUTOFF``.
@ -813,6 +807,15 @@ You can only resize a server when its status is ``ACTIVE`` or ``SHUTOFF``.
If the server is locked, you must have administrator privileges If the server is locked, you must have administrator privileges
to resize the server. to resize the server.
**Asynchronous Postconditions**
A successfully resized server shows a ``VERIFY_RESIZE`` status and ``finished``
migration status. If the cloud has configured the `resize_confirm_window`_
option of the Compute service to a positive value, the Compute service
automatically confirms the resize operation after the configured interval.
.. _resize_confirm_window: https://docs.openstack.org/nova/latest/configuration/config.html#DEFAULT.resize_confirm_window
.. note:: There is a `known limitation <https://bugs.launchpad.net/nova/+bug/1558880>`__ .. note:: There is a `known limitation <https://bugs.launchpad.net/nova/+bug/1558880>`__
that ephemeral disks are not resized. that ephemeral disks are not resized.