docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2021-2022 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _release_notes:
   7
   8
   9
  10 ========================
  11 DMI-Plugin Release Notes
  12 ========================
  13
  14 .. contents::
  15     :depth: 2
  16 ..
  17 ..      ====================
  18 ..      * * *   KOHN   * * *
  19 ..      ====================
  20
  21 Version: 1.2.0
  22 ==============
  23
  24 Release Data
  25 ------------
  26
  27 +--------------------------------------+--------------------------------------------------------+
  28 | **CPS Project**                      |  DMI-Plugin                                            |
  29 |                                      |                                                        |
  30 +--------------------------------------+--------------------------------------------------------+
  31 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.0                             |
  32 |                                      |                                                        |
  33 +--------------------------------------+--------------------------------------------------------+
  34 | **Release designation**              | 1.2.0 Kohn                                             |
  35 |                                      |                                                        |
  36 +--------------------------------------+--------------------------------------------------------+
  37 | **Release date**                     | 2022 September 21                                      |
  38 |                                      |                                                        |
  39 +--------------------------------------+--------------------------------------------------------+
  40
  41 Features
  42 --------
  43    - `CPS-562 <https://jira.onap.org/browse/CPS-562>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (DMI Plugin.)
  44    - `CPS-832 <https://jira.onap.org/browse/CPS-832>`_  Async: E2E Integration
  45    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
  46
  47 Bug Fixes
  48 ---------
  49    - None
  50
  51 Known Limitations, Issues and Workarounds
  52 -----------------------------------------
  53
  54 *System Limitations*
  55
  56 None
  57
  58 *Known Vulnerabilities*
  59
  60 None
  61
  62 *Workarounds*
  63
  64 None
  65
  66 Security Notes
  67 --------------
  68
  69 *Fixed Security Issues*
  70
  71 None
  72
  73 *Known Security Issues*
  74
  75 None
  76
  77 ..      ========================
  78 ..      * * *   JAKARTA   * * *
  79 ..      ========================
  80
  81 Version: 1.1.0
  82 ==============
  83
  84 Release Data
  85 ------------
  86
  87 +--------------------------------------+--------------------------------------------------------+
  88 | **CPS Project**                      |  DMI-Plugin                                            |
  89 |                                      |                                                        |
  90 +--------------------------------------+--------------------------------------------------------+
  91 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.1.0                            |
  92 |                                      |                                                        |
  93 +--------------------------------------+--------------------------------------------------------+
  94 | **Release designation**              | 1.1.0 Jakarta                                          |
  95 |                                      |                                                        |
  96 +--------------------------------------+--------------------------------------------------------+
  97 | **Release date**                     | 2022 March 15                                          |
  98 |                                      |                                                        |
  99 +--------------------------------------+--------------------------------------------------------+
 100
 101 Features
 102 --------
 103    - `CPS-637 <https://jira.onap.org/browse/CPS-637>`_  Support Update operation for datastore pass-through running
 104    - `CPS-639 <https://jira.onap.org/browse/CPS-639>`_  Support Delete operation for datastore pass-through running
 105    - `CPS-784 <https://jira.onap.org/browse/CPS-784>`_  Add examples to DMI-Plugin API Spec
 106
 107 Bug Fixes
 108 ---------
 109
 110    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 111
 112 Known Limitations, Issues and Workarounds
 113 -----------------------------------------
 114
 115 *System Limitations*
 116
 117 None
 118
 119 *Known Vulnerabilities*
 120
 121 None
 122
 123 *Workarounds*
 124
 125 None
 126
 127 Security Notes
 128 --------------
 129
 130 *Fixed Security Issues*
 131
 132 None
 133
 134 *Known Security Issues*
 135
 136 None
 137
 138 ..      ========================
 139 ..      * * *   ISTANBUL   * * *
 140 ..      ========================
 141
 142 Version: 1.0.3
 143 ==============
 144
 145 Release Data
 146 ------------
 147
 148 +--------------------------------------+--------------------------------------------------------+
 149 | **CPS Project**                      |  DMI-Plugin                                            |
 150 |                                      |                                                        |
 151 +--------------------------------------+--------------------------------------------------------+
 152 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.3                            |
 153 |                                      |                                                        |
 154 +--------------------------------------+--------------------------------------------------------+
 155 | **Release designation**              | 1.0.3 Istanbul                                         |
 156 |                                      |                                                        |
 157 +--------------------------------------+--------------------------------------------------------+
 158 | **Release date**                     | 2022-07-01                                             |
 159 |                                      |                                                        |
 160 +--------------------------------------+--------------------------------------------------------+
 161
 162 Bug Fixes
 163 ---------
 164
 165    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
 166
 167 Version: 1.0.2
 168 ==============
 169
 170 Release Data
 171 ------------
 172
 173 +--------------------------------------+--------------------------------------------------------+
 174 | **CPS Project**                      |  DMI-Plugin                                            |
 175 |                                      |                                                        |
 176 +--------------------------------------+--------------------------------------------------------+
 177 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.2                            |
 178 |                                      |                                                        |
 179 +--------------------------------------+--------------------------------------------------------+
 180 | **Release designation**              | 1.0.2 Istanbul                                         |
 181 |                                      |                                                        |
 182 +--------------------------------------+--------------------------------------------------------+
 183 | **Release date**                     | 2021-16-12                                             |
 184 |                                      |                                                        |
 185 +--------------------------------------+--------------------------------------------------------+
 186
 187 Bug Fixes
 188 ---------
 189
 190    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
 191
 192 Version: 1.0.1
 193 ==============
 194
 195 Release Data
 196 ------------
 197
 198 +--------------------------------------+--------------------------------------------------------+
 199 | **CPS Project**                      |  DMI-Plugin                                            |
 200 |                                      |                                                        |
 201 +--------------------------------------+--------------------------------------------------------+
 202 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.1                            |
 203 |                                      |                                                        |
 204 +--------------------------------------+--------------------------------------------------------+
 205 | **Release designation**              | 1.0.1 Istanbul                                         |
 206 |                                      |                                                        |
 207 +--------------------------------------+--------------------------------------------------------+
 208 | **Release date**                     | 2021-14-10                                             |
 209 |                                      |                                                        |
 210 +--------------------------------------+--------------------------------------------------------+
 211
 212 Bug Fixes
 213 ---------
 214
 215    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 216    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 217    - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
 218    - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
 219    - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
 220    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
 221
 222 Known Limitations, Issues and Workarounds
 223 -----------------------------------------
 224
 225 *System Limitations*
 226
 227   - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
 228
 229 *Known Vulnerabilities*
 230
 231 None
 232
 233 *Workarounds*
 234
 235 None
 236
 237 Security Notes
 238 --------------
 239
 240 *Fixed Security Issues*
 241
 242 None
 243
 244 *Known Security Issues*
 245
 246 None
 247
 248 Version: 1.0.0
 249 ==============
 250
 251 Release Data
 252 ------------
 253
 254 +--------------------------------------+--------------------------------------------------------+
 255 | **CPS Project**                      |  DMI-Plugin                                            |
 256 |                                      |                                                        |
 257 +--------------------------------------+--------------------------------------------------------+
 258 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.0                            |
 259 |                                      |                                                        |
 260 +--------------------------------------+--------------------------------------------------------+
 261 | **Release designation**              | 1.0.0 Istanbul                                         |
 262 |                                      |                                                        |
 263 +--------------------------------------+--------------------------------------------------------+
 264 | **Release date**                     | 2021-14-09                                             |
 265 |                                      |                                                        |
 266 +--------------------------------------+--------------------------------------------------------+
 267
 268 Features
 269 --------
 270 * Implement plugin registration.
 271 * Retrieve data from cmHandles using ncmp-datastores passthrough.
 272 * Retrieve Yang Resources from one or more modules of a  CM Handle.
 273
 274 .. _istanbul_deliverable:
 275
 276 Deliverables
 277 ------------
 278
 279 Software Deliverables
 280
 281 .. csv-table::
 282    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 283    :widths: auto
 284
 285    "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
 286
 287 Bug Fixes
 288 ---------
 289
 290    - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
 291    - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
 292    - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
 293
 294 Summary
 295 -------
 296
 297 Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
 298
 299     * Platform components
 300
 301     * Service components
 302
 303     * Additional resources that CPS utilizes deployed using ONAP common charts
 304
 305 Below service components (mS) are available to be deployed on-demand.
 306
 307 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 308
 309 Known Limitations, Issues and Workarounds
 310 -----------------------------------------
 311
 312 *System Limitations*
 313
 314 None
 315
 316 *Known Vulnerabilities*
 317
 318    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 319    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 320
 321 *Workarounds*
 322
 323 None
 324
 325 Security Notes
 326 --------------
 327
 328 *Fixed Security Issues*
 329
 330 None
 331
 332 *Known Security Issues*
 333
 334 None
 335
 336 References
 337 ----------
 338
 339 For more information on the ONAP Istanbul release, please see:
 340
 341 #. `ONAP Home Page`_
 342 #. `ONAP Documentation`_
 343 #. `ONAP Release Downloads`_
 344 #. `ONAP Wiki Page`_
 345
 346
 347 .. _`ONAP Home Page`: https://www.onap.org
 348 .. _`ONAP Wiki Page`: https://wiki.onap.org
 349 .. _`ONAP Documentation`: https://docs.onap.org
 350 .. _`ONAP Release Downloads`: https://git.onap.org
 351
 352 Quick Links:
 353
 354         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 355         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_