update composite release notes
[doc.git] / docs / release / index.rst
index 0a342d3..0bd6346 100644 (file)
@@ -2,12 +2,12 @@
    International License. http://creativecommons.org/licenses/by/4.0
 
 
-.. _release-notes:
+.. _onap-release-notes:
 
-Guilin Release Notes
-^^^^^^^^^^^^^^^^^^^^
+Istanbul Release Notes
+^^^^^^^^^^^^^^^^^^^^^^
 
-This page provides the release notes for the ONAP Guilin release. This
+This page provides the release notes for the ONAP Istanbul release. This
 includes details of software versions, known limitations, and outstanding
 trouble reports.
 
@@ -19,56 +19,215 @@ 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
-===============
+Istanbul Maintenance Release 9.1.0
+==================================
 
-The following releases are available for Guilin:
-  - `Guilin Major Release 7.0.0`_
++--------------------------------------+--------------------------------------+
+| **Project**                          | Open Network Automation Platform     |
+|                                      | (ONAP)                               |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Istanbul                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 9.1.0                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | February 17th, 2022                  |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
-Guilin Major Release 7.0.0
-==========================
+Features
+--------
+ONAP Istanbul Maintenance Release 1 focusses on:
 
-Release data
-============
+- fixing log4j vulnerabilities in AAI, CPS, DCAEGEN2, DMAAP, POLICY, SDNC
+  and VNFSDK 
+
+Istanbul Major Release 9.0.0
+============================
 
 +--------------------------------------+--------------------------------------+
 | **Project**                          | Open Network Automation Platform     |
 |                                      | (ONAP)                               |
 +--------------------------------------+--------------------------------------+
-| **Release name**                     | Guilin                               |
+| **Release name**                     | Istanbul                             |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release version**                  | 7.0.0                                |
+| **Release version**                  | 9.0.0                                |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | December 3rd 2020                    |
+| **Release date**                     | November 15th, 2021                  |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-Guilin Features
-===============
-ONAP Gulin focusses on:
+Features
+--------
+ONAP Istanbul focusses on:
+
+- Intent based networking (IBN) simplifies interaction and network
+  configuration by Control-Loop and Smart AI.
+- Alignment with O-RAN Strategy to enable new RAN use cases
+- Continued Cloud Native evolution with a rich feature set for CNF
+  orchestration capabilities
+- Next level of functionality for 5G use cases including Network Slicing,
+  Performance management, SON, and CCVPN
+- A second generation of control loop automation architecture
+- New Network Function lifecycle management features based on real-life use
+  cases
+- New functionality for complex network configuration management
+- Flexibility in resource onboarding with choice of modeling including SDC AID,
+  ETSI SOL001
+- Software quality and security improvements based on deployment experience
+
+Functional Requirements
+-----------------------
+
+Increased Cloud Native Functionality
+....................................
+Information about created CNF resources in k8s cluster are now available. This
+information can be utilized later on i.e. in closed-loop context. CNF
+Healthcheck Workflow in SO will let to monitor the status of CNF deployed into
+k8s cluster and whether it is healthy or not. Further changes in k8splugin
+related to Helm specification support allow for the better and more reliable
+deployment of complex CNFs defined as a Helm package. ONAP now supports
+Helm 3.5 package specification.
+
+E2E Network Slicing
+...................
+
+- Support for NSMF (Network Slice Management Function) based TN
+  (Transport Network) slices in which NSMF is responsible for TN-FH (FrontHaul)
+  and TN-MH (MidHaul) allocation
+- RAN NSSMF (Network Slice Subnet Management Function) integration with CPS
+  (Configuration Persistence Service) and handled closed loop impacts
+- POC on A1-interface for closed loop updates
+- KPI Monitoring enhancements
+
+Intent-based networking
+.......................
+The Intent Based Networking (IBN) use case includes the development of an
+intent framework that contains intent modeling, intent translation, intent
+execution and intent decision making. The intent UI is implemented in UUI
+and the components of the intent framework interact with many components of
+ONAP including SO, A&AI, Policy, DCAE, and CDS.
+
+Control Loop evolutions
+.......................
+
+- CLAMP functionality is merged into Policy Framework project
+- Control Loops can be defined and described in Metadata using TOSCA. Control
+  loops can run on the fly on any component that implements  a *participant*
+  API. Control Loops can be commissioned into Policy/CLAMP, they can be
+  parameterized, initiated on arbitrary participants, activated and monitored
+- Policy Handling Improvements: Support delta policies in PDPs
+- CLAMP Client Policy and TOSCA Handling
+- Policy Handling Improvements
+- System Attribute Improvements
+
+Fault management
+................
+
+- Updates in fault management reporting and fault handling to be in line with
+  VES 7.2, 3GPP and smoother future alignment with O1 for OOF-SON
+- Performance Management data collection control provides 5G network operators
+  with a dynamic and more efficient way to configure performance measurement
+  collection on a selected subset of PNFs/VNFs in the network and complements
+  the existing PM data collection and processing capabilities in ONAP/DCAE
+- Simplified deployment for DCAE services via Helm
+- Reduction on ONAP/DCAE footprint under transformation initiative by
+  deprecating Cloudify based platform components and Consul
+- VES 7.2.1 integration for HV_VES enables ONAP, 3GPP, ORAN alignment
+- Enhancements for Network Slicing, Bulk PM, OOF-SON usecases
+
+Extended O-RAN Integration
+..........................
+
+- Improvements for managing A1 Policies and terminating the A1 interface for
+  A1 Policies
+- A1 Adapter and A1 Policy Managements Enhancements
+
+Controllers
+...........
+
+- SDN-C is based on OpenDaylight major release upgrade (Silicon)
+- Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface
+
+Service Design
+..............
+
+- SDC can be used for onboarding resources and designing services with models
+  other than SDC AID
+
+Inventory
+.........
+
+- Model updates as part of CCVPN Transport Slicing Feature
+- Model updates as part of Smart Intent Guarantee based on IBN Feature
+- Model updates as part of CNF Orchestration Feature
+
+ONAP Operations Manager
+.......................
+
+- IPv4 / IPv6 dual stack support in ONAP: support for Kubernetes 1.20+
+  DualStack networking properties in ONAP K8S Service spec properties.
+  Upgraded EJBCA CMP v2 server to version 7.x
+- CMPv2 enhancements: certificate update implemented using Key Update Request
+  (KUR) and Certificate Request (CR) CMPv2 messages
+
+Non-Functional Requirements
+---------------------------
+
+The following 'non-functional' requirements are followed in the
+Istanbul Release:
+
+Best Practice
+.............
+
+- ONAP shall use STDOUT for logs collection
+- IPv4/IPv6 dual stack support in ONAP
+- 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
+
+Code Quality
+............
+
+- 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
+
+Security
+........
+
+- Python language 3.8
+- Java language 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
 
