summaryrefslogtreecommitdiffstats
path: root/docs/releasenotes/releasenotes.rst
diff options
context:
space:
mode:
authorGerald Kunzmann <kunzmann@docomolab-euro.com>2016-11-15 16:24:59 +0000
committerGerald Kunzmann <kunzmann@docomolab-euro.com>2017-01-05 10:06:25 +0000
commit2c3acc499c5b2c0c086233caf80951c284be0701 (patch)
tree9ccbc86c6d3aafae6e78f5913af455c5d9308a8f /docs/releasenotes/releasenotes.rst
parent69264fa32e7885be44667efa34c0c58cc110f5b6 (diff)
Update the documentation to Danube release: JIRA: DOCTOR-81
Change-Id: I118b9c8d54857deff72b51789e5adb25b3d28b20 Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>
Diffstat (limited to 'docs/releasenotes/releasenotes.rst')
-rw-r--r--docs/releasenotes/releasenotes.rst87
1 files changed, 15 insertions, 72 deletions
diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst
index 505fbdb5..efb7b08c 100644
--- a/docs/releasenotes/releasenotes.rst
+++ b/docs/releasenotes/releasenotes.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
=====================================
-OPNFV Doctor release notes (Colorado)
+OPNFV Doctor release notes (Danube)
=====================================
Version history
@@ -11,7 +11,7 @@ Version history
+------------+--------------+------------+-------------+
| **Date** | **Ver.** | **Author** | **Comment** |
+============+==============+============+=============+
-| 2016-09-19 | Colorado 1.0 | Ryota Mibu | |
+| 2016-XX-XX | Danube 1.0 | ... | |
+------------+--------------+------------+-------------+
Important notes
@@ -24,20 +24,17 @@ 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
+This document provides an overview of the Doctor project in the OPNFV Danube
release, including new features, known issues and documentation updates.
New features
============
-* **Congress as a Doctor Inspector**
+* **FEATURE 1**
- 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.
+ TODO: add description including pointer to `feature1`_ and explain what it is about.
-.. _Doctor driver: https://review.openstack.org/#/c/314915/
+.. _feature1: https://review.openstack.org/#/c/....../
Installer support and verification status
=========================================
@@ -49,27 +46,22 @@ 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)
+From the Danube release, key integrated features are:
-* 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
+of the basic doctor framework by configuring Doctor features. In the Danube
release, integration of Doctor features progressed in other OPNFV installers.
+TODO: TABLE TO BE UPDATED!
+
+-----------+-------------------+--------------+-----------------+------------------+
| Installer | Aodh | Nova: Force | Nova: Get valid | Congress |
| | integration | compute down | service status | integration |
@@ -108,63 +100,14 @@ our own test scenario running in OPNFV CI pipeline yet.
Documentation updates
=====================
-* **Alarm comparison**
+* **Update 1**
- 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`_).
+ Description including pointer to JIRA ticket (`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
+* ...