summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release-notes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/release-notes/release-notes.rst')
-rw-r--r--docs/release/release-notes/release-notes.rst185
1 files changed, 49 insertions, 136 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 7f7a1980..b525335e 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -2,87 +2,46 @@
.. http://creativecommons.org/licenses/by/4.0
-This document provides the release notes for Hunter of Doctor.
+This document provides the release notes for Iruya version of Doctor.
Important notes
===============
-In Hunter release, Doctor has been working with fault management alarming
-enhancement and maintenance use case to upstream.
+Jerma release has mainly been for finalizing maintenance use case testing
+supporting the ETSI FEAT03 defined interactino between VNFM and infrastructure.
+This is mainly to have infrastructure maintenance and upgrade operations
+opttimized as fast as they can while keeping VNFs on top with zero impact
+on their service.
-OpenStack Fenix (unofficial project) has been futher worked to implement the
-infrastructure rolling maintenance in interaction with VNFM. Doctor CI testing
-also supports maintenance testing with Fenix latest master version.
-
-MCP and Apex installers are currently supported. In MCP we test fault management
-without the enhanced alarm. In Apex we test fault management with alarm
-enhancement with sample implementation. Apex is also used for maintenance use
-case testing. Congress inspector support is not working.
-
-In this release, Doctor has not yet been working to look outside OpenStack.
-We might need to get back to this later to better meet the tough industry
-requirements as well as requirements from edge, containers and 5G.
+Further more this is the final release of Doctor and the more deep testing is
+moving more to upstream projects like Fenix for the maintenance. Also in
+this release we have made sure that all Doctor testing and any deeper testing
+with ehe upstream projects can be done in DevStack. This also makes DevStack
+the most important installer.
Summary
=======
-Hunter Doctor framework uses OpenStack Rocky integrated into its test cases.
-For testing, we use Doctor CI on OPNFV installers.
+Jerma Doctor framework uses OpenStack Train integrated into its test cases.
Release Data
============
Doctor changes
-+------------------------------------------+----------------------------------------------------------+
-| **commit-ID** | **Subject** |
-+------------------------------------------+----------------------------------------------------------+
-| b19b69d731cfb5a87f7c928cc898ea04ec85cec6 | Fix tox to clean python cache |
-+------------------------------------------+----------------------------------------------------------+
-| 364d2c2344be5775a0eef6fe19fda125d2c8853d | Handle the exception for running the profiler |
-+------------------------------------------+----------------------------------------------------------+
-| e6c857ba931a03fb7bfb49746cc4a7eb5b6ce6e1 | Hunter release documentation |
-+------------------------------------------+----------------------------------------------------------+
-| 73605c5c34b97ab56306bfa9af0f5888f3c7e46d | Support Fenix as admin tool |
-+------------------------------------------+----------------------------------------------------------+
-| 33293e9c23a21ad3228f46d2063f18c915eb2b79 | Wrong yamllint disable command |
-+------------------------------------------+----------------------------------------------------------+
-| d82ab34f15a9b67185c85c6afc5562bc8b72cb8b | Add local.conf.sample for devstack deployment of Doctor |
-+------------------------------------------+----------------------------------------------------------+
-| 7ecc40b445b2aa42f0680c96dc672accf4e40ba0 | Hi, the automation job failed. |
-+------------------------------------------+----------------------------------------------------------+
-| 2cd1ca4463121e2354fd920af2b26c65848fb9e2 | Remove Ryota from committers |
-+------------------------------------------+----------------------------------------------------------+
-| f31ab961c594595772b0c3d4bd40a0d9491fc6cb | Removing committers |
-+------------------------------------------+----------------------------------------------------------+
-| c653d95c67436698296e238396bf5d8370e3169a | Update to INFO file |
-+------------------------------------------+----------------------------------------------------------+
-| e6708c869855ab69f9b53959befd82bb2f32f9ad | Bug - Testing in Apex with OpenStack master fails |
-+------------------------------------------+----------------------------------------------------------+
-| e1c5dd0158d5168738fcc9918d24c04ca724b056 | remove to set ceilometer config in MCP |
-+------------------------------------------+----------------------------------------------------------+
-| d673e9218a53e047edc5ff6cd047ac6db5112651 | Support Fenix and sample implementation accordingly |
-+------------------------------------------+----------------------------------------------------------+
-| 916e4931a56c1a5d41d46148609bf348d4326d37 | fix the configparser for Python 2 and 3 Compatibility |
-+------------------------------------------+----------------------------------------------------------+
-| 4075b417e973adb257ae39ff5c25aa182a2af3ea | index.rst was blank |
-+------------------------------------------+----------------------------------------------------------+
-| dafdfcfad6866d7c413d4b8d5a9d25f3ab1f76dc | Minor docs updates |
-+------------------------------------------+----------------------------------------------------------+
-
-Releng changes
-
-+------------------------------------------+----------------------------------------------------------+
-| **commit-ID** | **Subject** |
-+------------------------------------------+----------------------------------------------------------+
-| cc290b2f937a2edbd60a5d2d1e20f333dfc7eb88 | Doctor to run Fenix as admin tool |
-+------------------------------------------+----------------------------------------------------------+
-| 488c558492201aacd359305a7afa3d5640a90b0e | Add parameter of `DEPLOY_SCENARIO` for doctor |
-+------------------------------------------+----------------------------------------------------------+
-| 30478e1e193485cce93164e9877002b811acf950 | remove `SSH_KEY` parameter from `doctor-slave-parameter` |
-+------------------------------------------+----------------------------------------------------------+
-| 513b05275cbac2ff98950bb0a384a275dd8884f5 | Parpare ssh_key for MCP in doctor |
-+------------------------------------------+----------------------------------------------------------+
+- Maintenance use case updated to support latest version of Fenix.
+- Maintenance use case now supports ETSI FEAT03 optimization with Fenix.
+- Doctor testing is now preferred to be done in DevStack environment
+ where one can easily select OpenStack release from Rocky to Ussuri to
+ test Doctor functionality. Latest OPNFV Fuel can also be used for the
+ OpenStack version it supports.
+
+Doctor CI
+
+- Doctor tested with fuel installer.
+- Fault management use case is tested with sample inspector.
+- Maintenance use case is tested with sample implementation and towards
+ the latest Fenix version. The includes the new ETSI FEAT03 optimization.
Version change
^^^^^^^^^^^^^^
@@ -90,37 +49,30 @@ Version change
Module version changes
~~~~~~~~~~~~~~~~~~~~~~
-- OpenStack has changed from Queens-1 to Rocky-1 since previous Gambia release.
+- OpenStack has changed Train
Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~
-These documents have been updated in Hunter release
-
-- Testing document
- docs/development/overview/testing.rst
-- Doctor scenario in functest:
- docs/development/overview/functest_scenario/doctor-scenario-in-functest.rst
+All documentation is updated to OPNFV unified format according to
+documentation guidelines. Small updates in many documents.
Reason for version
^^^^^^^^^^^^^^^^^^
-Documentation is updated due to maintenance use case testing using Fenix.
+N/A
Feature additions
~~~~~~~~~~~~~~~~~
-+--------------------+----------------------------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-+--------------------+----------------------------------------------------------+
-| DOCTOR-129 | Maintenance use case implementation in OpenStack Fenix |
-+--------------------+----------------------------------------------------------+
-| DOCTOR-131 | Support Fenix and sample implementation accordingly |
-+--------------------+----------------------------------------------------------+
-| DOCTOR-132 | Integrate with MCP |
-+--------------------+----------------------------------------------------------+
-| DOCTOR-133 | Doctor fault management with notification from Inspector |
-+--------------------+----------------------------------------------------------+
++--------------------+--------------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
++--------------------+--------------------------------------------+
+| DOCTOR-137 | VNFM maintenance with ETSI changes |
++--------------------+--------------------------------------------+
+| DOCTOR-136 | DevStack support |
++--------------------+--------------------------------------------+
+
Deliverables
------------
@@ -165,65 +117,21 @@ Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=sample
+--------------------------------------+--------------+
| **TEST-SUITE** | **Results:** |
+--------------------------------------+--------------+
-| INSTALLER_TYPE='Apex' 1) | SUCCESS |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Fuel' 2) | SUCCESS |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Local' | N/A |
+| INSTALLER_TYPE='fuel' | SUCCESS |
+--------------------------------------+--------------+
-1) Uses enhanced alarming worked in DOCTOR-133
-2) Uses alarm from Nova reset server state API generated notification. API call
- can take a lot of time and alarm might take over a second. This also happens
- with different installer and for more Telco grade performance we need the
- enhanced alarming.
-Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=congress
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Doctor CI results with TEST_CASE='maintenance' and INSPECTOR_TYPE=sample
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------------------------+--------------+
| **TEST-SUITE** | **Results:** |
+--------------------------------------+--------------+
-| INSTALLER_TYPE='Apex' 1) | FAILED |
+| INSTALLER_TYPE='fuel' | SUCCESS |
+| ADMIN_TOOL_TYPE='fenix' *) | |
+--------------------------------------+--------------+
-| INSTALLER_TYPE='Fuel' | N/A |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Local' | N/A |
-+--------------------------------------+--------------+
-1) Takes over one second because Nova reset server state error API is too slow
-Doctor Functest results with TEST_CASE='fault_management'
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-+--------------------------------------+--------------+
-| **TEST-SUITE** | **Results:** |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Apex' | skipped |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Fuel' | skipped |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Local' | N/A |
-+--------------------------------------+--------------+
-
-Note: Installer Functest does not currently test features or skips running the
-project test cases
-
-Doctor CI results with TEST_CASE='maintenance'
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-+--------------------------------------+--------------+
-| **TEST-SUITE** | **Results:** |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Apex' | SUCCESS |
-| ADMIN_TOOL_TYPE='sample' | |
-+--------------------------------------+--------------+
-| INSTALLER_TYPE='Apex' | SUCCESS |
-| ADMIN_TOOL_TYPE='fenix' | |
-+--------------------------------------+--------------+
-
-Doctor Functest results with TEST_CASE='maintenance'
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-N/A - Needs special target environment with at least 3 compute nodes
+*) Sample implementation not updated according to latest upstream Fenix
+ and is currently not being tested.
References
==========
@@ -231,3 +139,8 @@ References
For more information about the OPNFV Doctor latest work, please see:
https://wiki.opnfv.org/display/doctor/Doctor+Home
+
+Further information about ETSI FEAT03 optimization can be found from Fenix
+Documentation:
+
+https://fenix.readthedocs.io/en/latest