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