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