Correct typos in Release Note
[doc.git] / docs / release / index.rst
index 8606de3..8c2035b 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 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
-
-
-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:
-
- - Data Collection, Analytics and Events (DCAE) collects performance,
-   usage, and configuration data and publishes information to policy,
-   orchestration, and the data lake.
-
- - “Holmes” provides alarm correlation and analysis for Telecom cloud
-   infrastructure and services, including hosts, vims, VNFs and NSs
-
- - Common Services - operational services for all ONAP components including
-   activity logging, reporting, common data layer, access control, resiliency,
-   and software lifecycle management.
+.. _release-notes:
+
+Frankfurt Release Notes
+^^^^^^^^^^^^^^^^^^^^^^^
+
+This page provides the release notes for the ONAP Frankfurt 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.
+
+Frankfurt Releases
+==================
+
+The following releases are available for Frankfurt:
+  - `Frankfurt Major Release 6.0.0`_
+  - `Frankfurt Maintenance Release 6.0.1`_
+
+Frankfurt Maintenance Release 6.0.1
+===================================
+
+Release data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | Open Network Automation Platform     |
+|                                      | (ONAP)                               |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Frankfurt                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 6.0.1                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | August 17th 2020                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Frankfurt Maintenance Release 6.0.1 delivered a number of fixes and updates
+across the following projects:
+
+- AAF
+- OOM
+- CCSDK
+- CLAMP
+- DCAEGEN2
+- Integration
+- POLICY
+- SDC
+- SO
+- TEST
+
+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`_.
+
+Frankfurt Major Release 6.0.0
+=============================
+
+Release data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | Open Network Automation Platform     |
+|                                      | (ONAP)                               |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Frankfurt                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 6.0.0                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | June 11th 2020                       |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
 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 Amsterdam Release has been tested on Linux OSs. Details are `available here <http://onap.readthedocs.io/en/latest/guides/onap-developer/settingup/fullonap.html#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, refer to :ref:`the installation procedure available for each component<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>`_.
-* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/.
-* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
-
-Experimental installation using Kubernetes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a complete demo solution perspective using Kubernetes. This installs the whole ONAP, refer to `ONAP Operations Manager - Quick Start Guide <http://onap.readthedocs.io/en/latest/submodules/oom.git/docs/OOM%20Project%20Description/oom_project_description.html#quick-start-guide>`_.
-
 Documentation
-+++++++++++++
-ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
-For Amsterdam this includes:
+=============
+ONAP Frankfurt Release provides a set selection of documents,
+see `ONAP Documentation <https://docs.onap.org/en/frankfurt/index.html>`_.
 
- * A high level :ref:`architecture view<doc-architecture>` of how components
-   relate to each other.
+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.
 
- * A collection of documentation provided
-   by :ref:`each project <doc_onap-developer_guide_projects>`.
+Security Notes
+==============
+Details about discovered and mitigated vulnerabilities are in
+:ref:`ONAP Security <onap-osa:onap-security>`
 
- * Application Programming Interface
-   Reference :ref:`available here <doc-apiref>`.
+ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 
- * 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.
+- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
+- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 
-Usage
-+++++
-This section is intended to provide users on the usage of ONAP components.
+Project specific details are in the :ref:`release notes<doc-releaserepos>` for
+each project.
 
-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>`_.
+.. index:: maturity
 
-.. index:: Licensing
+ONAP Maturity Testing Notes
+===========================
+For the Frankfurt release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
 
-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>`_.
+The Integration team ran the 72 hours stability testing (100% passing rate)
+and full resilience testing (99.4% passing rate) at ONAP OpenLabs. More details
+in :ref:`ONAP Maturity Testing Notes <integration-s3p>`
 
 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 and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
+============================
+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:
-
-   release-manifest.rst
-   releaserepos.rst
-   repolist.rst