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