update composite release notes: fix version number
[doc.git] / docs / release / index.rst
index 6972311..587a1f2 100644 (file)
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
 
-Casablanca Release Notes
-^^^^^^^^^^^^^^^^^^^^^^^^
-This page is the ONAP Casablanca Release Notes. The first release was labelled
-Amsterdam, second release Beijing and subsequent major release will be named
-using city names.
-
-Release notes are cumulative for the release, meaning this release note for Casablanca will have an entry for each Major, Minor, and Maintenance release, if applicable. Information that is applicable regardless of release is included in the `Getting Started With ONAP`_ section of this document.
-
-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 releaese by each component is maintained in the component specific release notes.
-
-Casablanca Releases
-===================
-
-The following releases are available for Casablanca:
-  - `Casablanca Maintenance Release 3.0.2`_
-  - `Casablanca Maintenance Release 3.0.1`_
-  - `Casablanca Major Release 3.0.0`_
-
-Casablanca Maintenance Release 3.0.2
-====================================
-
-* Release Name: Casablanca
-* Release Version: 3.0.2
-* Release Date: Apr 15, 2019
-
-Casablanca Maintenance Release 3.0.2 addresses issue of certificate expiry across the following projects:
- - AAI
- - CLAMP
- - DMAAP
- - Policy
- - VID
- - Portal
-
-Details on the specific Jira tickets addressed by each project can be found in the component specific Release Notes. Link can be found below in section `Project Specific Release Notes`_.
-
-
-Casablanca Maintenance Release 3.0.1
-====================================
-
-* Release Name: Casablanca
-* Release Version: 3.0.1
-* Release Date: Jan 31, 2019
-
-Casablanca Maintenance Release 3.0.1 delivered a number of fixes and updates across the following projects:
- - AAI
- - APPC
- - CCSDK
- - CLAMP
- - DCAEGEN2
- - DOC
- - EXTAPI
- - Integration
- - MultiCloud
- - OOM
- - OOF
- - Policy
- - Portal
- - SDC
- - SDNC
- - SO
-
-Details on the specific Jira tickets addressed by each project can be found in the component specific Release Notes. Link can be found below in section `Project Specific Release Notes`_.
-
-Casablanca Major Release 3.0.0
-==============================
-
-* Release Name: Casablanca
-* Release Version: 3.0.0
-* Release Date: Nov 30, 2018
-
-The Casablanca 3.0.0 is the first of Casablanca.
-
-.. _getting-started:
-
-Getting Started With ONAP
-=========================
-
-Summary
--------
-ONAP provides a comprehensive platform for real-time, policy-driven
-service orchestration and automation including virtual network functions and
-applications instantiation and configuration, but also physical network
-functions configuration.
-ONAP will enable software, network, IT and cloud providers and developers
-to rapidly automate new services and support complete life cycle management.
-By unifying member resources, ONAP will accelerate the development of a
-vibrant ecosystem around a globally shared architecture and implementation
-for network automation-with an open standards focus-faster than any one
-product could on its own.
-
-Functionality
--------------
-**Portal** - a single, consistent user experience for both design time
-and run time environments, based on the user’s role.
-
-**Design Time Framework** - a comprehensive development environment with
-tools, techniques, and repositories for defining/describing resources,
-and services:
 
- - Service Design and Creation (SDC) provides tools, techniques, and
-   repositories to define/simulate/certify system assets as well as their
-   associated processes and policies.
+.. _onap-release-notes:
 
- - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP)
-   with tools for VNF supplier packaging and validation.
+Istanbul Release Notes
+^^^^^^^^^^^^^^^^^^^^^^
 
- - Policy Creation (POLICY) deals with conditions, requirements,
-   constraints, attributes, or needs that must be provided, maintained,
-   and/or enforced.
+This page provides the release notes for the ONAP Istanbul release. This
+includes details of software versions, known limitations, and outstanding
+trouble reports.
 
- - Closed Loop Automation Management Platform (CLAMP) provides a method
-   for designing and managing control loops.
+Release notes are cumulative for the release, meaning this release note will
+have an entry for each Major, Minor, and Maintenance release, if applicable.
 
- - Optimization Framework (OOF) provides a policy-driven and model-driven
-   framework for creating optimization applications.
+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.
 
-**Runtime Framework** - The runtime execution framework executes the
-rules and policies distributed by the design and creation environment
-and Controllers that manage resources corresponding to their assigned
-controlled domain:
+Istanbul Maintenance Release 9.0.1
+==================================
 
