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