rework of index page; add icons
[doc.git] / docs / release / index.rst
index 70d535f..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:
 
-Istanbul Release Notes
-^^^^^^^^^^^^^^^^^^^^^^
+'Kohn' Release Notes
+====================
 
-This page provides the release notes for the ONAP Istanbul 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,271 +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.
 
-Istanbul Maintenance Release 9.0.1
-==================================
-
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Open Network Automation Platform     |
-|                                      | (ONAP)                               |
-+--------------------------------------+--------------------------------------+
-| **Release name**                     | Istanbul                             |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release version**                  | 9.0.1                                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | February 17th, 2022                  |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
+Kohn Major Release 11.0.0
+-------------------------
 
-Features
---------
-ONAP Istanbul Maintenance Release 1:
-
-- Log4j vulnerabilities in direct dependencies were removed from A&AI, DMAAP,
-  SDNC and VNFSDK.
-- Log4j vulnerabilities introduced by transitive dependencies
-  are still in A&AI, CCSDK, DCAE, DMAAP, MULTICLOUD, SDNC, SO, VNFSDK.
-
-Istanbul Major Release 9.0.0
-============================
-
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Open Network Automation Platform     |
-|                                      | (ONAP)                               |
-+--------------------------------------+--------------------------------------+
-| **Release name**                     | Istanbul                             |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release version**                  | 9.0.0                                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | November 15th, 2021                  |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
++-----------------------------------+-----------------------------------------+
+| **Project**                       | Open Network Automation Platform (ONAP) |
++-----------------------------------+-----------------------------------------+
+| **Release name**                  | Kohn                                    |
++-----------------------------------+-----------------------------------------+
+| **Release version**               | 11.0.0                                  |
++-----------------------------------+-----------------------------------------+
+| **Release date**                  | 2022, December 1st                      |
++-----------------------------------+-----------------------------------------+
 
 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
+
+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
-....................................
-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.
+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
-...................
-
-- 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.
+^^^^^^^^^^^^^^^^^^^
+
+- 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
-.......................
-
-- 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
+^^^^^^^^^^^^^^^^^^^^^^^
+
+- 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
 
-- Improvements for managing A1 Policies and terminating the A1 interface for
-  A1 Policies
-- A1 Adapter and A1 Policy Managements Enhancements
+- 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
 
-- SDN-C is based on OpenDaylight major release upgrade (Silicon)
-- Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface
 
 Service Design
-..............
+^^^^^^^^^^^^^^
+
+- Application Service Descriptor support with:
 
-- SDC can be used for onboarding resources and designing services with models
-  other than SDC AID
+  - 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
 
-- 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
+- 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
-Istanbul 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
-
-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
+- Standardized log fields
+- Support dual stack IPv4/Ipv6 across all ONAP modules
+- GUI test suites for all UI exposing modules
 
 Security
-........
+^^^^^^^^
+
+- 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)
 
-- 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
-.............
+^^^^^^^^^^^^^
+
+- Development guide updated
+- Structural changes in 'Guide' section
 
-- 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
+Tests & Integration
+^^^^^^^^^^^^^^^^^^^
 
-Tests
-.....
+- 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
 
-- New E2E tests: basic_cnf
-- New tests: CPS healthcheck
-- Stability tests: basic_vm and basic_onboard
 
 .. 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>`
 
-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.
+Documentation Sources
+---------------------
 
-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.
+The formal ONAP 'Kohn' Release Documentation is available
+in :ref:`ReadTheDocs<master_index>`.
 
-Documentation
-=============
-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
+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 Istanbul 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 Istanbul 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 Istanbul 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>`.
+:ref:`project Release Notes <component-release-notes>`.