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