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