summaryrefslogtreecommitdiffstats
path: root/docs/release/installation/releasenotes.rst
diff options
context:
space:
mode:
authorRyota Mibu <r-mibu@cq.jp.nec.com>2017-02-17 04:36:05 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-02-17 04:36:05 +0000
commitf3ab498aaddb27f6f598a84e2dbe0203ced6d666 (patch)
treefc7b2be2681db87adc1eb935e6fdcc93a8bc1645 /docs/release/installation/releasenotes.rst
parent5d9c24fd28bcc02243306a8c96d0c68809523343 (diff)
parentd0b22e1d856cf8f78e152dfb6c150e001e03dd52 (diff)
Merge "Update docs structure according to new guidelines in https://wiki.opnfv.org/display/DOC"
Diffstat (limited to 'docs/release/installation/releasenotes.rst')
-rw-r--r--docs/release/installation/releasenotes.rst113
1 files changed, 113 insertions, 0 deletions
diff --git a/docs/release/installation/releasenotes.rst b/docs/release/installation/releasenotes.rst
new file mode 100644
index 00000000..efb7b08c
--- /dev/null
+++ b/docs/release/installation/releasenotes.rst
@@ -0,0 +1,113 @@
+.. 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** |
++============+==============+============+=============+
+| 2016-XX-XX | Danube 1.0 | ... | |
++------------+--------------+------------+-------------+
+
+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
+============
+
+* **FEATURE 1**
+
+ TODO: add description including pointer to `feature1`_ and explain what it is about.
+
+.. _feature1: https://review.openstack.org/#/c/....../
+
+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 features are:
+
+* ...
+
+* ...
+
+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.
+
+TODO: TABLE TO BE UPDATED!
+
++-----------+-------------------+--------------+-----------------+------------------+
+| 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
+=====================
+
+* **Update 1**
+
+ Description including pointer to JIRA ticket (`DOCTOR-46`_).
+
+.. _DOCTOR-46: https://jira.opnfv.org/browse/DOCTOR-46
+
+
+Known issues
+============
+
+* ...