danube release notesdanube.1.RC1

Change-Id: Ic2401cc2c3e57324504d2c2d66a69c2e90a4ee91
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
(cherry picked from commit 7a14778cf61c8a5000dbfb1600510440cad39e9f)

3 files changed, 342 insertions, 0 deletions

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644
index 00000000..ef5b6d54
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _doctor-installation:
+
+********************
+Doctor Release Notes
+********************
+
+.. toctree::
+    :maxdepth: 2
+
+    releasenotes.rst
diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst
new file mode 100644
index 00000000..2b1000d9
--- /dev/null
+++ b/docs/release/release-notes/releasenotes.rst
@@ -0,0 +1,159 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+=====================================
+OPNFV Doctor release notes (Danube)
+=====================================
+
+Version history
+===============
+
++------------+--------------+------------+-------------+
+| **Date**   | **Ver.**     | **Author** | **Comment** |
++============+==============+============+=============+
+| 2017-03-31 | Danube 1.0   | Ryota Mibu |             |
++------------+--------------+------------+-------------+
+
+Important notes
+===============
+
+OPNFV Doctor project started as a requirement project and identified gaps
+between "as-is" open source software (OSS) and an "ideal" platform for NFV.
+Based on this analysis, the Doctor project proposed missing features to
+upstream OSS projects. After those features were implemented, OPNFV installer
+projects integrated the features to the OPNFV platform and the OPNFV
+infra/testing projects verified the functionalities in the OPNFV Labs.
+
+This document provides an overview of the Doctor project in the OPNFV Danube
+release, including new features, known issues and documentation updates.
+
+New features
+============
+
+For Danube release, the Doctor project focused primarily on enhancing the
+testing tools, enabling additional test scenarios, and support and verification
+on a wider range of OPNFV installers.
+
+* **Performance profiler PoC**
+
+  The performance profiler is designed to get timestamp in each checkpoint of
+  components for further analysis. In Danube, initial PoC implementation of the
+  perfomance profiler has been added to the Doctor testing tools
+  by contribution from the `QTIP`_ team. The tools can now show how long it
+  takes for each component in a series of processes for fault notification.
+  Some checkpoints are not covered yet though. To activate this, set the
+  PROFILER_TYPE="poc" before running the main script ("tests/run.sh").
+  See `DOCTOR-72`_ for more details.
+
+* **Testing with multiple tenant VMs**
+
+  The Doctor testing tools now supports new testing scenario where multiple
+  tenant VMs in the system under test can be created (`DOCTOR-77`_).
+  This allows to measure fault notification time/cost with stressed VIM
+  controllers, in order to see perfomance trends.
+
+.. _QTIP: https://wiki.opnfv.org/display/qtip
+.. _DOCTOR-72: https://jira.opnfv.org/browse/DOCTOR-72
+.. _DOCTOR-77: https://jira.opnfv.org/browse/DOCTOR-77
+
+Installer support and verification status
+=========================================
+
+Integrated features
+-------------------
+
+Minimal Doctor functionality of VIM is available in the OPNFV platform from
+the Brahmaputra release. The basic Doctor framework in VIM consists of a
+Controller (Nova) and a Notifier (Ceilometer+Aodh) along with a sample
+Inspector and Monitor developed by the Doctor team.
+
+From the Danube release, key integrated feature is:
+
+* **Congress as Doctor Inspector**
+
+  Congress Inspector is now verified with latest vanilla OpenStack without
+  backporting any patch, like the one we had backported for adding Doctor
+  driver of Congress in Colorado.
+
+OPNFV installer support matrix
+------------------------------
+
+In the Brahmaputra release, only one installer (Apex) supported the deployment
+of the basic doctor framework by configuring Doctor features. In the Danube
+release, integration of Doctor features progressed in other OPNFV installers.
+
++-----------+-------------------+--------------+-----------------+-------------------+
+| Installer | Aodh              | Nova: Force  | Nova: Get valid | Congress          |
+|           | integration       | compute down | service status  | integration       |
++===========+===================+==============+=================+===================+
+| Apex      | Available         | Available    | Available,      | Available         |
+|           |                   |              | Verified only   |                   |
+|           |                   |              | for admin users |                   |
++-----------+-------------------+--------------+-----------------+-------------------+
+| Fuel      | Available         | Available    | Available,      | N/A               |
+|           | (`DOCTOR-58`_)    |              | Verified only   | (`FUEL-230`_)     |
+|           |                   |              | for admin users |                   |
++-----------+-------------------+--------------+-----------------+-------------------+
+| Joid      | Available         | TBC          | TBC             | Available         |
+|           | (`JOID-76`_),     |              |                 | (`JOID-73`_),     |
+|           | Not verified      |              |                 | Not verified      |
++-----------+-------------------+--------------+-----------------+-------------------+
+| Compass   | Available         | TBC          | TBC             | Available         |
+|           | (`COMPASS-357`_), |              |                 | (`COMPASS-367`_), |
+|           | Not verified      |              |                 | Not verified      |
++-----------+-------------------+--------------+-----------------+-------------------+
+
+.. _DOCTOR-58: https://jira.opnfv.org/browse/DOCTOR-58
+.. _FUEL-230: https://jira.opnfv.org/browse/FUEL-230
+.. _JOID-76: https://jira.opnfv.org/browse/JOID-76
+.. _JOID-73: https://jira.opnfv.org/browse/JOID-73
+.. _COMPASS-357: https://jira.opnfv.org/browse/COMPASS-357
+.. _COMPASS-367: https://jira.opnfv.org/browse/COMPASS-367
+
+Note: 'Not verified' means that we didn't verify the functionality by having
+our own test scenario running in OPNFV CI pipeline yet.
+
+Documentation updates
+=====================
+
+* **Configuration manual for Congress**
+
+  Steps to configure Congress as Doctor Inspector have been added
+  to Doctor configuration manual (`DOCTOR-85`_).
+
+* **Alarm comparison**
+
+  As part of the review between Doctor Danube (OpenStack Newton) and ETSI NFV
+  IFA, the alarm comparison table has been updated (`DOCTOR-82`_).
+
+* **OpenStack mechanisms for fencing**
+
+  The section on fencing in the requirement document has been updated with more
+  details of Nova and Neutron (`REVIEW#27049`_).
+
+* **How to test**
+
+  Two ways to run the Doctor testing tools have been added
+  (`REVIEW#28223`_).
+
+You can also find other minor updates in `DOCTOR-81`_.
+
+.. _DOCTOR-81: https://jira.opnfv.org/browse/DOCTOR-81
+.. _DOCTOR-82: https://jira.opnfv.org/browse/DOCTOR-82
+.. _DOCTOR-85: https://jira.opnfv.org/browse/DOCTOR-85
+.. _REVIEW#28223: https://gerrit.opnfv.org/gerrit/28223/
+.. _REVIEW#27049: https://gerrit.opnfv.org/gerrit/27049/
+
+Known issues
+============
+
+* Doctor testing scenario is not verified with non-admin user (`DOCTOR-80`_).
+
+* Congress Nova driver is relying on deprecated Nova APIs and can lead to
+  an error (`BUG#1670345`_). The workaround for this issue is to specify nova
+  micro version to 2.34 . Apex is using this workaround for OpenStack Newton
+  (`_REVIEW#29463`_).
+
+.. _DOCTOR-80: https://jira.opnfv.org/browse/DOCTOR-80
+.. _BUG#1670345: https://bugs.launchpad.net/congress/+bug/1670345
+.. _REVIEW#29463: https://gerrit.opnfv.org/gerrit/29463/
diff --git a/docs/release/release-notes/releasenotes_colorado.rst b/docs/release/release-notes/releasenotes_colorado.rst
new file mode 100644
index 00000000..505fbdb5
--- /dev/null
+++ b/docs/release/release-notes/releasenotes_colorado.rst
@@ -0,0 +1,170 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+=====================================
+OPNFV Doctor release notes (Colorado)
+=====================================
+
+Version history
+===============
+
++------------+--------------+------------+-------------+
+| **Date**   | **Ver.**     | **Author** | **Comment** |
++============+==============+============+=============+
+| 2016-09-19 | Colorado 1.0 | Ryota Mibu |             |
++------------+--------------+------------+-------------+
+
+Important notes
+===============
+
+OPNFV Doctor project started as a requirement project and identified gaps
+between "as-is" open source software (OSS) and an "ideal" platform for NFV.
+Based on this analysis, the Doctor project proposed missing features to
+upstream OSS projects. After those features were implemented, OPNFV installer
+projects integrated the features to the OPNFV platform and the OPNFV
+infra/testing projects verified the functionalities in the OPNFV Labs.
+
+This document provides an overview of the Doctor project in the OPNFV Colorado
+release, including new features, known issues and documentation updates.
+
+New features
+============
+
+* **Congress as a Doctor Inspector**
+
+  Since `Doctor driver`_ in OpenStack Congress has been implemented in Mitaka,
+  OpenStack Congress can now take the role of the Doctor Inspector to correlate
+  an error in a physical resource to the affected virtual resource(s)
+  immediately.
+
+.. _Doctor driver: https://review.openstack.org/#/c/314915/
+
+Installer support and verification status
+=========================================
+
+Integrated features
+-------------------
+
+Minimal Doctor functionality of VIM is available in the OPNFV platform from
+the Brahmaputra release. The basic Doctor framework in VIM consists of a
+Controller (Nova) and a Notifier (Ceilometer+Aodh) along with a sample
+Inspector and Monitor developed by the Doctor team.
+From the Colorado release, key integrated features are:
+
+* Immediate notification upon state update of virtual resource enabled by
+  Ceilometer and Aodh (Aodh integration)
+
+* Consistent state awareness improved by having nova API to mark nova-compute
+  service down (Nova: Force compute down)
+
+* Consistent state awareness improved by exposing host status in server (VM)
+  information via Nova API (Nova: Get valid service status)
+
+* OpenStack Congress enabling policy-based flexible failure correlation
+  (Congress integration)
+
+OPNFV installer support matrix
+------------------------------
+
+In the Brahmaputra release, only one installer (Apex) supported the deployment
+of the basic doctor framework by configuring Doctor features. In the Colorado
+release, integration of Doctor features progressed in other OPNFV installers.
+
++-----------+-------------------+--------------+-----------------+------------------+
+| Installer | Aodh              | Nova: Force  | Nova: Get valid | Congress         |
+|           | integration       | compute down | service status  | integration      |
++===========+===================+==============+=================+==================+
+| Apex      | Available         | Available    | Available       | Available        |
+|           |                   |              | (`DOCTOR-67`_), | (`APEX-135`_,    |
+|           |                   |              | Verified only   | `APEX-158`_),    |
+|           |                   |              | for admin users | Not Verified     |
++-----------+-------------------+--------------+-----------------+------------------+
+| Fuel      | Available         | Available    | Available,      | N/A              |
+|           | (`DOCTOR-58`_),   |              | Verified only   | (`FUEL-119`_)    |
+|           | Not verified      |              | for admin users |                  |
++-----------+-------------------+--------------+-----------------+------------------+
+| Joid      | Available         | TBC          | TBC             | TBC              |
+|           | (`JOID-76`_),     |              |                 | (`JOID-73`_)     |
+|           | Not verified      |              |                 |                  |
++-----------+-------------------+--------------+-----------------+------------------+
+| Compass   | Available         | TBC          | TBC             | N/A              |
+|           | (`COMPASS-357`_), |              |                 | (`COMPASS-367`_) |
+|           | Not verified      |              |                 |                  |
++-----------+-------------------+--------------+-----------------+------------------+
+
+.. _DOCTOR-67: https://jira.opnfv.org/browse/DOCTOR-67
+.. _APEX-135: https://jira.opnfv.org/browse/APEX-135
+.. _APEX-158: https://jira.opnfv.org/browse/APEX-158
+.. _DOCTOR-58: https://jira.opnfv.org/browse/DOCTOR-58
+.. _FUEL-119: https://jira.opnfv.org/browse/FUEL-119
+.. _JOID-76: https://jira.opnfv.org/browse/JOID-76
+.. _JOID-73: https://jira.opnfv.org/browse/JOID-73
+.. _COMPASS-357: https://jira.opnfv.org/browse/COMPASS-357
+.. _COMPASS-367: https://jira.opnfv.org/browse/COMPASS-367
+
+Note: 'Not verified' means that we didn't verify the functionality by having
+our own test scenario running in OPNFV CI pipeline yet.
+
+Documentation updates
+=====================
+
+* **Alarm comparison**
+
+  A report on the gap analysis across alarm specifications in ETSI NFV IFA,
+  OPNFV Doctor and OpenStack Aodh has been added, along with some proposals
+  on how to improve the alignment between SDO specification and OSS
+  implementation as a future work (`DOCTOR-46`_).
+
+.. _DOCTOR-46: https://jira.opnfv.org/browse/DOCTOR-46
+
+* **Description of test scenario**
+
+  The description of the Doctor scenario, which is running as one of the
+  feature verification scenarios in Functest, has been updated (`DOCTOR-53`_).
+
+.. _DOCTOR-53: https://jira.opnfv.org/browse/DOCTOR-53
+
+* **Neutron port status update**
+
+  Design documentation for port status update has been added, intending to
+  propose new features to OpenStack Neutron.
+
+* **SB I/F specification**
+
+  The initial specification of the Doctor southbound interface, which is for
+  the Inspector to receive event messages from Monitors, has been added
+  (`DOCTOR-17`_).
+
+.. _DOCTOR-17: https://jira.opnfv.org/browse/DOCTOR-17
+
+Known issues
+============
+
+* **Aodh 'event-alarm' is not available as default (Fuel)**
+
+  In Fuel 9.0, Aodh integration for 'event-alarm' is not completed.
+  Ceilometer and Nova would be mis-configured and cannot pass event
+  notification to Aodh.
+  You can use `fuel-plugin-doctor`_ to correct Ceilometer and Nova
+  configuration as a workaround. See `DOCTOR-62`_.
+
+.. _fuel-plugin-doctor: https://github.com/openzero-zte/fuel-plugin-doctor
+.. _DOCTOR-62: https://jira.opnfv.org/browse/DOCTOR-62
+
+* **Security notice**
+
+  Security notice has been raised in [*]_. Please insure that the debug option
+  of Flask is set to False, before running in production.
+
+.. [*] http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2016-September/012610.html
+
+* **Performance issue in correct resource status (Fuel)**
+
+  Although the Doctor project is aiming to ensure that the time interval
+  between detection and notification to the user is less than 1 second, we
+  observed that it takes more than 2 seconds in the default OPNFV deployment
+  using the Fuel installer [*]_.
+  This issue will be solved by checking the OpenStack configuration and
+  improving Doctor testing scenario.
+
+.. [*] http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2016-September/012542.html