docs/sections/release-notes.rst

   1 ..
   2  This work is licensed under a Creative Commons Attribution 4.0
   3  International License.
   4 .. _release_notes:
   5
   6 =============
   7 Release Notes
   8 =============
   9
  10
  11 ..      ===========================
  12 ..      * * *   ISTANBUL  * * *
  13 ..      ===========================
  14
  15 Abstract
  16 ========
  17
  18 This document provides the release notes for the Istanbul release.
  19
  20 Summary
  21 =======
  22
  23
  24 Release Data
  25 ============
  26
  27
  28 +--------------------------------------+--------------------------------------+
  29 | **OOF Project**                      |                                      |
  30 |                                      |                                      |
  31 +--------------------------------------+--------------------------------------+
  32 | **Docker images**                    |   optf-osdf 3.0.6                    |
  33 |                                      |                                      |
  34 |                                      |                                      |
  35 +--------------------------------------+--------------------------------------+
  36 | **Release designation**              | 8.0.0 istanbul                       |
  37 |                                      |                                      |
  38 +--------------------------------------+--------------------------------------+
  39 | **Release date**                     | 28/10/2021 (TBD)                     |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42
  43
  44 New features
  45 ------------
  46
  47 - Enhancements in NxI termination to support second level NSSIs
  48 - Update NxI termination app to use AAI DSL query
  49 - Add CPS client for PCI app
  50 - OSDF image optimization
  51
  52 Bug Fixes
  53 ---------
  54
  55 - OPTFRA-511 Return error when policies are not present
  56 - OPTFRA-943 Fix issues in NSI selection response
  57 - OPTFRA-853 Remove unwanted gplv3 components from docker image
  58
  59
  60 Known Limitations, Issues and Workarounds
  61 =========================================
  62
  63 System Limitations
  64 ------------------
  65
  66
  67 Known Vulnerabilities
  68 ---------------------
  69
  70
  71 Workarounds
  72 -----------
  73
  74
  75 Security Notes
  76 --------------
  77
  78
  79 References
  80 ==========
  81
  82 For more information on the ONAP Honolulu release, please see:
  83
  84 #. `ONAP Home Page`_
  85 #. `ONAP Documentation`_
  86 #. `ONAP Release Downloads`_
  87 #. `ONAP Wiki Page`_
  88
  89
  90 .. _`ONAP Home Page`: https://www.onap.org
  91 .. _`ONAP Wiki Page`: https://wiki.onap.org
  92 .. _`ONAP Documentation`: https://docs.onap.org
  93 .. _`ONAP Release Downloads`: https://git.onap.org
  94
  95 Quick Links:
  96     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
  97     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
  98
  99
 100 ..      ===========================
 101 ..      * * *   HONOLULU  * * *
 102 ..      ===========================
 103
 104 Abstract
 105 ========
 106
 107 This document provides the release notes for the Honolulu release.
 108
 109 Summary
 110 =======
 111
 112
 113 Release Data
 114 ============
 115
 116
 117 +--------------------------------------+--------------------------------------+
 118 | **OOF Project**                      |                                      |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 | **Docker images**                    |   optf-osdf 3.0.4                    |
 122 |                                      |                                      |
 123 |                                      |                                      |
 124 +--------------------------------------+--------------------------------------+
 125 | **Release designation**              | 8.0.0 honolulu                       |
 126 |                                      |                                      |
 127 +--------------------------------------+--------------------------------------+
 128 | **Release date**                     | 04/08/2021 (TBD)                     |
 129 |                                      |                                      |
 130 +--------------------------------------+--------------------------------------+
 131
 132
 133 New features
 134 ------------
 135
 136 - Add NST selection feature with AAI & SDC
 137 - Configuration management with consul KV store
 138
 139 Bug Fixes
 140 ---------
 141
 142 - OPTFRA-906  Update slice/service profile attributes
 143 - OPTFRA-871  Bug Fix in ML SON - convert cell_id before sending it to Minizinc
 144
 145
 146 Known Limitations, Issues and Workarounds
 147 =========================================
 148
 149 System Limitations
 150 ------------------
 151
 152
 153 Known Vulnerabilities
 154 ---------------------
 155
 156
 157 Workarounds
 158 -----------
 159
 160
 161 Security Notes
 162 --------------
 163
 164
 165 References
 166 ==========
 167
 168 For more information on the ONAP Honolulu release, please see:
 169
 170 #. `ONAP Home Page`_
 171 #. `ONAP Documentation`_
 172 #. `ONAP Release Downloads`_
 173 #. `ONAP Wiki Page`_
 174
 175
 176 .. _`ONAP Home Page`: https://www.onap.org
 177 .. _`ONAP Wiki Page`: https://wiki.onap.org
 178 .. _`ONAP Documentation`: https://docs.onap.org
 179 .. _`ONAP Release Downloads`: https://git.onap.org
 180
 181 Quick Links:
 182     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 183     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 184
 185 ..      ===========================
 186 ..      * * *   GUILIN   * * *
 187 ..      ===========================
 188
 189 Abstract
 190 ========
 191
 192 This document provides the release notes for the Guilin release.
 193
 194 Summary
 195 =======
 196
 197
 198 Release Data
 199 ============
 200
 201
 202 +--------------------------------------+--------------------------------------+
 203 | **OOF Project**                      |                                      |
 204 |                                      |                                      |
 205 +--------------------------------------+--------------------------------------+
 206 | **Docker images**                    |   optf-osdf 3.0.2                    |
 207 |                                      |                                      |
 208 |                                      |                                      |
 209 +--------------------------------------+--------------------------------------+
 210 | **Release designation**              | 7.0.0 guilin                         |
 211 |                                      |                                      |
 212 +--------------------------------------+--------------------------------------+
 213 | **Release date**                     | 2020-11-19 (TBD)                     |
 214 |                                      |                                      |
 215 +--------------------------------------+--------------------------------------+
 216
 217
 218 New features
 219 ------------
 220
 221 - NSI selection enhancements
 222 - Support for NSSI selection
 223 - Support for NSI/NSSI Termination
 224 - Support for Inter domain route optimization
 225 - Support for ML based SON optimization
 226 - Upgrade python version to 3.8
 227
 228 Bug Fixes
 229 ---------
 230
 231 - OPTFRA-839  Remove python 2.7 from OSDF docker image
 232 - OPTFRA-855  Fix slice selection API
 233 - OPTFRA-852  Callback implementation for NST selection
 234
 235 Known Limitations, Issues and Workarounds
 236 =========================================
 237
 238 System Limitations
 239 ------------------
 240
 241
 242 Known Vulnerabilities
 243 ---------------------
 244
 245
 246 Workarounds
 247 -----------
 248
 249
 250 Security Notes
 251 --------------
 252
 253
 254 References
 255 ==========
 256
 257 For more information on the ONAP Guilin release, please see:
 258
 259 #. `ONAP Home Page`_
 260 #. `ONAP Documentation`_
 261 #. `ONAP Release Downloads`_
 262 #. `ONAP Wiki Page`_
 263
 264
 265 .. _`ONAP Home Page`: https://www.onap.org
 266 .. _`ONAP Wiki Page`: https://wiki.onap.org
 267 .. _`ONAP Documentation`: https://docs.onap.org
 268 .. _`ONAP Release Downloads`: https://git.onap.org
 269
 270 Quick Links:
 271     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 272     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 273
 274 ..      ===========================
 275 ..      * * *    FRANKFURT    * * *
 276 ..      ===========================
 277
 278 Abstract
 279 ========
 280
 281 This document provides the release notes for the Frankfurt release.
 282
 283 Summary
 284 =======
 285
 286
 287 Release Data
 288 ============
 289
 290
 291 +--------------------------------------+--------------------------------------+
 292 | **OOF Project**                      |                                      |
 293 |                                      |                                      |
 294 +--------------------------------------+--------------------------------------+
 295 | **Docker images**                    |   optf-osdf 2.0.4                    |
 296 |                                      |                                      |
 297 |                                      |                                      |
 298 +--------------------------------------+--------------------------------------+
 299 | **Release designation**              | 6.0.0 frankfurt                      |
 300 |                                      |                                      |
 301 +--------------------------------------+--------------------------------------+
 302 | **Release date**                     | 2020-05-07 (TBD)                     |
 303 |                                      |                                      |
 304 +--------------------------------------+--------------------------------------+
 305
 306
 307 New features
 308 ------------
 309
 310 - Project is restructured into apps and libs.
 311 - A Generic optimizing engine is implemented.
 312 - New optimizer model for route optimization is added.
 313 - Policy apis are migrated from legacy apis to new decision api.
 314 - The Conductor adapter is moved from placement to adapters.
 315 - NST and NSI selection function has been implemented for Network
 316   Slicing use case.
 317 - PCI optimization is enhanced to support fixed cells field.
 318
 319 Bug Fixes
 320 ---------
 321
 322 - OPTFRA-482 The field "unique" should be defined in vnf policy.
 323 - OPTFRA-729 OSDF fails to start in the k8s environment.
 324 - OPTFRA-731 OSDF Policy interface is not working
 325 - OPTFRA-754 Return slice profile when service profile indicates the
 326   resource sharing level as not shared
 327 - OPTFRA-755 OOF Policy filtering does not work.
 328
 329 Known Limitations, Issues and Workarounds
 330 =========================================
 331
 332 System Limitations
 333 ------------------
 334
 335
 336 Known Vulnerabilities
 337 ---------------------
 338
 339
 340 Workarounds
 341 -----------
 342
 343
 344 Security Notes
 345 --------------
 346
 347
 348 References
 349 ==========
 350
 351 For more information on the ONAP Frankfurt release, please see:
 352
 353 #. `ONAP Home Page`_
 354 #. `ONAP Documentation`_
 355 #. `ONAP Release Downloads`_
 356 #. `ONAP Wiki Page`_
 357
 358
 359 .. _`ONAP Home Page`: https://www.onap.org
 360 .. _`ONAP Wiki Page`: https://wiki.onap.org
 361 .. _`ONAP Documentation`: https://docs.onap.org
 362 .. _`ONAP Release Downloads`: https://git.onap.org
 363
 364 Quick Links:
 365     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 366     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 367
 368
 369 Version: 5.0.1
 370 --------------
 371
 372 :Release Date: 2019-09-30 (El Alto Release)
 373
 374 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
 375
 376 Artifacts released:
 377
 378 optf-has:1.3.3
 379 optf-osdf:1.3.4
 380 optf-cmso:2.1.1
 381
 382 **New Features**
 383
 384 While no new features were added in the release, the following Stories were delivered as enhancements.
 385
 386     * [OPTFRA-415] Automation on policy model uploading
 387     * [OPTFRA-427] CMSO - Schedule a workflow in SO and track status to completion
 388
 389 * Platform Maturity Level 1
 390     * ~65.1+ unit test coverage
 391
 392
 393 **Bug Fixes**
 394
 395 The El Alto release for OOF fixed the following Bugs.
 396
 397     * [OPTFRA-579] Json error in homing solution
 398     * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
 399     * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
 400     * [OPTFRA-577] Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
 401     * [OPTFRA-517] Clean up optf/cmso in integration/csit for Dublin
 402     * [OPTFRA-486] Support "identifiers" field as a list of values
 403     * [OPTFRA-403] OOF CMSO Service kubernetes resources allocation is not done
 404     * [OPTFRA-526] OOF pods not running
 405     * [OPTFRA-409] Template example : purpose to be explained
 406     * [OPTFRA-593] OOF-CSMO healthcheck is failing in Master
 407
 408
 409 **Known Issues**
 410
 411     * [OPTFRA-576] optf-has-master-csit-has is testing Dublin image
 412     * [OPTFRA-596] CMSO - Sonar and CSIT jobs failing
 413     * [OPTFRA-608] Error in Homing with multiple policies
 414
 415 **Security Notes**
 416
 417 *Fixed Security Issues*
 418
 419     * [OJSI-122] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.
 420     * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
 421     * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
 422     * [OPTFRA-455] CMSO - Mitigate License Threat tomcat-embed-core
 423
 424 *Known Security Issues*
 425
 426     * [OPTFRA-481] Fix Vulnerability with spring-data-jpa package
 427     * [OPTFRA-431] Fix Vulnerability with spring-security-web package
 428
 429 *Known Vulnerabilities in Used Modules*
 430
 431 **Upgrade Notes**
 432
 433
 434 **Deprecation Notes**
 435
 436
 437 **Other**
 438
 439
 440 Version: 4.0.0
 441 --------------
 442
 443 :Release Date: 2019-06-06 (Dublin Release)
 444
 445 **New Features**
 446
 447 The Dublin release is the third release for ONAP Optimization Framework (OOF).
 448
 449 A summary of features includes
 450
 451 * Support SON (PCI/ANR) optimization using OSDF
 452 * Implement encryption for OSDF internal and external communication
 453
 454 * Platform Maturity Level 1
 455     * ~65.1+ unit test coverage
 456
 457 The Dublin release for OOF delivered the following Epics.
 458
 459     * [OPTFRA-426]      Track the changes to CMSO to support change management schedule optimization
 460     * [OPTFRA-424]      Extend OOF to support traffic distribution optimization
 461     * [OPTFRA-422]      Move OOF projects' CSIT to run on OOM
 462     * [OPTFRA-276]      Implementing a POC for 5G SON Optimization
 463     * [OPTFRA-270]      This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
 464
 465
 466 **Bug Fixes**
 467
 468 * The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10463>`_
 469
 470 **Known Issues**
 471
 472
 473
 474 **Security Notes**
 475
 476 *Fixed Security Issues*
 477
 478 *Known Security Issues*
 479
 480     * [`OJSI-122 <https://jira.onap.org/browse/OJSI-122>`_] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.
 481
 482 *Known Vulnerabilities in Used Modules*
 483
 484 OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 485 The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_.
 486
 487 Quick Links:
 488     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 489     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 490     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
 491
 492 **Upgrade Notes**
 493
 494 None.
 495
 496 **Deprecation Notes**
 497
 498 None.
 499
 500 **Other**
 501
 502 None
 503
 504 Version: 3.0.1
 505 --------------
 506
 507 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
 508
 509 The following items were deployed with the Casablanca Maintenance Release:
 510
 511
 512 **New Features**
 513
 514 None.
 515
 516 **Bug Fixes**
 517
 518 * [OPTFRA-401] -        Need flavor id while launching vm.
 519
 520
 521
 522 Version: 3.0.0
 523 --------------
 524
 525 :Release Date: 2018-11-30 (Casablanca Release)
 526
 527 **New Features**
 528
 529 The Casablanca release is the second release for ONAP Optimization Framework (OOF).
 530
 531 A summary of features includes
 532
 533 * Homing enhancements for improving service deployability
 534     * Discovering and reusing shared resources when processing multiple homing requests in parallel
 535     * Considering Latency Reduction (in addition to geographical distances) for homing optimization
 536     * Enhanced capacity checks during VNF homing
 537     * Asynchronous communication between HAS components
 538 * OOF Casablanca S3P Usability enhancement
 539     * Adherence to ONAP API Common Versioning Strategy (CVS) Proposal
 540     * Move all internal and external facing APIs to Swagger 2.0
 541 * OOF Casablanca S3P Performance enhancements
 542     * Creating a plan for performance improvements based on the baseline measured metrics
 543 * OOF development platform hardening
 544     * Deployment scripts
 545     * Fix Build Docker image script for supporting multiple versions
 546     * Fix OOM, HEAT deployment scripts (versioning)
 547     * CSIT functional tests for each repo
 548     * CI Jobs for different streams (Beijing, master etc)
 549     * Clean up nexus binaries and maven versioning
 550 * Integrate OOF with Certificate and Secret Management Service (CSM)
 551 * Support SON (PCI) optimization using OSDF
 552
 553 * Platform Maturity Level 1
 554     * ~65.1+ unit test coverage
 555
 556 The Casablanca release for OOF delivered the following Epics.
 557
 558     * [OPTFRA-273] - Epic Name: OOF Casablanca S3P Manageability enhancement
 559     * [OPTFRA-270] - Maintain current S3P levels
 560     * [OPTFRA-271] - OOF Casablanca S3P Security enhancement
 561     * [OPTFRA-267] - OOF - HPA Enhancements
 562     * [OPTFRA-276] - Implementing a POC for 5G SON Optimization
 563
 564
 565 **Bug Fixes**
 566
 567 * The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10445>`_
 568
 569 **Known Issues**
 570
 571   * [OPTFRA-223] -      On boarding and testing AAF certificates for OSDF.
 572   * [OPTFRA-293] -      Implement encryption for all OSDF internal and external communication
 573   * [OPTFRA-329] -      role based access control for OSDF-Policy interface
 574
 575 **Security Notes**
 576
 577 OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 578 The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_.
 579
 580 Quick Links:
 581     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 582     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 583     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_
 584
 585 **Upgrade Notes**
 586
 587 None.
 588
 589 **Deprecation Notes**
 590
 591 None.
 592
 593 **Other**
 594
 595 None
 596
 597 Version: 2.0.0
 598 --------------
 599
 600 :Release Date: 2018-06-07
 601
 602 **New Features**
 603
 604
 605 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features includes:
 606
 607 * Baseline HAS functionality
 608     * support for VCPE use case
 609     * support for HPA (Hardware Platform Awareness)
 610 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
 611 * Platform Maturity Level 1
 612     * ~50%+ unit test coverage
 613
 614 The Beijing release for OOF delivered the following Epics.
 615
 616     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
 617     * [OPTFRA-6] - Integrate OOF with other ONAP components
 618     * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
 619     * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
 620     * [OPTFRA-21] - OOF Packaging
 621     * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
 622     * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
 623     * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
 624     * [OPTFRA-33] - OOF Support for HPA
 625     * [OPTFRA-105] - All Documentation Related User Stories and Tasks
 626
 627
 628 **Bug Fixes**
 629
 630 None. Initial release R2 Beijing. No previous versions
 631
 632 **Known Issues**
 633
 634 None.
 635
 636 **Security Notes**
 637
 638 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 639
 640 Quick Links:
 641     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 642     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 643
 644 **Upgrade Notes**
 645
 646 None. Initial release R2 Beijing. No previous versions
 647
 648 **Deprecation Notes**
 649
 650 None. Initial release R2 Beijing. No previous versions
 651
 652 **Other**
 653
 654 None