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