X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=99b1400ff3f38f7af02cfa896140662201bbae2f;hb=946096b392f07e4bd05d027bee7ea3593fadd675;hp=22248483845eb190becadbc2ae5f259191902660;hpb=0172ec27a6e54ebdd0f7ded1478ff79b28ed10d3;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index 222484838..99b1400ff 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,176 +1,96 @@ .. 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 -+++++++++++++ -*Portal* - a single, consistent user experience for both design timer -and run time environments, based on the user’s role. +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. -*Design Time Framework* - a comprehensive development environment with -tools, techniques, and repositories for defining/describing resources, -services, and products: +Dublin Major Release 4.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. +* Release Name: Dublin +* Release Version: 4.0.0 +* Release Date: , 2019 - - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier - packaging and validation. +The Dublin 4.0.0 is the first release for Dublin. - - 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. +Project Specific Release Notes +============================== +ONAP releases are specified by a list of project artifact versions in a :ref:`manifest artifacts ` +and :ref:`manifest dockers `. - - “Holmes” provides alarm correlation and analysis for Telecom cloud - infrastructure and services, including hosts, vims, VNFs and NSs +.. toctree:: + :hidden: - - Common Services - operational services for all ONAP components including - activity logging, reporting, common data layer, access control, resiliency, - and software lifecycle management. + release-manifest-docker.rst + release-manifest.rst -Project Specific Release Notes -++++++++++++++++++++++++++++++ -ONAP releases are specified by a list of project artifact -versions in a :ref:`manifest`. 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 +============== +ONAP has adopted the `CII Best Practice Badge Program `_. +The goal of the Casablanca release is for all ONAP projects to be close to achieving a CII Passing badge. - * A high level :ref:`architecture view` of how components - relate to each other. +- `Badging Requirements `_ +- `Badging Status for all ONAP projects `_ - * A collection of documentation provided - by :ref:`each project `. +Project specific details are in the :ref:`release notes` for each project. - * Application Programming Interface - Reference :ref:`available here `. +.. index:: maturity - * The `developer wiki `_ remains a good source of - information on meeting plans and notes from committees, project teams and - community events. +ONAP Maturity Testing Notes +=========================== +For the Casablanca 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 (96.9% passing rate) at ONAP OpenLabs. More details in :ref:`ONAP Maturity Testing Notes ` Known Issues and Limitations -++++++++++++++++++++++++++++ -Known Issues and limitations are documented in each project Release Notes. - -Refer to :ref:`release notes ` for each project. +============================ +Known Issues and limitations are documented in each :ref:`project Release Notes `. -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 `_. +.. 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 `_. - - * 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 . - -You may consider these `recommendations `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. - - -Download -++++++++ - -* 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 . - + * 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 -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 `_. +.. toctree:: + :hidden: + releaserepos.rst + repolist.rst