docs/release/release-notes/releasenotes_euphrates.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 (Euphrates)
   6 ======================================
   7
   8 This document provides an overview of the Doctor project in the OPNFV Euphrates
   9 release, including new features, known issues and documentation updates.
  10
  11 Version history
  12 ===============
  13
  14 +------------+----------+------------+-------------+
  15 | **Date**   | **Ver.** | **Author** | **Comment** |
  16 +============+==========+============+=============+
  17 | 2017-10-02 | 5.0.0    | Ryota Mibu |             |
  18 +------------+----------+------------+-------------+
  19
  20 Important notes
  21 ===============
  22
  23 OPNFV Doctor project started as a requirement project and identified gaps
  24 between "as-is" open source software (OSS) and an "ideal" platform for NFV.
  25 Based on this analysis, the Doctor project proposed missing features to
  26 upstream OSS projects. After those features were implemented, OPNFV installer
  27 projects integrated the features to the OPNFV platform and the OPNFV
  28 infra/testing projects verified the functionalities in the OPNFV Labs.
  29
  30 For Euphrates release, the Doctor project focused primarily on extending to
  31 network state and refactoring testing code by python.
  32
  33 New features
  34 ============
  35
  36 Doctor now supports network state handling where VIM tells you the actual data
  37 plane port state, utilizing the new feature called `port-dp-status`_ developed
  38 in OpenStack Neutron as the result of our upstreaming efforts.
  39
  40 .. _port-data-plane-status: https://specs.openstack.org/openstack/neutron-specs/specs/backlog/ocata/port-data-plane-status.html
  41
  42 Installer support and verification status
  43 =========================================
  44
  45 Integrated features
  46 -------------------
  47
  48 The testing code for doctor test cases are enhanced by refactoring in python,
  49 and supporting collectd monitor.
  50
  51 The python refactoring improves readability and maintainability of the testing
  52 code in the Doctor repository. This would help Doctor developers as well as
  53 engineers who are referring OPNFV.
  54
  55 From the Euphrates release, key integrated feature is:
  56
  57 * **collectd as Doctor Monitor**
  58
  59  This is experimental, as CI job is not enabled yet. But, you can see and test
  60  with collectd integrated in Doctor reference architecture.
  61
  62 OPNFV installer support matrix
  63 ------------------------------
  64
  65 (TBC)
  66
  67 In the Brahmaputra release, only one installer (Apex) supported the deployment
  68 of the basic Doctor framework by configuring Doctor features. In the Euphrates
  69 release, integration of Doctor features progressed in other OPNFV installers.
  70
  71 +-----------+-------------------+--------------+-----------------+-------------------+
  72 | Installer | Aodh              | Nova: Force  | Nova: Get valid | Congress          |
  73 |           | integration       | compute down | service status  | integration       |
  74 +===========+===================+==============+=================+===================+
  75 | Apex      | Available         | Available    | Available       | Available         |
  76 +-----------+-------------------+--------------+-----------------+-------------------+
  77 | Fuel      | Available         | Available    | Available       | N/A               |
  78 |           | (`DOCTOR-58`_)    |              |                 | (`FUEL-230`_)     |
  79 +-----------+-------------------+--------------+-----------------+-------------------+
  80 | Joid      | Available         | TBC          | TBC             | Available         |
  81 |           | (`JOID-76`_),     |              |                 | (`JOID-73`_),     |
  82 |           | Not verified      |              |                 | Not verified      |
  83 +-----------+-------------------+--------------+-----------------+-------------------+
  84 | Compass   | Available         | TBC          | TBC             | Available         |
  85 |           | (`COMPASS-357`_), |              |                 | (`COMPASS-367`_), |
  86 |           | Not verified      |              |                 | Not verified      |
  87 +-----------+-------------------+--------------+-----------------+-------------------+
  88
  89 .. _DOCTOR-58: https://jira.opnfv.org/browse/DOCTOR-58
  90 .. _FUEL-230: https://jira.opnfv.org/browse/FUEL-230
  91 .. _JOID-76: https://jira.opnfv.org/browse/JOID-76
  92 .. _JOID-73: https://jira.opnfv.org/browse/JOID-73
  93 .. _COMPASS-357: https://jira.opnfv.org/browse/COMPASS-357
  94 .. _COMPASS-367: https://jira.opnfv.org/browse/COMPASS-367
  95
  96 Note: 'Not verified' means that we didn't verify the functionality by having
  97 our own test scenario running in OPNFV CI pipeline yet.
  98
  99 Documentation updates
 100 =====================
 101
 102 * **maintenance detailed spec**
 103
 104   The maintenance design document was filed, including suggestions how to
 105   leverage features in OpenStack while developing automated maintenance
 106   capability.
 107
 108 * **Inspector design guideline**
 109
 110 Known issues
 111 ============
 112
 113 * Testing code for `port-data-plane-status` in Doctor repository was disabled
 114   in 5.0, as we have problem in neutron client load in CI job container.