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