diff options
| author | Matt Riedemann <mriedem.os@gmail.com> | 2019-11-14 10:25:06 -0500 |
|---|---|---|
| committer | Matt Riedemann <mriedem.os@gmail.com> | 2019-11-14 10:25:06 -0500 |
| commit | 2d91a8463f194edae863b51b2224bbec5cd8c68a (patch) | |
| tree | 111fd5bd8eafd436dc7a296a6082f5bb493bc3b0 /api-guide | |
| parent | 8f341eb4a49be1d01a953387b00eed1c6de5713a (diff) | |
| download | nova-2d91a8463f194edae863b51b2224bbec5cd8c68a.tar.gz | |
docs: update SUSPENDED server status wrt supported drivers
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
Diffstat (limited to 'api-guide')
| -rw-r--r-- | api-guide/source/server_concepts.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/api-guide/source/server_concepts.rst b/api-guide/source/server_concepts.rst index 8155126860..921dfff182 100644 --- a/api-guide/source/server_concepts.rst +++ b/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 |