rework of index page; add icons
[doc.git] / docs / release / index.rst
index 1038209..2b58d21 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
-^^^^^^^^^^^^^^^^^^^^
+'Kohn' Release Notes
+====================
 
-This page provides the release notes for the ONAP Guilin release. This
+This page provides the release notes for the ONAP 'Kohn' release. This
 includes details of software versions, known limitations, and outstanding
 trouble reports.
 
@@ -19,233 +20,247 @@ 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 Major Release 7.0.0`_
-
-Guilin Major Release 7.0.0
-==========================
-
-Release data
-============
-
-+--------------------------------------+--------------------------------------+
-| **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
--------------------------------
-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.
+Kohn Major Release 11.0.0
+-------------------------
+
++-----------------------------------+-----------------------------------------+
+| **Project**                       | Open Network Automation Platform (ONAP) |
++-----------------------------------+-----------------------------------------+
+| **Release name**                  | Kohn                                    |
++-----------------------------------+-----------------------------------------+
+| **Release version**               | 11.0.0                                  |
++-----------------------------------+-----------------------------------------+
+| **Release date**                  | 2022, December 1st                      |
++-----------------------------------+-----------------------------------------+
+
+Features
+--------
+
+ONAP 'Kohn' focusses on:
+
+- Further O-RAN integration with A1 and O1 policy control for SON use cases
+- improved flows for Cloud-Native Network Functions (CNF) orchestration and
+  upgrade
+- Intent-driven Closed-loop Autonomous Networks with the CCVPN use case
+- Robust KPI computation for use in Intent Based E2E Network Slicing
+- Improved configuration query and change notifications in the Configuration
+  Persistency Service (CPS)
+- Improved slice analysis in the Control loop automation
+- Continued modernization of the Policy framework including Service Mesh
+  integration and native Kafka messaging
+- Security enhancements that include removal of known vulnerabilities and
+  adoption of key software supply chain artifacts
 
 Functional Requirements
 -----------------------
-The following requirements have been introduced in the Guilin Release:
 
-xNF Integration
-...............
+Richer set of Cloud Native Functionality
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- ONAP CNF orchestration - Enhancements
-- Extension of PNF Pre-onboarding/onboarding
-- Enhancements for PNF Plug & Play'
-- xNF License Management
+- CDS support for Application Service Descriptor
 
-Lifecycle Management
-....................
+  - Onboarding ASD CSARs
+  - Transformation to ONAP SDC CSAR
+  - Model updates to support ASD TOSCA types
+  - Support in SDC TOSCA parser
 
-- 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
+- SO improved flows around the CNF orchestration, CNF Upgrade, and minor bug
+  fixes around the slicing use case.
 
-Security
-........
+  - Create multiple PNF instances in the same request
+  - Support for long-running CDS process
+  - Recursive orchestration Support
+  - CNF Upgrade Workflow with Da-2 supported
+
+E2E Network Slicing
+^^^^^^^^^^^^^^^^^^^
+
+- Slice Analysis MS enhancement to support real-time intent listening using
+  DCAE SDK dmaap-client lib
+- KPI Computation MS enhancement to support new KPI reporting to UUI, KPIs
+  spanning multiple resources and error handling for missing counter
+- Enhancements for Intent-based Cloud Leased Line and Transport Slicing with
+  DCAE SDK alignment for SliceAnalysis MS & enhancing AAI interface for
+  supporting IBN CL
+
+Control Loop evolutions
+^^^^^^^^^^^^^^^^^^^^^^^
+
+- 5G SON use case enhancements including Control Loop message for ANR modified
+  to align with A1-based flow/support
+- CCVPN enhancements for Intent-based Cloud Leased Line and Transport Slicing
+
+
+Extended O-RAN Integration
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Continued maturing A1-Policy controller functions:
+
+  - Support updated RESTCONF spec (RFC 8040) between A1 PMS & A1 Adapter
+  - Numerous 3PP dependency updates
+  - Support custom south-bound adapters for custom A1-AP protocol versions
+  - Deprecate DMaaP NBI
+  - Improved logging / Tracing / Metrics
+  - Improved logging/debug-ability in CSIT tests
+  - Support JWT access tokens - for use in service mesh environments.
+  - Additional SONAR reporting for A1-PMS service
+
+- Better alignment with O-RAN in the 5G SON use case with use of O1 and A1
+  interfaces.
+
+  - Introduction of specific control loop flows for O1-based and A1-based RAN
+    actions. This includes changes in Policy, SDN-R, SON-Handler MS, and
+    RAN-Sim.
+  - Enhancement of RAN-Sim to support A1-based actions
+  - Modification of Control Loop message formats and policies to direct O1 and
+    A1 flows appropriately
+
+Controllers
+^^^^^^^^^^^
+
+- Resource Resolution Enhancements
+
+  - Enabled deleting resources by lastN occurrences
+  - Template headers, path, and outputs mapping in the rest processor
+  - The empty Output mapping means for JSON/MAP all keys and for other types
+    extracting of primitive
+  - The empty response is mapped to the value is output mapping is empty (but
+    not null)
+  - Open resolution processors for in-CBA customization
+  - Improve resolution tests verification
+  - Use RestProcessor for testing RestProcessor
+  - Added component for deleting resources and templates
+  - Fixed enrichment for multiple assignments
+  - Fixed the transform-templating for referenced complex types
+  - Creation of dynamic data-type using all workflow steps
+
+- CDS now has an endpoint for template deletion
+
+
+Service Design
+^^^^^^^^^^^^^^
 
-- CMPv2 Enhancements
+- Application Service Descriptor support with:
 
-Standard alignment
-..................
+  - Onboarding ASD CSARs
+  - Transformation to ONAP SDC CSAR
+  - Model updates to support ASD TOSCA types
+  - Support in SDC TOSCA parser
 
-- ETSI-Alignment for Guilin
-- ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES
-- Extend ORAN A1 Adapter and add A1 Policy Management
+- Deletion of archived assets
+- Improved support for TOSCA constructs
+- Support for TOSCA value expressions using TOSCA functions
+- Improved support for import of services
+- Application metrics
 
-NFV testing Automatic Platform
-...............................
+Inventory
+^^^^^^^^^
 
-- Test Result Auto Analysis & Certification
-- Test Task Auto Execution
-- Test Environment Auto Deploy
-- Test Topology Auto Design
+- Updates to schema and edge rules
+
+  - Model updates for User Network Interfaces (uni), Route target, Network
+    Route, BGP neighbor, VPN binding, Lag interface, Physical interface and
+    Logical interface
+  - Edge rule changes
+
+
+ONAP Operations Manager
+^^^^^^^^^^^^^^^^^^^^^^^
+
+- Update of Infrastructure and tools versions to improve build and deployment
+  time, as well as fixing vulnerabilities
+- Initial Setup for "ONAP on ServiceMesh" deployment as basis for the London
+  release
+  - using Istio 1.14.1 as SM platform
+  - including Istio Ingress Gateway for external access
+  - modify 90% of ONAP component charts to support Sevice Mesh
+  - Established daily deployment pipelines to test the SM setup
 
 Non-Functional Requirements
 ---------------------------
-The following 'non-functional' requirements have been introduced in the Guilin
-Release:
+
+The following 'non-functional' requirements are followed in the
+Kohn Release:
 
 Best Practice
-.............
+^^^^^^^^^^^^^
 
-- 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
+- Standardized log fields
+- Support dual stack IPv4/Ipv6 across all ONAP modules
+- GUI test suites for all UI exposing modules
 
-Code Quality
-............
+Security
+^^^^^^^^
 
-- 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
+- Adoption of software bill of materials (SBOMs)
+- Usage of basic images that provide the most updated and secure Java and
+  Python versions
+- Improve OpenSSF (formerly CII badging)
 
-Security
-........
 
-- 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
+Documentation
+^^^^^^^^^^^^^
+
+- Development guide updated
+- Structural changes in 'Guide' section
 
-Tests
-.....
+Tests & Integration
+^^^^^^^^^^^^^^^^^^^
 
-- More tests integrated in CI/CD but enhancements expected in Honolulu
-- ONAP shall increase the number of Docker Benchmark tests
+- deployment/noheat refactorization, fixes and updates:
 
-Others
-......
+  - Updated Ansible, Galaxy collections and Python libs to latest versions
+  - Better Galaxy collections and Python libraries versions management
+  - Added playbook to deploy Devstack
+  - Added option to deploy Istio
+  - Ability to set arbitrary overrides file
+  - Added one playbook to deploy whole infrastructure (i.e. create OpenStack
+    VMs in which Devstack, k8s and ONAP gets deployed)
+  - Documentation updates
 
-- ONAP to support Multi - tenancy
 
 .. important::
    Some non-functional requirements are not fully finalized. Please, check details
-   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
+   on the :doc:`Integration <onap-integration:usecases/release_non_functional_requirements>`
 
+Documentation Sources
+---------------------
 
-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.
+The formal ONAP 'Kohn' Release Documentation is available
+in :ref:`ReadTheDocs<master_index>`.
 
-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
-=============
-ONAP Guilin Release provides a set selection of documents,
-see `ONAP Documentation <https://docs.onap.org/en/guilin/index.html>`_.
-
-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,
+In the Kohn release,
 
-- 100% projects passed 90% of the CII badge
-- 85% projects passed the CII badge
-- 11% projects passed the CII Silver badge
+- 100% projects passed 90% of the OpenSSF badge
+- 86% passed the OpenSSF badge
+- 11% projects passed the OpenSSF Silver 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 Kohn 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>`.