Added Guilin Release Note
[doc.git] / docs / release / index.rst
index 16ab8b9..0a342d3 100644 (file)
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
 
-.. index:: Release Notes
 
-Releases
-========
-This page is the ONAP Beijing Release Notes. The first release was
-Amsterdam and subsequent major release will be named using city names.
+.. _release-notes:
 
-* Release Name: Beijing
-* Release Version: 1.0.0
-* Release Date: May 24, 2018
+Guilin Release Notes
+^^^^^^^^^^^^^^^^^^^^
 
+This page provides the release notes for the ONAP Guilin release. This
+includes details of software versions, known limitations, and outstanding
+trouble reports.
 
-Getting Started With ONAP
--------------------------
+Release notes are cumulative for the release, meaning this release note will
+have an entry for each Major, Minor, and Maintenance release, if applicable.
 
-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.
+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.
 
-Functionality
-+++++++++++++
-**Portal** - a single, consistent user experience for both design timer
-and run time environments, based on the user’s role.
+Guilin Releases
+===============
 
-**Design Time Framework** - a comprehensive development environment with
-tools, techniques, and repositories for defining/describing resources,
-services, and products:
+The following releases are available for Guilin:
+  - `Guilin Major Release 7.0.0`_
 
- - Service Design and Creation (SDC) provides tools, techniques, and
-   repositories to define/simulate/certify system assets as well as their
-   associated processes and policies.
+Guilin Major Release 7.0.0
+==========================
 
- - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier
-   packaging and validation.
+Release data
+============
 
- - Policy Creation (POLICY) deals with conditions, requirements,
-   constraints, attributes, or needs that must be provided, maintained,
-   and/or enforced.
++--------------------------------------+--------------------------------------+
+| **Project**                          | Open Network Automation Platform     |
+|                                      | (ONAP)                               |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Guilin                               |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 7.0.0                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | December 3rd 2020                    |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
- - Closed Loop Automation Management Platform (CLAMP) provides a method
-   for designing and managing control loops.
+Guilin Features
+===============
+ONAP Gulin focusses on:
 
-**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:
+* 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.
 
- - 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.
+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.
 
- - Software Defined Network Controller (SDNC) executes network configuration
-   for cloud computing resources and network.
+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. 
 
- - Application Controller (APPC) executes Virtual Network Functions (VNF)
-   configurations and lifecycle management operations.
+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).
 
- - 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.
-
- - Common Services - operational services for all ONAP components including
-   activity logging, reporting, common data layer, access control, resiliency,
-   and software lifecycle management.
+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.
 
 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.
 
-Platforms Requirements
-++++++++++++++++++++++
-ONAP Beijing Release has been tested on Linux OSs. Details are
-:ref:`available here <demo-installing-running-onap-requirements>`.
-
-
-.. index:: Download
-
-Download & Install
-++++++++++++++++++
-There are 3 approaches to install ONAP:
-
-* Full ONAP installation using Heat template
-* Advanced installation to install individual components
-* Experimental installation using Kubernetes
-
-Full ONAP installation using Heat template
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a complete demo solution perspective. This installs the whole ONAP,
-refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
-
-Advanced installation to install individual components
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a developer perspective, ONAP can be installed component per component.
-For details, refer to :ref:`the installation procedure available for each
-component<index-setting-individual-components>`.
-The advanced installation procedure is recommended only for experienced
-developers who desire to focus their attention on a few components and who have
-a deep understanding of dependencies between components.
-This type of installation is not recommended to fully install ONAP.
-
-* The list of ports used by default within ONAP is documented in
-  `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
-
-* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org
-  or Git at https://git.onap.org/.
+Documentation
+=============
+ONAP Guilin Release provides a set selection of documents,
+see `ONAP Documentation <https://docs.onap.org/en/guilin/index.html>`_.
 
-* ONAP is packaged within Docker and can be dowloaded from Docker Hub at
-  https://hub.docker.com/r/onap.
+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.
 
-Experimental installation using Kubernetes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a complete demo solution perspective using Kubernetes. This installs the
-whole ONAP, refer to :ref:`ONAP Operations Manager -
-Quick Start Guide <onap-operations-manager-project>`.
+Security Notes
+==============
+Details about discovered and mitigated vulnerabilities are in
+:ref:`ONAP Security <onap-osa:onap-security>`
 
-Documentation
-+++++++++++++
-ONAP Beijing Release documentation is available :ref:`here <master_index>`.
-For Beijing this includes:
+ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 
- * A high level :ref:`architecture view<doc-architecture>` of how components
-   relate to each other.
+- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
+- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 
- * A collection of documentation provided
-   by :ref:`each project <doc_onap-developer_guide_projects>`.
+In the Guilin release, 24% projects pass the CII badge, 52% projects pass 75% of the CII silver badge tests (next badge up from the vanilla CII badge), 5% projects pass 84% of the CII silver badge tests, and 20% pass the entirety of the silver CII badge.
 
- * Application Programming Interface
-   Reference :ref:`available here <doc-apiref>`.
+Project specific details are in the :ref:`release notes<doc-releaserepos>` for
+each project.
 
- * 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:: maturity
 
-Usage
-+++++
-This section is intended to provide users on the usage of ONAP components.
+ONAP Maturity Testing Notes
+===========================
+For the Guilin release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
 
-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>`_.
+In Guilin the Integration team focussed in
 
-.. index:: Licensing
+- 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+Community>`_.
-
-You may 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:
-
-   release-manifest.rst
-   releaserepos.rst
-   repolist.rst