docs/release/installation/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 | 2016-XX-XX | Danube 1.0   | ...        |             |
  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 * **FEATURE 1**
  34
  35   TODO: add description including pointer to `feature1`_ and explain what it is about.
  36
  37 .. _feature1: https://review.openstack.org/#/c/....../
  38
  39 Installer support and verification status
  40 =========================================
  41
  42 Integrated features
  43 -------------------
  44
  45 Minimal Doctor functionality of VIM is available in the OPNFV platform from
  46 the Brahmaputra release. The basic Doctor framework in VIM consists of a
  47 Controller (Nova) and a Notifier (Ceilometer+Aodh) along with a sample
  48 Inspector and Monitor developed by the Doctor team.
  49
  50 From the Danube release, key integrated features are:
  51
  52 * ...
  53
  54 * ...
  55
  56 OPNFV installer support matrix
  57 ------------------------------
  58
  59 In the Brahmaputra release, only one installer (Apex) supported the deployment
  60 of the basic doctor framework by configuring Doctor features. In the Danube
  61 release, integration of Doctor features progressed in other OPNFV installers.
  62
  63 TODO: TABLE TO BE UPDATED!
  64
  65 +-----------+-------------------+--------------+-----------------+------------------+
  66 | Installer | Aodh              | Nova: Force  | Nova: Get valid | Congress         |
  67 |           | integration       | compute down | service status  | integration      |
  68 +===========+===================+==============+=================+==================+
  69 | Apex      | Available         | Available    | Available       | Available        |
  70 |           |                   |              | (`DOCTOR-67`_), | (`APEX-135`_,    |
  71 |           |                   |              | Verified only   | `APEX-158`_),    |
  72 |           |                   |              | for admin users | Not Verified     |
  73 +-----------+-------------------+--------------+-----------------+------------------+
  74 | Fuel      | Available         | Available    | Available,      | N/A              |
  75 |           | (`DOCTOR-58`_),   |              | Verified only   | (`FUEL-119`_)    |
  76 |           | Not verified      |              | for admin users |                  |
  77 +-----------+-------------------+--------------+-----------------+------------------+
  78 | Joid      | Available         | TBC          | TBC             | TBC              |
  79 |           | (`JOID-76`_),     |              |                 | (`JOID-73`_)     |
  80 |           | Not verified      |              |                 |                  |
  81 +-----------+-------------------+--------------+-----------------+------------------+
  82 | Compass   | Available         | TBC          | TBC             | N/A              |
  83 |           | (`COMPASS-357`_), |              |                 | (`COMPASS-367`_) |
  84 |           | Not verified      |              |                 |                  |
  85 +-----------+-------------------+--------------+-----------------+------------------+
  86
  87 .. _DOCTOR-67: https://jira.opnfv.org/browse/DOCTOR-67
  88 .. _APEX-135: https://jira.opnfv.org/browse/APEX-135
  89 .. _APEX-158: https://jira.opnfv.org/browse/APEX-158
  90 .. _DOCTOR-58: https://jira.opnfv.org/browse/DOCTOR-58
  91 .. _FUEL-119: https://jira.opnfv.org/browse/FUEL-119
  92 .. _JOID-76: https://jira.opnfv.org/browse/JOID-76
  93 .. _JOID-73: https://jira.opnfv.org/browse/JOID-73
  94 .. _COMPASS-357: https://jira.opnfv.org/browse/COMPASS-357
  95 .. _COMPASS-367: https://jira.opnfv.org/browse/COMPASS-367
  96
  97 Note: 'Not verified' means that we didn't verify the functionality by having
  98 our own test scenario running in OPNFV CI pipeline yet.
  99
 100 Documentation updates
 101 =====================
 102
 103 * **Update 1**
 104
 105   Description including pointer to JIRA ticket (`DOCTOR-46`_).
 106
 107 .. _DOCTOR-46: https://jira.opnfv.org/browse/DOCTOR-46
 108
 109
 110 Known issues
 111 ============
 112
 113 * ...