rework of index page; add icons
[doc.git] / docs / release / index.rst
index 181f86f..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:
 
-Honolulu Release Notes
-^^^^^^^^^^^^^^^^^^^^^^
+'Kohn' Release Notes
+====================
 
-This page provides the release notes for the ONAP Honolulu 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,273 +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.
 
-Honolulu Releases
-=================
-
-The following releases are available for Honolulu:
-  - `Honolulu Maintenance Release 8.0.1`_
-  - `Honolulu Major Release 8.0.0`_
-
-Honolulu Maintenance Release 8.0.1
-==================================
-
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Open Network Automation Platform     |
-|                                      | (ONAP)                               |
-+--------------------------------------+--------------------------------------+
-| **Release name**                     | Honolulu Maintenance Release         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release version**                  | 8.0.1                                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | September 30th 2021                  |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-New Features
-============
-
-Honolulu Maintenance Release 8.0.1 delivered a number of fixes and updates
-across the following projects:
-
- - SO          - bugfixes and support for transport slicing usecase
- - CDS         - fix BluePrint* classes renaming
- - MULTICLOUD  - update of k8s plugin to support Helm3
- - OOM         - fixes for common Helm chart templates and product charts
- - POLICY      - new versions of Policy Framework components
- - DCAE        - new version of the policy-handler and dashboard
- - OOF         - use new AAI schema version (v21)
- - CCSDK       - fix fault and pnf-registration event losses
-
-Details on the specific Jira tickets addressed by each project can be found in
-the component specific Release Notes: :ref:`release notes<doc-releaserepos>`
-
-
-Honolulu Major Release 8.0.0
-============================
-
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Open Network Automation Platform     |
-|                                      | (ONAP)                               |
-+--------------------------------------+--------------------------------------+
-| **Release name**                     | Honolulu                             |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release version**                  | 8.0.0                                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | May 11th  2021                       |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-Honolulu Features
-=================
-ONAP Honolulu focusses on:
-
-* Cloud Native Function (CNF) support with  with seamless configuration of Helm
-  based CNFs and K8s resources
-* End-to-end 5G network slicing with three network slicing components for RAN,
-  core, and transport
-* Introducing a new component: Configuration Persistence Service (CPS) to store
-  persistent configuation data
-* Modularity to pick and choose the components needed for specific use case
-* Improving integration with many SDOs
+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
 -----------------------
 
-Increased Cloud Native Functionality
-....................................
-The Honolulu release has important updates to support cloud native network
-functions (CNF). The functionality includes configuration of Helm based CNFs
-and seamless day 1, 2 operations. The Configuration API allows a user to
-create, modify and delete Kubernetes (K8s) resource templates and their base
-parameters and the Profile API allows for sophisticated day 0 configuration.
-The Query API gathers filtered status of the CNF and the HealthCheck API
-executes dedicated health check jobs to verify the status of a CNF. This new
-functionality is implemented in the Controller Design Studio (CDS) component
-using dedicated templates called Controller Blueprint Archives (CBA).
-In addition, there is Swagger documentation for the API of the K8s plugin
-component in the MutliCloud project.
-
-Deeper 5G Support
-.................
-There is a significant set of new functionality around end-to-end 5G network
-slicing in the Honolulu release. This release includes three internal Network
-Slice Subnet Management Function (NSSMF) components for RAN, core, and
-transport domains. External NSSMFs continue to be supported for RAN and core.
-Next, slice optimization continues to be an area of ongoing effort with closed
-loop automation and intelligent slicing testing. There are also enhancements in
-NST, NSI, and NSSI selection in the OOF project and A&AI includes schema
-changes to accommodate network and transport slicing.
-
-In addition, the ExtAPI project now included Enhanced Service Ordering for
-additional service types and the UUI graphical user interface has improved
-slicing support. The VID graphical user has support for PNF plug-and-play
-allowing operators to interact with PNFs via VID. In addition, there is better
-compliance to standards such as 3GPP TS28.540/541 5G NRM driven xNF models in
-ONAP. Finally the OOF SON functionality supports offline trained ML-models
-providing additional inputs for Physical Cell Identity (PCI) optimization.
-DCAE includes a new KPI microservice.
-
-Configuration Persistence Service
-.................................
-Another key 5G related initiative is the new Configuration Persistence Service
-(CPS) module that allows ONAP projects to store persistent state defined by
-YANG models, deploy YANG models at runtime, and share access to configuration
-management data.
-
-Further O-RAN Integration
-.........................
-A key enhancement in the Honolulu release was increased support for the O-RAN
-A1 standard that is implemented in the CCSDK and SDN-C projects. The O-RAN A1
-interface provides a flexible way for RAN operators to manage wide area RAN
-network optimization reducing capex investment needs. Both the enhanced A1
-interface controller and A1 policy capabilities are now usable in ONAP with a
-Near-Real-Time Radio Intelligent Controller (nRTRIC). This functionality is
-also used downstream in O-RAN-Source Community (OSC) Non-RealTime RIC
-(NONRTRIC) project, strengthening alignment between ONAP & OSC. In addition,
-the DCAE project includes VES 7.2 integration that improves integration with
-both O-RAN and 3GPP. Finally, there is a new CPS interface to query RAN
-configuration data.
-
-Expanded Modularity
-...................
-Modularity has been an important topic in ONAP to allow users to pick and
-choose the components they need for their specific use case and Honolulu
-continues to advance modularity. DCAE now simplifies microservice deployment
-via Helm charts.
+Richer set of Cloud Native Functionality
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- CDS support for Application Service Descriptor
+
+  - Onboarding ASD CSARs
+  - Transformation to ONAP SDC CSAR
+  - Model updates to support ASD TOSCA types
+  - Support in SDC TOSCA parser
+
+- SO improved flows around the CNF orchestration, CNF Upgrade, and minor bug
+  fixes around the slicing use case.
+
+  - 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
-..............
+^^^^^^^^^^^^^^
 
