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