From 9ef3cc590e9008f088a117ef1da63bf20be7c563 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Wed, 2 Nov 2022 14:51:48 +0100 Subject: update release notes (doc & composite) Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: I5cb0f352803edf4d01583bff5f6555e40bfc05ea (cherry picked from commit 0377ab25a167f310858e5f99f4f357745b7f2a32) --- docs/release/index.rst | 339 ++++++++++++++++++++++--------------------------- 1 file changed, 151 insertions(+), 188 deletions(-) (limited to 'docs/release/index.rst') diff --git a/docs/release/index.rst b/docs/release/index.rst index fb66c1327..e7fb8c57d 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -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: -ONAP 'Jakarta' Release Notes +ONAP 'Kohn' Release Notes ============================ -This page provides the release notes for the ONAP 'Jakarta' 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,238 +20,204 @@ 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. -Jakarta Major Release 10.0.0 ----------------------------- +Kohn Major Release 11.0.0 +------------------------- -+--------------------------------------+--------------------------------------+ -| **Project** | Open Network Automation Platform | -| | (ONAP) | -+--------------------------------------+--------------------------------------+ -| **Release name** | Jakarta | -| | | -+--------------------------------------+--------------------------------------+ -| **Release version** | 10.0.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | 2022, June 30th | -| | | -+--------------------------------------+--------------------------------------+ ++-----------------------------------+-----------------------------------------+ +| **Project** | Open Network Automation Platform (ONAP) | ++-----------------------------------+-----------------------------------------+ +| **Release name** | Kohn | ++-----------------------------------+-----------------------------------------+ +| **Release version** | 11.0.0 | ++-----------------------------------+-----------------------------------------+ +| **Release date** | not released yet | ++-----------------------------------+-----------------------------------------+ Features -------- -ONAP Jakarta focusses on: - -- Security enhancements in the A&AI, CCSDK, MSB, and MultiCloud projects, - reducing log4j vulnerability and removing most GPLv3 dependencies -- Deepened O-RAN integration in the OOF SON and CCSDK projects with O-RAN O1 - models and the O-RAN AI Policy interface (consumed downstream by the O-RAN - Software community) -- Enabling a richer set of day-2 configuration for Cloud-Native Network - Functions (CNF) through CDS API extensions -- Intent based networking (IBN) for closed loop for E2E Network Slicing -- New functionality in the Configuration Persistence Service (CPS) that allows - more granular control of configuration-heavy network services like RAN -- Simplification of control loop automation architecture, enabling easy - deployment of new control modules -- New Network Function lifecycle management features based on real-life use - cases -- Modeling: Solidified the data model for CNFs using the novel Application - Service Descriptor (ASD) approach, while continuing alignment with data - models produced by SDOs such as ETSI -- An overhaul of the policy framework allowing easy composition of control - loop policies and better observability -- Continued 5G Super Blueprint integrations, including EMCO, Magma 1.6, Anuket - and KubeRef RI2 +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 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Richer set of Cloud Native Functionality +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- CDS support for Application Service Descriptor -- Improved synchronization of k8s resources after the creation of the CNF. - When some change occurs for the CNF in the k8s cluster, k8splugin sends - a notification to the cnf-adapter which performs an update of the changes - into A&AI. -- CDS integration with k8splugin + - Onboarding ASD CSARs + - Transformation to ONAP SDC CSAR + - Model updates to support ASD TOSCA types + - Support in SDC TOSCA parser - - The creation of the profile allows the specification of labels and - additional k8sresource types to be returned by the status API - - Better Configuration API support including rollback, improved deletion - of the configuration with or without removal of the configuration - resources in the cluster - - Creation of the configuration template without a dedicated helm chart - which allows for easy update of the override values by configuration API - without a need to duplicate configuration template helm chart from the - main Helm chart. The configuration template (Helm chart) is taken from - the main definition. +- SO improved flows around the CNF orchestration, CNF Upgrade, and minor bug + fixes around the slicing use case. -- New model for CNF modeling: Application Service Descriptor (ASD) model + - 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 ^^^^^^^^^^^^^^^^^^^ -- CPS Integration with SDN-R for RAN Slice allocate and reconfigure scenarios -- E2E network Slicing with CPS is completed for allocation and re-use scenarios -- E2E Closed loop with CPS is functional -- IBN based closed loop with ML MS (POC) and Config DB is functional -- Optimization of cm-handle registration with CPS-DMI Plugin to upload yang - model -- CPS Integration Stabilization for RAN Slice activate/deactivate scenarios -- Addition of call to OOF for allocateNSSI to enable TN NSSI reuse in TN NSSMF -- Addition of call to OOF for terminateNxi API to deallocate NSSI - (without terminating TN NSSI even when NSI is terminated) in TN NSSMF -- Closed-loop enhancement in CCVPN to support Transport Slicing’s closed-loop +- 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 ^^^^^^^^^^^^^^^^^^^^^^^ -- Control Loop in TOSCA LCM Improvement: abstract Automation Composition - Management (ACM) logic with a generic Automation Composition definition, - isolating Composition logic from ONAP component logic. It elaborates APIs - that allow integrate with other design systems as well as 3PP component - integration. -- The current PMSH and TCS control loops are migrated to use an Automation - Composition approach. Support for Automation Compositions in SDC is also - introduced. -- A Metadata set allows a global set of metadata containing rules or global - parameters that all instances of a certain policy type can use. Metadata - sets are introduced in the Policy Framework in the Jakarta release. This - means that different rule set implementations can be associated with a - policy type, which can be used in appropriate situations. -- Introduction of Prometheus for monitoring Policy components so that - necessary alerts can be easily triggered and possible outages can be - avoided in production systems. - - - Expose application level metrics in policy components. An end user can - plug in a Prometheus instance and start listening to the metrics exposed - by Policy components and either raise alerts or show them on a Grafana - dashboard for operations team to keep monitoring the health of the system. - - Improve the policy/api and policy/pap readiness probes to handle database - failures so that the policy/api and policy/pap kubernetes pods are marked - ready only if the Policy database pod is ready. - - Provide sample Grafana dashboards for policy metrics - -- Migration of Policy Framework components to Springboot to support easier - handling, configuration and maintenance. -- Policy Framework Database Configurability. The Policy Framework can be - configured to use any JDBC-compliant RDBMS and configuration files are - supplied for the Postgres RDBMS. MariaDB remains the default RDBMS for the - Policy Framework in ONAP -- System Attribute Improvements - - - Transaction boundaries on REST calls are implemented per REST call - - JDBC backend uses Spring and Hibernate rather than Eclipselink - - All GUIs are now included in the policy/gui microservice - - Documentation is rationalized and cleaned up, testing documentation is - now complete - - Scripts are added to make release of the Policy Framework easier - -Fault management -^^^^^^^^^^^^^^^^ - -- DCAE Helm Transformation finalized -- Topic alignment for DCAE microservices: use standard topics for PM-Mapper, - Slice-Analysis and KPI-MS +- 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^ -- The O-RAN A1 interface (from the CCSDK project) provides a flexible way for - RAN operators to manage wide area RAN network optimization -- Enhanced A1 interface controller and A1 Policy capabilities are now usable - by any service provider deploying and using ONAP. This functionality is used - downstream in the O-RAN-SC Non-RealTime RIC project -- The OOF SON project has updated the SDN-R to use O-RAN aligned O1 YANG models - and the RAN-Sim to use O-RAN aligned O1 YANG models -- Convergence on VES message formats for Performance Management, - Fault Management, Configuration Management +- 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 ^^^^^^^^^^^ -- SDN-C is upgraded to OpenDaylight Phosphorus release -- Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface +- 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 ^^^^^^^^^^^^^^ -- Improved support for TOSCA features -- Automation Composition Management model -- Support for large CSAR via S3 storage +- 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 ^^^^^^^^^ -- Schema updated for CCVPN use case mainly enhancing and bug fixes of the Cloud - Leased Line (CLL) service +- 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 ^^^^^^^^^^^^^^^^^^^^^^^ -- Introduction of Strimzi Kafka Operator -- Migration of all Kafka native clients to use Strimzi Apache Kafka. -- Disable VID, Portal +- 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 -Jakarta 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 ^^^^^^^^ -- 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 updates the vulnerable direct dependencies in their code base -- Pilot for automating the creation of a Software Bill of Materials (SBOM). - Tools for automated SBOM creation are now rolled into the CI chain of ONAP +- 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) + Documentation ^^^^^^^^^^^^^ -- Documentation cleaned up. Chapters which include unmaintained projects were - removed to avoid misunderstandings at the readership -- Projects (repositories) which do not create a stable release branch are no - longer included in the release documentation. This should help to improve the - release management process -- Beginning with this release we are providing example configuration files for - setting up a proper process of documentation creation -- The Interactive Architecture Overview is updated -- The guide to set up a development system for documentation is updated +- Development guide updated +- Structural changes in 'Guide' section Tests & Integration ^^^^^^^^^^^^^^^^^^^ -- Create Java and Python base images -- Adapt robot tests to DCAE project changes: Cloudify to Helm migration -- New test: basic_cnf_macro -- Release ONAP data provider tool -- Automate repositories INFO.yaml updates +- 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 + .. important:: Some non-functional requirements are not fully finalized. Please, check details @@ -259,26 +226,26 @@ Tests & Integration Documentation Sources --------------------- -The formal ONAP 'Jakarta' Release Documentation is available +The formal ONAP 'Kohn' Release Documentation is available in :ref:`ReadTheDocs`. The `Developer Wiki `_ remains a good source of information on meeting plans and notes from committees, project teams and community events. -CII Best Practice ------------------ +OpenSSF Best Practice +--------------------- -ONAP has adopted the `CII Best Practice Badge Program `_. +ONAP has adopted the `OpenSSF Best Practice Badge Program `_. - `Badging Requirements `_ - `Badging Status for all ONAP projects `_ -In the Jakarta 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 +- % projects passed 90% of the OpenSSF badge +- % passed the OpenSSF badge +- % projects passed the OpenSSF Silver badge Project specific details are in the :ref:`release notes` for each component. @@ -287,13 +254,9 @@ for each component. ONAP Maturity Testing Notes --------------------------- -For the Jakarta 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 Jakarta 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` -- cgit 1.2.3-korg