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
   7 :numref:`figure1` shows the currently implemented and tested architecture of
   8 Doctor. The implementation is based on OpenStack and related components. The
   9 Monitor can be realized by a sample Python-based implementation provided in the
  10 Doctor code repository. The Controller is realized by OpenStack Nova, Neutron
  11 and Cinder for compute, network and storage, respectively. The Inspector can be
  12 realized by OpenStack Congress or a sample Python-based implementation also
  13 available in the code repository of Doctor. The Notifier is realized by
  14 OpenStack Aodh.
  15
  16 .. figure:: images/figure1.png
  17    :name: figure1
  18    :width: 100%
  19
  20    Implemented and tested architecture
  21
  22
  23 Immediate Notification
  24 ----------------------
  25
  26 Immediate notification can be used by creating 'event' type alarm via
  27 OpenStack Alarming (Aodh) API with relevant internal components support.
  28
  29 See, upstream spec document:
  30 http://specs.openstack.org/openstack/ceilometer-specs/specs/liberty/event-alarm-evaluator.html
  31
  32 An example of a consumer of this notification can be found in the Doctor
  33 repository. It can be executed as follows:
  34
  35 .. code-block:: bash
  36
  37     git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/danube
  38     cd doctor/tests
  39     CONSUMER_PORT=12346
  40     python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 &
  41
  42 Consistent resource state awareness
  43 -----------------------------------
  44
  45 Resource state of compute host can be changed/updated according to a trigger
  46 from a monitor running outside of OpenStack Compute (Nova) by using
  47 force-down API.
  48
  49 See
  50 http://artifacts.opnfv.org/doctor/danube/manuals/mark-host-down_manual.html
  51 for more detail.
  52
  53 Valid compute host status given to VM owner
  54 -------------------------------------------
  55
  56 The resource state of a compute host can be retrieved by a user with the
  57 OpenStack Compute (Nova) servers API.
  58
  59 See
  60 http://artifacts.opnfv.org/doctor/danube/manuals/get-valid-server-state.html
  61 for more detail.