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