update composite release notes: fix version number
[doc.git] / docs / release / index.rst
index 2224848..587a1f2 100644 (file)
 .. 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
+^^^^^^^^^^^^^^^^^^^^^^
+
+This page provides the release notes for the ONAP Istanbul release. This
+includes details of software versions, known limitations, and outstanding
+trouble reports.
+
+Release notes are cumulative for the release, meaning this release note will
+have an entry for each Major, Minor, and Maintenance release, if applicable.
+
+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**                          | 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
+
+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
+.............
 
-Amsterdam Release
------------------
-
-Summary
-+++++++
-ONAP provides a comprehensive platform for real-time, policy-driven
-orchestration and automation of physical and virtual network functions
-that 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 timer
-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,
-services, and products:
-
- - Service Design and Creation (SDC) provides tools, techniques, and
-   repositories to define/simulate/certify system assets as well as their
-   associated processes and policies.
-
- - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier
-   packaging and validation.
-
- - Policy Creation (POLICY) deals with conditions, requirements,
-   constraints, attributes, or needs that must be provided, maintained,
-   and/or enforced.
-
- - Closed Loop Automation Management Platform (CLAMP) provides a method
-   for designing and managing control loops.**
-
-*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:
-
- - Service Orchestrator (SO) executes the specified 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.
-
- - Software Defined Network Controller (SDNC) network configuration of
-   cloud computing resources.
-
- - Application Controller (APPC) Application resources.
-
- - Virtual Function Controller (VF-C) provides an ETSI NFV compliant NFV-O
-   functions, and is responsible for life cycle management of virtual services
-   and the associated physical COTS server infrastructure.
-
- - Active and Available Inventory (A&AI) provides real-time views of a
-   system’s resources, services, products and their relationships with each
-   other.
-
-*Closed-Loop Automation* -- Design -> Create -> Collect -> Analyze >
-Detect -> Publish -> Respond:
+- 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
 
- - Data Collection, Analytics and Events (DCAE) collects performance,
-   usage, and configuration data and publishes information to policy,
-   orchestration, and the data lake.
+Tests
+.....
 
- - “Holmes” provides alarm correlation and analysis for Telecom cloud
-   infrastructure and services, including hosts, vims, VNFs and NSs
+- New E2E tests: basic_cnf
+- New tests: CPS healthcheck
+- Stability tests: basic_vm and basic_onboard
 
- - Common Services - operational services for all ONAP components including
-   activity logging, reporting, common data layer, access control, resiliency,
-   and software lifecycle management.
+.. 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<doc-release-manifest>`.
+==============================
+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.
 
-
-Supported Platforms
-+++++++++++++++++++
-ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is
-the only OS supported.
-
 Documentation
-+++++++++++++
-ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
-For Amsterdam this includes:
-
- * A high level :ref:`architecture view<doc-architecture>` of how components
-   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>`.
+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.
 
- * 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.
-
-
-Known Issues and Limitations
-++++++++++++++++++++++++++++
-Known Issues and limitations are documented in each project Release Notes.
+Security Notes
+==============
+Details about discovered and mitigated vulnerabilities are in
+:ref:`ONAP Security <onap-osa:onap-security>`
 
-Refer to :ref:`release notes <doc-releaserepos>` for each project.
+ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 
-Licenses
-++++++++
-ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
-ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
+- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
+- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 
-How to Report a Bug
-+++++++++++++++++++
-There are 2 ways to report a bug in ONAP.
+In the Istanbul release,
 
- * 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>`_.
+- 100% projects passed 90% of the CII badge
+- 85% projects passed the CII badge
+- 11% projects passed the CII Silver badge
 
- * 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 .
+Project specific details are in the :ref:`release notes<doc-releaserepos>` for
+each project.
 
-You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
+.. index:: maturity
 
+ONAP Maturity Testing Notes
+===========================
+For the Istanbul release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
 
-Download
-++++++++
+In Istanbul the Integration team focussed in
 
-* ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ .
+- Automating ONAP Testing to improve the overall quality
+- Adding security and E2E tests
 
-* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
-
-
-Install
-+++++++
-There are 2 approaches to install ONAP.
-
-* From a complete demo solution perspective. This installs the whole ONAP,
-  refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
-
-* From a developer perspective. ONAP is installed component per component.
-  Each
-  component :ref:`installation is listed in<doc_onap-developer_guide_projects>`.
-  The list of ports used by default within ONAP is documented
-  in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
-
-Usage
-+++++
-This section is intended to provide users on the usage of ONAP components.
-
-Instructions on using the ONAP deployment including Robot, Portal, SDC and VID
-in the context of running (Onboarding, service creation, service deployment,
-VNF creation, VNF preload, VF Module creation and closed loop operations)
-the vFirewall sanity use case is documented
-in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
+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>`.