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 ..      =========================
  19 ..      * * *   NEW DELHI   * * *
  20 ..      =========================
  21
  22 Version: 1.5.0
  23 ==============
  24
  25 Release Data
  26 ------------
  27
  28 +--------------------------------------+--------------------------------------------------------+
  29 | **CPS Project**                      |  DMI-Plugin                                            |
  30 |                                      |                                                        |
  31 +--------------------------------------+--------------------------------------------------------+
  32 | **Docker images**                    | onap/ncmp-dmi-plugin:1.5.0                             |
  33 |                                      |                                                        |
  34 +--------------------------------------+--------------------------------------------------------+
  35 | **Release designation**              | 1.5.0 Montreal                                         |
  36 |                                      |                                                        |
  37 +--------------------------------------+--------------------------------------------------------+
  38 | **Release date**                     | 2024 April 3                                           |
  39 |                                      |                                                        |
  40 +--------------------------------------+--------------------------------------------------------+
  41
  42 Features
  43 --------
  44    - `CPS-2030 <https://jira.onap.org/browse/CPS-2030>`_  Add moduleSetTag to the request towards dmi plugin if moduleSetTag is set for the cmHandle.
  45
  46 ..      ====================
  47 ..      * * *   KOHN   * * *
  48 ..      ====================
  49
  50 Version: 1.4.1
  51 ==============
  52
  53 Release Data
  54 ------------
  55
  56 +--------------------------------------+--------------------------------------------------------+
  57 | **CPS Project**                      |  DMI-Plugin                                            |
  58 |                                      |                                                        |
  59 +--------------------------------------+--------------------------------------------------------+
  60 | **Docker images**                    | onap/ncmp-dmi-plugin:1.4.1                             |
  61 |                                      |                                                        |
  62 +--------------------------------------+--------------------------------------------------------+
  63 | **Release designation**              | 1.4.1 Montreal                                         |
  64 |                                      |                                                        |
  65 +--------------------------------------+--------------------------------------------------------+
  66 | **Release date**                     | (not yet released)                                     |
  67 |                                      |                                                        |
  68 +--------------------------------------+--------------------------------------------------------+
  69
  70 Features
  71 --------
  72
  73 Version: 1.4.0
  74 ==============
  75
  76 Release Data
  77 ------------
  78
  79 +--------------------------------------+--------------------------------------------------------+
  80 | **CPS Project**                      |  DMI-Plugin                                            |
  81 |                                      |                                                        |
  82 +--------------------------------------+--------------------------------------------------------+
  83 | **Docker images**                    | onap/ncmp-dmi-plugin:1.4.0                             |
  84 |                                      |                                                        |
  85 +--------------------------------------+--------------------------------------------------------+
  86 | **Release designation**              | 1.4.0 Montreal                                         |
  87 |                                      |                                                        |
  88 +--------------------------------------+--------------------------------------------------------+
  89 | **Release date**                     | 2023 November 7                                        |
  90 |                                      |                                                        |
  91 +--------------------------------------+--------------------------------------------------------+
  92
  93 Features
  94 --------
  95    - `CPS-1775 <https://jira.onap.org/browse/CPS-1775>`_  Migrate to Java 17.
  96    - `CPS-1790 <https://jira.onap.org/browse/CPS-1790>`_  Update to Spring Boot 3.1.2.
  97
  98
  99 Version: 1.2.2 (not yet released)
 100 =================================
 101
 102 Release Data
 103 ------------
 104
 105 +--------------------------------------+--------------------------------------------------------+
 106 | **CPS Project**                      |  DMI-Plugin                                            |
 107 |                                      |                                                        |
 108 +--------------------------------------+--------------------------------------------------------+
 109 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.2                             |
 110 |                                      |                                                        |
 111 +--------------------------------------+--------------------------------------------------------+
 112 | **Release designation**              | 1.2.2 Kohn                                             |
 113 |                                      |                                                        |
 114 +--------------------------------------+--------------------------------------------------------+
 115 | **Release date**                     | (not yet released)                                     |
 116 |                                      |                                                        |
 117 +--------------------------------------+--------------------------------------------------------+
 118
 119 Bug Fixes
 120 ---------
 121    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
 122
 123
 124 Version: 1.2.1
 125 ==============
 126
 127 Release Data
 128 ------------
 129
 130 +--------------------------------------+--------------------------------------------------------+
 131 | **CPS Project**                      |  DMI-Plugin                                            |
 132 |                                      |                                                        |
 133 +--------------------------------------+--------------------------------------------------------+
 134 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.1                             |
 135 |                                      |                                                        |
 136 +--------------------------------------+--------------------------------------------------------+
 137 | **Release designation**              | 1.2.1 Kohn                                             |
 138 |                                      |                                                        |
 139 +--------------------------------------+--------------------------------------------------------+
 140 | **Release date**                     | 2022 October 5                                         |
 141 |                                      |                                                        |
 142 +--------------------------------------+--------------------------------------------------------+
 143
 144 Bug Fixes
 145 ---------
 146    - None
 147
 148 Version: 1.2.0
 149 ==============
 150
 151 Release Data
 152 ------------
 153
 154 +--------------------------------------+--------------------------------------------------------+
 155 | **CPS Project**                      |  DMI-Plugin                                            |
 156 |                                      |                                                        |
 157 +--------------------------------------+--------------------------------------------------------+
 158 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.0                             |
 159 |                                      |                                                        |
 160 +--------------------------------------+--------------------------------------------------------+
 161 | **Release designation**              | 1.2.0 Kohn                                             |
 162 |                                      |                                                        |
 163 +--------------------------------------+--------------------------------------------------------+
 164 | **Release date**                     | 2022 September 21                                      |
 165 |                                      |                                                        |
 166 +--------------------------------------+--------------------------------------------------------+
 167
 168 Features
 169 --------
 170    - `CPS-562 <https://jira.onap.org/browse/CPS-562>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (DMI Plugin.)
 171    - `CPS-832 <https://jira.onap.org/browse/CPS-832>`_  Async: E2E Integration
 172    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
 173
 174 Bug Fixes
 175 ---------
 176    - None
 177
 178 Known Limitations, Issues and Workarounds
 179 -----------------------------------------
 180
 181 *System Limitations*
 182
 183 None
 184
 185 *Known Vulnerabilities*
 186
 187 None
 188
 189 *Workarounds*
 190
 191 None
 192
 193 Security Notes
 194 --------------
 195
 196 *Fixed Security Issues*
 197
 198 None
 199
 200 *Known Security Issues*
 201
 202 None
 203
 204 ..      ========================
 205 ..      * * *   JAKARTA   * * *
 206 ..      ========================
 207
 208 Version: 1.1.0
 209 ==============
 210
 211 Release Data
 212 ------------
 213
 214 +--------------------------------------+--------------------------------------------------------+
 215 | **CPS Project**                      |  DMI-Plugin                                            |
 216 |                                      |                                                        |
 217 +--------------------------------------+--------------------------------------------------------+
 218 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.1.0                            |
 219 |                                      |                                                        |
 220 +--------------------------------------+--------------------------------------------------------+
 221 | **Release designation**              | 1.1.0 Jakarta                                          |
 222 |                                      |                                                        |
 223 +--------------------------------------+--------------------------------------------------------+
 224 | **Release date**                     | 2022 March 15                                          |
 225 |                                      |                                                        |
 226 +--------------------------------------+--------------------------------------------------------+
 227
 228 Features
 229 --------
 230    - `CPS-637 <https://jira.onap.org/browse/CPS-637>`_  Support Update operation for datastore pass-through running
 231    - `CPS-639 <https://jira.onap.org/browse/CPS-639>`_  Support Delete operation for datastore pass-through running
 232    - `CPS-784 <https://jira.onap.org/browse/CPS-784>`_  Add examples to DMI-Plugin API Spec
 233
 234 Bug Fixes
 235 ---------
 236
 237    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 238
 239 Known Limitations, Issues and Workarounds
 240 -----------------------------------------
 241
 242 *System Limitations*
 243
 244 None
 245
 246 *Known Vulnerabilities*
 247
 248 None
 249
 250 *Workarounds*
 251
 252 None
 253
 254 Security Notes
 255 --------------
 256
 257 *Fixed Security Issues*
 258
 259 None
 260
 261 *Known Security Issues*
 262
 263 None
 264
 265 ..      ========================
 266 ..      * * *   ISTANBUL   * * *
 267 ..      ========================
 268
 269 Version: 1.0.3
 270 ==============
 271
 272 Release Data
 273 ------------
 274
 275 +--------------------------------------+--------------------------------------------------------+
 276 | **CPS Project**                      |  DMI-Plugin                                            |
 277 |                                      |                                                        |
 278 +--------------------------------------+--------------------------------------------------------+
 279 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.3                            |
 280 |                                      |                                                        |
 281 +--------------------------------------+--------------------------------------------------------+
 282 | **Release designation**              | 1.0.3 Istanbul                                         |
 283 |                                      |                                                        |
 284 +--------------------------------------+--------------------------------------------------------+
 285 | **Release date**                     | 2022-07-01                                             |
 286 |                                      |                                                        |
 287 +--------------------------------------+--------------------------------------------------------+
 288
 289 Bug Fixes
 290 ---------
 291
 292    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
 293
 294 Version: 1.0.2
 295 ==============
 296
 297 Release Data
 298 ------------
 299
 300 +--------------------------------------+--------------------------------------------------------+
 301 | **CPS Project**                      |  DMI-Plugin                                            |
 302 |                                      |                                                        |
 303 +--------------------------------------+--------------------------------------------------------+
 304 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.2                            |
 305 |                                      |                                                        |
 306 +--------------------------------------+--------------------------------------------------------+
 307 | **Release designation**              | 1.0.2 Istanbul                                         |
 308 |                                      |                                                        |
 309 +--------------------------------------+--------------------------------------------------------+
 310 | **Release date**                     | 2021-16-12                                             |
 311 |                                      |                                                        |
 312 +--------------------------------------+--------------------------------------------------------+
 313
 314 Bug Fixes
 315 ---------
 316
 317    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
 318
 319 Version: 1.0.1
 320 ==============
 321
 322 Release Data
 323 ------------
 324
 325 +--------------------------------------+--------------------------------------------------------+
 326 | **CPS Project**                      |  DMI-Plugin                                            |
 327 |                                      |                                                        |
 328 +--------------------------------------+--------------------------------------------------------+
 329 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.1                            |
 330 |                                      |                                                        |
 331 +--------------------------------------+--------------------------------------------------------+
 332 | **Release designation**              | 1.0.1 Istanbul                                         |
 333 |                                      |                                                        |
 334 +--------------------------------------+--------------------------------------------------------+
 335 | **Release date**                     | 2021-14-10                                             |
 336 |                                      |                                                        |
 337 +--------------------------------------+--------------------------------------------------------+
 338
 339 Bug Fixes
 340 ---------
 341
 342    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 343    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 344    - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
 345    - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
 346    - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
 347    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
 348
 349 Known Limitations, Issues and Workarounds
 350 -----------------------------------------
 351
 352 *System Limitations*
 353
 354   - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
 355
 356 *Known Vulnerabilities*
 357
 358 None
 359
 360 *Workarounds*
 361
 362 None
 363
 364 Security Notes
 365 --------------
 366
 367 *Fixed Security Issues*
 368
 369 None
 370
 371 *Known Security Issues*
 372
 373 None
 374
 375 Version: 1.0.0
 376 ==============
 377
 378 Release Data
 379 ------------
 380
 381 +--------------------------------------+--------------------------------------------------------+
 382 | **CPS Project**                      |  DMI-Plugin                                            |
 383 |                                      |                                                        |
 384 +--------------------------------------+--------------------------------------------------------+
 385 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.0                            |
 386 |                                      |                                                        |
 387 +--------------------------------------+--------------------------------------------------------+
 388 | **Release designation**              | 1.0.0 Istanbul                                         |
 389 |                                      |                                                        |
 390 +--------------------------------------+--------------------------------------------------------+
 391 | **Release date**                     | 2021-14-09                                             |
 392 |                                      |                                                        |
 393 +--------------------------------------+--------------------------------------------------------+
 394
 395 Features
 396 --------
 397 * Implement plugin registration.
 398 * Retrieve data from cmHandles using ncmp-datastores passthrough.
 399 * Retrieve Yang Resources from one or more modules of a  CM Handle.
 400
 401 .. _istanbul_deliverable:
 402
 403 Deliverables
 404 ------------
 405
 406 Software Deliverables
 407
 408 .. csv-table::
 409    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 410    :widths: auto
 411
 412    "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
 413
 414 Bug Fixes
 415 ---------
 416
 417    - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
 418    - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
 419    - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
 420
 421 Summary
 422 -------
 423
 424 Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
 425
 426     * Platform components
 427
 428     * Service components
 429
 430     * Additional resources that CPS utilizes deployed using ONAP common charts
 431
 432 Below service components (mS) are available to be deployed on-demand.
 433
 434 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 435
 436 Known Limitations, Issues and Workarounds
 437 -----------------------------------------
 438
 439 *System Limitations*
 440
 441 None
 442
 443 *Known Vulnerabilities*
 444
 445    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 446    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 447
 448 *Workarounds*
 449
 450 None
 451
 452 Security Notes
 453 --------------
 454
 455 *Fixed Security Issues*
 456
 457 None
 458
 459 *Known Security Issues*
 460
 461 None
 462
 463 References
 464 ----------
 465
 466 For more information on the latest ONAP release, please see:
 467
 468 #. `ONAP Home Page`_
 469 #. `ONAP Wiki Page`_
 470 #. `ONAP Documentation`_
 471 #. `ONAP DMI Plugin Documentation`_
 472 #. `ONAP Release Downloads`_
 473
 474
 475 .. _`ONAP Home Page`: https://www.onap.org
 476 .. _`ONAP Wiki Page`: https://wiki.onap.org
 477 .. _`ONAP Documentation`: https://docs.onap.org
 478 .. _`ONAP DMI Plugin Documentation`: https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin
 479 .. _`ONAP Release Downloads`: https://git.onap.org
 480
 481 Quick Links:
 482
 483         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 484         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_