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