update architecture description
[doc.git] / docs / release / index.rst
index 9a3dff5..555ca8b 100644 (file)
@@ -1,13 +1,14 @@
-.. This work is licensed under a Creative Commons Attribution 4.0
-   International License. http://creativecommons.org/licenses/by/4.0
+..
+  This work is licensed under a Creative Commons Attribution 4.0
+  International License. http://creativecommons.org/licenses/by/4.0
 
 
 .. _onap-release-notes:
 
-Guilin Release Notes
-^^^^^^^^^^^^^^^^^^^^
+'NewDelhi' Release Notes
+========================
 
-This page provides the release notes for the ONAP Guilin release. This
+This page provides the release notes for the ONAP 'NewDelhi' release. This
 includes details of software versions, known limitations, and outstanding
 trouble reports.
 
@@ -19,271 +20,124 @@ release notes and links to those release notes are provided below.
 Details on the specific items delivered in each release by each component is
 maintained in the component specific release notes.
 
-Guilin Releases
-===============
-
-The following releases are available for Guilin:
-  - `Guilin Maintenance Release 7.0.1`_
-  - `Guilin Major Release 7.0.0`_
-
-Guilin Maintenance Release 7.0.1
-================================
-
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Open Network Automation Platform     |
-|                                      | (ONAP)                               |
-+--------------------------------------+--------------------------------------+
-| **Release name**                     | Guilin Maintenance Release           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release version**                  | 7.0.1                                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | March 11th 2021                      |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-New Features
-============
-
-Guilin Maintenance Release 7.0.1 delivered a number of fixes and updates
-across the following projects:
-
- - AAI         - bug fixes and certificate update
- - CCSDK       - bug fixes and certificate update
- - DCAEGEN2    - bug fixes
- - DMaaP       - bug fixes
- - DOC         - restructure user guides section and added tutorials
- - Integration - new docker for robot framework
- - Music       - certificate update
- - MSB         - bug fixes
- - OOM         - docker improvement
- - SDNC        - bug fixes
- - SO          - bug fixes
- - VID         - certificate update
-
-Details on the specific Jira tickets addressed by each project can be found in
-the component specific Release Notes: :ref:`release notes<doc-releaserepos>`
-
-
-Guilin Major Release 7.0.0
-==========================
-
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Open Network Automation Platform     |
-|                                      | (ONAP)                               |
-+--------------------------------------+--------------------------------------+
-| **Release name**                     | Guilin                               |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release version**                  | 7.0.0                                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | December 3rd 2020                    |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-Guilin Features
-===============
-ONAP Guilin focusses on:
-
-* 5G network automation and services such as network slicing through RAN, core
-  and transport
-* deepening O-RAN Software Community integration along with other leading SDOs
-* seamless orchestration of CNFs, VNFs and PNFs
-* and bringing several new ONAP Blueprint and docs updates.
-
-5G Network Slicing
-------------------
-In the industry evolution toward 5G networks, Guilin expands upon the
-end-to-end network slicing introduced with Frankfurt with the addition of RAN,
-core, and transport through Network Slice Subnet Management Function (NSSMF)
-which completes functionality with the Communication Service Management
-Function (CSMF) and Network Slice Management Function (NSMF) components. In
-addition to the NSSMF included in Guilin, ONAP supports an external RAN NSSMF.
-Next, the RAN domain also has initial support for a simple closed control loop
-and machine learning (ML) for intelligent slicing.
-
-ONAP/O-RAN Alignment
---------------------
-The release also marks greater ONAP + O-RAN Software Community harmonization by
-adding  support for the A1 interface (O-RAN A1-AP v1.1), adding to the existing
-O1 support. ONAP can now manage multiple A1 targets with different versions and
-includes a A1 Policy Management Service that interacts with the Near Real-Time
-RIC\19s policy instances and provides a transient cache for these policies.
-
-CNF, VNF and PNF integration
-----------------------------
-Guilin contains a large number of new features classified into design time,
-run time, and ONAP operations to optimize the self-serve control loop and
-dashboard, make it easier to reuse existing models, make xNF pre-onboarding and
-onboarding easier, speed up UI development, and more. For Documentation
-(Usability), ONAP documentation made improvements such as setting up ONAP,
-Platform Operations, Service Design and Deployment, and User Guides. Specific
-to cloud native, The Service Design & Creation (SDC) project, the unified
-design time tool, now supports Helm types to natively support Cloud Native
-Network Functions (CNF).
-
-Enhancements in ONAP Blueprints
+'NewDelhi' Major Release 14.0.0
 -------------------------------
