Merge "tests: fix inject_failure() for deployment built by apex"
[doctor.git] / docs / platformoverview / doctor.rst
1 ===============
2 Doctor Platform
3 ===============
4
5 https://wiki.opnfv.org/doctor
6
7 Features
8 ========
9
10 Doctor platform, as of Brahmaputra release, provides the two features:
11
12 * Immediate Notification
13 * Consistent resource state awareness (Compute)
14
15 These features enable high availability of Network Services on top of
16 the virtualized infrastructure. Immediate notification allows VNF managers
17 (VNFM) to process recovery actions promptly once a failure has occurred.
18 Consistency of resource state is necessary to properly execute recovery
19 actions properly in the VIM.
20
21 Components
22 ==========
23
24 Doctor platform, as of Brahmaputra release, consists of the following
25 components:
26
27 * OpenStack Compute (Nova)
28 * OpenStack Telemetry (Ceilometer)
29 * OpenStack Alarming (Aodh)
30 * Doctor Inspector
31 * Doctor Monitor
32
33 .. note::
34     Doctor Inspector and Monitor are sample implementation for reference.
35
36 You can see an overview of the Doctor platform and how components interact in
37 :numref:`figure-p1`.
38
39 .. figure:: images/figure-p1.png
40     :name: figure-p1
41     :width: 100%
42
43     Doctor platform and typical sequence (Brahmaputra)
44
45 Detailed information on the Doctor architecture can be found in the Doctor
46 requirements documentation:
47 http://artifacts.opnfv.org/doctor/docs/requirements/05-implementation.html