diff options
| author | Matt Riedemann <mriedem.os@gmail.com> | 2019-10-29 12:56:59 -0400 |
|---|---|---|
| committer | Matt Riedemann <mriedem.os@gmail.com> | 2019-10-29 12:56:59 -0400 |
| commit | e416b19ba1e2be23e075b4ff3eb3bae309f5df10 (patch) | |
| tree | ace2d7eebea3743dc46d85b4f59121d780d39560 /api-ref | |
| parent | d3e38143a7e46d06a6632b41b5484b13e81884cf (diff) | |
| download | nova-e416b19ba1e2be23e075b4ff3eb3bae309f5df10.tar.gz | |
api-ref: re-work resize action post-conditions
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
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/servers-actions.inc | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index 30f882a98f..47b12705d6 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -800,12 +800,6 @@ Resizes a server. 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** 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 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>`__ that ephemeral disks are not resized. |