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