docs/release/release-notes/releasenotes.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 =====================================
   5 OPNFV Doctor release notes (Danube)
   6 =====================================
   7
   8 Version history
   9 ===============
  10
  11 +------------+--------------+------------+-------------+
  12 | **Date**   | **Ver.**     | **Author** | **Comment** |
  13 +============+==============+============+=============+
  14 | 2017-03-31 | Danube 1.0   | Ryota Mibu |             |
  15 +------------+--------------+------------+-------------+
  16
  17 Important notes
  18 ===============
  19
  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.
  26
  27 This document provides an overview of the Doctor project in the OPNFV Danube
  28 release, including new features, known issues and documentation updates.
  29
  30 New features
  31 ============
  32
  33 For Danube release, the Doctor project focused primarily on enhancing the
  34 testing tools, enabling additional test scenarios, and support and verification
  35 on a wider range of OPNFV installers.
  36
  37 * **Performance profiler PoC**
  38
  39   The performance profiler is designed to get timestamp in each checkpoint of
  40   components for further analysis. In Danube, initial PoC implementation of the
  41   perfomance profiler has been added to the Doctor testing tools
  42   by contribution from the `QTIP`_ team. The tools can now show how long it
  43   takes for each component in a series of processes for fault notification.
  44   Some checkpoints are not covered yet though. To activate this, set the
  45   PROFILER_TYPE="poc" before running the main script ("tests/run.sh").
  46   See `DOCTOR-72`_ for more details.
  47
  48 * **Testing with multiple tenant VMs**
  49
  50   The Doctor testing tools now supports new testing scenario where multiple
  51   tenant VMs in the system under test can be created (`DOCTOR-77`_).
  52   This allows to measure fault notification time/cost with stressed VIM
  53   controllers, in order to see perfomance trends.
  54
  55 .. _QTIP: https://wiki.opnfv.org/display/qtip
  56 .. _DOCTOR-72: https://jira.opnfv.org/browse/DOCTOR-72
  57 .. _DOCTOR-77: https://jira.opnfv.org/browse/DOCTOR-77
  58
  59 Installer support and verification status
  60 =========================================
  61
  62 Integrated features
  63 -------------------
  64
  65 Minimal Doctor functionality of VIM is available in the OPNFV platform from
  66 the Brahmaputra release. The basic Doctor framework in VIM consists of a
  67 Controller (Nova) and a Notifier (Ceilometer+Aodh) along with a sample
  68 Inspector and Monitor developed by the Doctor team.
  69
  70 From the Danube release, key integrated feature is:
  71
  72 * **Congress as Doctor Inspector**
  73
  74   Congress Inspector is now verified with latest vanilla OpenStack without
  75   backporting any patch, like the one we had backported for adding Doctor
  76   driver of Congress in Colorado.
  77
  78 OPNFV installer support matrix
  79 ------------------------------
  80
  81 In the Brahmaputra release, only one installer (Apex) supported the deployment
  82 of the basic Doctor framework by configuring Doctor features. In the Danube
  83 release, integration of Doctor features progressed in other OPNFV installers.
  84
  85 +-----------+-------------------+--------------+-----------------+-------------------+
  86 | Installer | Aodh              | Nova: Force  | Nova: Get valid | Congress          |
  87 |           | integration       | compute down | service status  | integration       |
  88 +===========+===================+==============+=================+===================+
  89 | Apex      | Available         | Available    | Available,      | Available         |
  90 |           |                   |              | Verified only   |                   |
  91 |           |                   |              | for admin users |                   |
  92 +-----------+-------------------+--------------+-----------------+-------------------+
  93 | Fuel      | Available         | Available    | Available,      | N/A               |
  94 |           | (`DOCTOR-58`_)    |              | Verified only   | (`FUEL-230`_)     |
  95 |           |                   |              | for admin users |                   |
  96 +-----------+-------------------+--------------+-----------------+-------------------+
  97 | Joid      | Available         | TBC          | TBC             | Available         |
  98 |           | (`JOID-76`_),     |              |                 | (`JOID-73`_),     |
  99 |           | Not verified      |              |                 | Not verified      |
 100 +-----------+-------------------+--------------+-----------------+-------------------+
 101 | Compass   | Available         | TBC          | TBC             | Available         |
 102 |           | (`COMPASS-357`_), |              |                 | (`COMPASS-367`_), |
 103 |           | Not verified      |              |                 | Not verified      |
 104 +-----------+-------------------+--------------+-----------------+-------------------+
 105
 106 .. _DOCTOR-58: https://jira.opnfv.org/browse/DOCTOR-58
 107 .. _FUEL-230: https://jira.opnfv.org/browse/FUEL-230
 108 .. _JOID-76: https://jira.opnfv.org/browse/JOID-76
 109 .. _JOID-73: https://jira.opnfv.org/browse/JOID-73
 110 .. _COMPASS-357: https://jira.opnfv.org/browse/COMPASS-357
 111 .. _COMPASS-367: https://jira.opnfv.org/browse/COMPASS-367
 112
 113 Note: 'Not verified' means that we didn't verify the functionality by having
 114 our own test scenario running in OPNFV CI pipeline yet.
 115
 116 Documentation updates
 117 =====================
 118
 119 * **Configuration manual for Congress**
 120
 121   Steps to configure Congress as Doctor Inspector have been added
 122   to Doctor configuration manual (`DOCTOR-85`_).
 123
 124 * **Alarm comparison**
 125
 126   As part of the review between Doctor Danube (OpenStack Newton) and ETSI NFV
 127   IFA, the alarm comparison table has been updated (`DOCTOR-82`_).
 128
 129 * **OpenStack mechanisms for fencing**
 130
 131   The section on fencing in the requirement document has been updated with more
 132   details of Nova and Neutron (`REVIEW#27049`_).
 133
 134 * **How to test**
 135
 136   Two ways to run the Doctor testing tools have been added
 137   (`REVIEW#28223`_).
 138
 139 You can also find other minor updates in `DOCTOR-81`_.
 140
 141 .. _DOCTOR-81: https://jira.opnfv.org/browse/DOCTOR-81
 142 .. _DOCTOR-82: https://jira.opnfv.org/browse/DOCTOR-82
 143 .. _DOCTOR-85: https://jira.opnfv.org/browse/DOCTOR-85
 144 .. _REVIEW#28223: https://gerrit.opnfv.org/gerrit/28223/
 145 .. _REVIEW#27049: https://gerrit.opnfv.org/gerrit/27049/
 146
 147 Known issues
 148 ============
 149
 150 * Doctor testing scenario is not verified with non-admin user (`DOCTOR-80`_).
 151
 152 * Congress Nova driver is relying on deprecated Nova APIs and can lead to
 153   an error (`BUG#1670345`_). The workaround for this issue is to specify nova
 154   micro version to 2.34 . Apex is using this workaround for OpenStack Newton
 155   (`REVIEW#29463`_).
 156
 157 .. _DOCTOR-80: https://jira.opnfv.org/browse/DOCTOR-80
 158 .. _BUG#1670345: https://bugs.launchpad.net/congress/+bug/1670345
 159 .. _REVIEW#29463: https://gerrit.opnfv.org/gerrit/29463/