blob: 6421e9f86886734279d1f172abc146e537358f4e [file] [log] [blame]
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2021-2022 Nordix Foundation
.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
.. _release_notes:
========================
DMI-Plugin Release Notes
========================
.. contents::
:depth: 2
..
.. ====================
.. * * * KOHN * * *
.. ====================
Version: 1.2.2 (not yet released)
=================================
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.2.2 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.2.2 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | (not yet released) |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
Version: 1.2.1
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.2.1 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.2.1 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 October 5 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- None
Version: 1.2.0
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.2.0 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.2.0 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 September 21 |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
- `CPS-562 <https://jira.onap.org/browse/CPS-562>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (DMI Plugin.)
- `CPS-832 <https://jira.onap.org/browse/CPS-832>`_ Async: E2E Integration
- `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
Bug Fixes
---------
- None
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
None
*Known Vulnerabilities*
None
*Workarounds*
None
Security Notes
--------------
*Fixed Security Issues*
None
*Known Security Issues*
None
.. ========================
.. * * * JAKARTA * * *
.. ========================
Version: 1.1.0
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.1.0 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.1.0 Jakarta |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 March 15 |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
- `CPS-637 <https://jira.onap.org/browse/CPS-637>`_ Support Update operation for datastore pass-through running
- `CPS-639 <https://jira.onap.org/browse/CPS-639>`_ Support Delete operation for datastore pass-through running
- `CPS-784 <https://jira.onap.org/browse/CPS-784>`_ Add examples to DMI-Plugin API Spec
Bug Fixes
---------
- `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
None
*Known Vulnerabilities*
None
*Workarounds*
None
Security Notes
--------------
*Fixed Security Issues*
None
*Known Security Issues*
None
.. ========================
.. * * * ISTANBUL * * *
.. ========================
Version: 1.0.3
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.0.3 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.0.3 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022-07-01 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
Version: 1.0.2
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.0.2 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.0.2 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-16-12 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
Version: 1.0.1
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.0.1 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.0.1 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-14-10 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
- `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
- `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
- `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
- `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
- `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
- `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
*Known Vulnerabilities*
None
*Workarounds*
None
Security Notes
--------------
*Fixed Security Issues*
None
*Known Security Issues*
None
Version: 1.0.0
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | DMI-Plugin |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/ncmp-dmi-plugin:1.0.0 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.0.0 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-14-09 |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
* Implement plugin registration.
* Retrieve data from cmHandles using ncmp-datastores passthrough.
* Retrieve Yang Resources from one or more modules of a CM Handle.
.. _istanbul_deliverable:
Deliverables
------------
Software Deliverables
.. csv-table::
:header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
:widths: auto
"cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
Bug Fixes
---------
- `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
- `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
- `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
Summary
-------
Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
* Platform components
* Service components
* Additional resources that CPS utilizes deployed using ONAP common charts
Below service components (mS) are available to be deployed on-demand.
Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
None
*Known Vulnerabilities*
- `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
- `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
*Workarounds*
None
Security Notes
--------------
*Fixed Security Issues*
None
*Known Security Issues*
None
References
----------
For more information on the ONAP Istanbul release, please see:
#. `ONAP Home Page`_
#. `ONAP Documentation`_
#. `ONAP Release Downloads`_
#. `ONAP Wiki Page`_
.. _`ONAP Home Page`: https://www.onap.org
.. _`ONAP Wiki Page`: https://wiki.onap.org
.. _`ONAP Documentation`: https://docs.onap.org
.. _`ONAP Release Downloads`: https://git.onap.org
Quick Links:
- `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
- `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_