blob: fdaf8af5c9536051e60eca9fee73dd054122d034 [file] [log] [blame]
shivasubedi3d1579c2021-09-13 16:43:20 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
5.. _release_notes:
6
7
8
9========================
DylanB95ESTb1556c02021-10-11 13:39:21 +010010DMI-Plugin Release Notes
shivasubedi3d1579c2021-09-13 16:43:20 +010011========================
12
shivasubedi3d1579c2021-09-13 16:43:20 +010013.. contents::
14 :depth: 2
15..
16
17.. ========================
18.. * * * ISTANBUL * * *
19.. ========================
20
DylanB95ESTb1556c02021-10-11 13:39:21 +010021Version: 1.0.1
shivasubedi3d1579c2021-09-13 16:43:20 +010022==============
23
shivasubedi3d1579c2021-09-13 16:43:20 +010024Release Data
25------------
26
27+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +010028| **CPS Project** | DMI-Plugin |
shivasubedi3d1579c2021-09-13 16:43:20 +010029| | |
30+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +010031| **Docker images** | onap/ncmp-dmi-plugin:1.0.1 |
shivasubedi3d1579c2021-09-13 16:43:20 +010032| | |
33+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +010034| **Release designation** | 1.0.1 Istanbul |
shivasubedi3d1579c2021-09-13 16:43:20 +010035| | |
36+--------------------------------------+--------------------------------------------------------+
37| **Release date** | 2021-14-10 |
38| | |
39+--------------------------------------+--------------------------------------------------------+
40
DylanB95ESTb1556c02021-10-11 13:39:21 +010041Bug Fixes
42---------
43
44 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
45 - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
46 - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
47 - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
48 - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
49 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
50
51Known Limitations, Issues and Workarounds
52-----------------------------------------
53
54*System Limitations*
55
56 - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
57
58*Known Vulnerabilities*
59
60None
61
62*Workarounds*
63
64None
65
66Security Notes
67--------------
68
69*Fixed Security Issues*
70
71None
72
73*Known Security Issues*
74
75None
76
77Version: 1.0.0
78==============
79
80Release Data
81------------
82
83+--------------------------------------+--------------------------------------------------------+
84| **CPS Project** | DMI-Plugin |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Docker images** | onap/ncmp-dmi-plugin:1.0.0 |
88| | |
89+--------------------------------------+--------------------------------------------------------+
90| **Release designation** | 1.0.0 Istanbul |
91| | |
92+--------------------------------------+--------------------------------------------------------+
93| **Release date** | 2021-14-09 |
94| | |
95+--------------------------------------+--------------------------------------------------------+
96
shivasubedi3d1579c2021-09-13 16:43:20 +010097Features
98--------
99* Implement plugin registration.
DylanB95ESTb1556c02021-10-11 13:39:21 +0100100* Retrieve data from cmHandles using ncmp-datastores passthrough.
shivasubedi3d1579c2021-09-13 16:43:20 +0100101* Retrieve Yang Resources from one or more modules of a CM Handle.
102
103.. _istanbul_deliverable:
104
105Deliverables
106------------
107
108Software Deliverables
109
110.. csv-table::
111 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
112 :widths: auto
113
DylanB95ESTb1556c02021-10-11 13:39:21 +0100114 "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
shivasubedi3d1579c2021-09-13 16:43:20 +0100115
116Bug Fixes
117---------
118
DylanB95ESTb1556c02021-10-11 13:39:21 +0100119 - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
120 - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
121 - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
shivasubedi3d1579c2021-09-13 16:43:20 +0100122
123Summary
124-------
125
DylanB95ESTb1556c02021-10-11 13:39:21 +0100126Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
shivasubedi3d1579c2021-09-13 16:43:20 +0100127
128 * Platform components
129
130 * Service components
131
132 * Additional resources that CPS utilizes deployed using ONAP common charts
133
134Below service components (mS) are available to be deployed on-demand.
135
136Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
137
138Known Limitations, Issues and Workarounds
139-----------------------------------------
140
141*System Limitations*
142
shivasubedi3d1579c2021-09-13 16:43:20 +0100143None
144
DylanB95ESTb1556c02021-10-11 13:39:21 +0100145*Known Vulnerabilities*
146
147 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
148 - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
149
shivasubedi3d1579c2021-09-13 16:43:20 +0100150*Workarounds*
151
DylanB95ESTb1556c02021-10-11 13:39:21 +0100152None
153
shivasubedi3d1579c2021-09-13 16:43:20 +0100154Security Notes
155--------------
156
157*Fixed Security Issues*
158
DylanB95ESTb1556c02021-10-11 13:39:21 +0100159None
160
shivasubedi3d1579c2021-09-13 16:43:20 +0100161*Known Security Issues*
162
DylanB95ESTb1556c02021-10-11 13:39:21 +0100163None
shivasubedi3d1579c2021-09-13 16:43:20 +0100164
165References
166----------
167
DylanB95ESTb1556c02021-10-11 13:39:21 +0100168For more information on the ONAP Istanbul release, please see:
shivasubedi3d1579c2021-09-13 16:43:20 +0100169
170#. `ONAP Home Page`_
171#. `ONAP Documentation`_
172#. `ONAP Release Downloads`_
173#. `ONAP Wiki Page`_
174
175
176.. _`ONAP Home Page`: https://www.onap.org
177.. _`ONAP Wiki Page`: https://wiki.onap.org
178.. _`ONAP Documentation`: https://docs.onap.org
179.. _`ONAP Release Downloads`: https://git.onap.org
180
181Quick Links:
182
DylanB95ESTb1556c02021-10-11 13:39:21 +0100183 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
shivasubedi3d1579c2021-09-13 16:43:20 +0100184 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_