59090a77bf0c6eb4c258ae646f6325332f49e706
[doctor.git] / docs / userguide / featureusage.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
7 ..
8     This section will be compiled into OPNFV composite document.
9
10 Immediate Notification
11 ----------------------
12
13 Immediate notification can be used by creating 'event' type alarm via
14 OpenStack Alarming (Aodh) API with relevant internal components support.
15
16 See, upstream spec document:
17 http://specs.openstack.org/openstack/ceilometer-specs/specs/liberty/event-alarm-evaluator.html
18
19 You can find an example of consumer of this notification in doctor repository.
20 It can be executed as follows:
21
22 .. code-block:: bash
23
24     git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
25     cd doctor/tests
26     CONSUMER_PORT=12346
27     python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 &
28
29 Consistent resource state awareness (Compute/host-down)
30 -------------------------------------------------------
31
32 Resource state of compute host can be fixed according to an input from a monitor
33 sitting out side of OpenStack Compute (Nova) by using force-down API.
34
35 See
36 http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html
37 for more detail.