Update version info of image
[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 provides these features in `Colorado Release <https://wiki.opnfv.org/display/SWREL/Colorado>`_:
16
17 * Immediate Notification
18 * Consistent resource state awareness for compute host down
19 * Valid compute host status given to VM owner
20
21 These features enable high availability of Network Services on top of
22 the virtualized infrastructure.
23
24 Immediate notification allows VNF managers (VNFM) to process recovery
25 actions promptly once a failure has occurred.
26
27 Consistency of resource state is necessary to properly execute recovery
28 actions properly in the VIM.
29
30 Ability to query host status gives VM owner (VNFM) the possibility to get
31 consistent state information through an API in case of a compute host
32 fault.
33
34 Components
35 ----------
36
37 Doctor platform, as of Colorado release, consists of the following
38 components:
39
40 * OpenStack Compute (Nova)
41 * OpenStack Telemetry (Ceilometer)
42 * OpenStack Alarming (Aodh)
43 * Doctor Inspector
44 * Doctor Monitor
45
46 .. note::
47     Doctor Inspector and Monitor are sample implementation for reference.
48
49 You can see an overview of the Doctor platform and how components interact in
50 :numref:`figure-p1`.
51
52 .. figure:: images/figure-p1.png
53     :name: figure-p1
54     :width: 100%
55
56     Doctor platform and typical sequence (Colorado)
57
58 Detailed information on the Doctor architecture can be found in the Doctor
59 requirements documentation:
60 http://artifacts.opnfv.org/doctor/docs/requirements/05-implementation.html