docs/sections/release-notes.rst

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