- - Service Orchestrator (SO) executes the specified BPMN processes and
-   automates sequences of activities, tasks, rules and policies needed for
-   on-demand creation, modification or removal of network, application or
-   infrastructure services and resources. SO is especially able to drive
-   any OpenStack-based cloud platform.
++--------------------------------------+--------------------------------------+
+| **Project**                          | Open Network Automation Platform     |
+|                                      | (ONAP)                               |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Istanbul                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 9.0.1                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | February 17th, 2022                  |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
- - Software Defined Network Controller (SDNC) executes network configuration
-   for cloud computing resources and network.
+Features
+--------
+ONAP Istanbul Maintenance Release 1 focusses on:
 
- - Application Controller (APPC) executes Virtual Network Functions (VNF)
-   configurations and lifecycle management operations.
+- fixing log4j vulnerabilities in AAI, CPS, DCAEGEN2, DMAAP, POLICY, SDNC
+  and VNFSDK 
 
- - Virtual Function Controller (VF-C) is responsible for lifecycle management
-   of virtual network functions and network services based on VNF using
-   VNF Manager.
-
- - Active and Available Inventory (A&AI) provides real-time views of a
-   system’s resources, services, products and their relationships with each
-   other.
+Istanbul Major Release 9.0.0
+============================
 
-**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
-Detect -> Publish -> Respond:
++--------------------------------------+--------------------------------------+
+| **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
+
+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
 
- - Data Collection, Analytics and Events (DCAE) collects events, performance,
-   usage and publishes information to policy that executes the rules to perform
-   closed loop actions.
+Documentation
+.............
 
- - Holmes provides alarm correlation and analysis for Telecom cloud
-   infrastructure and services, including servers, cloud infrastructure,
-   VNFs and Network Services.
+- 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
 
- - Common Services - operational services for all ONAP components including
-   activity logging, reporting, common data layer, access control, resiliency,
-   multisite state coordination, credential/secret management and
-   software lifecycle management.
+Tests
+.....
 
-**Microservices Support**
+- New E2E tests: basic_cnf
+- New tests: CPS healthcheck
+- Stability tests: basic_vm and basic_onboard
 
- - ONAP Operation Manager (OOM) use Kubernetes and Helm to manage ONAP components.
- - Microservices Bus (MSB) provides service registration/discovery,
-   external API gateway, internal API gateway, client software development kit
-   (SDK), and Swagger SDK.
+.. important::
+   Some non-functional requirements are not fully finalized. Please, check details
+   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
 
 Project Specific Release Notes
 ==============================
-ONAP releases are specified by a list of project artifact versions in a :ref:`manifest artifacts <doc-release-manifest-artifacts>` and :ref:`manifest dockers <doc-release-manifest-docker>`.
-
-.. toctree::
-   :hidden:
-
-   release-manifest-docker.rst
-   release-manifest.rst
+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.
 
-.. index:: Download
-
-Installation
-============
-ONAP is installed using :ref:`ONAP Operations Manager (OOM) over Kubernetes<installing-onap>`
-
 Documentation
 =============
-ONAP Casablanca Release provides multiple documents including the following:
-
- * A high level :ref:`architecture view<doc-architecture>` of how component
-   relate to each other.
+ONAP Istanbul Release provides a set selection of documents,
+see :ref:`ONAP Documentation<master_index>`.
 
- * A collection of documentation provided
-   by :ref:`each project <doc_onap-developer_guide_projects>`.
-
- * Application Programming Interface
-   Reference :ref:`available here <doc-apiref>`.
-
- * 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.
-
-.. index:: Licensing
+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>`
+
 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
-The goal of the Casablanca release is for all ONAP projects to be close to achieving a CII Passing badge.
 
-- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
+- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 
-Project specific details are in the :ref:`release notes<doc-releaserepos>` for each project.
+In the Istanbul release,
+
+- 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<doc-releaserepos>` for
+each project.
 
 .. index:: maturity
 
 ONAP Maturity Testing Notes
 ===========================
-For the Casablanca release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics.
+For the Istanbul release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
 
-The Integration team ran the 72 hours stability testing (100% passing rate) and full resilience testing (96.9% passing rate) at ONAP OpenLabs. More details in :ref:`ONAP Maturity Testing Notes <integration-s3p>`
+In Istanbul the Integration team focussed in
 
-Licenses
-========
-ONAP Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
-ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
-International License <http://creativecommons.org/licenses/by/4.0>`_.
+- 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>`.
-
-.. index:: Reporting Bugs
-
-How to Report a Bug
-===================
-There are 2 ways to report a bug in ONAP.
-
- * In case you are familiar within ONAP, you can directly report a bug by
-   creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
-
- * If you don't know you are facing a bug or have a question, post your
-   question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
-   You will need a Linux Foundation ID to login and post your question.
-   Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.
-
-To properly report a bug in Jira, you may want to consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
-
-
-.. Include files referenced by link in the toctree as hidden
-
-.. toctree::
-   :hidden:
-
-   releaserepos.rst
-   repolist.rst
+Known Issues and limitations are documented in each
+:ref:`project Release Notes <doc-releaserepos>`.