openstack/nova
Code Issues Proposed changes

docs: update SUSPENDED server status wrt supported drivers

Browse Source 
Two things here:

1. The API guide was missing the hyper-v driver which supports
   the suspend operation. Rather than hard-code a list of supported
   drivers in the doc, this change just links to the entry in the
   feature support matrix.

2. The supported hypervisors mention in the API reference is removed
   because the end user using the API should not need to know or care
   what backend hypervisor on which their server is running. They can
   either suspend or not, but we don't need to mention the supporting
   drivers for that in the API reference.

Change-Id: Ib76779a8e34b2c68b0f4af190f71576180360d0f
Related-Bug: #1815403
This commit is contained in:
Matt Riedemann 2019-11-14 10:25:06 -05:00
parent 8f341eb4a4
commit 2d91a8463f
2 changed files with 4 additions and 4 deletions
api-guide/source
server_concepts.rst
api-ref/source
servers.inc

5
api-guide/source/server_concepts.rst

@ -69,8 +69,9 @@ server status is one of the following values:
expires, the server will be deleted permanently.
- ``SUSPENDED``: The server is suspended, either by request or
necessity. This status appears for only the following hypervisors:
XenServer/XCP, KVM, and ESXi. When you suspend a server, its state is stored
necessity. See the
:nova-doc:`feature support matrix <user/support-matrix.html#operation_suspend>`
for supported compute drivers. When you suspend a server, its state is stored
on disk, all memory is written to disk, and the server is stopped.
Suspending a server is similar to placing a device in hibernation and its
occupied resource will not be freed but rather kept for when the server is

3
api-ref/source/servers.inc

@ -139,8 +139,7 @@ body. The possible server status values are:
- ``SOFT_DELETED``. The server is marked as deleted but the disk
images are still available to restore.
- ``SUSPENDED``. The server is suspended, either by request or
necessity. This status appears for only the following hypervisors:
XenServer/XCP, KVM, and ESXi. When you suspend a server, its state is stored
necessity. When you suspend a server, its state is stored
on disk, all memory is written to disk, and the server is stopped.
Suspending a server is similar to placing a device in hibernation and its
occupied resource will not be freed but rather kept for when the server is