docs/userguide/userguide.rst

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