From c729db802db6472b9b89b8a1eff0eba8057d0741 Mon Sep 17 00:00:00 2001 From: Noemi Wagner Date: Thu, 7 Mar 2019 13:55:42 +0100 Subject: Overview document created The overview document targets to provide the reader with a basic understanding on ONAP and its basic functional description.The doc also provides insight to Benefit of ONAP, licenses needed, basic releases etc. Issue-ID: DOC-364 Change-Id: I87c10896dc308d24d5aa8b54d920545372ffc41d Signed-off-by: Noemi Wagner --- docs/guides/overview/index.rst | 14 ++ .../media/ONAP_architecture_high_level.des | Bin 0 -> 20734 bytes .../media/ONAP_architecture_high_level.png | Bin 0 -> 256914 bytes .../media/ONAP_architecture_high_level.svg | 142 ++++++++++++++++ docs/guides/overview/media/ONAP_main_functions.des | Bin 0 -> 16198 bytes docs/guides/overview/media/ONAP_main_functions.png | Bin 0 -> 60229 bytes docs/guides/overview/media/ONAP_main_functions.svg | 75 +++++++++ docs/guides/overview/overview.rst | 183 +++++++++++++++++++++ docs/index.rst | 1 + docs/media/ONAP-architecture-high-level.svg | 2 +- docs/release/index.rst | 6 +- docs/use-cases/vfw.rst | 3 +- 12 files changed, 423 insertions(+), 3 deletions(-) create mode 100644 docs/guides/overview/index.rst create mode 100644 docs/guides/overview/media/ONAP_architecture_high_level.des create mode 100644 docs/guides/overview/media/ONAP_architecture_high_level.png create mode 100644 docs/guides/overview/media/ONAP_architecture_high_level.svg create mode 100644 docs/guides/overview/media/ONAP_main_functions.des create mode 100644 docs/guides/overview/media/ONAP_main_functions.png create mode 100644 docs/guides/overview/media/ONAP_main_functions.svg create mode 100644 docs/guides/overview/overview.rst diff --git a/docs/guides/overview/index.rst b/docs/guides/overview/index.rst new file mode 100644 index 000000000..403c3980e --- /dev/null +++ b/docs/guides/overview/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2019 Nokia + + +.. index:: Overview + +ONAP Overview +========================================= + +.. toctree:: + :maxdepth: 2 + + overview.rst diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.des b/docs/guides/overview/media/ONAP_architecture_high_level.des new file mode 100644 index 000000000..e90a061e6 Binary files /dev/null and b/docs/guides/overview/media/ONAP_architecture_high_level.des differ diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.png b/docs/guides/overview/media/ONAP_architecture_high_level.png new file mode 100644 index 000000000..8fa45e9b1 Binary files /dev/null and b/docs/guides/overview/media/ONAP_architecture_high_level.png differ diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.svg b/docs/guides/overview/media/ONAP_architecture_high_level.svg new file mode 100644 index 000000000..d55f71c31 --- /dev/null +++ b/docs/guides/overview/media/ONAP_architecture_high_level.svg @@ -0,0 +1,142 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ONAP Portal + + Run-time framework + + Design-time framework + + + VNF Software Development Kit (SDK) + + + + VNF Validation Program (VVP) + + + + Service Design and Creation (SDC) + + POLICY framework + + Service Orchestration (SO) + + Service-defined Network Controller (SDNC) + + Application Controller (APPC) + + Virtual Function Controller (VFC) + + Active and Available Inventory (A& AI) + Common Services + + ONAP Optimization framework + + Multi-Site State Coordination Service (MUSIC) + + + ONAP Operations Manager (OOM) + + + OSS/BSS + + + Closed Loop Automation Platform (CLAMP) + + Data collection, Analytics and Events (DCAE) + + VNF Requirements + + + + ONAP supporting activities + + + diff --git a/docs/guides/overview/media/ONAP_main_functions.des b/docs/guides/overview/media/ONAP_main_functions.des new file mode 100644 index 000000000..daa7b9626 Binary files /dev/null and b/docs/guides/overview/media/ONAP_main_functions.des differ diff --git a/docs/guides/overview/media/ONAP_main_functions.png b/docs/guides/overview/media/ONAP_main_functions.png new file mode 100644 index 000000000..a3d5c6001 Binary files /dev/null and b/docs/guides/overview/media/ONAP_main_functions.png differ diff --git a/docs/guides/overview/media/ONAP_main_functions.svg b/docs/guides/overview/media/ONAP_main_functions.svg new file mode 100644 index 000000000..0afc78019 --- /dev/null +++ b/docs/guides/overview/media/ONAP_main_functions.svg @@ -0,0 +1,75 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Run-time framework + + Design-time framework + + + + + + ONAP + Service Design + Service Deployment + Service Operations + + + diff --git a/docs/guides/overview/overview.rst b/docs/guides/overview/overview.rst new file mode 100644 index 000000000..83c7e9de8 --- /dev/null +++ b/docs/guides/overview/overview.rst @@ -0,0 +1,183 @@ +.. This work is licensed under a Creative Commons Attribution +.. 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2019 Nokia; Copyright 2017-2018 Huawei Technologies Co., Ltd.; Copyright 2017 AT&T Intellectual Property. + +Open Network Automation Platform Overview +========================================= + +The Open Network Automation Platform (ONAP) project addresses the +rising need for a **common automation platform for telecommunication, cable, +and cloud service providers**—and their solution providers— that enables the +**automation of different lifecycle processes**, to deliver differentiated +network services on demand, profitably and competitively, while leveraging +existing investments. + +Prior to ONAP, telecommunication network operators had to keep up with the +scale and cost of manual changes required to implement new service offerings, +from installing new data center equipment to, in some cases, upgrading +customer equipment on-premises. Many operators are seeking to exploit +Software Defined Network (SDN) and Network Function Virtualization (NFV) +to improve service velocity, simplify equipment interoperability and +integration, and reduce overall CapEx and OpEx costs. In addition, the +current, highly fragmented management landscape makes it difficult to +monitor and guarantee service-level agreements (SLAs). + +ONAP is addressing these challenges by developing global and massive +scale (multi-site and multi-Virtual Infrastructure Manager (VIM)) +automation capabilities for both physical and virtual network elements. +It facilitates service agility by supporting data models for rapid +service and resource deployment, by providing a common set of Northbound +REST APIs that are open and interoperable, and by supporting model +driven interfaces to the networks. ONAP’s modular and layered nature +improves interoperability and simplifies integration, allowing it to +support multiple VNF environments by integrating with multiple VIMs, +virtualized network function managers (VNFMs), SDN Controllers, and +even legacy equipment. ONAP’s consolidated VNF requirements enable +commercial development of ONAP-compliant VNFs. This approach allows +network and cloud operators to optimize their physical and virtual +infrastructure for cost and performance; at the same time, ONAP’s +use of standard models reduces integration and deployment costs of +heterogeneous equipment, while minimizing management fragmentation. + +Scope of ONAP +------------- + +ONAP enables end user organizations and their network or cloud providers +to collaboratively instantiate network elements and services in a dynamic, +closed control loop process, with real-time response to actionable events. + +ONAP’s major activities, that is designing, deploying and operating +services, are provided based on ONAP’s two major frameworks, namely on +Design-time framework and Run-time framework: + +.. image:: media/ONAP_main_functions.png + :scale: 40 % + +In order to design, deploy and operate services and assure these dynamic +services, ONAP activities are built up as follows: + +* **Service design** – Service design is built on a robust design framework that + allows specification of the service in all aspects – modeling the resources and + relationships that make up the service, specifying the policy rules that guide + the service behavior, specifying the applications, analytics and closed control + loop events needed for the elastic management of the service. +* **Service deployment** – Service deployment is built on an orchestration + and control framework that is policy-driven (Service Orchestrator and + Controllers) to provide automated instantiation of the service when + needed and managing service demands in an elastic manner. +* **Service operations** – Service operations are built on an analytic + framework that closely monitors the service behavior during the service + lifecycle based on the specified design, analytics and policies to enable + response as required from the control framework, to deal with situations + ranging from those that require healing to those that require scaling + of the resources to elastically adjust to demand variations. + +ONAP enables product- or service-independent capabilities for design, +deployment and operation, in accordance with the following foundational +principles: + +1. Ability to dynamically introduce full service lifecycle orchestration + (design, provisioning and operation) and service API for new services + and technologies without the need for new platform software releases + or without affecting operations for the existing services + +2. Carrier-grade scalability including horizontal scaling (linear scale-out) + and distribution to support large number of services and large networks + +3. Metadata-driven and policy-driven architecture to ensure flexible and + automated ways in which capabilities are used and delivered + +4. The architecture shall enable sourcing best-in-class components + +5. Common capabilities are ‘developed’ once and ‘used’ many times + +6. Core capabilities shall support many diverse services and infrastructures + +7. The architecture shall support elastic scaling as needs grow or shrink + +Functional overview of ONAP +=========================== + +The following guidelines show the main ONAP activities in a chronological order, presenting ONAP's functional structure: + +1. **Service design** - ONAP supports Service Design operations, using the TOSCA approach. +These service design activities are built up of the following subtasks: + a. Planning VNF onboarding – checking which VNFs will be necessary for the required environment and features + b. Creating resources, composing services + c. Distributing services - Distributing services constitutes of 2 subtasks: + * TOSCA C-SAR package is stored in the Catalog + * new service notification is published + +2. **Service orchestration and deployment** + a. Defining which VNFs are necessary for the service + b. Defining orchestration steps + c. Selecting valid cloud region + d. Service orchestration calling cloud APIs to deploy VNFs + * The onboarding and instantiation of VNFs in ONAP is represented via + the example of onboarding and instantiating a virtual network function + (VNF), the virtual Firewall (vFirewall). Following the guidelines and + steps of this example, any other VNF can be similarly onboarded + and instantiated to ONAP. See :ref:`virtual Firewall Onboarding and + Instantiating ` examples. + e. Controllers applying configuration on VNFs +3. **Service operations** + a. Closed Loop design and deployment + b. Collecting and evaluating event data + +Benefits of ONAP +================ + +Open Network Automation Platform provides the following benefits: + +* common automation platform, which enables common management of services and + connectivity, while the applications run separately +* a unified operating framework for vendor-agnostic, policy-driven service + design, implementation, analytics and lifecycle management for + large-scale workloads and services +* orchestration for both virtual and physical network functions +* ONAP offers Service or VNF Configuration capability, in contrast to other + open-source orchestration platforms +* the model-driven approach enables ONAP to support services, that are using + different VNFs, as a common service block +* service modelling enables operators to use the same deployment and management + mechanisms, beside also using the same platform + +ONAP Release information +======================== + +ONAP is enhanced with numerous features from release to release. Each release +is named after a city. + ++----------------------+----------------+----------------------+-----------------------------------------------------------+ +|Release Name |Release version |Release Date |Features delivered | ++======================+================+======================+===========================================================+ +|Casablanca |* 3.0.2 |* 31 January 2019 | :ref:`Casablanca Release Notes ` | +| |* 3.0.1 |* 30 November 2018 | | +| |* 3.0.0 |* 15 April 2019 | | ++----------------------+----------------+----------------------+-----------------------------------------------------------+ +|Beijing |2.0.0 |7 June 2018 | + ++----------------------+----------------+----------------------+-----------------------------------------------------------+ +|Amsterdam |1.0.0 |16 November 2017 | + ++----------------------+----------------+----------------------+-----------------------------------------------------------+ + +ONAP Blueprints and environments +================================ + +ONAP is able to deploy and operate VNFs running OpenStack based Centralized Private Cloud Instances, as well as Mobile Edge Cloud instances. +ONAP has been tested in the following network environments: + +* Voice Over LTE (VoLTE) +* Customer Premise Equipment (CPE) +* 5G +* Cross Domain and Cross Layer VPN (CCVPN) +* Broadband Service (BBS) + +Licenses +======== + +Open Network Automation Platform (ONAP) is an open source project hosted by the Linux Foundation. + +ONAP Source Code is licensed under the `Apache Version 2 License `_. +ONAP Documentation is licensed under the `Creative Commons Attribution 4.0 +International License `_. diff --git a/docs/index.rst b/docs/index.rst index 749af32b0..895355d83 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,6 +58,7 @@ You can reach the complete Casablanca Release documentation from the Navigation :hidden: Home + guides/overview/index release/index guides/onap-developer/architecture/index guides/onap-developer/settingup/index diff --git a/docs/media/ONAP-architecture-high-level.svg b/docs/media/ONAP-architecture-high-level.svg index 0e8935336..54593d8a1 100644 --- a/docs/media/ONAP-architecture-high-level.svg +++ b/docs/media/ONAP-architecture-high-level.svg @@ -6,7 +6,7 @@ viewBox="0 0 210 297" xmlns:xlink="http://www.w3.org/1999/xlink"> - diff --git a/docs/release/index.rst b/docs/release/index.rst index e7d77cf3e..c27ed9178 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,8 +1,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 + +.. _casablancarelease-notes: + Casablanca Release Notes ^^^^^^^^^^^^^^^^^^^^^^^^ + This page is the ONAP Casablanca Release Notes. The first release was labelled Amsterdam, second release Beijing and subsequent major release will be named using city names. @@ -199,7 +203,7 @@ Project specific details are in the :ref:`release notes` for e ONAP Maturity Testing Notes =========================== -For the Casablanca release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics. +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 ` diff --git a/docs/use-cases/vfw.rst b/docs/use-cases/vfw.rst index 7c230ca0d..b5fe9f074 100644 --- a/docs/use-cases/vfw.rst +++ b/docs/use-cases/vfw.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. _vfirewall_usecase: + vFirewall ========= @@ -11,7 +13,6 @@ Description Onboarding ---------- - .. uml:: @startuml -- cgit 1.2.3-korg