X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=0683e06214b6af5f698f8e5a5415bb8ef17dc55d;hb=94bef1308d5a285dd7a3e5c8c5395325867e0d5a;hp=c142ca9e46012f87403b1b35b1dfaf46a8561ca5;hpb=1d42ffef91658f9d17a22c675bf48e149903c1c7;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index c142ca9e4..0683e0621 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,92 +1,95 @@ .. 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 +.. _dublinrelease-notes: +Dublin Release Notes +^^^^^^^^^^^^^^^^^^^^ -Amsterdam Release ------------------ +This page provides the release notes for the ONAP Dublin 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 Dublin 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. +Dublin Major Release 4.0.0 +========================== + +* Release Name: Dublin +* Release Version: 4.0.0 +* Release Date: , 2019 + +The Dublin 4.0.0 is the first release for Dublin. 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. +Documentation +============= +ONAP Dublin Release provides multiple documents, see :ref:`ONAP Home`. -Supported Platforms -+++++++++++++++++++ -ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported. +The `developer wiki `_ 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 `. -For Amsterdam this includes: +Security Notes +============== +Details about discovered and mitigated vulnerabilities are in :ref:`ONAP Security ` -* A high level :ref:`architecture view` of how components - relate to each other. +.. toctree:: + :hidden: -* A collection of documentation provided - by :ref:`each project `. + ../submodules/osa.git/docs/index.rst -* Application Programming Interface Reference :ref:`available here `. +ONAP has adopted the `CII Best Practice Badge Program `_. -* The `developer wiki `_ remains a good source of - information on meeting plans and notes from committees, project teams and - community events. See the doc - project :ref:`release notes ` for current status on documentation. +- `Badging Requirements `_ +- `Badging Status for all ONAP projects `_ +Project specific details are in the :ref:`release notes` for each project. -Known Issues and Limitations -++++++++++++++++++++++++++++ -Known Issues and limitations are documented in each project Release Notes. +.. index:: maturity -Refer to :ref:`release notes ` for each project. +ONAP Maturity Testing Notes +=========================== +For Dublin release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics. -License -+++++++ -ONAP Amsterdam is an `Apache Version 2 license `_ type of Open Source project. +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 ` -How to Report a Bug -+++++++++++++++++++ -There are 2 ways to report a bug in ONAP. +Known Issues and Limitations +============================ +Known Issues and limitations are documented in each :ref:`project Release Notes `. -In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira `_. +.. index:: Reporting Bugs -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 . +How to Report a Bug +=================== +There are 2 ways to report a bug in ONAP. -You may consider these `recommendations `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. + * In case you are familiar within ONAP, you can directly report a bug by + creating a Jira issue at `ONAP Jira `_. + * 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 `_. -Download and Use -++++++++++++++++ +To properly report a bug in Jira, you may want to consider these `recommendations `_ to elaborate the issue you are facing. -* 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 . +.. Include files referenced by link in the toctree as hidden -* To Install Amsterdam ONAP refer to :ref:`Setting Up ONAP `. +.. toctree:: + :hidden: + releaserepos.rst + repolist.rst