1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 =====================================
5 OPNFV Doctor release notes (Colorado)
6 =====================================
11 +------------+--------------+------------+-------------+
12 | **Date** | **Ver.** | **Author** | **Comment** |
13 +============+==============+============+=============+
14 | 2016-09-19 | Colorado 1.0 | Ryota Mibu | |
15 +------------+--------------+------------+-------------+
20 OPNFV Doctor project started as a requirement project and identified gaps
21 between "as-is" open source software (OSS) and an "ideal" platform for NFV.
22 Based on this analysis, the Doctor project proposed missing features to
23 upstream OSS projects. After those features were implemented, OPNFV installer
24 projects integrated the features to the OPNFV platform and the OPNFV
25 infra/testing projects verified the functionalities in the OPNFV Labs.
27 This document provides an overview of the Doctor project in the OPNFV Colorado
28 release, including new features, known issues and documentation updates.
33 * **Congress as a Doctor Inspector**
35 Since `Doctor driver`_ in OpenStack Congress has been implemented in Mitaka,
36 OpenStack Congress can now take the role of the Doctor Inspector to correlate
37 an error in a physical resource to the affected virtual resource(s)
40 .. _Doctor driver: https://review.openstack.org/#/c/314915/
42 Installer support and verification status
43 =========================================
48 Minimal Doctor functionality of VIM is available in the OPNFV platform from
49 the Brahmaputra release. The basic Doctor framework in VIM consists of a
50 Controller (Nova) and a Notifier (Ceilometer+Aodh) along with a sample
51 Inspector and Monitor developed by the Doctor team.
52 From the Colorado release, key integrated features are:
54 * Immediate notification upon state update of virtual resource enabled by
55 Ceilometer and Aodh (Aodh integration)
57 * Consistent state awareness improved by having nova API to mark nova-compute
58 service down (Nova: Force compute down)
60 * Consistent state awareness improved by exposing host status in server (VM)
61 information via Nova API (Nova: Get valid service status)
63 * OpenStack Congress enabling policy-based flexible failure correlation
64 (Congress integration)
66 OPNFV installer support matrix
67 ------------------------------
69 In the Brahmaputra release, only one installer (Apex) supported the deployment
70 of the basic doctor framework by configuring Doctor features. In the Colorado
71 release, integration of Doctor features progressed in other OPNFV installers.
73 +-----------+-------------------+--------------+-----------------+------------------+
74 | Installer | Aodh | Nova: Force | Nova: Get valid | Congress |
75 | | integration | compute down | service status | integration |
76 +===========+===================+==============+=================+==================+
77 | Apex | Available | Available | Available | Available |
78 | | | | (`DOCTOR-67`_), | (`APEX-135`_, |
79 | | | | Verified only | `APEX-158`_), |
80 | | | | for admin users | Not Verified |
81 +-----------+-------------------+--------------+-----------------+------------------+
82 | Fuel | Available | Available | Available, | N/A |
83 | | (`DOCTOR-58`_), | | Verified only | (`FUEL-119`_) |
84 | | Not verified | | for admin users | |
85 +-----------+-------------------+--------------+-----------------+------------------+
86 | Joid | Available | TBC | TBC | TBC |
87 | | (`JOID-76`_), | | | (`JOID-73`_) |
88 | | Not verified | | | |
89 +-----------+-------------------+--------------+-----------------+------------------+
90 | Compass | Available | TBC | TBC | N/A |
91 | | (`COMPASS-357`_), | | | (`COMPASS-367`_) |
92 | | Not verified | | | |
93 +-----------+-------------------+--------------+-----------------+------------------+
95 .. _DOCTOR-67: https://jira.opnfv.org/browse/DOCTOR-67
96 .. _APEX-135: https://jira.opnfv.org/browse/APEX-135
97 .. _APEX-158: https://jira.opnfv.org/browse/APEX-158
98 .. _DOCTOR-58: https://jira.opnfv.org/browse/DOCTOR-58
99 .. _FUEL-119: https://jira.opnfv.org/browse/FUEL-119
100 .. _JOID-76: https://jira.opnfv.org/browse/JOID-76
101 .. _JOID-73: https://jira.opnfv.org/browse/JOID-73
102 .. _COMPASS-357: https://jira.opnfv.org/browse/COMPASS-357
103 .. _COMPASS-367: https://jira.opnfv.org/browse/COMPASS-367
105 Note: 'Not verified' means that we didn't verify the functionality by having
106 our own test scenario running in OPNFV CI pipeline yet.
108 Documentation updates
109 =====================
111 * **Alarm comparison**
113 A report on the gap analysis across alarm specifications in ETSI NFV IFA,
114 OPNFV Doctor and OpenStack Aodh has been added, along with some proposals
115 on how to improve the alignment between SDO specification and OSS
116 implementation as a future work (`DOCTOR-46`_).
118 .. _DOCTOR-46: https://jira.opnfv.org/browse/DOCTOR-46
120 * **Description of test scenario**
122 The description of the Doctor scenario, which is running as one of the
123 feature verification scenarios in Functest, has been updated (`DOCTOR-53`_).
125 .. _DOCTOR-53: https://jira.opnfv.org/browse/DOCTOR-53
127 * **Neutron port status update**
129 Design documentation for port status update has been added, intending to
130 propose new features to OpenStack Neutron.
132 * **SB I/F specification**
134 The initial specification of the Doctor southbound interface, which is for
135 the Inspector to receive event messages from Monitors, has been added
138 .. _DOCTOR-17: https://jira.opnfv.org/browse/DOCTOR-17
143 * **Aodh 'event-alarm' is not available as default (Fuel)**
145 In Fuel 9.0, Aodh integration for 'event-alarm' is not completed.
146 Ceilometer and Nova would be mis-configured and cannot pass event
147 notification to Aodh.
148 You can use `fuel-plugin-doctor`_ to correct Ceilometer and Nova
149 configuration as a workaround. See `DOCTOR-62`_.
151 .. _fuel-plugin-doctor: https://github.com/openzero-zte/fuel-plugin-doctor
152 .. _DOCTOR-62: https://jira.opnfv.org/browse/DOCTOR-62
154 * **Security notice**
156 Security notice has been raised in [*]_. Please insure that the debug option
157 of Flask is set to False, before running in production.
159 .. [*] http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2016-September/012610.html
161 * **Performance issue in correct resource status (Fuel)**
163 Although the Doctor project is aiming to ensure that the time interval
164 between detection and notification to the user is less than 1 second, we
165 observed that it takes more than 2 seconds in the default OPNFV deployment
166 using the Fuel installer [*]_.
167 This issue will be solved by checking the OpenStack configuration and
168 improving Doctor testing scenario.
170 .. [*] http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2016-September/012542.html