Update the documentation to Danube release: JIRA: DOCTOR-81

Change-Id: I118b9c8d54857deff72b51789e5adb25b3d28b20
Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>

diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst
index f90b213..519b4e0 100644 (file)
--- a/docs/installationprocedure/feature.configuration.rst
+++ b/docs/installationprocedure/feature.configuration.rst
@@ -18,7 +18,7 @@ Then, you can configure Doctor Inspector as follows:
 
 .. code-block:: bash
 
 
 .. code-block:: bash
 

-    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/colorado
+    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/danube

     cd doctor/tests
     INSPECTOR_PORT=12345
     python inspector.py $INSPECTOR_PORT > inspector.log 2>&1 &
     cd doctor/tests
     INSPECTOR_PORT=12345
     python inspector.py $INSPECTOR_PORT > inspector.log 2>&1 &


@@ -38,7 +38,7 @@ Then, you can configure the Doctor Monitor as follows (Example for Apex deployme
 
 .. code-block:: bash
 
 
 .. code-block:: bash
 

-    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/colorado
+    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/danube

     cd doctor/tests
     INSPECTOR_PORT=12345
     COMPUTE_HOST='overcloud-novacompute-1.localdomain.com'
     cd doctor/tests
     INSPECTOR_PORT=12345
     COMPUTE_HOST='overcloud-novacompute-1.localdomain.com'

diff --git a/docs/manuals/get-valid-server-state.rst b/docs/manuals/get-valid-server-state.rst
index ed1c6d5..824ea3c 100644 (file)
--- a/docs/manuals/get-valid-server-state.rst
+++ b/docs/manuals/get-valid-server-state.rst
@@ -119,7 +119,7 @@ Links:
 ======
 
 [1] Manual for OpenStack NOVA API for marking host down
 ======
 
 [1] Manual for OpenStack NOVA API for marking host down

-http://artifacts.opnfv.org/doctor/colorado/manuals/mark-host-down_manual.html
+http://artifacts.opnfv.org/doctor/docs/manuals/mark-host-down_manual.html

 
 [2] OpenStack compute manual page
 http://developer.openstack.org/api-ref-compute-v2.1.html#compute-v2.1
 
 [2] OpenStack compute manual page
 http://developer.openstack.org/api-ref-compute-v2.1.html#compute-v2.1

diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst
index 505fbdb..efb7b08 100644 (file)
--- a/docs/releasenotes/releasenotes.rst
+++ b/docs/releasenotes/releasenotes.rst
@@ -2,7 +2,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 =====================================
 .. http://creativecommons.org/licenses/by/4.0
 
 =====================================

-OPNFV Doctor release notes (Colorado)
+OPNFV Doctor release notes (Danube)

 =====================================
 
 Version history
 =====================================
 
 Version history


@@ -11,7 +11,7 @@ Version history
 +------------+--------------+------------+-------------+
 | **Date**   | **Ver.**     | **Author** | **Comment** |
 +============+==============+============+=============+
 +------------+--------------+------------+-------------+
 | **Date**   | **Ver.**     | **Author** | **Comment** |
 +============+==============+============+=============+

-| 2016-09-19 | Colorado 1.0 | Ryota Mibu |             |
+| 2016-XX-XX | Danube 1.0   | ...        |             |

 +------------+--------------+------------+-------------+
 
 Important notes
 +------------+--------------+------------+-------------+
 
 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.
 
 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
 ============
 
 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
 =========================================
 
 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.
 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
 
 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.
 
 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      |
 +-----------+-------------------+--------------+-----------------+------------------+
 | 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
 =====================
 
 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
 
 
 .. _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
 ============
 
 
 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
+* ...

diff --git a/docs/releasenotes/releasenotes_colorado.rst b/docs/releasenotes/releasenotes_colorado.rst
new file mode 100644 (file)
index 0000000..505fbdb
--- /dev/null
+++ b/docs/releasenotes/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

diff --git a/docs/requirements/glossary.rst b/docs/requirements/glossary.rst
index 059dc1b..2c82b37 100644 (file)
--- a/docs/requirements/glossary.rst
+++ b/docs/requirements/glossary.rst
@@ -81,7 +81,7 @@ mapping/translating the OPNFV terms to terminology used in other contexts.
         Virtualized non-volatile storage allocated to a VM.
 
     VNF
         Virtualized non-volatile storage allocated to a VM.
 
     VNF

-        Virtualized Network Function. Implementation of an Network Function that
+        Virtualized Network Function. Implementation of a Network Function that

         can be deployed on a Network Function Virtualization Infrastructure
         (NFVI).
 
         can be deployed on a Network Function Virtualization Infrastructure
         (NFVI).
 

diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
index d58075b..fcbfb88 100644 (file)
--- a/docs/requirements/index.rst
+++ b/docs/requirements/index.rst
@@ -34,6 +34,9 @@ Doctor: Fault Management and Maintenance
           02.12.2014 Project creation
           14.04.2015 Initial version of the deliverable uploaded to Gerrit
           18.05.2015 Stable version of the Doctor deliverable
           02.12.2014 Project creation
           14.04.2015 Initial version of the deliverable uploaded to Gerrit
           18.05.2015 Stable version of the Doctor deliverable

+          25.02.2016 Updated version for the Brahmaputra release
+          26.09.2016 Updated version for the Colorado release
+          xx.xx.2017 Updated version for the Danube release

           ========== =====================================================
 
 .. raw:: latex
           ========== =====================================================
 
 .. raw:: latex

diff --git a/docs/scenarios/functest/doctor-scenario-in-functest.rst b/docs/scenarios/functest/doctor-scenario-in-functest.rst
index 3c021d6..b3d73d5 100644 (file)
--- a/docs/scenarios/functest/doctor-scenario-in-functest.rst
+++ b/docs/scenarios/functest/doctor-scenario-in-functest.rst
@@ -6,7 +6,7 @@
 Platform overview
 """""""""""""""""
 
 Platform overview
 """""""""""""""""
 

-Doctor platform provides these features in `Colorado Release <https://wiki.opnfv.org/display/SWREL/Colorado>`_:
+Doctor platform provides these features in `Danube Release <https://wiki.opnfv.org/display/SWREL/Danube>`_:

 
 * Immediate Notification
 * Consistent resource state awareness for compute host down
 
 * Immediate Notification
 * Consistent resource state awareness for compute host down


@@ -41,11 +41,11 @@ You can see an overview of the Doctor platform and how components interact in
     :name: figure-p1
     :width: 100%
 
     :name: figure-p1
     :width: 100%
 

-    Doctor platform and typical sequence (Colorado)
+    Doctor platform and typical sequence

 
 Detailed information on the Doctor architecture can be found in the Doctor
 requirements documentation:
 
 Detailed information on the Doctor architecture can be found in the Doctor
 requirements documentation:

-http://artifacts.opnfv.org/doctor/colorado/requirements/05-implementation.html
+http://artifacts.opnfv.org/doctor/docs/requirements/05-implementation.html

 
 Use case
 """"""""
 
 Use case
 """"""""

diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
index 4e080eb..4ae521b 100644 (file)
--- a/docs/userguide/feature.userguide.rst
+++ b/docs/userguide/feature.userguide.rst
@@ -17,7 +17,7 @@ repository. It can be executed as follows:
 
 .. code-block:: bash
 
 
 .. code-block:: bash
 

-    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/colorado
+    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/danube

     cd doctor/tests
     CONSUMER_PORT=12346
     python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 &
     cd doctor/tests
     CONSUMER_PORT=12346
     python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 &


@@ -30,7 +30,7 @@ from a monitor running outside of OpenStack Compute (Nova) by using
 force-down API.
 
 See
 force-down API.
 
 See

-http://artifacts.opnfv.org/doctor/colorado/manuals/mark-host-down_manual.html
+http://artifacts.opnfv.org/doctor/danube/manuals/mark-host-down_manual.html

 for more detail.
 
 Valid compute host status given to VM owner
 for more detail.
 
 Valid compute host status given to VM owner


@@ -40,5 +40,5 @@ The resource state of a compute host can be retrieved by a user with the
 OpenStack Compute (Nova) servers API.
 
 See
 OpenStack Compute (Nova) servers API.
 
 See

-http://artifacts.opnfv.org/doctor/colorado/manuals/get-valid-server-state.html
+http://artifacts.opnfv.org/doctor/danube/manuals/get-valid-server-state.html

 for more detail.
 for more detail.