update release notes (doc & composite)
[doc.git] / docs / release / index.rst
index c3c5516..e7fb8c5 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 Data Router
- - 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.
+..
+  This work is licensed under a Creative Commons Attribution 4.0
+  International License. http://creativecommons.org/licenses/by/4.0
 
-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:
+.. _onap-release-notes:
 
- - 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 'Kohn' Release Notes
+============================
 
- - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP)
-   with tools for VNF supplier packaging and validation.
+This page provides the release notes for the ONAP 'Kohn' 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.
+
+Kohn Major Release 11.0.0
+-------------------------
+
++-----------------------------------+-----------------------------------------+
+| **Project**                       | Open Network Automation Platform (ONAP) |
++-----------------------------------+-----------------------------------------+
+| **Release name**                  | Kohn                                    |
++-----------------------------------+-----------------------------------------+
+| **Release version**               | 11.0.0                                  |
++-----------------------------------+-----------------------------------------+
+| **Release date**                  | not released yet                        |
++-----------------------------------+-----------------------------------------+
+
+Features
+--------
+
+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
+-----------------------
+
+Richer set of Cloud Native Functionality
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- CDS support for Application Service Descriptor
+
+  - Onboarding ASD CSARs
+  - Transformation to ONAP SDC CSAR
+  - Model updates to support ASD TOSCA types
+  - Support in SDC TOSCA parser
+
+- SO improved flows around the CNF orchestration, CNF Upgrade, and minor bug
+  fixes around the slicing use case.
+
+  - 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
+^^^^^^^^^^^^^^^^^^^
+
+- 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
+^^^^^^^^^^^^^^^^^^^^^^^
+
+- 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
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- 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
 
- - Policy Creation (POLICY) deals with conditions, requirements,
-   constraints, attributes, or needs that must be provided, maintained,
-   and/or enforced.
+- Better alignment with O-RAN in the 5G SON use case with use of O1 and A1
+  interfaces.
 
- - Closed Loop Automation Management Platform (CLAMP) provides a method
-   for designing and managing control loops.
-
- - Optimization Framework (OOF) provides a policy-driven and model-driven
-   framework for creating optimization applications.
-
-**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 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.
-
- - Software Defined Network Controller (SDNC) executes network configuration
-   for cloud computing resources and network.
+  - 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
+^^^^^^^^^^^
+
+- Resource Resolution Enhancements
 
- - Application Controller (APPC) executes Virtual Network Functions (VNF)
-   configurations and lifecycle management operations.
+  - 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
 
- - 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.
-
-**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
-Detect -> Publish -> Respond:
-
- - Data Collection, Analytics and Events (DCAE) collects events, performance,
-   usage and publishes information to policy that executes the rules to perform
-   closed loop actions.
-
- - Holmes provides alarm correlation and analysis for Telecom cloud
-   infrastructure and services, including servers, cloud infrastructure,
-   VNFs and Network Services.
+- CDS now has an endpoint for template deletion
 
- - 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.
 
-**Microservices Support**
+Service Design
+^^^^^^^^^^^^^^
 
- - 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.
+- Application Service Descriptor support with:
 
-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>`.
+  - Onboarding ASD CSARs
+  - Transformation to ONAP SDC CSAR
+  - Model updates to support ASD TOSCA types
+  - Support in SDC TOSCA parser
 
-.. toctree::
-   :hidden:
+- 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
 
-   release-manifest-docker.rst
-   release-manifest.rst
+Inventory
+^^^^^^^^^
 
-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.
+- Updates to schema and edge rules
 
-.. index:: Download
+  - 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
 
-Installation
-============
-ONAP is installed using :ref:`ONAP Operations Manager (OOM) over Kubernetes<installing-onap>`
 
-Documentation
-=============
-ONAP Casablanca Release provides multiple documents including the following:
+ONAP Operations Manager
+^^^^^^^^^^^^^^^^^^^^^^^
 
- * A high level :ref:`architecture view<doc-architecture>` of how component
-   relate to each other.
+- 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
 
- * A collection of documentation provided
-   by :ref:`each project <doc_onap-developer_guide_projects>`.
+Non-Functional Requirements
+---------------------------
 
- * Application Programming Interface
-   Reference :ref:`available here <doc-apiref>`.
+The following 'non-functional' requirements are followed in the
+Kohn Release:
 
- * 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.
+Best Practice
+^^^^^^^^^^^^^
 
-.. index:: Licensing
+- Standardized log fields
+- Support dual stack IPv4/Ipv6 across all ONAP modules
+- GUI test suites for all UI exposing modules
 
-Security Notes
-==============
-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.
+Security
+^^^^^^^^
 
-- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
-- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=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)
 
-Project specific details are in the :ref:`release notes<doc-releaserepos>` for each project.
 
-.. index:: maturity
+Documentation
+^^^^^^^^^^^^^
 
-ONAP Maturity Testing Notes
-===========================
-For the Casablanca release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics.
+- Development guide updated
+- Structural changes in 'Guide' section
 
-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>`
+Tests & Integration
+^^^^^^^^^^^^^^^^^^^
 
-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>`_.
+- deployment/noheat refactorization, fixes and updates:
 
-Known Issues and Limitations
-============================
-Known Issues and limitations are documented in each :ref:`project Release Notes <doc-releaserepos>`.
+  - 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
 
-.. index:: Reporting Bugs
 
-How to Report a Bug
-===================
-There are 2 ways to report a bug in ONAP.
+.. important::
+   Some non-functional requirements are not fully finalized. Please, check details
+   on the :doc:`Integration<usecases/release_non_functional_requirements>`
 
- * 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>`_.
+Documentation Sources
+---------------------
 
- * 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?>`_.
+The formal ONAP 'Kohn' Release Documentation is available
+in :ref:`ReadTheDocs<master_index>`.
 
-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.
+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.
 
+OpenSSF Best Practice
+---------------------
 
-.. Include files referenced by link in the toctree as hidden
+ONAP has adopted the `OpenSSF 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>`_
 
-.. toctree::
-   :hidden:
+In the Kohn release,
 
-   releaserepos.rst
-   repolist.rst
+- <TODO:Add number>% projects passed 90% of the OpenSSF badge
+- <TODO:Add number>% passed the OpenSSF badge
+- <TODO:Add number>% projects passed the OpenSSF Silver badge
+
+Project specific details are in the :ref:`release notes<component-release-notes>`
+for each component.
+
+.. index:: maturity
+
+ONAP Maturity Testing Notes
+---------------------------
+For the Kohn release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
+
+
+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 <component-release-notes>`.