summaryrefslogtreecommitdiff
path: root/api-guide/source
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2017-11-24 17:00:51 +0000
committerGerrit Code Review <review@openstack.org>2017-11-24 17:00:52 +0000
commit6457bb3df897119983866d586651e19a94c811c2 (patch)
treefcf4d12689b549a7f58a185233f255178f3e26da /api-guide/source
parent7678139e383733591150d474a5294ceb079bdea9 (diff)
parent409b511dbbaae29fca582e752704f27776f0cf79 (diff)
downloadnova-6457bb3df897119983866d586651e19a94c811c2.tar.gz
Merge "Update server status api guide"
Diffstat (limited to 'api-guide/source')
-rw-r--r--api-guide/source/server_concepts.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/api-guide/source/server_concepts.rst b/api-guide/source/server_concepts.rst
index 231c895d61..889fb5e6a0 100644
--- a/api-guide/source/server_concepts.rst
+++ b/api-guide/source/server_concepts.rst
@@ -8,10 +8,6 @@ a physical machine or a container.
Server status
~~~~~~~~~~~~~
-TODO: This section's content is old, we need to update the status list.
-The task_state and vm_state which expose to Administrator need description to
-help user to understand the difference.
-
You can filter the list of servers by image, flavor, name, and status
through the respective query parameters.
@@ -87,13 +83,19 @@ server status is one of the following values:
- ``VERIFY_RESIZE``: System is awaiting confirmation that the server is
operational after a move or resize.
-The compute provisioning algorithm has an anti-affinity property that
-attempts to spread customer VMs across hosts. Under certain situations,
-VMs from the same customer might be placed on the same host. hostId
-represents the host your server runs on and can be used to determine
-this scenario if it is relevant to your application.
+Server status is caculated from vm_state and task_state, which
+are exposed to administrators:
+
+- vm_state describes a VM's current stable (not transition) state. That is, if
+ there is no ongoing compute API calls (running tasks), vm_state should reflect
+ what the customer expect the VM to be. When combined with task states,
+ a better picture can be formed regarding the server's health and progress.
+ Please see: `VM States <https://docs.openstack.org/nova/latest/reference/vm-states.html>`_.
-.. note:: HostId is unique *per account* and is not globally unique.
+- task_state represents what is happening to the instance at the
+ current moment. These tasks can be generic, such as 'spawning', or specific,
+ such as 'block_device_mapping'. These task states allow for a better view into
+ what a server is doing.
Server creation
~~~~~~~~~~~~~~~