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