diff options
| -rw-r--r-- | docs/release/release-notes/releasenotes.rst | 120 | ||||
| -rw-r--r-- | docs/release/release-notes/releasenotes_euphrates.rst | 114 |
2 files changed, 166 insertions, 68 deletions
diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst index 29565953..30965be3 100644 --- a/docs/release/release-notes/releasenotes.rst +++ b/docs/release/release-notes/releasenotes.rst @@ -1,21 +1,21 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -====================================== -OPNFV Doctor release notes (Euphrates) -====================================== +=================================== +OPNFV Doctor release notes (Fraser) +=================================== -This document provides an overview of the Doctor project in the OPNFV Euphrates +This document provides an overview of the Doctor project in the OPNFV Fraser release, including new features, known issues and documentation updates. Version history =============== -+------------+----------+------------+-------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -+============+==========+============+=============+ -| 2017-10-02 | 5.0.0 | Ryota Mibu | | -+------------+----------+------------+-------------+ ++------------+----------+--------------+-------------+ +| **Date** | **Ver.** | **Author** | **Comment** | ++============+==========+==============+=============+ +| 2018-04-23 | 6.0.0 | Tomi Juvonen | | ++------------+----------+--------------+-------------+ Important notes =============== @@ -25,19 +25,20 @@ 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. +infra/testing projects verified the functionalities in the OPNFV Labs. After +Euphrates release Doctor also graduated and became a mature project. This means +it has completed the implementation of the fault management use case. Based on +this implementation, Doctor has now started to implement the second use case on +maintenance. -For Euphrates release, the Doctor project focused primarily on extending to -network state and refactoring testing code by python. +For Fraser release, the Doctor project completed re-factoring testing code by +python, added support for installers and started working the maintenance use +case. Doctor now supports Apex, Fuel, Joid, Compass and Daisy installer. New features ============ -Doctor now supports network state handling where VIM tells you the actual data -plane port state, utilizing the new feature called `port-dp-status`_ developed -in OpenStack Neutron as the result of our upstreaming efforts. - -.. _port-data-plane-status: https://specs.openstack.org/openstack/neutron-specs/specs/backlog/ocata/port-data-plane-status.html +Doctor now supports Vitrage as Inspector for local installer. Installer support and verification status ========================================= @@ -45,53 +46,40 @@ Installer support and verification status Integrated features ------------------- -The testing code for doctor test cases are enhanced by refactoring in python, -and supporting collectd monitor. - -The python refactoring improves readability and maintainability of the testing -code in the Doctor repository. This would help Doctor developers as well as -engineers who are referring OPNFV. - -From the Euphrates release, key integrated feature is: - -* **collectd as Doctor Monitor** - - This is experimental, as CI job is not enabled yet. But, you can see and test - with collectd integrated in Doctor reference architecture. +- The enhancement work for Doctor testing code done by re-factoring in python is + now complete. +- Lint support for the code changes was added. +- Doctor now supports Vitrage as Inspector for local installer. OPNFV installer support matrix ------------------------------ -(TBC) - -In the Brahmaputra release, only one installer (Apex) supported the deployment -of the basic Doctor framework by configuring Doctor features. In the Euphrates -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 | -+-----------+-------------------+--------------+-----------------+-------------------+ -| Fuel | Available | Available | Available | N/A | -| | (`DOCTOR-58`_) | | | (`FUEL-230`_) | -+-----------+-------------------+--------------+-----------------+-------------------+ -| 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 +Doctor has already support for several installers for fault management testing. +This work also continued in the Fraser release. Here is latest additions [*] + ++-----------+--------------+--------------+-----------------+--------------+--------------+ +| Installer | Aodh | Nova: Force | Nova: Get valid | Congress | Vitrage | +| | integration | compute down | service status | integration | integration | ++===========+==============+==============+=================+==============+==============+ +| Apex | Available | Available | Available | Available | N/A | ++-----------+--------------+--------------+-----------------+--------------+--------------+ +| Fuel | Available | Available | Available | TBC | N/A | +| (MCP) | | | | | | ++-----------+--------------+--------------+-----------------+--------------+--------------+ +| Joid | Available | TBC | TBC | Available | N/A | +| | Not verified | | | Not verified | | ++-----------+--------------+--------------+-----------------+--------------+--------------+ +| Compass | Available | TBC | TBC | Available | N/A | +| | Not verified | | | Not verified | | ++-----------+--------------+--------------+-----------------+--------------+--------------+ +| Daisy* | Available | TBC | TBC | TBC | N/A | +| | | | | | | ++-----------+--------------+--------------+-----------------+--------------+--------------+ +| Local | Available | TBC | TBC | Available | Available* | +| | Not verified | | | Not verified | Not verified | ++-----------+--------------+--------------+-----------------+--------------+--------------+ + +Note: Local installer is devstack. Note: 'Not verified' means that we didn't verify the functionality by having our own test scenario running in OPNFV CI pipeline yet. @@ -99,16 +87,12 @@ our own test scenario running in OPNFV CI pipeline yet. Documentation updates ===================== -* **maintenance detailed spec** - - The maintenance design document was filed, including suggestions how to - leverage features in OpenStack while developing automated maintenance - capability. - -* **Inspector design guideline** +No major updates Known issues ============ -* Testing code for `port-data-plane-status` in Doctor repository was disabled +- Testing code for `port-data-plane-status` in Doctor repository was disabled in 5.0, as we have problem in neutron client load in CI job container. +- Maintenance test case work was started in Fraser. Some initial test case code + is available, however it is yet not fully implemented in this release. diff --git a/docs/release/release-notes/releasenotes_euphrates.rst b/docs/release/release-notes/releasenotes_euphrates.rst new file mode 100644 index 00000000..29565953 --- /dev/null +++ b/docs/release/release-notes/releasenotes_euphrates.rst @@ -0,0 +1,114 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +====================================== +OPNFV Doctor release notes (Euphrates) +====================================== + +This document provides an overview of the Doctor project in the OPNFV Euphrates +release, including new features, known issues and documentation updates. + +Version history +=============== + ++------------+----------+------------+-------------+ +| **Date** | **Ver.** | **Author** | **Comment** | ++============+==========+============+=============+ +| 2017-10-02 | 5.0.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. + +For Euphrates release, the Doctor project focused primarily on extending to +network state and refactoring testing code by python. + +New features +============ + +Doctor now supports network state handling where VIM tells you the actual data +plane port state, utilizing the new feature called `port-dp-status`_ developed +in OpenStack Neutron as the result of our upstreaming efforts. + +.. _port-data-plane-status: https://specs.openstack.org/openstack/neutron-specs/specs/backlog/ocata/port-data-plane-status.html + +Installer support and verification status +========================================= + +Integrated features +------------------- + +The testing code for doctor test cases are enhanced by refactoring in python, +and supporting collectd monitor. + +The python refactoring improves readability and maintainability of the testing +code in the Doctor repository. This would help Doctor developers as well as +engineers who are referring OPNFV. + +From the Euphrates release, key integrated feature is: + +* **collectd as Doctor Monitor** + + This is experimental, as CI job is not enabled yet. But, you can see and test + with collectd integrated in Doctor reference architecture. + +OPNFV installer support matrix +------------------------------ + +(TBC) + +In the Brahmaputra release, only one installer (Apex) supported the deployment +of the basic Doctor framework by configuring Doctor features. In the Euphrates +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 | ++-----------+-------------------+--------------+-----------------+-------------------+ +| Fuel | Available | Available | Available | N/A | +| | (`DOCTOR-58`_) | | | (`FUEL-230`_) | ++-----------+-------------------+--------------+-----------------+-------------------+ +| 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 +===================== + +* **maintenance detailed spec** + + The maintenance design document was filed, including suggestions how to + leverage features in OpenStack while developing automated maintenance + capability. + +* **Inspector design guideline** + +Known issues +============ + +* Testing code for `port-data-plane-status` in Doctor repository was disabled + in 5.0, as we have problem in neutron client load in CI job container. |