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