4ae521bdae758736f5876e8b83a99633ceab47ef
[doctor.git] / docs / release / userguide / feature.userguide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Doctor capabilities and usage
5 =============================
6 Immediate Notification
7 ----------------------
8
9 Immediate notification can be used by creating 'event' type alarm via
10 OpenStack Alarming (Aodh) API with relevant internal components support.
11
12 See, upstream spec document:
13 http://specs.openstack.org/openstack/ceilometer-specs/specs/liberty/event-alarm-evaluator.html
14
15 An example of a consumer of this notification can be found in the Doctor
16 repository. It can be executed as follows:
17
18 .. code-block:: bash
19
20     git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/danube
21     cd doctor/tests
22     CONSUMER_PORT=12346
23     python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 &
24
25 Consistent resource state awareness
26 -----------------------------------
27
28 Resource state of compute host can be changed/updated according to a trigger
29 from a monitor running outside of OpenStack Compute (Nova) by using
30 force-down API.
31
32 See
33 http://artifacts.opnfv.org/doctor/danube/manuals/mark-host-down_manual.html
34 for more detail.
35
36 Valid compute host status given to VM owner
37 -------------------------------------------
38
39 The resource state of a compute host can be retrieved by a user with the
40 OpenStack Compute (Nova) servers API.
41
42 See
43 http://artifacts.opnfv.org/doctor/danube/manuals/get-valid-server-state.html
44 for more detail.