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