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 (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 This document provides an overview of the Doctor project in the OPNFV Euphrates
  31 release, including new features, known issues and documentation updates.
  32
  33 New features
  34 ============
  35
  36 Doctor now supports network state handling where VIM notifies on 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 For Euphrates release, the Doctor project also refactored testing code to python.
  43
  44
  45 Installer support and verification status
  46 =========================================
  47
  48 Integrated features
  49 -------------------
  50
  51 The testing code for Doctor test cases are enhanced by refactoring to python,
  52 and supporting collectd monitor.
  53
  54 The python refactoring improves readability and maintainability of the testing
  55 code in the Doctor repository. This helps Doctor developers as well as
  56 engineers who are interested in OPNFV Doctor.
  57
  58 From the Euphrates release, key integrated feature is:
  59
  60 * **collectd as Doctor Monitor**
  61
  62   Collectd was added as additional Doctor monitoring solution.
  63   This is experimental, as CI job is not enabled yet. But, you can see and test
  64   with collectd integrated in Doctor reference architecture.
  65
  66 OPNFV installer support matrix
  67 ------------------------------
  68
  69 +-----------+-------------------+----------------+-----------------+-------------------+
  70 | Installer | Aodh              | Nova: Force    | Nova: Get valid | Congress          |
  71 |           | integration       | compute down   | service status  | integration       |
  72 +===========+===================+================+=================+===================+
  73 | Apex      | Available         | Available      | Available       | Available         |
  74 +-----------+-------------------+----------------+-----------------+-------------------+
  75 | Fuel/MCP  | Available         | Available      | Available       | N/A               |
  76 |           | (`DOCTOR-58`_)    | (not verified) | (not verified)  |                   |
  77 +-----------+-------------------+----------------+-----------------+-------------------+
  78 | Joid      | Available         | TBC            | TBC             | Available         |
  79 |           | (`JOID-76`_),     |                |                 | (`JOID-73`_),     |
  80 |           | Not verified      |                |                 | Not verified      |
  81 +-----------+-------------------+----------------+-----------------+-------------------+
  82 | Compass   | Available         | TBC            | TBC             | Available         |
  83 |           | (`COMPASS-357`_), |                |                 | (`COMPASS-367`_), |
  84 |           | Not verified      |                |                 | Not verified      |
  85 +-----------+-------------------+----------------+-----------------+-------------------+
  86
  87 .. _DOCTOR-58: https://jira.opnfv.org/browse/DOCTOR-58
  88 .. _JOID-76: https://jira.opnfv.org/browse/JOID-76
  89 .. _JOID-73: https://jira.opnfv.org/browse/JOID-73
  90 .. _COMPASS-357: https://jira.opnfv.org/browse/COMPASS-357
  91 .. _COMPASS-367: https://jira.opnfv.org/browse/COMPASS-367
  92
  93 Note: 'Not verified' means that we didn't verify the functionality by having
  94 our own test scenario running in OPNFV CI pipeline yet.
  95
  96 Documentation updates
  97 =====================
  98
  99 * **maintenance detailed spec**
 100
 101   The maintenance design document was filed, including suggestions how to
 102   leverage features in OpenStack while developing automated maintenance
 103   capability.
 104
 105 * **Inspector design guideline**
 106
 107   The documentation on the Inspector design has been updated to include
 108   guidelines on the 'host specific VMs list', 'parallel execution', and 'shortcut notification'.
 109
 110 Known issues
 111 ============
 112
 113 * Testing code for `port-data-plane-status` in Doctor repository was disabled
 114   in 5.0.0, as we have problem in neutron client load in CI job container.