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