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