Update the Release date and corrected component changes
[doc.git] / docs / release / index.rst
index 3ba0b48..9a3dff5 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.1`_
-  - `Casablanca Major Release 3.0.0`_
-
-Casablanca Maintenance Release 3.0.1
-====================================
-
-* Release Name: Casablanca
-* Release Version: 3.0.1
-* Release Date: Jan 31, 2019
-
-The Casablanca Maintenance Release 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
- - UsecaseUI
-
-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.
 
- - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP)
-   with tools for VNF supplier packaging and validation.
+.. _onap-release-notes:
 
- - Policy Creation (POLICY) deals with conditions, requirements,
-   constraints, attributes, or needs that must be provided, maintained,
-   and/or enforced.
+Guilin Release Notes
+^^^^^^^^^^^^^^^^^^^^
 
- - Closed Loop Automation Management Platform (CLAMP) provides a method
-   for designing and managing control loops.
+This page provides the release notes for the ONAP Guilin release. This
+includes details of software versions, known limitations, and outstanding
+trouble reports.
 
- - Optimization Framework (OOF) provides a policy-driven and model-driven
-   framework for creating optimization applications.
+Release notes are cumulative for the release, meaning this release note will
+have an entry for each Major, Minor, and Maintenance release, if applicable.
 
-**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:
+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.
 
- - 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.
+Guilin Releases
+===============
 
- - Software Defined Network Controller (SDNC) executes network configuration
-   for cloud computing resources and network.
+The following releases are available for Guilin:
+  - `Guilin Maintenance Release 7.0.1`_
+  - `Guilin Major Release 7.0.0`_
 
- - Application Controller (APPC) executes Virtual Network Functions (VNF)
-   configurations and lifecycle management operations.
+Guilin Maintenance Release 7.0.1
+================================
 
- - Virtual Function Controller (VF-C) is responsible for lifecycle management
-   of virtual network functions and network services based on VNF using
-   VNF Manager.
++--------------------------------------+--------------------------------------+
+| **Project**                          | Open Network Automation Platform     |
+|                                      | (ONAP)                               |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Guilin Maintenance Release           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 7.0.1                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | March 11th 2021                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
- - 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.
+New Features
+============
 
- - 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.
+Guilin Maintenance Release 7.0.1 delivered a number of fixes and updates
+across the following projects:
+
+ - AAI         - bug fixes and certificate update
+ - CCSDK       - bug fixes and certificate update
+ - DCAEGEN2    - bug fixes
+ - DMaaP       - bug fixes
+ - DOC         - restructure user guides section and added tutorials
+ - Integration - new docker for robot framework
+ - Music       - certificate update
+ - MSB         - bug fixes
+ - OOM         - docker improvement
+ - SDNC        - bug fixes
+ - SO          - bug fixes
+ - VID         - certificate update
+
+Details on the specific Jira tickets addressed by each project can be found in
+the component specific Release Notes: :ref:`release notes<doc-releaserepos>`
+
+
+Guilin Major Release 7.0.0
+==========================
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | Open Network Automation Platform     |
+|                                      | (ONAP)                               |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Guilin                               |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 7.0.0                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | December 3rd 2020                    |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Guilin Features
+===============
+ONAP Guilin focusses on:
+
+* 5G network automation and services such as network slicing through RAN, core
+  and transport
+* deepening O-RAN Software Community integration along with other leading SDOs
+* seamless orchestration of CNFs, VNFs and PNFs
+* and bringing several new ONAP Blueprint and docs updates.
+
+5G Network Slicing
+------------------
+In the industry evolution toward 5G networks, Guilin expands upon the
+end-to-end network slicing introduced with Frankfurt with the addition of RAN,
+core, and transport through Network Slice Subnet Management Function (NSSMF)
+which completes functionality with the Communication Service Management
+Function (CSMF) and Network Slice Management Function (NSMF) components. In
+addition to the NSSMF included in Guilin, ONAP supports an external RAN NSSMF.
+Next, the RAN domain also has initial support for a simple closed control loop
+and machine learning (ML) for intelligent slicing.
+
+ONAP/O-RAN Alignment
+--------------------
+The release also marks greater ONAP + O-RAN Software Community harmonization by
+adding  support for the A1 interface (O-RAN A1-AP v1.1), adding to the existing
+O1 support. ONAP can now manage multiple A1 targets with different versions and
+includes a A1 Policy Management Service that interacts with the Near Real-Time
+RIC\19s policy instances and provides a transient cache for these policies.
+
+CNF, VNF and PNF integration
+----------------------------
+Guilin contains a large number of new features classified into design time,
+run time, and ONAP operations to optimize the self-serve control loop and
+dashboard, make it easier to reuse existing models, make xNF pre-onboarding and
+onboarding easier, speed up UI development, and more. For Documentation
+(Usability), ONAP documentation made improvements such as setting up ONAP,
+Platform Operations, Service Design and Deployment, and User Guides. Specific
+to cloud native, The Service Design & Creation (SDC) project, the unified
+design time tool, now supports Helm types to natively support Cloud Native
+Network Functions (CNF).
+
+Enhancements in ONAP Blueprints
+-------------------------------
+Other enhancements to the ONAP Blueprints includes a new Standard Defined VNF
+Event Stream (VES) event for Fault Management (FM) / Performance Management
+(PM) Data Collection, the first use of Machine Learning in Self-Organizing
+Networks (SON), and greater support for 5G RAN Wireless Network Resource Model
+(NRM) with Service Modeling and Definition and Intent Based Network supporting
+intent-drive 5G slice creation. The Cross Domain and Cross Layer VPN (CC-VPN)
+includes transport slicing and the MDONS (Multi-Domain Optical Network Service
+) has been extended.
+
+Functional Requirements
+-----------------------
+The following requirements have been introduced in the Guilin Release:
+
+xNF Integration
+...............
+
+- ONAP CNF orchestration - Enhancements
+- Extension of PNF Pre-onboarding/onboarding
+- Enhancements for PNF Plug & Play'
+- xNF License Management
+
+Lifecycle Management
+....................
+
+- Policy Based Filtering
+- CLAMP Deployment of Native policies
+- Bulk PM / PM Data Control Extension
+- Support xNF Software Upgrade in association to schema updates
+- Configuration & Persistency Service
+
+Security
+........
+
+- CMPv2 Enhancements
+
+Standard alignment
+..................
+
+- ETSI-Alignment for Guilin
+- ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES
+- Extend ORAN A1 Adapter and add A1 Policy Management
+
+NFV testing Automatic Platform
+...............................
+
+- Test Result Auto Analysis & Certification
+- Test Task Auto Execution
+- Test Environment Auto Deploy
+- Test Topology Auto Design
+
+Non-Functional Requirements
+---------------------------
+The following 'non-functional' requirements have been introduced in the Guilin
+Release:
+
+Best Practice
+.............
+
+- ONAP shall use STDOUT for logs collection
+- IPv4/IPv6 dual stack support in ONAP (Guilin)
+- 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
+........
+
+- ONAP must complete update of the Python language (from 2.7 -> 3.8)
+- ONAP must complete update of the java language (from v8 -> 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
+
+Tests
+.....
+
+- More tests integrated in CI/CD but enhancements expected in Honolulu
+- ONAP shall increase the number of Docker Benchmark tests
+
+Others
+......
+
+- ONAP to support Multi - tenancy
 
-**Microservices Support**
+.. important::
+   Some non-functional requirements are not fully finalized. Please, check details
+   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
 
- - 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.
 
 Project Specific Release Notes
 ==============================
-ONAP releases are specified by a list of project artifact versions in a :ref:`manifest<doc-release-manifest>`.
-
-.. toctree::
-   :hidden:
-
-   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 components
-   relate to each other.
-
- * 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.
+ONAP Guilin Release provides a set selection of documents,
+see `ONAP Documentation <https://docs.onap.org/en/guilin/index.html>`_.
 
-.. 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 Guilin 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 Guilin release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
+
+In Guilin the Integration team focussed in
 
-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>`
+- Automating ONAP Testing to improve the overall quality
+- Adding security and E2E tests
+- Integrated new ONAP Python SDK in E2E testing
 
-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>`_.
+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.
+Known Issues and limitations are documented in each
+:ref:`project Release Notes <doc-releaserepos>`.
 
 
 .. Include files referenced by link in the toctree as hidden
-
-.. toctree::
-   :hidden:
-
-   releaserepos.rst
-   repolist.rst
-