From d133d967e8499c098cfb94e09c7669ce537919f1 Mon Sep 17 00:00:00 2001 From: Tomi Juvonen Date: Tue, 10 May 2016 10:36:52 +0300 Subject: [PATCH] Manual for get-valid-server-state Change-Id: I684b94c18bc1961859907b5565f8498b97987092 JIRA: DOCTOR-47 Signed-off-by: Tomi Juvonen --- docs/manuals/get-valid-server-state.rst | 125 ++++++++++++++++++++++++++++++++ docs/manuals/index.rst | 1 + docs/userguide/featureusage.rst | 20 +++-- 3 files changed, 140 insertions(+), 6 deletions(-) create mode 100644 docs/manuals/get-valid-server-state.rst diff --git a/docs/manuals/get-valid-server-state.rst b/docs/manuals/get-valid-server-state.rst new file mode 100644 index 00000000..5d74e9ed --- /dev/null +++ b/docs/manuals/get-valid-server-state.rst @@ -0,0 +1,125 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +====================== +Get valid server state +====================== + +Related Blueprints: +=================== + +https://blueprints.launchpad.net/nova/+spec/get-valid-server-state + +Problem description +=================== + +Previously when the owner of a VM has queried his VMs, he has not received +enough state information, states have not changed fast enough in the VIM and +they have not been accurate in some scenarios. With this change this gap is now +closed. + +A typical case is that, in case of a fault of a host, the user of a high +availability service running on top of that host, needs to make an immediate +switch over from the faulty host to an active standby host. Now, if the compute +host is forced down [1] as a result of that fault, the user has to be notified +about this state change such that the user can react accordingly. Similarly, +a change of the host state to "maintenance" should also be notified to the +users. + +What is changed +=============== + +A new ``host_status`` parameter is added to the ``/servers/{server_id}`` and +``/servers/detail`` endpoints in microversion 2.16. By this new parameter +user can get additional state information about the host. + +``host_status`` possible values where next value in list can override the +previous: + +- ``UP`` if nova-compute is up. +- ``UNKNOWN`` if nova-compute status was not reported by servicegroup driver + within configured time period. Default is within 60 seconds, + but can be changed with ``service_down_time`` in nova.conf. +- ``DOWN`` if nova-compute was forced down. +- ``MAINTENANCE`` if nova-compute was disabled. MAINTENANCE in API directly + means nova-compute service is disabled. Different wording is used to avoid + the impression that the whole host is down, as only scheduling of new VMs + is disabled. +- Empty string indicates there is no host for server. + +``host_status`` is returned in the response in case the policy permits. By +default the policy is for admin only in Nova policy.json:: + + "os_compute_api:servers:show:host_status": "rule:admin_api" + +For an NFV use case this has to also be enabled for the owner of the VM:: + + "os_compute_api:servers:show:host_status": "rule:admin_or_owner" + +REST API examples: +================== + +Case where nova-compute is enabled and reporting normally:: + + GET /v2.1/{tenant_id}/servers/{server_id} + + 200 OK + { + "server": { + "host_status": "UP", + ... + } + } + +Case where nova-compute is enabled, but not reporting normally:: + + GET /v2.1/{tenant_id}/servers/{server_id} + + 200 OK + { + "server": { + "host_status": "UNKNOWN", + ... + } + } + +Case where nova-compute is enabled, but forced_down:: + + GET /v2.1/{tenant_id}/servers/{server_id} + + 200 OK + { + "server": { + "host_status": "DOWN", + ... + } + } + +Case where nova-compute is disabled:: + + GET /v2.1/{tenant_id}/servers/{server_id} + + 200 OK + { + "server": { + "host_status": "MAINTENANCE", + ... + } + } + +Host Status is also visible in python-novaclient:: + + +-------+------+--------+------------+-------------+----------+-------------+ + | ID | Name | Status | Task State | Power State | Networks | Host Status | + +-------+------+--------+------------+-------------+----------+-------------+ + | 9a... | vm1 | ACTIVE | - | RUNNING | xnet=... | UP | + +-------+------+--------+------------+-------------+----------+-------------+ + +Links: +====== + +[1] Manual for OpenStack NOVA API for marking host down +http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html + +[2] OpenStack compute manual page +http://developer.openstack.org/api-ref-compute-v2.1.html#compute-v2.1 diff --git a/docs/manuals/index.rst b/docs/manuals/index.rst index 52d36096..05831b2b 100644 --- a/docs/manuals/index.rst +++ b/docs/manuals/index.rst @@ -10,3 +10,4 @@ Manuals :maxdepth: 2 .. include:: mark-host-down_manual.rst +.. include:: get-valid-server-state.rst diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst index 59090a77..4df2d41a 100644 --- a/docs/userguide/featureusage.rst +++ b/docs/userguide/featureusage.rst @@ -16,8 +16,8 @@ OpenStack Alarming (Aodh) API with relevant internal components support. See, upstream spec document: http://specs.openstack.org/openstack/ceilometer-specs/specs/liberty/event-alarm-evaluator.html -You can find an example of consumer of this notification in doctor repository. -It can be executed as follows: +An example of a consumer of this notification can be found in the Doctor +repository. It can be executed as follows: .. code-block:: bash @@ -26,12 +26,20 @@ It can be executed as follows: CONSUMER_PORT=12346 python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 & -Consistent resource state awareness (Compute/host-down) -------------------------------------------------------- +Consistent resource state awareness +----------------------------------- -Resource state of compute host can be fixed according to an input from a monitor -sitting out side of OpenStack Compute (Nova) by using force-down API. +Resource state of compute host can be changed/updated according to a trigger +from a monitor running outside of OpenStack Compute (Nova) by using +force-down API. See http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html for more detail. + +The resource state of a compute host can be retrieved by a user with the +OpenStack Compute (Nova) servers API. + +See +http://artifacts.opnfv.org/doctor/colorado/docs/manuals/get-valid-server-state.html +for more detail. -- 2.16.6