diff options
| -rw-r--r-- | docs/guides/overview/overview.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 5 | ||||
| -rw-r--r-- | docs/release/index.rst | 128 |
3 files changed, 13 insertions, 124 deletions
diff --git a/docs/guides/overview/overview.rst b/docs/guides/overview/overview.rst index 83c7e9de8..fc4570532 100644 --- a/docs/guides/overview/overview.rst +++ b/docs/guides/overview/overview.rst @@ -152,7 +152,9 @@ is named after a city. +----------------------+----------------+----------------------+-----------------------------------------------------------+ |Release Name |Release version |Release Date |Features delivered | +======================+================+======================+===========================================================+ -|Casablanca |* 3.0.2 |* 31 January 2019 | :ref:`Casablanca Release Notes <casablancarelease-notes>` | +|Dublin |4.0.0 |2019 | :ref:`Dublin Release Notes <dublinrelease-notes>` | ++----------------------+----------------+----------------------+-----------------------------------------------------------+ +|Casablanca |* 3.0.2 |* 31 January 2019 | | | |* 3.0.1 |* 30 November 2018 | | | |* 3.0.0 |* 15 April 2019 | | +----------------------+----------------+----------------------+-----------------------------------------------------------+ diff --git a/docs/index.rst b/docs/index.rst index 9902db952..fc772b8bb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,9 @@ Please find some guidance here on the content of ONAP documentation: +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | Main documentation areas | Description | +=================================================================================+===============================================================================================+ + | :ref:`Release Notes <dublinrelease-notes>` | The Release Notes besides providing the basic information on the main release, also | + | | presents link to the release information of each, specific ONAP component. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main | | | functionalities of ONAP. Basic guidelines on license details, limitations and | | | security references support understanding the solution. | @@ -62,8 +65,8 @@ Please find some guidance here on the content of ONAP documentation: :hidden: Home <self> - guides/overview/index release/index + guides/overview/index guides/onap-developer/architecture/index guides/onap-developer/developing/index guides/onap-developer/settingup/index diff --git a/docs/release/index.rst b/docs/release/index.rst index c3bcba2f4..99b1400ff 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -2,7 +2,7 @@ International License. http://creativecommons.org/licenses/by/4.0 -.. _casablancarelease-notes: +.. _dublinrelease-notes: Dublin Release Notes ^^^^^^^^^^^^^^^^^^^^ @@ -11,8 +11,7 @@ This page provides the release notes for the ONAP Dublin release. This includes outstanding trouble reports. 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. Information that is applicable regardless of release is included in the `Getting Started With ONAP`_ section of this -document. +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 releaese by each component is maintained in the component specific release notes. @@ -26,98 +25,6 @@ Dublin Major Release 4.0.0 The Dublin 4.0.0 is the first release for Dublin. -.. _getting-started: - -Getting Started With ONAP -========================= - -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. - -Functionality -------------- -**Portal** - a single, consistent user experience for both design time -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, -and services: - - - 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) and VNF Validation Program (VVP) - 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. - - - Optimization Framework (OOF) provides a policy-driven and model-driven - framework for creating optimization applications. - -**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, - multisite state coordination, credential/secret management and - software lifecycle management. - -**Microservices Support** - - - ONAP Operation Manager (OOM) use Kubernetes and Helm to manage ONAP components. - - Microservices Bus (MSB) provides service registration/discovery, - external API gateway, internal API gateway, client software development kit - (SDK), and Swagger SDK. - Project Specific Release Notes ============================== ONAP releases are specified by a list of project artifact versions in a :ref:`manifest artifacts <doc-release-manifest-artifacts>` @@ -133,30 +40,13 @@ 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. -.. index:: Download - -Installation -============ -ONAP is installed using :ref:`ONAP Operations Manager (OOM) over Kubernetes<installing-onap>` - Documentation ============= -ONAP Dublin Release provides multiple documents including the following: - - * A high level :ref:`architecture view<doc-architecture>` of how component - relate to each other. - - * A collection of documentation provided - by :ref:`each project <doc_onap-developer_guide_projects>`. +ONAP Dublin Release provides multiple documents, see :ref:`ONAP Home<master_index>`. - * Application Programming Interface - Reference :ref:`available here <doc-apiref>`. - - * 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. - -.. index:: Licensing +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. Security Notes ============== @@ -176,12 +66,6 @@ For the Casablanca release, ONAP continues to improve in multiple areas of Scal 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 <integration-s3p>` -Licenses -======== -ONAP Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_. -ONAP Documentation is licensed under the `Creative Commons Attribution 4.0 -International License <http://creativecommons.org/licenses/by/4.0>`_. - Known Issues and Limitations ============================ Known Issues and limitations are documented in each :ref:`project Release Notes <doc-releaserepos>`. |