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 Guilin Release Notes
   8 ^^^^^^^^^^^^^^^^^^^^
   9
  10 This page provides the release notes for the ONAP Guilin 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 Guilin Releases
  23 ===============
  24
  25 The following releases are available for Guilin:
  26   - `Guilin Maintenance Release 7.0.1`_
  27   - `Guilin Major Release 7.0.0`_
  28
  29 Guilin Maintenance Release 7.0.1
  30 ================================
  31
  32 +--------------------------------------+--------------------------------------+
  33 | **Project**                          | Open Network Automation Platform     |
  34 |                                      | (ONAP)                               |
  35 +--------------------------------------+--------------------------------------+
  36 | **Release name**                     | Guilin Maintenance Release           |
  37 |                                      |                                      |
  38 +--------------------------------------+--------------------------------------+
  39 | **Release version**                  | 7.0.1                                |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42 | **Release date**                     | February 28th 2021                   |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45
  46 New Features
  47 ============
  48
  49 Guilin Maintenance Release 7.0.1 delivered a number of fixes and updates
  50 across the following projects:
  51
  52  - AAI         - bug fixes
  53  - OOM         - bug fixes
  54  - CCSDK       - bug fixes
  55  - DCAEGEN2    - bug fixes
  56  - DMaaP       - bug fixes
  57  - DOC         - restructure user guides section and added tutorials
  58  - Integration - new docker for robot framework
  59  - Music       - certificate update
  60  - MSB         - bug fixes
  61  - OOM         - docker improvement
  62  - SDNC        - bug fixes
  63  - SO          - bug fixes
  64  - VID         - certificate update
  65
  66 Details on the specific Jira tickets addressed by each project can be found in
  67 the component specific Release Notes: :ref:`release notes<doc-releaserepos>`
  68
  69
  70 Guilin Major Release 7.0.0
  71 ==========================
  72
  73 +--------------------------------------+--------------------------------------+
  74 | **Project**                          | Open Network Automation Platform     |
  75 |                                      | (ONAP)                               |
  76 +--------------------------------------+--------------------------------------+
  77 | **Release name**                     | Guilin                               |
  78 |                                      |                                      |
  79 +--------------------------------------+--------------------------------------+
  80 | **Release version**                  | 7.0.0                                |
  81 |                                      |                                      |
  82 +--------------------------------------+--------------------------------------+
  83 | **Release date**                     | December 3rd 2020                    |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86
  87 Guilin Features
  88 ===============
  89 ONAP Guilin focusses on:
  90
  91 * 5G network automation and services such as network slicing through RAN, core
  92   and transport
  93 * deepening O-RAN Software Community integration along with other leading SDOs
  94 * seamless orchestration of CNFs, VNFs and PNFs
  95 * and bringing several new ONAP Blueprint and docs updates.
  96
  97 5G Network Slicing
  98 ------------------
  99 In the industry evolution toward 5G networks, Guilin expands upon the
 100 end-to-end network slicing introduced with Frankfurt with the addition of RAN,
 101 core, and transport through Network Slice Subnet Management Function (NSSMF)
 102 which completes functionality with the Communication Service Management
 103 Function (CSMF) and Network Slice Management Function (NSMF) components. In
 104 addition to the NSSMF included in Guilin, ONAP supports an external RAN NSSMF.
 105 Next, the RAN domain also has initial support for a simple closed control loop
 106 and machine learning (ML) for intelligent slicing.
 107
 108 ONAP/O-RAN Alignment
 109 --------------------
 110 The release also marks greater ONAP + O-RAN Software Community harmonization by
 111 adding  support for the A1 interface (O-RAN A1-AP v1.1), adding to the existing
 112 O1 support. ONAP can now manage multiple A1 targets with different versions and
 113 includes a A1 Policy Management Service that interacts with the Near Real-Time
 114 RIC\19s policy instances and provides a transient cache for these policies.
 115
 116 CNF, VNF and PNF integration
 117 ----------------------------
 118 Guilin contains a large number of new features classified into design time,
 119 run time, and ONAP operations to optimize the self-serve control loop and
 120 dashboard, make it easier to reuse existing models, make xNF pre-onboarding and
 121 onboarding easier, speed up UI development, and more. For Documentation
 122 (Usability), ONAP documentation made improvements such as setting up ONAP,
 123 Platform Operations, Service Design and Deployment, and User Guides. Specific
 124 to cloud native, The Service Design & Creation (SDC) project, the unified
 125 design time tool, now supports Helm types to natively support Cloud Native
 126 Network Functions (CNF).
 127
 128 Enhancements in ONAP Blueprints
 129 -------------------------------
 130 Other enhancements to the ONAP Blueprints includes a new Standard Defined VNF
 131 Event Stream (VES) event for Fault Management (FM) / Performance Management
 132 (PM) Data Collection, the first use of Machine Learning in Self-Organizing
 133 Networks (SON), and greater support for 5G RAN Wireless Network Resource Model
 134 (NRM) with Service Modeling and Definition and Intent Based Network supporting
 135 intent-drive 5G slice creation. The Cross Domain and Cross Layer VPN (CC-VPN)
 136 includes transport slicing and the MDONS (Multi-Domain Optical Network Service
 137 ) has been extended.
 138
 139 Functional Requirements
 140 -----------------------
 141 The following requirements have been introduced in the Guilin Release:
 142
 143 xNF Integration
 144 ...............
 145
 146 - ONAP CNF orchestration - Enhancements
 147 - Extension of PNF Pre-onboarding/onboarding
 148 - Enhancements for PNF Plug & Play'
 149 - xNF License Management
 150
 151 Lifecycle Management
 152 ....................
 153
 154 - Policy Based Filtering
 155 - CLAMP Deployment of Native policies
 156 - Bulk PM / PM Data Control Extension
 157 - Support xNF Software Upgrade in association to schema updates
 158 - Configuration & Persistency Service
 159
 160 Security
 161 ........
 162
 163 - CMPv2 Enhancements
 164
 165 Standard alignment
 166 ..................
 167
 168 - ETSI-Alignment for Guilin
 169 - ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES
 170 - Extend ORAN A1 Adapter and add A1 Policy Management
 171
 172 NFV testing Automatic Platform
 173 ...............................
 174
 175 - Test Result Auto Analysis & Certification
 176 - Test Task Auto Execution
 177 - Test Environment Auto Deploy
 178 - Test Topology Auto Design
 179
 180 Non-Functional Requirements
 181 ---------------------------
 182 The following 'non-functional' requirements have been introduced in the Guilin
 183 Release:
 184
 185 Best Practice
 186 .............
 187
 188 - ONAP shall use STDOUT for logs collection
 189 - IPv4/IPv6 dual stack support in ONAP (Guilin)
 190 - Containers must crash properly when a failure occurs
 191 - Containers must have no more than one main process
 192 - Application config should be fully prepared before starting the
 193   application container
 194 - No root (superuser) access to database from application container
 195
 196 Code Quality
 197 ............
 198
 199 - Each ONAP project shall improve its CII Badging score by improving input
 200   validation and documenting it in their CII Badging site
 201 - Each ONAP project shall define code coverage improvements and achieve at
 202   least 55% code coverage
 203
 204 Security
 205 ........
 206
 207 - ONAP must complete update of the Python language (from 2.7 -> 3.8)
 208 - ONAP must complete update of the java language (from v8 -> v11)
 209 - All containers must run as non-root user
 210 - Continue hardcoded passwords removal
 211 - Flow management must be activated for ONAP.
 212 - Each project will update the vulnerable direct dependencies in their code
 213   base
 214
 215 Tests
 216 .....
 217
 218 - More tests integrated in CI/CD but enhancements expected in Honolulu
 219 - ONAP shall increase the number of Docker Benchmark tests
 220
 221 Others
 222 ......
 223
 224 - ONAP to support Multi - tenancy
 225
 226 .. important::
 227    Some non-functional requirements are not fully finalized. Please, check details
 228    on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
 229
 230
 231 Project Specific Release Notes
 232 ==============================
 233 ONAP releases are specified by a list of project artifact versions in the
 234 project repositories and docker container image versions listed in the OOM
 235 Helm charts.
 236
 237 Each project provides detailed :ref:`release notes<doc-releaserepos>`
 238 and prepends to these if/when any updated versions the project team believes
 239 are compatible with a major release are made available.
 240
 241 Documentation
 242 =============
 243 ONAP Guilin Release provides a set selection of documents,
 244 see `ONAP Documentation <https://docs.onap.org/en/guilin/index.html>`_.
 245
 246 The `developer wiki <http://wiki.onap.org>`_ remains a good source of
 247 information on meeting plans and notes from committees, project teams and
 248 community events.
 249
 250 Security Notes
 251 ==============
 252 Details about discovered and mitigated vulnerabilities are in
 253 :ref:`ONAP Security <onap-osa:onap-security>`
 254
 255 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 256
 257 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
 258 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 259
 260 In the Guilin release,
 261
 262 - 100% projects passed 90% of the CII badge
 263 - 85% projects passed the CII badge
 264 - 11% projects passed the CII Silver badge
 265
 266 Project specific details are in the :ref:`release notes<doc-releaserepos>` for
 267 each project.
 268
 269 .. index:: maturity
 270
 271 ONAP Maturity Testing Notes
 272 ===========================
 273 For the Guilin release, ONAP continues to improve in multiple areas of
 274 Scalability, Security, Stability and Performance (S3P) metrics.
 275
 276 In Guilin the Integration team focussed in
 277
 278 - Automating ONAP Testing to improve the overall quality
 279 - Adding security and E2E tests
 280 - Integrated new ONAP Python SDK in E2E testing
 281
 282 More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
 283
 284 Known Issues and Limitations
 285 ============================
 286 Known Issues and limitations are documented in each
 287 :ref:`project Release Notes <doc-releaserepos>`.
 288
 289
 290 .. Include files referenced by link in the toctree as hidden