-* 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.
+Documentation
+.............
 
-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.
+- Interactive architecture map including short description and link to detailed
+  documentation for every architecture building block
+- Changes in the Sphinx configuration for all contributing projects
+- Guide to set up a documentation development environment with preview function
 
-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. 
+Tests
+.....
 
-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).
+- New E2E tests: basic_cnf
+- New tests: CPS healthcheck
+- Stability tests: basic_vm and basic_onboard
 
-Enhancements in ONAP Blueprints
--------------------------------
-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.
+.. important::
+   Some non-functional requirements are not fully finalized. Please, check details
+   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
 
 Project Specific Release Notes
 ==============================
@@ -82,8 +241,8 @@ are compatible with a major release are made available.
 
 Documentation
 =============
-ONAP Guilin Release provides a set selection of documents,
-see `ONAP Documentation <https://docs.onap.org/en/guilin/index.html>`_.
+ONAP Istanbul Release provides a set selection of documents,
+see :ref:`ONAP Documentation<master_index>`.
 
 The `developer wiki <http://wiki.onap.org>`_ remains a good source of
 information on meeting plans and notes from committees, project teams and
@@ -99,7 +258,11 @@ ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.cor
 - `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, 24% projects pass the CII badge, 52% projects pass 75% of the CII silver badge tests (next badge up from the vanilla CII badge), 5% projects pass 84% of the CII silver badge tests, and 20% pass the entirety of the silver CII badge.
+In the Istanbul release,
+
+- 100% projects passed 90% of the CII badge
+- 85% projects passed the CII badge
+- 11% projects passed the CII Silver badge
 
 Project specific details are in the :ref:`release notes<doc-releaserepos>` for
 each project.
@@ -108,14 +271,13 @@ each project.
 
 ONAP Maturity Testing Notes
 ===========================
-For the Guilin release, ONAP continues to improve in multiple areas of
+For the Istanbul release, ONAP continues to improve in multiple areas of
 Scalability, Security, Stability and Performance (S3P) metrics.
 
-In Guilin the Integration team focussed in
+In Istanbul 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>`
 
@@ -123,6 +285,3 @@ 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