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