-Other enhancements to the ONAP Blueprints includes a new Standard Defined VNF
-Event Stream (VES) event for Fault Management (FM) / Performance Management
-(PM) Data Collection, the first use of Machine Learning in Self-Organizing
-Networks (SON), and greater support for 5G RAN Wireless Network Resource Model
-(NRM) with Service Modeling and Definition and Intent Based Network supporting
-intent-drive 5G slice creation. The Cross Domain and Cross Layer VPN (CC-VPN)
-includes transport slicing and the MDONS (Multi-Domain Optical Network Service
-) has been extended.
-
-Functional Requirements
------------------------
-The following requirements have been introduced in the Guilin Release:
-
-xNF Integration
-...............
-
-- ONAP CNF orchestration - Enhancements
-- Extension of PNF Pre-onboarding/onboarding
-- Enhancements for PNF Plug & Play'
-- xNF License Management
-
-Lifecycle Management
-....................
-
-- Policy Based Filtering
-- CLAMP Deployment of Native policies
-- Bulk PM / PM Data Control Extension
-- Support xNF Software Upgrade in association to schema updates
-- Configuration & Persistency Service
-
-Security
-........
-
-- CMPv2 Enhancements
 
-Standard alignment
-..................
++-----------------------------------+-----------------------------------------+
+| **Project**                       | Open Network Automation Platform (ONAP) |
++-----------------------------------+-----------------------------------------+
+| **Release name**                  | NewDelhi                                |
++-----------------------------------+-----------------------------------------+
+| **Release version**               | 14.0.0                                  |
++-----------------------------------+-----------------------------------------+
+| **Release date**                  | 2024, not released yet                  |
++-----------------------------------+-----------------------------------------+
 
-- ETSI-Alignment for Guilin
-- ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES
-- Extend ORAN A1 Adapter and add A1 Policy Management
+ONAP is evolving. We took efforts in streamlining processes and roles and
+NewDelhi release is the first one with agreed simplified software development
+life cycle governance.
 
-NFV testing Automatic Platform
-...............................
+OpenSSF Gold Standard
+---------------------
 
-- Test Result Auto Analysis & Certification
-- Test Task Auto Execution
-- Test Environment Auto Deploy
-- Test Topology Auto Design
+We are proud to announce that first ONAP project achieved OpenSSF Gold
+standard. It will give ONAP consumers great confidence in the quality,
+security, and reliability of CPS.
 
-Non-Functional Requirements
----------------------------
-The following 'non-functional' requirements have been introduced in the Guilin
-Release:
+Java 17
+-------
 
-Best Practice
-.............
+First ONAP projects (CCSDK, CPS, UUI and Policy) completed their upgrades to
+Java 17. Spring boot (uplift to v3.1.2) and OpenApi 3 upgrades were also
+performed. These upgrades allow benefits of patched vulnerabilities and
+software efficiencies in the latest versions.
 
-- ONAP shall use STDOUT for logs collection
-- IPv4/IPv6 dual stack support in ONAP (Guilin)
-- Containers must crash properly when a failure occurs
-- Containers must have no more than one main process
-- Application config should be fully prepared before starting the
-  application container
-- No root (superuser) access to database from application container
+CPS
+---
 
-Code Quality
-............
+ONAP CPS project continued efforts in improvement of read/write, query
+operations, and huge reduction of memory consumption allowing for improved
+query performance and improve stability.
 
-- Each ONAP project shall improve its CII Badging score by improving input
-  validation and documenting it in their CII Badging site
-- Each ONAP project shall define code coverage improvements and achieve at
-  least 55% code coverage
+Modeling
+--------
 
-Security
-........
+Modeling project added provision of YANG modules automation tools, which helps
+improve the YANG development efficiency and check the version update of the
+YANG model.
 
