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 Version: 4.0.0
  10 --------------
  11
  12 :Release Date: 2019-06-06 (Dublin Release)
  13
  14 **New Features**
  15
  16 A summary of features includes:
  17
  18 * Extend OOF to support traffic distribution optimization
  19 * Implement encryption for HAS internal and external communication
  20
  21 * Platform Maturity Level 1
  22     * ~56.2%+ unit test coverage
  23
  24 The Dublin release for OOF delivered the following Epics.
  25
  26     * [OPTFRA-424]      Extend OOF to support traffic distribution optimization
  27     * [OPTFRA-422]      Move OOF projects' CSIT to run on OOM
  28     * [OPTFRA-270]      This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
  29
  30 **Bug Fixes**
  31     * OPTFRA-515        Pod oof-has-controller is in CrashLoopBackOff after ONAP deployment
  32     * OPTFRA-513        OOF-HAS pods fail to come up in ONAP deployment
  33     * OPTFRA-492        HAS API pod failure
  34     * OPTFRA-487        OOF HAS CSIT failing with HTTPS changes
  35     * OPTFRA-475        Remove Casablanca jobs in preparation for Dublin branch
  36     * OPTFRA-467        Remove aai simulator code from HAS solver
  37     * OPTFRA-465        Fix data code smells
  38     * OPTFRA-461        Enable HTTPS and TLS for HAS API
  39     * OPTFRA-452        Remove misleading reservation logic
  40     * OPTFRA-449        Create OOM based CSIT for HAS
  41     * OPTFRA-448        Multiple Sonar Issues
  42     * OPTFRA-445        Modify HAS Data component to support new A&AI requests required by Distribute Traffic functionality
  43     * OPTFRA-444        Implement Distribute Traffic API exposure in HAS
  44     * OPTFRA-412        Got 'NoneType' error when there's no flavor info inside vim
  45     * OPTFRA-411        latency_country_rules_loader.py - Remove the unused local variable "ctx".
  46     * OPTFRA-302        Enhance coverage of existing HAS code to 55%
  47
  48
  49 **Known Issues**
  50
  51 These are all issues with fix version: Dublin Release and status: open, in-progress, reopened
  52
  53     * OPTFRA-494        HAS request 'limit' argument is ignored.
  54
  55 **Security Issues**
  56
  57 *Fixed Security Issues*
  58
  59 *Known Security Issues*
  60
  61     * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
  62
  63 *Known Vulnerabilities in Used Modules*
  64
  65 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_.
  66
  67 **Quick Links**:
  68     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
  69     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
  70     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
  71 **Upgrade Notes**
  72 To upgrade, run docker container or install from source, See Distribution page
  73
  74 **Deprecation Notes**
  75 No features deprecated in this release
  76
  77 **Other**
  78 None
  79
  80
  81 Version: 3.0.1
  82 --------------
  83
  84 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
  85
  86 The following items were deployed with the Casablanca Maintenance Release:
  87
  88
  89 **New Features**
  90
  91 None.
  92
  93 **Bug Fixes**
  94
  95 * [OPTFRA-401] -        Need flavor id while launching vm.
  96
  97
  98
  99 Version: 3.0.0
 100 --------------
 101
 102 :Release Date: 2018-11-30 (R3 Casablanca Release)
 103
 104 **New Features**
 105
 106 A summary of features includes:
 107
 108 * Security enhancements, including integration with AAF to implement access controls on
 109     OSDF and HAS northbound interfaces
 110 * Integration with SMS
 111 * Platform Maturity Level 1
 112     * ~50%+ unit test coverage
 113 * Hardware Platform Awareness Enhancements
 114     1) Added support for SRIOV-NIC and directives to assist the orchestrator
 115     2) Select the best candidate across all cloud region based on HPA score.
 116     3) HPA metrics using prometheus
 117
 118 The Casablanca release for OOF delivered the following Epics.
 119
 120     * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
 121     * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
 122     * OPTFRA-267 - OOF - HPA Enhancements
 123     * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
 124     * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
 125     * OPTFRA-271 - This epic spans the work to progress further from the current security level
 126     * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
 127     * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
 128     * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
 129     * OPTFRA-275 - This epic spans the stories to improve deployability of services
 130     * OPTFRA-276 - Implementing a POC for 5G SON Optimization
 131     * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
 132
 133 **Bug Fixes**
 134
 135     * OPTFRA-205 - Generated conductor.conf missing configurations
 136     * OPTFRA-210 - Onboarding to Music error
 137     * OPTFRA-211 - Error solution for HPA
 138     * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
 139     * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
 140     * OPTFRA-264 - oof-has-zookeeper image pull error
 141     * OPTFRA-305 - Analyze OOM health check failure
 142     * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
 143     * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
 144     * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name
 145     * OPTFRA-325 - spelling mistake
 146     * OPTFRA-326 - hyperlink links are missing
 147     * OPTFRA-335 - Making flavors an optional field in HAS candidate object
 148     * OPTFRA-336 - OOM oof deployment failure on missing image - optf-osdf:1.2.0
 149     * OPTFRA-338 - Create authentication key for OOF-VFC integration
 150     * OPTFRA-341 - Cannot support multiple candidates for one feature in one flavor
 151     * OPTFRA-344 - Fix broken HPA CSIT test
 152     * OPTFRA-354 - Generalize the logic to process Optimization policy
 153     * OPTFRA-358 - Tox fails with the AttributeError: 'module' object has no attribute 'MUSIC_API'
 154     * OPTFRA-359 - Create index on plans table for HAS
 155     * OPTFRA-362 - AAF Authentication CSIT issues
 156     * OPTFRA-365 - Fix Jenkins jobs for CMSO
 157     * OPTFRA-366 - HAS CSIT issues
 158     * OPTFRA-370 - Update the version of the OSDF and HAS images
 159     * OPTFRA-374 - 'ModelCustomizationName' should be optional for the request
 160     * OPTFRA-375 - SO-OSDF request is failing without modelCustomizationName value
 161     * OPTFRA-384 - Generate and Validate Policy for vFW testing
 162     * OPTFRA-385 - resourceModelName is sent in place of resourceModuleName
 163     * OPTFRA-388 - Fix OOF to handle sdnr/configdb api changes
 164     * OPTFRA-395 - CMSO - Fix security violations and increment version
 165
 166
 167 **Known Issues**
 168
 169 These are all issues with fix version: Casablanca Release and status: open, in-progress, reopened
 170
 171     * OPTFRA-401 - Need flavor id while launching vm
 172     * OPTFRA-398 - Add documentation for OOF-VFC interaction
 173     * OPTFRA-393 - CMSO Implement code coverage
 174     * OPTFRA-383 - OOF 7 of 8 pods are not starting in a clean master 20181029
 175     * OPTFRA-368 - Remove Beijing repositories from CLM jenkins
 176     * OPTFRA-337 - Document new transitions in HAS states
 177     * OPTFRA-331 - Role-based access controls to OOF
 178     * OPTFRA-329 - role based access control for OSDF-Policy interface
 179     * OPTFRA-316 - Clean up hard-coded references to south bound dependencies
 180     * OPTFRA-314 - Create user stories for documenting new APIs defined for OOF
 181     * OPTFRA-304 - Code cleaning
 182     * OPTFRA-300 - Fix Heat deployment scripts for OOF
 183     * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
 184     * OPTFRA-297 - OOF Should support Cross Domain and Cross Layer VPN
 185     * OPTFRA-296 - Support SON (PCI) optimization using OSDF
 186     * OPTFRA-293 - Implement encryption for all OSDF internal and external communication
 187     * OPTFRA-292 - Implement encryption for all HAS internal and external communication
 188     * OPTFRA-279 - Policy-based capacity check enhancements
 189     * OPTFRA-276 - Implementing a POC for 5G SON Optimization
 190     * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
 191     * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
 192     * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
 193     * OPTFRA-271 - This epic spans the work to progress further from the current security level
 194     * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
 195     * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
 196     * OPTFRA-268 - OOF - project specific enhancements
 197     * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
 198     * OPTFRA-262 - ReadTheDoc - update for R3
 199     * OPTFRA-260 - Testing vCPE flows with multiple clouds
 200     * OPTFRA-240 - Driving Superior Isolation for Tiered Services using Resource Reservation -- Optimization Policies for Residential vCPE
 201     * OPTFRA-223 - On boarding and testing AAF certificates for OSDF
 202
 203 **Security Issues**
 204
 205 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 206
 207 **Quick Links**:
 208         - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 209
 210         - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 211
 212 **Upgrade Notes**
 213 To upgrade, run docker container or install from source, See Distribution page
 214
 215 **Deprecation Notes**
 216 No features deprecated in this release
 217
 218 **Other**
 219 None
 220
 221 Version: 2.0.0
 222 --------------
 223
 224 :Release Date: 2018-06-07 (Beijing Release)
 225
 226 **New Features**
 227
 228 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
 229
 230 * Baseline HAS functionality
 231     * support for VCPE use case
 232     * support for HPA (Hardware Platform Awareness)
 233 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
 234 * Platform Maturity Level 1
 235     * ~50%+ unit test coverage
 236
 237 The Beijing release for OOF delivered the following Epics.
 238
 239     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
 240
 241     * [OPTFRA-6] - Integrate OOF with other ONAP components
 242
 243     * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
 244
 245     * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
 246
 247     * [OPTFRA-21] - OOF Packaging
 248
 249     * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
 250
 251     * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
 252
 253     * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
 254
 255     * [OPTFRA-33] - OOF Support for HPA
 256
 257     * [OPTFRA-105] - All Documentation Related User Stories and Tasks
 258
 259
 260 **Bug Fixes**
 261
 262 None. Initial release R2 Beijing. No previous versions
 263
 264 **Known Issues**
 265
 266     * [OPTFRA-179] - Error solution for HPA
 267
 268     * [OPTFRA-205] - Onboarding to Music error
 269
 270     * [OPTFRA-210] - Generated conductor.conf missing configurations
 271
 272     * [OPTFRA-211] - Remove Extraneous Flavor Information from cloud-region cache
 273
 274
 275 **Security Issues**
 276
 277 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 278
 279 Quick Links:
 280         - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 281
 282         - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 283
 284 **Upgrade Notes**
 285 None. Initial release R2 Beijing. No previous versions
 286
 287 **Deprecation Notes**
 288 None. Initial release R2 Beijing. No previous versions
 289
 290 **Other**
 291 None