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