-- Includes increased support for ETSI standards such as SOL001, SOL004, and
-  SOL007 and allows users to choose unlicensed or externally licensed xNFs.
-- Vendor License Model is now optional
-- SDC distribution status report enhanced
+- Application Service Descriptor support with:
+
+  - Onboarding ASD CSARs
+  - Transformation to ONAP SDC CSAR
+  - Model updates to support ASD TOSCA types
+  - Support in SDC TOSCA parser
+
+- 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
 
 Inventory
-.........
+^^^^^^^^^
+
+- 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
 
-- A&AI includes support for multi tenancy.
-- Model updates for CCVPN Transport Slicing and Network Slicing
-- GraphGraph POC enhanced for schema visualization and visual model generation
-- Sparky UI updates including Browse, Specialized Search, BYOQ, and BYOQ
-  Builder Views
 
 ONAP Operations Manager
-.......................
+^^^^^^^^^^^^^^^^^^^^^^^
 
-- Portal-Cassandra image updated to Bitnami, supporting IPv4/IPv6 Dual Stack
-- CMPv2 external issuer implemented which extends Cert-Manager with ability to
-  enroll X.509 certificates from CMPv2 servers
-- New version for MariaDB Galera using Bitnami image, supporting IPv4/IPv6 Dual
-  Stack
-- Support of Helm v3.4 and Helm v3.5
+- 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 are followed in the
-Honolulu Release:
+Kohn 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
+- 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
-........
 
-- 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
+Documentation
+^^^^^^^^^^^^^
 
-Tests
-.....
+- Development guide updated
+- Structural changes in 'Guide' section
 
-- New E2E tests
-- New IPv4/Ipv6 daily CI chain
+Tests & Integration
+^^^^^^^^^^^^^^^^^^^
 
-.. important::
-   Some non-functional requirements are not fully finalized. Please, check details
-   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
+- deployment/noheat refactorization, fixes and updates:
 
+  - 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
 
-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.
 
-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.
+.. important::
+   Some non-functional requirements are not fully finalized. Please, check details
+   on the :doc:`Integration <onap-integration:usecases/release_non_functional_requirements>`
 
-Documentation
-=============
-ONAP Honolulu Release provides a set selection of documents,
-see :ref:`ONAP Documentation<master_index>`.
+Documentation Sources
+---------------------
+
+The formal ONAP 'Kohn' 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 Honolulu 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 Honolulu 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 Honolulu the Integration team focussed in
-
-- Automating ONAP Testing to improve the overall quality
-- Adding security and E2E tests
 
 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>`.