docs/release/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License. http://creativecommons.org/licenses/by/4.0
   3
   4
   5 .. _onap-release-notes:
   6
   7 Honolulu Release Notes
   8 ^^^^^^^^^^^^^^^^^^^^^^
   9
  10 This page provides the release notes for the ONAP Honolulu release. This
  11 includes details of software versions, known limitations, and outstanding
  12 trouble reports.
  13
  14 Release notes are cumulative for the release, meaning this release note will
  15 have an entry for each Major, Minor, and Maintenance release, if applicable.
  16
  17 Each component within the ONAP solution maintains their own component level
  18 release notes and links to those release notes are provided below.
  19 Details on the specific items delivered in each release by each component is
  20 maintained in the component specific release notes.
  21
  22 Honolulu Releases
  23 =================
  24
  25 The following releases are available for Honolulu:
  26   - `Honolulu Maintenance Release 8.0.1`_
  27   - `Honolulu Major Release 8.0.0`_
  28
  29 Honolulu Maintenance Release 8.0.1
  30 ==================================
  31
  32 +--------------------------------------+--------------------------------------+
  33 | **Project**                          | Open Network Automation Platform     |
  34 |                                      | (ONAP)                               |
  35 +--------------------------------------+--------------------------------------+
  36 | **Release name**                     | Honolulu Maintenance Release         |
  37 |                                      |                                      |
  38 +--------------------------------------+--------------------------------------+
  39 | **Release version**                  | 8.0.1                                |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42 | **Release date**                     | September 30th 2021                  |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45
  46 New Features
  47 ============
  48
  49 Honolulu Maintenance Release 8.0.1 delivered a number of fixes and updates
  50 across the following projects:
  51
  52  - SO          - bugfixes and support for transport slicing usecase
  53  - CDS         - fix BluePrint* classes renaming
  54  - MULTICLOUD  - update of k8s plugin to support Helm3
  55  - OOM         - fixes for common Helm chart templates and product charts
  56  - POLICY      - new versions of Policy Framework components
  57  - DCAE        - new version of the policy-handler and dashboard
  58  - OOF         - use new AAI schema version (v21)
  59  - CCSDK       - fix fault and pnf-registration event losses
  60
  61 Details on the specific Jira tickets addressed by each project can be found in
  62 the component specific Release Notes: :ref:`release notes<doc-releaserepos>`
  63
  64
  65 Honolulu Major Release 8.0.0
  66 ============================
  67
  68 +--------------------------------------+--------------------------------------+
  69 | **Project**                          | Open Network Automation Platform     |
  70 |                                      | (ONAP)                               |
  71 +--------------------------------------+--------------------------------------+
  72 | **Release name**                     | Honolulu                             |
  73 |                                      |                                      |
  74 +--------------------------------------+--------------------------------------+
  75 | **Release version**                  | 8.0.0                                |
  76 |                                      |                                      |
  77 +--------------------------------------+--------------------------------------+
  78 | **Release date**                     | May 11th  2021                       |
  79 |                                      |                                      |
  80 +--------------------------------------+--------------------------------------+
  81
  82 Honolulu Features
  83 =================
  84 ONAP Honolulu focusses on:
  85
  86 * Cloud Native Function (CNF) support with  with seamless configuration of Helm
  87   based CNFs and K8s resources
  88 * End-to-end 5G network slicing with three network slicing components for RAN,
  89   core, and transport
  90 * Introducing a new component: Configuration Persistence Service (CPS) to store
  91   persistent configuation data
  92 * Modularity to pick and choose the components needed for specific use case
  93 * Improving integration with many SDOs
  94
  95 Functional Requirements
  96 -----------------------
  97
  98 Increased Cloud Native Functionality
  99 ....................................
 100 The Honolulu release has important updates to support cloud native network
 101 functions (CNF). The functionality includes configuration of Helm based CNFs
 102 and seamless day 1, 2 operations. The Configuration API allows a user to
 103 create, modify and delete Kubernetes (K8s) resource templates and their base
 104 parameters and the Profile API allows for sophisticated day 0 configuration.
 105 The Query API gathers filtered status of the CNF and the HealthCheck API
 106 executes dedicated health check jobs to verify the status of a CNF. This new
 107 functionality is implemented in the Controller Design Studio (CDS) component
 108 using dedicated templates called Controller Blueprint Archives (CBA).
 109 In addition, there is Swagger documentation for the API of the K8s plugin
 110 component in the MultiCloud project.
 111
 112 Deeper 5G Support
 113 .................
 114 There is a significant set of new functionality around end-to-end 5G network
 115 slicing in the Honolulu release. This release includes three internal Network
 116 Slice Subnet Management Function (NSSMF) components for RAN, core, and
 117 transport domains. External NSSMFs continue to be supported for RAN and core.
 118 Next, slice optimization continues to be an area of ongoing effort with closed
 119 loop automation and intelligent slicing testing. There are also enhancements in
 120 NST, NSI, and NSSI selection in the OOF project and A&AI includes schema
 121 changes to accommodate network and transport slicing.
 122
 123 In addition, the ExtAPI project now included Enhanced Service Ordering for
 124 additional service types and the UUI graphical user interface has improved
 125 slicing support. The VID graphical user has support for PNF plug-and-play
 126 allowing operators to interact with PNFs via VID. In addition, there is better
 127 compliance to standards such as 3GPP TS28.540/541 5G NRM driven xNF models in
 128 ONAP. Finally the OOF SON functionality supports offline trained ML-models
 129 providing additional inputs for Physical Cell Identity (PCI) optimization.
 130 DCAE includes a new KPI microservice.
 131
 132 Configuration Persistence Service
 133 .................................
 134 Another key 5G related initiative is the new Configuration Persistence Service
 135 (CPS) module that allows ONAP projects to store persistent state defined by
 136 YANG models, deploy YANG models at runtime, and share access to configuration
 137 management data.
 138
 139 Further O-RAN Integration
 140 .........................
 141 A key enhancement in the Honolulu release was increased support for the O-RAN
 142 A1 standard that is implemented in the CCSDK and SDN-C projects. The O-RAN A1
 143 interface provides a flexible way for RAN operators to manage wide area RAN
 144 network optimization reducing capex investment needs. Both the enhanced A1
 145 interface controller and A1 policy capabilities are now usable in ONAP with a
 146 Near-Real-Time Radio Intelligent Controller (nRTRIC). This functionality is
 147 also used downstream in O-RAN-Source Community (OSC) Non-RealTime RIC
 148 (NONRTRIC) project, strengthening alignment between ONAP & OSC. In addition,
 149 the DCAE project includes VES 7.2 integration that improves integration with
 150 both O-RAN and 3GPP. Finally, there is a new CPS interface to query RAN
 151 configuration data.
 152
 153 Expanded Modularity
 154 ...................
 155 Modularity has been an important topic in ONAP to allow users to pick and
 156 choose the components they need for their specific use case and Honolulu
 157 continues to advance modularity. DCAE now simplifies microservice deployment
 158 via Helm charts.
 159
 160 Service Design
 161 ..............
 162
 163 - Includes increased support for ETSI standards such as SOL001, SOL004, and
 164   SOL007 and allows users to choose unlicensed or externally licensed xNFs.
 165 - Vendor License Model is now optional
 166 - SDC distribution status report enhanced
 167
 168 Inventory
 169 .........
 170
 171 - A&AI includes support for multi tenancy.
 172 - Model updates for CCVPN Transport Slicing and Network Slicing
 173 - GraphGraph POC enhanced for schema visualization and visual model generation
 174 - Sparky UI updates including Browse, Specialized Search, BYOQ, and BYOQ
 175   Builder Views
 176
 177 ONAP Operations Manager
 178 .......................
 179
 180 - Portal-Cassandra image updated to Bitnami, supporting IPv4/IPv6 Dual Stack
 181 - CMPv2 external issuer implemented which extends Cert-Manager with ability to
 182   enroll X.509 certificates from CMPv2 servers
 183 - New version for MariaDB Galera using Bitnami image, supporting IPv4/IPv6 Dual
 184   Stack
 185 - Support of Helm v3.4 and Helm v3.5
 186
 187 Non-Functional Requirements
 188 ---------------------------
 189 The following 'non-functional' requirements are followed in the
 190 Honolulu Release:
 191
 192 Best Practice
 193 .............
 194
 195 - ONAP shall use STDOUT for logs collection
 196 - IPv4/IPv6 dual stack support in ONAP
 197 - Containers must crash properly when a failure occurs
 198 - Containers must have no more than one main process
 199 - Application config should be fully prepared before starting the
 200   application container
 201 - No root (superuser) access to database from application container
 202
 203 Code Quality
 204 ............
 205
 206 - Each ONAP project shall improve its CII Badging score by improving input
 207   validation and documenting it in their CII Badging site
 208 - Each ONAP project shall define code coverage improvements and achieve at
 209   least 55% code coverage
 210
 211 Security
 212 ........
 213
 214 - Python language 3.8
 215 - Java language v11
 216 - All containers must run as non-root user
 217 - Continue hardcoded passwords removal
 218 - Flow management must be activated for ONAP.
 219 - Each project will update the vulnerable direct dependencies in their code
 220   base
 221
 222 Tests
 223 .....
 224
 225 - New E2E tests
 226 - New IPv4/Ipv6 daily CI chain
 227
 228 .. important::
 229    Some non-functional requirements are not fully finalized. Please, check details
 230    on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
 231
 232
 233 Project Specific Release Notes
 234 ==============================
 235 ONAP releases are specified by a list of project artifact versions in the
 236 project repositories and docker container image versions listed in the OOM
 237 Helm charts.
 238
 239 Each project provides detailed :ref:`release notes<doc-releaserepos>`
 240 and prepends to these if/when any updated versions the project team believes
 241 are compatible with a major release are made available.
 242
 243 Documentation
 244 =============
 245 ONAP Honolulu Release provides a set selection of documents,
 246 see :ref:`ONAP Documentation<master_index>`.
 247
 248 The `developer wiki <http://wiki.onap.org>`_ remains a good source of
 249 information on meeting plans and notes from committees, project teams and
 250 community events.
 251
 252 Security Notes
 253 ==============
 254 Details about discovered and mitigated vulnerabilities are in
 255 :ref:`ONAP Security <onap-osa:onap-security>`
 256
 257 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 258
 259 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
 260 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 261
 262 In the Honolulu release,
 263
 264 - 100% projects passed 90% of the CII badge
 265 - 85% projects passed the CII badge
 266 - 11% projects passed the CII Silver badge
 267
 268 Project specific details are in the :ref:`release notes<doc-releaserepos>` for
 269 each project.
 270
 271 .. index:: maturity
 272
 273 ONAP Maturity Testing Notes
 274 ===========================
 275 For the Honolulu release, ONAP continues to improve in multiple areas of
 276 Scalability, Security, Stability and Performance (S3P) metrics.
 277
 278 In Honolulu the Integration team focussed in
 279
 280 - Automating ONAP Testing to improve the overall quality
 281 - Adding security and E2E tests
 282
 283 More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
 284
 285 Known Issues and Limitations
 286 ============================
 287 Known Issues and limitations are documented in each
 288 :ref:`project Release Notes <doc-releaserepos>`.
 289
 290
 291 .. Include files referenced by link in the toctree as hidden