X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=f8a5771c73479c7aad336d4c7fa13c88ea44e108;hb=refs%2Fchanges%2F79%2F127179%2F1;hp=73af7336dbf7aa78950edb39d7bc092e11aa1a9b;hpb=4ad97c99e57df5fd5fd11a81de7b44b5743b69eb;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index 73af7336d..587a1f22b 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,84 +1,287 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 -Releases -======== -This page is the ONAP Amsterdam Release Notes. The first release is Amsterdam and subsequent major release will be named using city names. -* Release Name: Amsterdam -* Release Version: 1.0.0 -* Release Date: November 16, 2017 +.. _onap-release-notes: +Istanbul Release Notes +^^^^^^^^^^^^^^^^^^^^^^ -Amsterdam Release ------------------ +This page provides the release notes for the ONAP Istanbul release. This +includes details of software versions, known limitations, and outstanding +trouble reports. -Summary -+++++++ +Release notes are cumulative for the release, meaning this release note will +have an entry for each Major, Minor, and Maintenance release, if applicable. -Functionality -+++++++++++++ +Each component within the ONAP solution maintains their own component level +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 Specific Release Notes -++++++++++++++++++++++++++++++ -ONAP releases are specified by a list of project artifact -versions in a :ref:`manifest`. -Each project provides detailed :ref:`release notes` -and prepends to these if/when any updated versions the project team believes -are compatible with a major release are made available. ++--------------------------------------+--------------------------------------+ +| **Project** | Open Network Automation Platform | +| | (ONAP) | ++--------------------------------------+--------------------------------------+ +| **Release name** | Istanbul | +| | | ++--------------------------------------+--------------------------------------+ +| **Release version** | 9.0.1 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | February 17th, 2022 | +| | | ++--------------------------------------+--------------------------------------+ + +Features +-------- +ONAP Istanbul Maintenance Release 1 focusses on: + +- fixing log4j vulnerabilities in AAI, CPS, DCAEGEN2, DMAAP, POLICY, SDNC + and 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 | +| | | ++--------------------------------------+--------------------------------------+ + +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 + +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. + +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. + +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 + +Extended O-RAN Integration +.......................... + +- Improvements for managing A1 Policies and terminating the A1 interface for + A1 Policies +- A1 Adapter and A1 Policy Managements Enhancements + +Controllers +........... +- SDN-C is based on OpenDaylight major release upgrade (Silicon) +- Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface -Supported Platforms -+++++++++++++++++++ -ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported. +Service Design +.............. + +- SDC can be used for onboarding resources and designing services with models + other than SDC AID + +Inventory +......... + +- 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 + +Non-Functional Requirements +--------------------------- + +The following 'non-functional' requirements are followed in the +Istanbul 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 + +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 -+++++++++++++ -ONAP Amsterdam Release documentation is available :ref:`here `. -For Amsterdam this includes: +............. -* A high level :ref:`architecture view` of how components - relate to each other. +- 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 -* A collection of documentation provided - by :ref:`each project `. +Tests +..... -* Application Programming Interface Reference :ref:`available here `. +- New E2E tests: basic_cnf +- New tests: CPS healthcheck +- Stability tests: basic_vm and basic_onboard -* The `developer wiki `_ remains a good source of - information on meeting plans and notes from committees, project teams and - community events. See the doc - project :ref:`release notes ` for current status on documentation. +.. important:: + Some non-functional requirements are not fully finalized. Please, check details + on the :ref:`Integration` +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. -Known Issues and Limitations -++++++++++++++++++++++++++++ -Known Issues and limitations are documented in each project Release Notes. +Each project provides detailed :ref:`release notes` +and prepends to these if/when any updated versions the project team believes +are compatible with a major release are made available. + +Documentation +============= +ONAP Istanbul Release provides a set selection of documents, +see :ref:`ONAP Documentation`. -Refer to :ref:`release notes ` for each project. +The `developer wiki `_ remains a good source of +information on meeting plans and notes from committees, project teams and +community events. -License -+++++++ -ONAP Amsterdam is an `Apache Version 2 license `_ type of Open Source project. +Security Notes +============== +Details about discovered and mitigated vulnerabilities are in +:ref:`ONAP Security ` -How to Report a Bug -+++++++++++++++++++ -There are 2 ways to report a bug in ONAP. +ONAP has adopted the `CII Best Practice Badge Program `_. -In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira `_. +- `Badging Requirements `_ +- `Badging Status for all ONAP projects `_ -If you don't know you are facing a bug or have a question, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org . +In the Istanbul release, -You may consider these `recommendations `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. +- 100% projects passed 90% of the CII badge +- 85% projects passed the CII badge +- 11% projects passed the CII Silver badge +Project specific details are in the :ref:`release notes` for +each project. -Download and Use -++++++++++++++++ +.. index:: maturity -* ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ . +ONAP Maturity Testing Notes +=========================== +For the Istanbul release, ONAP continues to improve in multiple areas of +Scalability, Security, Stability and Performance (S3P) metrics. -* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap . +In Istanbul the Integration team focussed in -* To Install Amsterdam ONAP refer to :ref:`Setting Up ONAP `. +- Automating ONAP Testing to improve the overall quality +- Adding security and E2E tests +More details in :ref:`ONAP Integration Project` + +Known Issues and Limitations +============================ +Known Issues and limitations are documented in each +:ref:`project Release Notes `.