Update git submodules
[doc.git] / docs / release / index.rst
index ff81038..453d7c1 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-notes:
 
-* Release Name: Amsterdam
-* Release Version: 1.0.0
-* Release Date: November 16, 2017
+El Alto Release Notes
+^^^^^^^^^^^^^^^^^^^^^
 
+This page provides the release notes for the ONAP El Alto release. This
+includes details of software versions used, known limitations, and outstanding
+trouble reports.
 
-Getting Started With Amsterdam
-------------------------------
+Release notes are cumulative for the release, meaning this release note for the
+El Alto release 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 releaese 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.
+El Alto Major Release 5.0.1
+===========================
 
-**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 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.
-
- - Application Controller (APPC) executes Virtual Network Functions (VNF) configurations and lifecycle
-   management operations.
-
- - 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.
+* Release Name: El Alto
+* Release Version: 5.0.1
+* Release Date: October 24 2019
 
 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 :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<doc_onap-developer_guide_projects>`.
-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/.
-* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
+Documentation
+=============
+ONAP El Alto Release provides a set selection of documents,
+see :ref:`ONAP Home<master_index>`.
 
-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>`.
+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.
 
-Documentation
-+++++++++++++
-ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
-For Amsterdam this includes:
+Security Notes
+==============
+Details about discovered and mitigated vulnerabilities are in
+:ref:`ONAP Security <onap-security>`
 
- * A high level :ref:`architecture view<doc-architecture>` of how components
-   relate to each other.
+.. toctree::
+   :hidden:
 
- * A collection of documentation provided
-   by :ref:`each project <doc_onap-developer_guide_projects>`.
+   ../submodules/osa.git/docs/index.rst
 
- * 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#core-infrastructure-initiative-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 El Alto 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>`.
+============================
+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>`_.
+ * 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>`_.
+ * 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?>`_.
 
-You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
+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.
 
 
 .. Include files referenced by link in the toctree as hidden
-
-.. toctree::
-   :hidden:
-
-   release-manifest.rst
-   releaserepos.rst
-   repolist.rst