.. _onap-release-notes:
-Honolulu Release Notes
-^^^^^^^^^^^^^^^^^^^^^^
+Jakarta Release Notes
+^^^^^^^^^^^^^^^^^^^^^
-This page provides the release notes for the ONAP Honolulu release. This
+This page provides the release notes for the ONAP Jakarta release. This
includes details of software versions, known limitations, and outstanding
trouble reports.
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
+Jakarta Major Release 10.0.0
============================
+--------------------------------------+--------------------------------------+
| **Project** | Open Network Automation Platform |
| | (ONAP) |
+--------------------------------------+--------------------------------------+
-| **Release name** | Honolulu |
+| **Release name** | Jakarta |
| | |
+--------------------------------------+--------------------------------------+
-| **Release version** | 8.0.0 |
+| **Release version** | 10.0.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | May 11th 2021 |
+| **Release date** | June 9th, 2022 |
| | |
+--------------------------------------+--------------------------------------+
-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
+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
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 MultiCloud 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
+
+- 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
+
+ - 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.
+
+- New model for CNF modeling: Application Service Descriptor (ASD) model
+
+E2E Network Slicing
...................
-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.
+
+- 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
+
+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
+
+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
+
+
+Controllers
+...........
+
+- SDN-C is upgraded to OpenDaylight Phosphorus release
+- Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface
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
+- Improved support for TOSCA features
+- Automation Composition Management model
+- Support for large CSAR via S3 storage
Inventory
.........
-- 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
+- Schema updated for CCVPN use case mainly enhancing and bug fixes of the Cloud
+ Leased Line (CLL) service
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
+- Introduction of Strimzi Kafka Operator
+- Migration of all Kafka native clients to use Strimzi Apache Kafka.
+- Disable VID, Portal
Non-Functional Requirements
---------------------------
+
The following 'non-functional' requirements are followed in the
-Honolulu Release:
+Jakarta Release:
Best Practice
.............
- 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
+- 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
-Tests
-.....
+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
+
+Tests & Integration
+...................
-- New E2E tests
-- New IPv4/Ipv6 daily CI chain
+- 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
.. 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<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
+project repositories and Docker container image versions listed in the OOM
Helm charts.
Each project provides detailed :ref:`release notes<doc-releaserepos>`
Documentation
=============
-ONAP Honolulu Release provides a set selection of documents,
+ONAP Jakarta 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
community events.
-Security Notes
-==============
-Details about discovered and mitigated vulnerabilities are in
-:ref:`ONAP Security <onap-osa:onap-security>`
+CII Best Practice
+=================
ONAP has adopted the `CII 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 Jakarta release,
- 100% projects passed 90% of the CII badge
- 85% projects passed the CII badge
ONAP Maturity Testing Notes
===========================
-For the Honolulu release, ONAP continues to improve in multiple areas of
+For the Jakarta release, ONAP continues to improve in multiple areas of
Scalability, Security, Stability and Performance (S3P) metrics.
-In Honolulu the Integration team focussed in
+In Jakarta the Integration team focussed in
- Automating ONAP Testing to improve the overall quality
- Adding security and E2E tests
============================
Known Issues and limitations are documented in each
:ref:`project Release Notes <doc-releaserepos>`.
-
-
-.. Include files referenced by link in the toctree as hidden
Code Review / doc.git / blobdiff