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