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