X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=453d7c1aacadb37977a3ad2724c942cb05c3f65c;hb=6dee0826a47d1b1468207b28fc10ac7c7760b661;hp=7d21f3825f0bdd7ba03997c3b22ddb76eb9add8f;hpb=cd26a72b417b074a77611d00b642180b5ea7470b;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index 7d21f3825..453d7c1aa 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,103 +1,99 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 -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 +.. _release-notes: +El Alto Release Notes +^^^^^^^^^^^^^^^^^^^^^ -Amsterdam Release ------------------ +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. -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. +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. -Functionality -+++++++++++++ +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. +El Alto Major Release 5.0.1 +=========================== + +* 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`. +============================== +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` and prepends to these if/when any updated versions the project team believes are compatible with a major release are made available. - -Supported Platforms -+++++++++++++++++++ -ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported. - Documentation -+++++++++++++ -ONAP Amsterdam Release documentation is available :ref:`here `. -For Amsterdam this includes: - -* A high level :ref:`architecture view` of how components - relate to each other. - -* A collection of documentation provided - by :ref:`each project `. - -* Application Programming Interface Reference :ref:`available here `. +============= +ONAP El Alto Release provides a set selection of documents, +see :ref:`ONAP Home`. -* The `developer wiki `_ remains a good source of - information on meeting plans and notes from committees, project teams and - community events. +The `developer wiki `_ 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 ` -Known Issues and Limitations -++++++++++++++++++++++++++++ -Known Issues and limitations are documented in each project Release Notes. +.. toctree:: + :hidden: -Refer to :ref:`release notes ` for each project. + ../submodules/osa.git/docs/index.rst -Licenses -++++++++ -ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License `_. -ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License `_. +ONAP has adopted the `CII Best Practice Badge Program `_. -How to Report a Bug -+++++++++++++++++++ -There are 2 ways to report a bug in ONAP. +- `Badging Requirements `_ +- `Badging Status for all ONAP projects `_ -In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira `_. +Project specific details are in the :ref:`release notes` for +each project. -If you don't know you are facing a bug or have a question, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org . +.. index:: maturity -You may consider these `recommendations `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. +ONAP Maturity Testing Notes +=========================== +For El Alto release, ONAP continues to improve in multiple areas of +Scalability, Security, Stability and Performance (S3P) metrics. +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 ` -Download -++++++++ +Known Issues and Limitations +============================ +Known Issues and limitations are documented in each +:ref:`project Release Notes `. -* ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ . +.. index:: Reporting Bugs -* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap . +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 `_. -Install -+++++++ -There are 2 approaches to install ONAP. + * If you don't know you are facing a bug or have a question, post your + question into the `Ask question `_. + You will need a Linux Foundation ID to login and post your question. + Get a Linux Foundation Identity using this `quick procedure `_. -* From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP `. +To properly report a bug in Jira, you may want to consider these `recommendations `_ to elaborate the issue you are facing. -* From a developer perspective. ONAP is installed component per component. Each component :ref:`installation is listed in`. -The list of ports used by default within ONAP is documented in `ONAP Service List `_. -Usage -+++++ -This section is intended to provide users on the usage of ONAP components. +.. Include files referenced by link in the toctree as hidden