-- ONAP must complete update of the Python language (from 2.7 -> 3.8)
-- ONAP must complete update of the java language (from v8 -> v11)
-- All containers must run as non-root user
-- Continue hardcoded passwords removal
-- Flow management must be activated for ONAP.
-- Each project will update the vulnerable direct dependencies in their code
-  base
+OOM
+---
 
-Tests
-.....
+OOM project team added support for Gateway-API in Ingress template (13.0.1) as
+well as support for mariadb-operator (13.0.2). All ONAP MariaDB instances will
+now be created with the latest version by default using the mariaDB-operator.
+Added Galera clients (e.g. SO, SDNC) will use access to "primary" pod to avoid
+"Deadlocks". Additionally added default role creation to ServiceAccount for
+better access management.
 
-- More tests integrated in CI/CD but enhancements expected in Honolulu
-- ONAP shall increase the number of Docker Benchmark tests
+SDC
+---
 
-Others
-......
+SDC implemented-services update capability directly in yaml was added, more
+comprehensive support for defining behavior of interface operations and
+adaptability to define CSAR structure and content to suit the requirements of
+individual models.
 
-- ONAP to support Multi - tenancy
+CCSDK
+-----
 
-.. important::
-   Some non-functional requirements are not fully finalized. Please, check details
-   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
+CCSDK continued maintaining alignment with OpenDaylight release schedule by
+upgrading to OpenDaylight Argon version, Service Release 2. This allows latest
+ONAP user to make use of latest OpenDaylight software when they use latest
+release of ONAP.
 
+PortalNG
+--------s
 
-Project Specific Release Notes
-==============================
-ONAP releases are specified by a list of project artifact versions in the
-project repositories and docker container image versions listed in the OOM
-Helm charts.
+We introduced new PortalNG as a maintained alternative to the unmaintained
+Portal project.  Allows ONAP user to make informed decisions on software use of
+maintained and unmaintained projects.
 
-Each project provides detailed :ref:`release notes<doc-releaserepos>`
-and prepends to these if/when any updated versions the project team believes
-are compatible with a major release are made available.
+Documentation Sources
+---------------------
 
-Documentation
-=============
-ONAP Guilin Release provides a set selection of documents,
-see `ONAP Documentation <https://docs.onap.org/en/guilin/index.html>`_.
+The formal ONAP 'NewDelhi' Release Documentation is available
+in :ref:`ReadTheDocs<master_index>`.
 
-The `developer wiki <http://wiki.onap.org>`_ remains a good source of
+The `Developer Wiki <http://wiki.onap.org>`_ remains a good source of
 information on meeting plans and notes from committees, project teams and
 community events.
 
-Security Notes
-==============
-Details about discovered and mitigated vulnerabilities are in
-:ref:`ONAP Security <onap-osa:onap-security>`
+OpenSSF Best Practice
+---------------------
 
-ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
+ONAP has adopted the `OpenSSF Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 
 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 
-In the Guilin release,
 
-- 100% projects passed 90% of the CII badge
-- 85% projects passed the CII badge
-- 11% projects passed the CII Silver badge
+In the NewDelhi release,
+
+- 100% projects passed 95% of the OpenSSF badge
+- 94% passed the OpenSSF badge
+- 24% projects passed the OpenSSF Silver badge
+- 1 project passed the OpenSSF Gold badge
 
-Project specific details are in the :ref:`release notes<doc-releaserepos>` for
-each project.
+Project specific details are in the :ref:`release notes<component-release-notes>`
+for each component.
 
 .. index:: maturity
 
 ONAP Maturity Testing Notes
-===========================
-For the Guilin release, ONAP continues to improve in multiple areas of
+---------------------------
+For the 'NewDelhi' release, ONAP continues to improve in multiple areas of
 Scalability, Security, Stability and Performance (S3P) metrics.
 
-In Guilin the Integration team focussed in
-
-- Automating ONAP Testing to improve the overall quality
-- Adding security and E2E tests
-- Integrated new ONAP Python SDK in E2E testing
-
 More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
 
 Known Issues and Limitations
-============================
+----------------------------
 Known Issues and limitations are documented in each
-:ref:`project Release Notes <doc-releaserepos>`.
-
-
-.. Include files referenced by link in the toctree as hidden
+:ref:`project Release Notes <component-release-notes>`.