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-2024 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _release_notes:
   7
   8 CPS Release Notes
   9 #################
  10
  11 .. contents::
  12     :depth: 2
  13 ..
  14
  15 ..      =========================
  16 ..      * * *   NEW DELHI   * * *
  17 ..      =========================
  18
  19 Version: 3.4.2
  20 ==============
  21
  22 Release Data
  23 ------------
  24
  25 +--------------------------------------+--------------------------------------------------------+
  26 | **CPS Project**                      |                                                        |
  27 |                                      |                                                        |
  28 +--------------------------------------+--------------------------------------------------------+
  29 | **Docker images**                    | onap/cps-and-ncmp:3.4.2                                |
  30 |                                      |                                                        |
  31 +--------------------------------------+--------------------------------------------------------+
  32 | **Release designation**              | 3.4.2 New Delhi                                        |
  33 |                                      |                                                        |
  34 +--------------------------------------+--------------------------------------------------------+
  35 | **Release date**                     | Not yet released                                       |
  36 |                                      |                                                        |
  37 +--------------------------------------+--------------------------------------------------------+
  38
  39 Bug Fixes
  40 ---------
  41 3.4.2
  42
  43
  44 Features
  45 --------
  46     - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
  47     - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
  48
  49 Known Limitations, Issues and Workarounds
  50 -----------------------------------------
  51
  52 *System Limitations*
  53
  54 For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
  55 (`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
  56 As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
  57 NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
  58 Other operations (read, update, delete) are not impacted.
  59
  60
  61 Version: 3.4.1
  62 ==============
  63
  64 Release Data
  65 ------------
  66
  67 +--------------------------------------+--------------------------------------------------------+
  68 | **CPS Project**                      |                                                        |
  69 |                                      |                                                        |
  70 +--------------------------------------+--------------------------------------------------------+
  71 | **Docker images**                    | onap/cps-and-ncmp:3.4.1                                |
  72 |                                      |                                                        |
  73 +--------------------------------------+--------------------------------------------------------+
  74 | **Release designation**              | 3.4.1 New Delhi                                        |
  75 |                                      |                                                        |
  76 +--------------------------------------+--------------------------------------------------------+
  77 | **Release date**                     | 2023 December 20                                       |
  78 |                                      |                                                        |
  79 +--------------------------------------+--------------------------------------------------------+
  80
  81 Bug Fixes
  82 ---------
  83 3.4.1
  84     - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
  85
  86 Features
  87 --------
  88     - CPS-Temporal is no longer supported and any related documentation has been removed.
  89     - `CPS-1733 <https://jira.onap.org/browse/CPS-1733>`_ Upgrade YANG schema-set for CM handle without removing and adding it.
  90     - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
  91     - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
  92     - `CPS-2005 <https://jira.onap.org/browse/CPS-2005>`_ Removing notification feature for cps updated events ( exclusively used by cps-temporal )
  93
  94 Known Issues
  95 ------------
  96     - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
  97
  98
  99 Version: 3.4.0
 100 ==============
 101
 102 Release Data
 103 ------------
 104
 105 +--------------------------------------+--------------------------------------------------------+
 106 | **CPS Project**                      |                                                        |
 107 |                                      |                                                        |
 108 +--------------------------------------+--------------------------------------------------------+
 109 | **Docker images**                    | onap/cps-and-ncmp:3.4.0                                |
 110 |                                      |                                                        |
 111 +--------------------------------------+--------------------------------------------------------+
 112 | **Release designation**              | 3.4.0 New Delhi                                        |
 113 |                                      |                                                        |
 114 +--------------------------------------+--------------------------------------------------------+
 115 | **Release date**                     | 2023 November 09                                       |
 116 |                                      |                                                        |
 117 +--------------------------------------+--------------------------------------------------------+
 118
 119 Bug Fixes
 120 ---------
 121 3.4.0
 122     - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
 123
 124 ..      ========================
 125 ..      * * *   MONTREAL   * * *
 126 ..      ========================
 127
 128 Version: 3.3.9
 129 ==============
 130
 131 Release Data
 132 ------------
 133
 134 +--------------------------------------+--------------------------------------------------------+
 135 | **CPS Project**                      |                                                        |
 136 |                                      |                                                        |
 137 +--------------------------------------+--------------------------------------------------------+
 138 | **Docker images**                    | onap/cps-and-ncmp:3.3.9                                |
 139 |                                      |                                                        |
 140 +--------------------------------------+--------------------------------------------------------+
 141 | **Release designation**              | 3.3.9 Montreal                                         |
 142 |                                      |                                                        |
 143 +--------------------------------------+--------------------------------------------------------+
 144 | **Release date**                     | 2023 November 06                                       |
 145 |                                      |                                                        |
 146 +--------------------------------------+--------------------------------------------------------+
 147
 148 Bug Fixes
 149 ---------
 150 3.3.9
 151     - `CPS-1923 <https://jira.onap.org/browse/CPS-1923>`_ CPS and NCMP changed management endpoint and port from /manage to /actuator and port same as cps application port.
 152     - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
 153
 154 Features
 155 --------
 156
 157 Version: 3.3.8
 158 ==============
 159
 160 Release Data
 161 ------------
 162
 163 +--------------------------------------+--------------------------------------------------------+
 164 | **CPS Project**                      |                                                        |
 165 |                                      |                                                        |
 166 +--------------------------------------+--------------------------------------------------------+
 167 | **Docker images**                    | onap/cps-and-ncmp:3.3.8                                |
 168 |                                      |                                                        |
 169 +--------------------------------------+--------------------------------------------------------+
 170 | **Release designation**              | 3.3.8 Montreal                                         |
 171 |                                      |                                                        |
 172 +--------------------------------------+--------------------------------------------------------+
 173 | **Release date**                     | 2023 September 29                                      |
 174 |                                      |                                                        |
 175 +--------------------------------------+--------------------------------------------------------+
 176
 177 Bug Fixes
 178 ---------
 179 3.3.8
 180
 181 Features
 182 --------
 183     - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
 184
 185 Version: 3.3.7
 186 ==============
 187
 188 Release Data
 189 ------------
 190
 191 +--------------------------------------+--------------------------------------------------------+
 192 | **CPS Project**                      |                                                        |
 193 |                                      |                                                        |
 194 +--------------------------------------+--------------------------------------------------------+
 195 | **Docker images**                    | onap/cps-and-ncmp:3.3.7                                |
 196 |                                      |                                                        |
 197 +--------------------------------------+--------------------------------------------------------+
 198 | **Release designation**              | 3.3.7 Montreal                                         |
 199 |                                      |                                                        |
 200 +--------------------------------------+--------------------------------------------------------+
 201 | **Release date**                     | 2023 September 20                                      |
 202 |                                      |                                                        |
 203 +--------------------------------------+--------------------------------------------------------+
 204
 205 Bug Fixes
 206 ---------
 207 3.3.7
 208     - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
 209
 210 Features
 211 --------
 212     - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
 213
 214 Note
 215 ----
 216 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
 217
 218 Version: 3.3.6
 219 ==============
 220
 221 Release Data
 222 ------------
 223
 224 +--------------------------------------+--------------------------------------------------------+
 225 | **CPS Project**                      |                                                        |
 226 |                                      |                                                        |
 227 +--------------------------------------+--------------------------------------------------------+
 228 | **Docker images**                    | onap/cps-and-ncmp:3.3.6                                |
 229 |                                      |                                                        |
 230 +--------------------------------------+--------------------------------------------------------+
 231 | **Release designation**              | 3.3.6 Montreal                                         |
 232 |                                      |                                                        |
 233 +--------------------------------------+--------------------------------------------------------+
 234 | **Release date**                     | 2023 August 23                                         |
 235 |                                      |                                                        |
 236 +--------------------------------------+--------------------------------------------------------+
 237
 238 Bug Fixes
 239 ---------
 240 3.3.6
 241     - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
 242     - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
 243
 244 Features
 245 --------
 246     - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
 247     - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
 248
 249
 250 Version: 3.3.5
 251 ==============
 252
 253 Release Data
 254 ------------
 255
 256 +--------------------------------------+--------------------------------------------------------+
 257 | **CPS Project**                      |                                                        |
 258 |                                      |                                                        |
 259 +--------------------------------------+--------------------------------------------------------+
 260 | **Docker images**                    | onap/cps-and-ncmp:3.3.5                                |
 261 |                                      |                                                        |
 262 +--------------------------------------+--------------------------------------------------------+
 263 | **Release designation**              | 3.3.5 Montreal                                         |
 264 |                                      |                                                        |
 265 +--------------------------------------+--------------------------------------------------------+
 266 | **Release date**                     | 2023 July 21                                           |
 267 |                                      |                                                        |
 268 +--------------------------------------+--------------------------------------------------------+
 269
 270 Bug Fixes
 271 ---------
 272 3.3.5
 273
 274 Features
 275 --------
 276     - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
 277
 278 Version: 3.3.4
 279 ==============
 280
 281 Release Data
 282 ------------
 283
 284 +--------------------------------------+--------------------------------------------------------+
 285 | **CPS Project**                      |                                                        |
 286 |                                      |                                                        |
 287 +--------------------------------------+--------------------------------------------------------+
 288 | **Docker images**                    | onap/cps-and-ncmp:3.3.4                                |
 289 |                                      |                                                        |
 290 +--------------------------------------+--------------------------------------------------------+
 291 | **Release designation**              | 3.3.4 Montreal                                         |
 292 |                                      |                                                        |
 293 +--------------------------------------+--------------------------------------------------------+
 294 | **Release date**                     | 2023 July 19                                           |
 295 |                                      |                                                        |
 296 +--------------------------------------+--------------------------------------------------------+
 297
 298 Bug Fixes
 299 ---------
 300 3.3.4
 301
 302 Features
 303 --------
 304     - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
 305
 306 Version: 3.3.3
 307 ==============
 308
 309 Release Data
 310 ------------
 311
 312 +--------------------------------------+--------------------------------------------------------+
 313 | **CPS Project**                      |                                                        |
 314 |                                      |                                                        |
 315 +--------------------------------------+--------------------------------------------------------+
 316 | **Docker images**                    | onap/cps-and-ncmp:3.3.3                                |
 317 |                                      |                                                        |
 318 +--------------------------------------+--------------------------------------------------------+
 319 | **Release designation**              | 3.3.3 Montreal                                         |
 320 |                                      |                                                        |
 321 +--------------------------------------+--------------------------------------------------------+
 322 | **Release date**                     | 2023 June 30                                           |
 323 |                                      |                                                        |
 324 +--------------------------------------+--------------------------------------------------------+
 325
 326 Bug Fixes
 327 ---------
 328 3.3.3
 329
 330 Features
 331 --------
 332     - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
 333     - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
 334     - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
 335
 336 Version: 3.3.2
 337 ==============
 338
 339 Release Data
 340 ------------
 341
 342 +--------------------------------------+--------------------------------------------------------+
 343 | **CPS Project**                      |                                                        |
 344 |                                      |                                                        |
 345 +--------------------------------------+--------------------------------------------------------+
 346 | **Docker images**                    | onap/cps-and-ncmp:3.3.2                                |
 347 |                                      |                                                        |
 348 +--------------------------------------+--------------------------------------------------------+
 349 | **Release designation**              | 3.3.2 Montreal                                         |
 350 |                                      |                                                        |
 351 +--------------------------------------+--------------------------------------------------------+
 352 | **Release date**                     | 2023 June 15                                           |
 353 |                                      |                                                        |
 354 +--------------------------------------+--------------------------------------------------------+
 355
 356 Bug Fixes
 357 ---------
 358 3.3.2
 359     - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
 360
 361 Features
 362 --------
 363     - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
 364     - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
 365     - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
 366     - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
 367     - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
 368
 369 Version: 3.3.1
 370 ==============
 371
 372 Release Data
 373 ------------
 374
 375 +--------------------------------------+--------------------------------------------------------+
 376 | **CPS Project**                      |                                                        |
 377 |                                      |                                                        |
 378 +--------------------------------------+--------------------------------------------------------+
 379 | **Docker images**                    | onap/cps-and-ncmp:3.3.1                                |
 380 |                                      |                                                        |
 381 +--------------------------------------+--------------------------------------------------------+
 382 | **Release designation**              | 3.3.1 Montreal                                         |
 383 |                                      |                                                        |
 384 +--------------------------------------+--------------------------------------------------------+
 385 | **Release date**                     | 2023 May 03                                            |
 386 |                                      |                                                        |
 387 +--------------------------------------+--------------------------------------------------------+
 388
 389 Bug Fixes
 390 ---------
 391 3.3.1
 392     - None
 393
 394 Features
 395 --------
 396     - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
 397     - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
 398     - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
 399     - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
 400     - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
 401
 402 Version: 3.3.0
 403 ==============
 404
 405 Release Data
 406 ------------
 407
 408 +--------------------------------------+--------------------------------------------------------+
 409 | **CPS Project**                      |                                                        |
 410 |                                      |                                                        |
 411 +--------------------------------------+--------------------------------------------------------+
 412 | **Docker images**                    | onap/cps-and-ncmp:3.3.0                                |
 413 |                                      |                                                        |
 414 +--------------------------------------+--------------------------------------------------------+
 415 | **Release designation**              | 3.3.0 Montreal                                         |
 416 |                                      |                                                        |
 417 +--------------------------------------+--------------------------------------------------------+
 418 | **Release date**                     | 2023 April 20                                          |
 419 |                                      |                                                        |
 420 +--------------------------------------+--------------------------------------------------------+
 421
 422 Bug Fixes
 423 ---------
 424 3.3.0
 425     - None
 426
 427 Features
 428 --------
 429     - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
 430     - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
 431
 432 ..      ======================
 433 ..      * * *   LONDON   * * *
 434 ..      ======================
 435
 436 Version: 3.2.6
 437 ==============
 438
 439 Release Data
 440 ------------
 441
 442 +--------------------------------------+--------------------------------------------------------+
 443 | **CPS Project**                      |                                                        |
 444 |                                      |                                                        |
 445 +--------------------------------------+--------------------------------------------------------+
 446 | **Docker images**                    | onap/cps-and-ncmp:3.2.6                                |
 447 |                                      |                                                        |
 448 +--------------------------------------+--------------------------------------------------------+
 449 | **Release designation**              | 3.2.6 London                                           |
 450 |                                      |                                                        |
 451 +--------------------------------------+--------------------------------------------------------+
 452 | **Release date**                     | 2023 March 22                                          |
 453 |                                      |                                                        |
 454 +--------------------------------------+--------------------------------------------------------+
 455
 456 Bug Fixes
 457 ---------
 458 3.2.6
 459     - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
 460     - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
 461
 462 Features
 463 --------
 464     - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
 465
 466 Version: 3.2.5
 467 ==============
 468
 469 Release Data
 470 ------------
 471
 472 +--------------------------------------+--------------------------------------------------------+
 473 | **CPS Project**                      |                                                        |
 474 |                                      |                                                        |
 475 +--------------------------------------+--------------------------------------------------------+
 476 | **Docker images**                    | onap/cps-and-ncmp:3.2.5                                |
 477 |                                      |                                                        |
 478 +--------------------------------------+--------------------------------------------------------+
 479 | **Release designation**              | 3.2.5 London                                           |
 480 |                                      |                                                        |
 481 +--------------------------------------+--------------------------------------------------------+
 482 | **Release date**                     | 2023 March 10                                          |
 483 |                                      |                                                        |
 484 +--------------------------------------+--------------------------------------------------------+
 485
 486 Bug Fixes
 487 ---------
 488 3.2.5
 489     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
 490
 491 Features
 492 --------
 493     - None
 494
 495 Version: 3.2.4
 496 ==============
 497
 498 Release Data
 499 ------------
 500
 501 +--------------------------------------+--------------------------------------------------------+
 502 | **CPS Project**                      |                                                        |
 503 |                                      |                                                        |
 504 +--------------------------------------+--------------------------------------------------------+
 505 | **Docker images**                    | onap/cps-and-ncmp:3.2.4                                |
 506 |                                      |                                                        |
 507 +--------------------------------------+--------------------------------------------------------+
 508 | **Release designation**              | 3.2.4 London                                           |
 509 |                                      |                                                        |
 510 +--------------------------------------+--------------------------------------------------------+
 511 | **Release date**                     | 2023 March 09                                          |
 512 |                                      |                                                        |
 513 +--------------------------------------+--------------------------------------------------------+
 514
 515 Bug Fixes
 516 ---------
 517 3.2.4
 518     - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
 519     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
 520
 521 Features
 522 --------
 523     - None
 524
 525 Version: 3.2.3
 526 ==============
 527
 528 Release Data
 529 ------------
 530
 531 +--------------------------------------+--------------------------------------------------------+
 532 | **CPS Project**                      |                                                        |
 533 |                                      |                                                        |
 534 +--------------------------------------+--------------------------------------------------------+
 535 | **Docker images**                    | onap/cps-and-ncmp:3.2.3                                |
 536 |                                      |                                                        |
 537 +--------------------------------------+--------------------------------------------------------+
 538 | **Release designation**              | 3.2.3 London                                           |
 539 |                                      |                                                        |
 540 +--------------------------------------+--------------------------------------------------------+
 541 | **Release date**                     | 2023 March 07                                          |
 542 |                                      |                                                        |
 543 +--------------------------------------+--------------------------------------------------------+
 544
 545 Bug Fixes
 546 ---------
 547 3.2.3
 548    - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
 549
 550 Features
 551 --------
 552     - `CPS-1401 <https://jira.onap.org/browse/CPS-1401>`_ Added V2 of Get Data Node API,support to retrieve all data nodes under an anchor
 553     - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
 554
 555 Version: 3.2.2
 556 ==============
 557
 558 Release Data
 559 ------------
 560
 561 +--------------------------------------+--------------------------------------------------------+
 562 | **CPS Project**                      |                                                        |
 563 |                                      |                                                        |
 564 +--------------------------------------+--------------------------------------------------------+
 565 | **Docker images**                    | onap/cps-and-ncmp:3.2.2                                |
 566 |                                      |                                                        |
 567 +--------------------------------------+--------------------------------------------------------+
 568 | **Release designation**              | 3.2.2 London                                           |
 569 |                                      |                                                        |
 570 +--------------------------------------+--------------------------------------------------------+
 571 | **Release date**                     | 2023 February 08                                       |
 572 |                                      |                                                        |
 573 +--------------------------------------+--------------------------------------------------------+
 574
 575 Bug Fixes
 576 ---------
 577 3.2.2
 578    - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_  Delete Performance Improvements.
 579
 580 Features
 581 --------
 582    - None
 583
 584 Version: 3.2.1
 585 ==============
 586
 587 Release Data
 588 ------------
 589
 590 +--------------------------------------+--------------------------------------------------------+
 591 | **CPS Project**                      |                                                        |
 592 |                                      |                                                        |
 593 +--------------------------------------+--------------------------------------------------------+
 594 | **Docker images**                    | onap/cps-and-ncmp:3.2.1                                |
 595 |                                      |                                                        |
 596 +--------------------------------------+--------------------------------------------------------+
 597 | **Release designation**              | 3.2.1 London                                           |
 598 |                                      |                                                        |
 599 +--------------------------------------+--------------------------------------------------------+
 600 | **Release date**                     | 2023 January 27                                        |
 601 |                                      |                                                        |
 602 +--------------------------------------+--------------------------------------------------------+
 603
 604 Features
 605 --------
 606 3.2.1
 607    - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_  Added support for multiple data tree instances under 1 anchor.
 608    - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_  Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
 609    - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_  Upgrade Opendaylight
 610    - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_  Get all dataspaces.
 611    - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_  Get single dataspace.
 612    - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_  Added API to get all schema sets for a given dataspace.
 613    - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_  DMI audit support for NCMP: Filter on any properties of CM Handles
 614    - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_  Added support for application/xml Content-Type (write only).
 615    - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_  Query large outputs using limit/depth/pagination
 616    - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_  Optimized query for large number of hits with descendants.
 617    - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_  Fetch CM handles by collection of xpaths (CPS Core)
 618    - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_  Updating CmHandleStates using batch operation
 619    - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_  Use native query to delete data nodes
 620
 621 Bug Fixes
 622 ---------
 623 3.2.1
 624    - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_  Optimized retrieval of data nodes with many descendants.
 625    - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_  Hazelcast TTL for IMap is not working
 626    - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_  Getting wrong error code for create node api
 627    - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_  Creation of DataNodeBuilder with module name prefix is very slow
 628    - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_  Top level container (prefix) is not always the first module
 629    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
 630    - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_  Handle YangChoiceNode in right format.
 631    - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_  Fix Delete uses case with '/' in path.
 632    - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_  Fix to allow posting data with '/' key fields.
 633    - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_  CPS PATCH operation does not merge existing data
 634    - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_  Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
 635    - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_  CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
 636    - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_  CpsDataPersistenceService#getDataNodes does not handle root xpath
 637    - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_  CPS Path Processing Performance Test duration is too low
 638
 639 3.2.0
 640    - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_  CPS(/NCMP) does not have version control.
 641
 642 Known Limitations, Issues and Workarounds
 643 -----------------------------------------
 644
 645 *System Limitations*
 646
 647 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
 648 This is from commit CPS-506: List all known modules and revision to CPS-1312: Default CMHandles to READY during upgrade or from ONAP release Honolulu to Kohn.
 649
 650 CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
 651 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
 652
 653 ..      ====================
 654 ..      * * *   KOHN   * * *
 655 ..      ====================
 656
 657 Version: 3.1.4
 658 ==============
 659
 660 Release Data
 661 ------------
 662
 663 +--------------------------------------+--------------------------------------------------------+
 664 | **CPS Project**                      |                                                        |
 665 |                                      |                                                        |
 666 +--------------------------------------+--------------------------------------------------------+
 667 | **Docker images**                    | onap/cps-and-ncmp:3.1.4                                |
 668 |                                      |                                                        |
 669 +--------------------------------------+--------------------------------------------------------+
 670 | **Release designation**              | 3.1.4 Kohn                                             |
 671 |                                      |                                                        |
 672 +--------------------------------------+--------------------------------------------------------+
 673 | **Release date**                     | 2022 October 5                                         |
 674 |                                      |                                                        |
 675 +--------------------------------------+--------------------------------------------------------+
 676
 677 Bug Fixes
 678 ---------
 679    - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_  Revision field should not be required (NotNull) on cps-ri YangResourceEntity
 680    - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_  Kafka communication fault caused cmHandle registration error
 681
 682 Version: 3.1.3
 683 ==============
 684
 685 Release Data
 686 ------------
 687
 688 +--------------------------------------+--------------------------------------------------------+
 689 | **CPS Project**                      |                                                        |
 690 |                                      |                                                        |
 691 +--------------------------------------+--------------------------------------------------------+
 692 | **Docker images**                    | onap/cps-and-ncmp:3.1.3                                |
 693 |                                      |                                                        |
 694 +--------------------------------------+--------------------------------------------------------+
 695 | **Release designation**              | 3.1.3 Kohn                                             |
 696 |                                      |                                                        |
 697 +--------------------------------------+--------------------------------------------------------+
 698 | **Release date**                     | 2022 September 29                                      |
 699 |                                      |                                                        |
 700 +--------------------------------------+--------------------------------------------------------+
 701
 702 Bug Fixes
 703 ---------
 704    - None
 705
 706 Version: 3.1.2
 707 ==============
 708
 709 Release Data
 710 ------------
 711
 712 +--------------------------------------+--------------------------------------------------------+
 713 | **CPS Project**                      |                                                        |
 714 |                                      |                                                        |
 715 +--------------------------------------+--------------------------------------------------------+
 716 | **Docker images**                    | onap/cps-and-ncmp:3.1.2                                |
 717 |                                      |                                                        |
 718 +--------------------------------------+--------------------------------------------------------+
 719 | **Release designation**              | 3.1.2 Kohn                                             |
 720 |                                      |                                                        |
 721 +--------------------------------------+--------------------------------------------------------+
 722 | **Release date**                     | 2022 September 28                                      |
 723 |                                      |                                                        |
 724 +--------------------------------------+--------------------------------------------------------+
 725
 726 Bug Fixes
 727 ---------
 728    - None
 729
 730 Version: 3.1.1
 731 ==============
 732
 733 Release Data
 734 ------------
 735
 736 +--------------------------------------+--------------------------------------------------------+
 737 | **CPS Project**                      |                                                        |
 738 |                                      |                                                        |
 739 +--------------------------------------+--------------------------------------------------------+
 740 | **Docker images**                    | onap/cps-and-ncmp:3.1.1                                |
 741 |                                      |                                                        |
 742 +--------------------------------------+--------------------------------------------------------+
 743 | **Release designation**              | 3.1.1 Kohn                                             |
 744 |                                      |                                                        |
 745 +--------------------------------------+--------------------------------------------------------+
 746 | **Release date**                     | 2022 September 28                                      |
 747 |                                      |                                                        |
 748 +--------------------------------------+--------------------------------------------------------+
 749
 750 Bug Fixes
 751 ---------
 752    - None
 753
 754 Security Notes
 755 --------------
 756
 757 *Fixed Security Issues*
 758
 759    - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_  Security bug in the logs
 760
 761 Version: 3.1.0
 762 ==============
 763
 764 Release Data
 765 ------------
 766
 767 +--------------------------------------+--------------------------------------------------------+
 768 | **CPS Project**                      |                                                        |
 769 |                                      |                                                        |
 770 +--------------------------------------+--------------------------------------------------------+
 771 | **Docker images**                    | onap/cps-and-ncmp:3.1.0                                |
 772 |                                      |                                                        |
 773 +--------------------------------------+--------------------------------------------------------+
 774 | **Release designation**              | 3.1.0 Kohn                                             |
 775 |                                      |                                                        |
 776 +--------------------------------------+--------------------------------------------------------+
 777 | **Release date**                     | 2022 September 14                                      |
 778 |                                      |                                                        |
 779 +--------------------------------------+--------------------------------------------------------+
 780
 781 Features
 782 --------
 783    - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_  Patch and update the root data node
 784    - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
 785    - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_  Query based on Public CM Properties
 786    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
 787    - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_  Async: Internal message topic incl. basic producer & Consumer
 788    - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_  DMI-NCMP Asynchronously Publish Response Event to Client Topic
 789    - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_  Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
 790    - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_  Align CPS-Core output with SDN-C output (add module name)
 791    - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_  CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
 792    - `CPS-877 <https://jira.onap.org/browse/CPS-877>`_  CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY'
 793    - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_  Start and stop sessions on Java API
 794    - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_  Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
 795    - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_  Structured Errors response for passthrough use-cases in NCMP
 796    - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_  Update maven deploy plugin version
 797    - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_  Query CM Handles using CpsPath
 798    - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_  Create Data Synchronization watchdog
 799    - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_  Merge 2 'query' end points in NCMP
 800    - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_  Publish lifecycle events for ADVISED , READY and LOCKED state transition"
 801    - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_  Support retrieval of YANG module sources for CM handle on the NCMP interface
 802    - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_  Expose simplified 'external' lock reason enum state over REST interface
 803    - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_  Introducing the DELETING and DELETED Cmhandle State
 804    - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_  Register the Cmhandle Sends Advised State notification.
 805    - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_  Enable/Disable Data Sync for Cm Handle
 806    - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_  DMI Audit Support (get all CM Handles for a registered DMI)
 807
 808
 809 Bug Fixes
 810 ---------
 811    - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_  CM Handle Registration Process only partially completes when exception is thrown
 812    - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_  NCMP: fix getResourceDataForPassthroughOperational endpoint
 813    - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_  DuplicatedYangResourceException error at parallel cmHandle registration
 814    - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_  Wrong error response format in case of Dmi plugin error
 815    - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_  NCMP returns 500 error on searches endpoint when No DMI Handles registered
 816    - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_  Performance degradation on ncmp/v1/ch/searches endpoint
 817    - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_  Kafka consumer can not be turned off
 818    - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_  Unable to change state from LOCKED to ADVISED
 819    - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_  CmHandle creation performance degradation
 820    - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_  Incorrect response when empty body executed for cmhandle id-searches
 821    - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_  Node API - GET method returns invalid response when identifier contains '/'
 822    - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_  Additional Properties for CM Handles not included when send to DMI Plugin
 823    - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_  Searches endpoint gives back empty list however there are already available cmhandles
 824    - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_  NCMP logs are flooded with SyncUtils logs
 825
 826 Known Limitations, Issues and Workarounds
 827 -----------------------------------------
 828
 829 *System Limitations*
 830
 831 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
 832 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
 833
 834 *Known Vulnerabilities*
 835
 836 None
 837
 838 *Workarounds*
 839
 840 None
 841
 842 Security Notes
 843 --------------
 844
 845 *Fixed Security Issues*
 846
 847    - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_  Liquibase has got serious vulnerability, upgrade required
 848
 849 *Known Security Issues*
 850
 851 None
 852
 853 ..      ========================
 854 ..      * * *   JAKARTA   * * *
 855 ..      ========================
 856
 857 Version: 3.0.1
 858 ==============
 859
 860 Release Data
 861 ------------
 862
 863 +--------------------------------------+--------------------------------------------------------+
 864 | **CPS Project**                      |                                                        |
 865 |                                      |                                                        |
 866 +--------------------------------------+--------------------------------------------------------+
 867 | **Docker images**                    | onap/cps-and-ncmp:3.0.1                                |
 868 |                                      |                                                        |
 869 +--------------------------------------+--------------------------------------------------------+
 870 | **Release designation**              | 3.0.1 Jakarta                                          |
 871 |                                      |                                                        |
 872 +--------------------------------------+--------------------------------------------------------+
 873 | **Release date**                     | 2022 April 28                                          |
 874 |                                      |                                                        |
 875 +--------------------------------------+--------------------------------------------------------+
 876
 877 Bug Fixes
 878 ---------
 879    - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_  Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
 880
 881 Version: 3.0.0
 882 ==============
 883
 884 Release Data
 885 ------------
 886
 887 +--------------------------------------+--------------------------------------------------------+
 888 | **CPS Project**                      |                                                        |
 889 |                                      |                                                        |
 890 +--------------------------------------+--------------------------------------------------------+
 891 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
 892 |                                      |                                                        |
 893 +--------------------------------------+--------------------------------------------------------+
 894 | **Release designation**              | 3.0.0 Jakarta                                          |
 895 |                                      |                                                        |
 896 +--------------------------------------+--------------------------------------------------------+
 897 | **Release date**                     | 2022 March 15                                          |
 898 |                                      |                                                        |
 899 +--------------------------------------+--------------------------------------------------------+
 900
 901 Features
 902 --------
 903    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
 904    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
 905    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
 906    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
 907    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
 908    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
 909    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
 910    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
 911    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
 912    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
 913    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
 914
 915 Bug Fixes
 916 ---------
 917
 918    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
 919    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
 920    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
 921    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 922    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
 923    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
 924    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
 925    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
 926    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
 927    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
 928
 929 Known Limitations, Issues and Workarounds
 930 -----------------------------------------
 931
 932 *System Limitations*
 933
 934 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
 935 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
 936 of cm handle registration.
 937
 938 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
 939 for more information.
 940
 941 *Known Vulnerabilities*
 942
 943 None
 944
 945 *Workarounds*
 946
 947 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
 948 pass an empty string as the value if you do not want to include names for these values.
 949
 950 Security Notes
 951 --------------
 952
 953 *Fixed Security Issues*
 954
 955 None
 956
 957 *Known Security Issues*
 958
 959 None
 960
 961 ..      ========================
 962 ..      * * *   ISTANBUL   * * *
 963 ..      ========================
 964
 965 Version: 2.0.4
 966 ==============
 967
 968 Release Data
 969 ------------
 970
 971 +--------------------------------------+--------------------------------------------------------+
 972 | **CPS Project**                      |                                                        |
 973 |                                      |                                                        |
 974 +--------------------------------------+--------------------------------------------------------+
 975 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
 976 |                                      |                                                        |
 977 +--------------------------------------+--------------------------------------------------------+
 978 | **Release designation**              | 2.0.4 Istanbul                                         |
 979 |                                      |                                                        |
 980 +--------------------------------------+--------------------------------------------------------+
 981 | **Release date**                     | 2022 Feb 09                                            |
 982 |                                      |                                                        |
 983 +--------------------------------------+--------------------------------------------------------+
 984
 985 Bug Fixes
 986 ---------
 987
 988    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
 989    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
 990
 991 Version: 2.0.3
 992 ==============
 993
 994 Release Data
 995 ------------
 996
 997 +--------------------------------------+--------------------------------------------------------+
 998 | **CPS Project**                      |                                                        |
 999 |                                      |                                                        |
1000 +--------------------------------------+--------------------------------------------------------+
1001 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
1002 |                                      |                                                        |
1003 +--------------------------------------+--------------------------------------------------------+
1004 | **Release designation**              | 2.0.3 Istanbul                                         |
1005 |                                      |                                                        |
1006 +--------------------------------------+--------------------------------------------------------+
1007 | **Release date**                     | 2022-07-01                                             |
1008 |                                      |                                                        |
1009 +--------------------------------------+--------------------------------------------------------+
1010
1011 Bug Fixes
1012 ---------
1013
1014    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
1015
1016 Version: 2.0.2
1017 ==============
1018
1019 Release Data
1020 ------------
1021
1022 +--------------------------------------+--------------------------------------------------------+
1023 | **CPS Project**                      |                                                        |
1024 |                                      |                                                        |
1025 +--------------------------------------+--------------------------------------------------------+
1026 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
1027 |                                      |                                                        |
1028 +--------------------------------------+--------------------------------------------------------+
1029 | **Release designation**              | 2.0.2 Istanbul                                         |
1030 |                                      |                                                        |
1031 +--------------------------------------+--------------------------------------------------------+
1032 | **Release date**                     | 2021-16-12                                             |
1033 |                                      |                                                        |
1034 +--------------------------------------+--------------------------------------------------------+
1035
1036 Bug Fixes
1037 ---------
1038
1039    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
1040
1041 Version: 2.0.1
1042 ==============
1043
1044 Release Data
1045 ------------
1046
1047 +--------------------------------------+--------------------------------------------------------+
1048 | **CPS Project**                      |                                                        |
1049 |                                      |                                                        |
1050 +--------------------------------------+--------------------------------------------------------+
1051 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
1052 |                                      |                                                        |
1053 +--------------------------------------+--------------------------------------------------------+
1054 | **Release designation**              | 2.0.1 Istanbul                                         |
1055 |                                      |                                                        |
1056 +--------------------------------------+--------------------------------------------------------+
1057 | **Release date**                     | 2021-14-10                                             |
1058 |                                      |                                                        |
1059 +--------------------------------------+--------------------------------------------------------+
1060
1061 Bug Fixes
1062 ---------
1063
1064    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1065    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1066    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1067    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1068
1069 Known Limitations, Issues and Workarounds
1070 -----------------------------------------
1071
1072 *System Limitations*
1073
1074 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1075
1076 *Known Vulnerabilities*
1077
1078    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1079
1080 *Workarounds*
1081
1082 Add recursive method to save list node data to loop through all corresponding child nodes.
1083
1084 Security Notes
1085 --------------
1086
1087 *Fixed Security Issues*
1088
1089    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1090
1091 *Known Security Issues*
1092
1093 None
1094
1095 Version: 2.0.0
1096 ==============
1097
1098 Abstract
1099 --------
1100
1101 This document provides the release notes for Istanbul release.
1102
1103 Release Data
1104 ------------
1105
1106 +--------------------------------------+--------------------------------------------------------+
1107 | **CPS Project**                      |                                                        |
1108 |                                      |                                                        |
1109 +--------------------------------------+--------------------------------------------------------+
1110 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
1111 |                                      |                                                        |
1112 +--------------------------------------+--------------------------------------------------------+
1113 | **Release designation**              | 2.0.0 Istanbul                                         |
1114 |                                      |                                                        |
1115 +--------------------------------------+--------------------------------------------------------+
1116 | **Release date**                     | 2021-14-09                                             |
1117 |                                      |                                                        |
1118 +--------------------------------------+--------------------------------------------------------+
1119
1120 Features
1121 --------
1122 * Register DMI-Plugins with NCMP for CM Handle registrations.
1123 * Update, Create and Remove CM Handles.
1124 * Add support for retrieving and writing CM Handle data through NCMP datastores.
1125 * Automatic retrieval and caching of model information for CM Handles within NCMP.
1126
1127 Deliverables
1128 ------------
1129
1130 Software Deliverables
1131
1132 .. csv-table::
1133    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1134    :widths: auto
1135
1136    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1137
1138 Bug Fixes
1139 ---------
1140
1141    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1142    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1143    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1144    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1145    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1146    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1147    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1148    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1149    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1150    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1151    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1152    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1153    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1154    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1155    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1156    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1157    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1158    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1159    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1160    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1161    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1162    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1163    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1164    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1165    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1166    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1167
1168 This document provides the release notes for Istanbul release.
1169
1170 Summary
1171 -------
1172
1173 Following CPS components are available with default ONAP/CPS installation.
1174
1175
1176     * Platform components
1177
1178         - CPS (Helm charts)
1179
1180     * Service components
1181
1182         - CPS-NCMP
1183         - DMI-Plugin
1184
1185     * Additional resources that CPS utilizes deployed using ONAP common charts
1186
1187         - Postgres Database
1188
1189
1190 Below service components (mS) are available to be deployed on-demand.
1191     - CPS-TBDMT
1192
1193
1194 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1195
1196 Known Limitations, Issues and Workarounds
1197 -----------------------------------------
1198
1199 *System Limitations*
1200
1201 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1202
1203 *Known Vulnerabilities*
1204
1205    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1206    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1207    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1208
1209 *Workarounds*
1210
1211 Add recursive method to save list node data to loop through all corresponding child nodes.
1212
1213 Security Notes
1214 --------------
1215
1216 *Fixed Security Issues*
1217
1218    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1219
1220 *Known Security Issues*
1221
1222    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1223
1224 Test Results
1225 ------------
1226     * `Integration tests`
1227
1228 ..      ========================
1229 ..      * * *   HONOLULU   * * *
1230 ..      ========================
1231
1232 Version: 1.0.1
1233 ==============
1234
1235 Release Data
1236 ------------
1237
1238 +--------------------------------------+--------------------------------------------------------+
1239 | **CPS Project**                      |                                                        |
1240 |                                      |                                                        |
1241 +--------------------------------------+--------------------------------------------------------+
1242 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
1243 |                                      |                                                        |
1244 +--------------------------------------+--------------------------------------------------------+
1245 | **Release designation**              | 1.0.1 Honolulu                                         |
1246 |                                      |                                                        |
1247 +--------------------------------------+--------------------------------------------------------+
1248 | **Release date**                     | 2021-04-09                                             |
1249 |                                      |                                                        |
1250 +--------------------------------------+--------------------------------------------------------+
1251
1252 Bug Fixes
1253 ---------
1254
1255    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1256    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1257    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1258    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1259    - `CPS-292 <https://jira.onap.org/browse/CPS-292>`_ Detailed information is missing to explain why data is not compliant with the specified YANG model
1260    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1261    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1262    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1263
1264 Security Notes
1265 --------------
1266
1267 *Fixed Security Issues*
1268
1269    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1270
1271 *Known Security Issues*
1272
1273    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1274
1275 Version: 1.0.0
1276 ==============
1277
1278
1279 Abstract
1280 --------
1281
1282 This document provides the release notes for Honolulu release.
1283
1284 Summary
1285 -------
1286
1287 Following CPS components are available with default ONAP/CPS installation.
1288
1289
1290     * Platform components
1291
1292         - CPS (Helm charts)
1293
1294     * Service components
1295
1296         - CPS Core
1297
1298     * Additional resources that CPS utilizes deployed using ONAP common charts
1299
1300         - Postgres Database
1301
1302
1303 Below service components (mS) are available to be deployed on-demand.
1304     - CPS-TBDMT
1305
1306
1307 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1308
1309
1310 Release Data
1311 ------------
1312
1313 +--------------------------------------+--------------------------------------------------------+
1314 | **CPS Project**                      |                                                        |
1315 |                                      |                                                        |
1316 +--------------------------------------+--------------------------------------------------------+
1317 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
1318 |                                      |                                                        |
1319 +--------------------------------------+--------------------------------------------------------+
1320 | **Release designation**              | 1.0.0 Honolulu                                         |
1321 |                                      |                                                        |
1322 +--------------------------------------+--------------------------------------------------------+
1323 | **Release date**                     | 2021-03-11                                             |
1324 |                                      |                                                        |
1325 +--------------------------------------+--------------------------------------------------------+
1326
1327
1328 Features
1329 --------
1330 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1331 CPS has been driven by the needs of the E2E Networking Slicing use case.
1332 It currently supports basic (rw) persistence and simple queries.
1333 It also provides MVP support for network data access using simulated data.
1334
1335 .. _honolulu_deliverable:
1336
1337 Deliverables
1338 ------------
1339
1340 Software Deliverables
1341
1342 .. csv-table::
1343    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1344    :widths: auto
1345
1346    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1347
1348
1349 Known Limitations, Issues and Workarounds
1350 -----------------------------------------
1351
1352    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1353    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1354    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1355    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
1356
1357 *System Limitations*
1358
1359 None
1360
1361 *Known Vulnerabilities*
1362
1363 None
1364
1365 *Workarounds*
1366
1367 Documented under corresponding jira if applicable.
1368
1369 Security Notes
1370 --------------
1371
1372 *Fixed Security Issues*
1373
1374 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1375     - Upgrade org.onap.oparent to 3.2.0
1376     - Upgrade spring.boot to 2.3.8.RELEASE
1377     - Upgrade yangtools to 5.0.7
1378
1379 *Known Security Issues*
1380
1381     * Weak Cryptography using md5
1382     * Risk seen in Zip file expansion
1383
1384 *Known Vulnerabilities in Used Modules*
1385
1386     None
1387
1388 CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
1389
1390 Test Results
1391 ------------
1392     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1393
1394 References
1395 ----------
1396
1397 For more information on the latest ONAP release, please see:
1398
1399 #. `ONAP Home Page`_
1400 #. `ONAP Wiki Page`_
1401 #. `ONAP Documentation`_
1402 #. `ONAP CPS Documentation`_
1403 #. `ONAP Release Downloads`_
1404
1405
1406 .. _`ONAP Home Page`: https://www.onap.org
1407 .. _`ONAP Wiki Page`: https://wiki.onap.org
1408 .. _`ONAP Documentation`: https://docs.onap.org
1409 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1410 .. _`ONAP Release Downloads`: https://git.onap.org
1411
1412 Quick Links:
1413
1414         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1415         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_