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 An example of a consumer of this notification can be found in the Doctor
  20 repository. 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
  30 -----------------------------------
  31
  32 Resource state of compute host can be changed/updated according to a trigger
  33 from a monitor running outside of OpenStack Compute (Nova) by using
  34 force-down API.
  35
  36 See
  37 http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html
  38 for more detail.
  39
  40 Valid compute host status given to VM owner
  41 -------------------------------------------
  42
  43 The resource state of a compute host can be retrieved by a user with the
  44 OpenStack Compute (Nova) servers API.
  45
  46 See
  47 http://artifacts.opnfv.org/doctor/docs/manuals/get-valid-server-state.html
  48 for more detail.