From 65bec69096b0a2ef18cd72d87b89757da4ae1906 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 11 Aug 2022 13:05:18 +0200 Subject: improve navigation and readability Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Ib4f8246d548a77885c5f6c5457ce2c3b20e275b6 --- docs/_static/css/ribbon.css | 2 +- docs/guides/onap-developer/architecture/index.rst | 17 - .../onap-developer/architecture/media/ONAP-5G.png | Bin 81553 -> 0 bytes .../media/ONAP-5GSuperBP-Integration.png | Bin 218568 -> 0 bytes .../media/ONAP-IntentBasedNetworking.png | Bin 245495 -> 0 bytes .../media/ONAP-NetworkSlicingOptions.png | Bin 420474 -> 0 bytes .../architecture/media/ONAP-architecture.png | Bin 133346 -> 0 bytes .../onap-developer/architecture/media/ONAP-bbs.png | Bin 115218 -> 0 bytes .../architecture/media/ONAP-ccvpn.png | Bin 260011 -> 0 bytes .../architecture/media/ONAP-closedloop.png | Bin 220944 -> 0 bytes .../architecture/media/ONAP-fncview.png | Bin 441038 -> 0 bytes .../architecture/media/ONAP-mdons.png | Bin 106265 -> 0 bytes .../architecture/media/ONAP-vcpe.png | Bin 155109 -> 0 bytes .../architecture/media/ONAP-volte.png | Bin 182747 -> 0 bytes .../media/onap-architecture-overview-colors.svg | 350 -- ...onap-architecture-overview-interactive-path.svg | 6078 -------------------- .../onap-architecture-overview-interactive.svg | 2976 ---------- ...onap-architecture-overview-labels-and-links.csv | 86 - .../media/onap-architecture-overview-notes.txt | 70 - .../architecture/onap-architecture.rst | 902 --- .../onap-developer/architecture/references.rst | 55 - docs/guides/onap-developer/developing/index.rst | 262 - docs/guides/onap-user/index.rst | 3 + docs/guides/overview/index.rst | 16 - .../media/ONAP_architecture_high_level.des | Bin 20734 -> 0 bytes .../media/ONAP_architecture_high_level.png | Bin 256914 -> 0 bytes .../media/ONAP_architecture_high_level.svg | 142 - docs/guides/overview/media/ONAP_main_functions.des | Bin 16198 -> 0 bytes docs/guides/overview/media/ONAP_main_functions.png | Bin 60229 -> 0 bytes docs/guides/overview/media/ONAP_main_functions.svg | 75 - docs/guides/overview/overview.rst | 208 - docs/index.rst | 45 +- docs/platform/architecture/index.rst | 903 +++ docs/platform/architecture/media/ONAP-5G.png | Bin 0 -> 81553 bytes .../media/ONAP-5GSuperBP-Integration.png | Bin 0 -> 218568 bytes .../media/ONAP-IntentBasedNetworking.png | Bin 0 -> 245495 bytes .../media/ONAP-NetworkSlicingOptions.png | Bin 0 -> 420474 bytes .../architecture/media/ONAP-architecture.png | Bin 0 -> 133346 bytes docs/platform/architecture/media/ONAP-bbs.png | Bin 0 -> 115218 bytes docs/platform/architecture/media/ONAP-ccvpn.png | Bin 0 -> 260011 bytes .../architecture/media/ONAP-closedloop.png | Bin 0 -> 220944 bytes docs/platform/architecture/media/ONAP-fncview.png | Bin 0 -> 441038 bytes docs/platform/architecture/media/ONAP-mdons.png | Bin 0 -> 106265 bytes docs/platform/architecture/media/ONAP-vcpe.png | Bin 0 -> 155109 bytes docs/platform/architecture/media/ONAP-volte.png | Bin 0 -> 182747 bytes .../media/onap-architecture-overview-colors.svg | 350 ++ ...onap-architecture-overview-interactive-path.svg | 6078 ++++++++++++++++++++ .../onap-architecture-overview-interactive.svg | 2976 ++++++++++ ...onap-architecture-overview-labels-and-links.csv | 86 + .../media/onap-architecture-overview-notes.txt | 70 + docs/platform/components/index.rst | 262 + docs/platform/overview/index.rst | 178 + .../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 + .../overview/media/ONAP_main_functions.des | Bin 0 -> 16198 bytes .../overview/media/ONAP_main_functions.png | Bin 0 -> 60229 bytes .../overview/media/ONAP_main_functions.svg | 75 + docs/release/component-release-notes.rst | 112 + docs/release/history.rst | 35 + docs/release/index.rst | 6 +- docs/release/releaserepos.rst | 112 - docs/security/index.rst | 24 + 63 files changed, 11335 insertions(+), 11361 deletions(-) delete mode 100644 docs/guides/onap-developer/architecture/index.rst delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-5G.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-5GSuperBP-Integration.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-IntentBasedNetworking.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-NetworkSlicingOptions.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-architecture.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-bbs.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-ccvpn.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-closedloop.png delete mode 100755 docs/guides/onap-developer/architecture/media/ONAP-fncview.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-mdons.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-vcpe.png delete mode 100644 docs/guides/onap-developer/architecture/media/ONAP-volte.png delete mode 100644 docs/guides/onap-developer/architecture/media/onap-architecture-overview-colors.svg delete mode 100644 docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive-path.svg delete mode 100644 docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg delete mode 100644 docs/guides/onap-developer/architecture/media/onap-architecture-overview-labels-and-links.csv delete mode 100644 docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt delete mode 100644 docs/guides/onap-developer/architecture/onap-architecture.rst delete mode 100644 docs/guides/onap-developer/architecture/references.rst delete mode 100644 docs/guides/onap-developer/developing/index.rst delete mode 100644 docs/guides/overview/index.rst delete mode 100644 docs/guides/overview/media/ONAP_architecture_high_level.des delete mode 100644 docs/guides/overview/media/ONAP_architecture_high_level.png delete mode 100644 docs/guides/overview/media/ONAP_architecture_high_level.svg delete mode 100644 docs/guides/overview/media/ONAP_main_functions.des delete mode 100644 docs/guides/overview/media/ONAP_main_functions.png delete mode 100644 docs/guides/overview/media/ONAP_main_functions.svg delete mode 100644 docs/guides/overview/overview.rst create mode 100644 docs/platform/architecture/index.rst create mode 100644 docs/platform/architecture/media/ONAP-5G.png create mode 100644 docs/platform/architecture/media/ONAP-5GSuperBP-Integration.png create mode 100644 docs/platform/architecture/media/ONAP-IntentBasedNetworking.png create mode 100644 docs/platform/architecture/media/ONAP-NetworkSlicingOptions.png create mode 100644 docs/platform/architecture/media/ONAP-architecture.png create mode 100644 docs/platform/architecture/media/ONAP-bbs.png create mode 100644 docs/platform/architecture/media/ONAP-ccvpn.png create mode 100644 docs/platform/architecture/media/ONAP-closedloop.png create mode 100755 docs/platform/architecture/media/ONAP-fncview.png create mode 100644 docs/platform/architecture/media/ONAP-mdons.png create mode 100644 docs/platform/architecture/media/ONAP-vcpe.png create mode 100644 docs/platform/architecture/media/ONAP-volte.png create mode 100644 docs/platform/architecture/media/onap-architecture-overview-colors.svg create mode 100644 docs/platform/architecture/media/onap-architecture-overview-interactive-path.svg create mode 100644 docs/platform/architecture/media/onap-architecture-overview-interactive.svg create mode 100644 docs/platform/architecture/media/onap-architecture-overview-labels-and-links.csv create mode 100644 docs/platform/architecture/media/onap-architecture-overview-notes.txt create mode 100644 docs/platform/components/index.rst create mode 100644 docs/platform/overview/index.rst create mode 100644 docs/platform/overview/media/ONAP_architecture_high_level.des create mode 100644 docs/platform/overview/media/ONAP_architecture_high_level.png create mode 100644 docs/platform/overview/media/ONAP_architecture_high_level.svg create mode 100644 docs/platform/overview/media/ONAP_main_functions.des create mode 100644 docs/platform/overview/media/ONAP_main_functions.png create mode 100644 docs/platform/overview/media/ONAP_main_functions.svg create mode 100644 docs/release/component-release-notes.rst create mode 100644 docs/release/history.rst delete mode 100644 docs/release/releaserepos.rst create mode 100644 docs/security/index.rst diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 1dfe318db..afb9480d6 100644 --- a/docs/_static/css/ribbon.css +++ b/docs/_static/css/ribbon.css @@ -59,5 +59,5 @@ /* fix width of the screen */ .wy-nav-content { - max-width: 1280px; + max-width: 800px; } diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst deleted file mode 100644 index 34e0bb356..000000000 --- a/docs/guides/onap-developer/architecture/index.rst +++ /dev/null @@ -1,17 +0,0 @@ - -.. This work is licensed under a Creative Commons Attribution 4.0 - International License. http://creativecommons.org/licenses/by/4.0 - Copyright 2017 AT&T Intellectual Property. All rights reserved. - -.. index:: Platform Architecture - -.. _doc-architecture: - -ONAP Architecture -================= - -.. toctree:: - :maxdepth: 2 - - onap-architecture.rst - references.rst diff --git a/docs/guides/onap-developer/architecture/media/ONAP-5G.png b/docs/guides/onap-developer/architecture/media/ONAP-5G.png deleted file mode 100644 index 9ae0b2a6a..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-5G.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-5GSuperBP-Integration.png b/docs/guides/onap-developer/architecture/media/ONAP-5GSuperBP-Integration.png deleted file mode 100644 index 89d24e977..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-5GSuperBP-Integration.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-IntentBasedNetworking.png b/docs/guides/onap-developer/architecture/media/ONAP-IntentBasedNetworking.png deleted file mode 100644 index 327111ba3..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-IntentBasedNetworking.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-NetworkSlicingOptions.png b/docs/guides/onap-developer/architecture/media/ONAP-NetworkSlicingOptions.png deleted file mode 100644 index 90859d4ca..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-NetworkSlicingOptions.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png b/docs/guides/onap-developer/architecture/media/ONAP-architecture.png deleted file mode 100644 index 82a8a1b3e..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-bbs.png b/docs/guides/onap-developer/architecture/media/ONAP-bbs.png deleted file mode 100644 index 4996a066f..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-bbs.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-ccvpn.png b/docs/guides/onap-developer/architecture/media/ONAP-ccvpn.png deleted file mode 100644 index c98133874..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-ccvpn.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-closedloop.png b/docs/guides/onap-developer/architecture/media/ONAP-closedloop.png deleted file mode 100644 index 7d3a2cac8..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-closedloop.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png b/docs/guides/onap-developer/architecture/media/ONAP-fncview.png deleted file mode 100755 index 5497edb30..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-mdons.png b/docs/guides/onap-developer/architecture/media/ONAP-mdons.png deleted file mode 100644 index f58789138..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-mdons.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-vcpe.png b/docs/guides/onap-developer/architecture/media/ONAP-vcpe.png deleted file mode 100644 index 02ff80f7c..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-vcpe.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/ONAP-volte.png b/docs/guides/onap-developer/architecture/media/ONAP-volte.png deleted file mode 100644 index bce590655..000000000 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-volte.png and /dev/null differ diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-colors.svg b/docs/guides/onap-developer/architecture/media/onap-architecture-overview-colors.svg deleted file mode 100644 index 5cc237822..000000000 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-colors.svg +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive-path.svg b/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive-path.svg deleted file mode 100644 index c6577e793..000000000 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive-path.svg +++ /dev/null @@ -1,6078 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg b/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg deleted file mode 100644 index ffd8b5d82..000000000 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg +++ /dev/null @@ -1,2976 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - Unmaintained ONAP Component - - - - Entirety of ONAP Components - - - - Operations - - - - Orchestration & Management - - - - Design - - - - Color Legend: - - - - - - - Managed Environment - - - - - IP - MPLS - - - - PublicCloud - - - - PrivateDC Cloud - - - - PrivateEdge Cloud - - - - - - Hypervisor / OS Layer - - - - OpenStack - - - - Commercial VIM - - - - Kubernetes - - - - Public Cloud - - - - - - Network Function Layer - - - - - PNF - - - - VNF - - - - - - External Systems - - - - 3rd Party Controllers - - - - sVNFM - - - - EMS - - - - - - - - - - - Utilities - - - - - - - ONAP Shared Utilities - - - - - - TOSCA Parser - - - - - - Model Utilities - - - - - - Common Controller SDK (CCSDK) - - - - - - - - - Manage ONAP - - - - - - ONAP Operation Manager (OOM) - - - - - - - - Design-Time - - - - - - - Service Design & Creation -(SDC) - - - - - - Catalog - - - - - - DCAE Design Studio - - - - - - Controller Design Studio (CDS) - - - - - - Workflow Designer - - - - - - xNF Onboarding - - - - - - Service/xNF Design - - - - - - - - VNF Validation - - - - - - VNF SDK - - - - - - VVP - - - - - - - - - Run-Time - - - - - - - Shared Services - - - - - - Config. Persistence Service (CPS) - - - - - - Multi-Site State (MUSIC) - - - - - - Logging - - - - - - Optimization Framework (OOF) - - - - - - Appl. Authoriz. Framework (AAF) - - - - - - - Virtual Function -Controller -(VFC) - - - - - - Application -Controller -(APPC) - - - - - - SDN -Controller (SDNC) - - - - - - Controller -Design Studio -(CDS) - - - - - - Infrastructure -Adaption -(Multi-VIM/Cloud) - - - - - - - Data Collection, -Analytics & Events (DCAE) - - - - - - Analytics - - - - - - Collectors - - - - - - - Data Movement as a Platform (DMaaP) - - - - - - Microservice Bus (MSB) - - - - - - Active & Available Inventory (AAI) - - - - - - Service Orchestration -(SO) - - - - - - Correlation Engine (Holmes) - - - - - - - Policy Framework - - - - - - CLAMP - - - - - - - - Interfaces - - - - - - CLI - - - - - - External APIs - - - - - - Use-Case UI (UUI) - - - - - - O&M Dashboard (VID) - - - - - - Portal - - - - - - - - Northbound Interface (NBI) towards OSS, BSS and other - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-labels-and-links.csv b/docs/guides/onap-developer/architecture/media/onap-architecture-overview-labels-and-links.csv deleted file mode 100644 index 7f17c3efe..000000000 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-labels-and-links.csv +++ /dev/null @@ -1,86 +0,0 @@ -LabelText;Href;HrefTarget;Title;Remark;ProjectState;OptionalInfo -ONAP Logo;https://docs.onap.org/en/latest/guides/overview/overview.html;Overview;The Open Network Automation Platform (ONAP) is a comprehensive platform for orchestration, management, and automation of network and edge computing services for network operators, cloud providers, and enterprises. The open source project ONAP is hosted by the Linux Foundation.;;na; -RELEASE 10 »JAKARTA«;https://docs.onap.org/en/latest/guides/overview/overview.html#onap-release-information;Overview;ONAP Release 10 »Jakarta« is not yet released.;;na; -ONAP Components (Border);https://docs.onap.org/en/latest/guides/onap-developer/architecture/index.html;Architecture;The ONAP architecture consists of functions for the design-time, run-time, for managing ONAP itself and additional utilities.;;na; -Northbound Interface (NBI) towards OSS, BSS and other;https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/architecture/architecture.html#introduction;Component;The Northbound Interface (NBI) provides a set of API that can be used by external systems as OSS or BSS for example. These APIs are based on TMF API.;"Required in this map? Because we also show the ""External APIs"" block in the map?! ";na; -Design-Time;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#design-time-framework;Architecture;The Design-time framework is a comprehensive development environment with tools, techniques and repositories for defining/describing resources, services, and products.;;na; -Service Design & Creation (SDC);https://docs.onap.org/projects/onap-sdc/en/latest/index.html;Component;Service Design & Creation (SDC) provides a well-structured organization of visual design and testing tools, templates and catalogs to model and create resources, and services. The output of the SDC is a set of models which drives the orchestration. In addition, it provides process workflow support for talking to the VNF/PNF or other resources and services through the process steps design, test and deploy.;Map update required? The elements below are a mix of tasks and ABB?! ;maintained; -Service/xNF Design;https://docs.onap.org/en/latest/guides/onap-user/design/index.html;GuideUser;The goal of the design process is to create all artifacts (models) that are required to instantiate and manage resources, services, and products on the ONAP platform.;;na;https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter7/VNF-On-boarding-and-package-management.html -xNF Onboarding;https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter7/VNF-On-boarding-and-package-management.html;VnfRequirements;The VNF provider must provide VNF packages that include a rich set of recipes, management and functional interfaces, policies, configuration parameters, and infrastructure requirements that can be utilized by the ONAP Design module to onboard and catalog these resources.;;na; -Workflow Designer;https://docs.onap.org/projects/onap-sdc/en/latest/workflow.html;Component;Workflow Designer allows a user to design a workflow, save it, and attach it to a SDC service as an artifact. Workflow Designer also manages the definitions of activities, which can be later used as parts of the designed workflows.;;na; -Controller Design Studio (CDS);https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html;Component;The design-time part of the Controller Design Studio (CDS) – the CDS Designer UI – is a framework to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1, or day2 configuration. A designer can define what actions are required for a given service, along with anything comprising the action. Its content is driven from a catalog of reusable data dictionary and component, delivering a reusable and simplified self-service experience. CDS modeling is mainly based on the TOSCA standard, using JSON as a representation. CDS is part of CCSDK.;;maintained; -DCAE Design Studio;https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.html;Component;Data Collection, Analytics and Events (DCAE) Design Studio enables to define and configure the monitoring flows of DCAE.;"Revise description? Rename ABB to ""DCAE MOD""?";maintained;"Data Collection, Analytics and Events (DCAE) Microservice Onboarding & Design (MOD) -Support automated adaptation of ML model from Acumos to DCAE design & runtime environment. -Provide simplified mS Onboarding, Service Assurance flow design, & mS configurations in DCAE. -Auto-generate blueprint at the end of the design process, not onboarded before the design process. -Support Policy onboarding & artifact distribution to Policy/CLAMP to support Self Service Control Loop. -Integrate with ONAP User Experience portals (initially ONAP portal, later SDC portal)." -Catalog;https://docs.onap.org/projects/onap-sdc/en/latest/architecture.html;Component;The key output of SDC is a set of models containing descriptions of asset capabilities and instructions to manage them. These models are stored in the SDC Master Reference Catalog for the entire enterprise to use.;Description of the SDC Catalog is missing in RTD. Link is rerouted to DevWiki / ARC Review.;na; -VNF Validation;https://docs.onap.org/en/latest/guides/onap-provider/index.html#vnf-and-pnf-requirements-and-guidelines;GuideProvider;Ensures that a network function (e.g. CNF, PNF, VNF) fits all ONAP guidelines and requirements.;;na; -VVP;https://docs.onap.org/projects/onap-vvp-documentation/en/latest/index.html;Component;The VNF Validation Platform (VVP) provides the functionality to validate that a VNF Heat package is compliant with the ONAP VNF Heat Template Requirements from the ONAP VNF Requirements (VNFRQTS) project.;;maintained; -VNF SDK;https://docs.onap.org/projects/onap-vnfsdk-model/en/latest/index.html;Component;The Virtual Network Function Software Development Kit (VNF SDK) provides the functionality to create VNF and PNF packages, test VNF and VNF ONAP compliance, and provides market place functionality to store VNF and PNF packages.;;maintained; -Run-Time;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#runtime-framework;Architecture;The Run-time execution framework executes the rules and policies and other models distributed by the design and creation environment.;;na; -Interfaces;https://docs.onap.org/en/latest/guides/onap-developer/architecture/references.html#user-interfaces;Architecture;Various ONAP components provide also a user interface.;;na; -Portal;https://docs.onap.org/projects/onap-portal/en/guilin/index.html;Component;Portal is a GUI platform that provides the ability to integrate different ONAP components GUIs into an centralized portal.;"Links to ""Guilin"" (latest available version)";unmaintained; -O&M Dashboard (VID);https://docs.onap.org/projects/onap-vid/en/latest/index.html;Component;Virtual Infrastructure Deployment (VID) is a UI interface that allows the operations and network infrastructure engineers to orchestrate and change configurations related to the infrastructure expansion and maintenance.;;unmaintained; -Use-Case UI (UUI);https://docs.onap.org/projects/onap-usecase-ui/en/latest/index.html;Component;Usecase User Interface (UUI) is an application portal which provides the ability to manage ONAP service instances. It allows customers to create, delete and update service instances, as well as to monitor the alarms and performance of these instances.;;maintained; -External APIs;https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/index.html;Component;External API exposes ONAPs capabilities through TMF standardized interfaces. It enables ONAP to hide the internal API.;;unmaintained; -CLI;https://docs.onap.org/projects/onap-cli/en/latest/index.html;Component;The Command Line Interface (CLI) provides commands to operate ONAP during design and run-time for network service functionalities. It also provides the 'Open Command Platform' which helps to orchestrate the commands from YAML and helps in agile automation.;;maintained; -Policy Framework;https://docs.onap.org/projects/onap-policy-parent/en/latest/index.html;Component;Policy Core Functions provide a logically centralized environment for the creation and management of policies, including conditional rules (e.g. create and validate policies/rules, identify overlaps, resolve conflicts, derive additional policies as needed).;;maintained; -CLAMP;https://docs.onap.org/projects/onap-policy-clamp/en/latest/index.html;Component;The Closed Loop Automation Platform (CLAMP) provides the capability to manage runtime control loops.;;maintained; -Correlation Engine (Holmes);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#holmes-holmes-alarm-correlation-and-analysis;ComponentIndex;Holmes provides the capability to analyze the relationship among different alarms (e.g. root cause, correlation).;;maintained; -Service Orchestration (SO);https://docs.onap.org/projects/onap-so/en/latest/index.html;Component;The Service Orchestration (SO) component is in charge of orchestration of network services and resources. It is based on the use of BPMN to document the Workflows.;;maintained; -Active & Available Inventory (AAI);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#aai-active-and-available-inventory;ComponentIndex;The Active and Available Inventory (AAI) provides real-time views of the resources and services in managed by and their relationships.;;maintained; -Microservice Bus (MSB);https://docs.onap.org/projects/onap-msb-apigateway/en/latest/index.html;Component;The Microservice Bus (MSB) provides service registration, discovery and communication services for microservices as well as a gateway for internal and external communication for the services.;;maintained; -Data Movement As A Platform (DMaaP);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#dmaap-data-movement-as-a-platform;ComponentIndex;Data Movement as a Platform (DMaaP) is a component that provides data movement services that transports and processes data from any source to any target.;;maintained; -Data Collection, Analytics & Events (DCAE);https://docs.onap.org/projects/onap-dcaegen2/en/latest/index.html;Component;Data Collection, Analytics & Events (DCAE) gathers performance, usage, and configuration data from the managed environment.;;maintained; -Collectors;https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html#collectors;Component;The collection layer provides the various data collectors that are needed to collect the instrumentation that is available from the cloud infrastructure. Included are both physical and virtual elements.;;na; -Analytics;https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html#analytics;Component;The gathered data from multiple streams and sources is fed to analytic applications. Those applications can be real-time – for example, analytics, anomaly detection, capacity monitoring, congestion monitoring, or alarm correlation – or non-real time, such as applications that perform analytics on previously collected data or forward synthesized, aggregated or transformed data to big data stores and other applications.;;na; -Infrastructure Adaption (Multi-VIM / Cloud);https://docs.onap.org/projects/onap-multicloud-framework/en/latest/index.html;Component;MultiCloud provides mediation capabilities to connect to different infrastructure providers (VM based, Container based). It has capabilities to discover and register infrastructure resource information. Also it relays FCAPS data from infrastructure to DCAE.;"Map update? Rename to ""Infrastructure Adaption (MultiCloud)"" (like the project name)?";maintained; -Controller Design Studio (CDS);https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html;Component;The run-time part of the Controller Design Studio (CDS) enables operators and ISPs to implement/operate hybrid network (CNF, PNF, VNF, Whitebox, etc.). The components are able to process and execute the design-time model intent defined by the users to support the lifecycle management. Included are a Self Service API, a TOSCA Workflow Engine, a Resource & Template API, a Southbound Adapter, a Python Executor and a Kotlin Executor.;;maintained; -SDN Controller (SDNC);https://docs.onap.org/projects/onap-sdnc-oam/en/latest/index.html;Component;The ONAP Controller Family (SDNC/APPC) configures and maintains the health of Layer 1-7 network functions (VNF, PNF, CNFs) and network services throughout their lifecycle. Both provide similar services (application level configuration using NetConf, Chef, Ansible, RestConf, etc.) and life cycle management functions (e.g. stop, resume, health check). SDNC is being used mainly for Layer 1-3 network elements.;;maintained; -Application Controller (APPC);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#appc-application-controller;ComponentIndex;The ONAP Controller Family (SDNC/APPC) configures and maintains the health of Layer 1-7 network functions (VNF, PNF, CNFs) and network services throughout their lifecycle. Both provide similar services (application level configuration using NetConf, Chef, Ansible, RestConf) and life cycle management functions (e.g. stop, resume, health check, etc.). APPC is being used mainly for Layer 4-7 network functions.;;unmaintained; -Virtual Function Controller (VFC);https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/latest/index.html;Component;The Virtual Function Controller (VFC) leverages the ETSI NFV MANO Architecture and information model as a reference and implements the full life cycle management and FCAPS of VNF and NS.;;maintained; -Shared Services;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#shared-services;Architecture;ONAP provides a set of operational services for all ONAP components including activity logging, reporting, common data layer, configuration, persistence, access control, secret and credential management, resiliency, and software lifecycle management.;;na; -Appl. Authoriz. Framework (AAF);https://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html;Component;The Application Authorization Framework (AAF) provides the services for authentication, authorization and certificate management to the ONAP components. It provides the services to the ONAP components to manage the lifecycle of authentication and authorization elements such as permissions, roles and credentials.;;unmaintained;Original Name: AuthN/AuthZ (AAF) -Optimization Framework (OOF);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#oof-optimization-framework;ComponentIndex;The ONAP Optimization Framework (OOF) addresses the optimization needs of ONAP. OOF is a framework that supports creating and running a suite of optimizing applications including Homing/Placement, PCI optimizer, Route optimizer, Slice selection, Change Management Scheduling Optimizer.;;maintained; -Logging;https://docs.onap.org/projects/onap-logging-analytics/en/latest/index.html;Component;Logging provides the capability to capture information required to operate, troubleshoot and report on the performance of the ONAP platform.;;unmaintained; -Multi-Site State (MUSIC);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#music-onap-multi-site-integration;ComponentIndex;Multi-Site State (MUSIC) provides a multi-site state coordination/management service (MUSIC) with a rich suite of recipes that each ONAP component can simply configure and use for their state-management needs.;;unmaintained; -Config. Persistence Service (CPS);https://docs.onap.org/projects/onap-cps/en/latest/index.html;Component;The Configuration Persistence Service (CPS) provides storage for real-time run-time configuration and operational parameters that need to be used by ONAP.;;maintained; -Manage ONAP;https://docs.onap.org/en/latest/guides/onap-operator/index.html#operations-and-administration-guides;GuideOperator;Management capabilities for the Open Network Automation Platform itself.;;na; -ONAP Operations Manager (OOM);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#oom-onap-operations-manager;ComponentIndex;The ONAP Operations Manager (OOM) is responsible for lifecycle management of the ONAP platform itself. OOM provides the ability to manage cloud-native installations and deployments of ONAP to Kubernetes-managed cloud environments.;;maintained; -Utilities;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#id1;Architecture;ONAP utilities provide support of the ONAP components.;;na; -ONAP Shared Utilities;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#id1;Architecture;ONAP shared utilities provide support of the ONAP components.;;na; -Common Controller SDK (CCSDK);https://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/index.html;Component;The Common Controller Software Development Kit (CCSDK) provides a common set of reusable code that can be used across multiple controllers. For example, the SDN-C , APP-C, DCAE, ONAP Operations Manager and ONAP controller can reuse common pieces from this framework.;;maintained; -Model Utilities;https://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/;Component;[TO BE REVISED] The unified model-driven approach uses models as sources of data for generating processes/codes and following workflows (not code development as source). This way, the system can be more flexible and future proof, easy to update and use for cross-platform solutions since the “only” thing needed is a model update and manipulation through engine.;Better description required;maintained; -TOSCA Parser;https://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/;Component;[TO BE REVISED] etsicatalog provides package management service and parser service by Micro Service. It can be used to store packages distributed by the SDC, and can be consumed by other projects or components such as UUI, VFC, etc. It also includes a TOSCA parser service.;Better description required;na; -;;;;;; -Managed Environment;;;;;; -External Systems;;;;;; -3rd Party Controllers;;;;;; -sVNFM;;;;;; -EMS;;;;;; -Network Function Layer;;;;;; -VNF;;;;"""CNF"" missing?";; -PNF;;;;;; -Hypervisor / OS Layer;;;;;; -OpenStack;;;;;; -Commercial VIM;;;;;; -Kubernetes;;;;;; -Public Cloud;;;;;; -Private Edge Cloud;;;;;; -Private DC Cloud;;;;;; -Public Cloud;;;;;; -MPLS;;;;;; -IP;;;;;; -;;;;;; -LEGEND;;;;;; -Design;;;;;; -Orchestration & Management;;;;;; -Operations;;;;;; -Entirety of ONAP Components;;;;;; -Unmaintained ONAP Component;;;;;; -;;;;;; -OBSOLETE;;;;;; -Audit (POMBA);https://docs.onap.org/projects/onap-logging-analytics/en/latest/Logging_Enhancements_Project/logging_enhancements_project.html;Component;Post Orchestration Model Based Audit (POMBA) provides a event-driven audit of the operational data integrity across the NFV orchestration environment and NFV infrastructure using model driven approach. It reports discrepancies and anomalies between model and instance artifacts.;;unmaintained; -External System Register (ESR);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#aai-active-and-available-inventory;ComponentIndex;The External System Register (ESR) provides capabilities to manage external systems (e.g. register, test, update status in AAI).;"Check if ""unmaintained"" is correct";unmaintained; diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt b/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt deleted file mode 100644 index a6df71bde..000000000 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt +++ /dev/null @@ -1,70 +0,0 @@ -ONAP ARCHITECTURE OVERVIEW NOTES - -Version 1.1, 2021-11-10 - -This file contains information about how the map and its interactive functions were realized and how it can be maintained. - -The map was designed in Inkscape 1.1 running on Ubuntu 20.04. - -The following fonts, styles and spacings are used: -sans-serif, bold, 18 pt -sans-serif, bold, 9 pt -sans-serif, normal, 18 pt -sans-serif, normal, 9 pt -spacing between baselines: 1,05 lines -spacing between letters: -0,35 px -spacing between words: -1,00 px - -Drawing: Rectangles have a stroke (width 2 or 4 mm). To avoid that the stroke rezizes in case you rezize the single rectangle, have a look at the Inkscape button "When scaling objects, scale the stroke width by the same proportion" and turn it off! But turn it on, if you like to scale the complete (grouped) map because you need it in a smaler size. - -Rezising: If you need to resize a grouped object (with a label) do not resize the full group because then also the label will resized and distorted. Select only the form you want to resize in the "Objects" window. Then rezize it according your needs. You do not have to ungroup label/form for this action! - -Text Alignment: Do not align text in a rectangle manually! Create a rectangle which has a stroke (2 mm, 4 mm) in the same color as the box, create text, format text, select both, box and text and choose menu "Text - Flow into Frame". Thats it! The stroke acts as a border. - -Open the "Objects" window (Objects - Objects) and use it as your central point to select objects. Try to avoid ungrouping objects. - -Open the "Objects Properties" window (Objects - Objects Properties) to see and change properties of the object. - -Naming conventions: -onap-architecture-overview-interactive.svg (editable version) -onap-architecture-overview-interactive-path.svg (all text converted to pathes; to be used in rst documentation files) - -Text to Path: To avoid display problems caused of missing fonts you should release the map only when all characters are rendered as pathes. To do so, open the "master file" of this map and save it with a new name (please note the naming conventions). Then select all elemets (STRG-A) and choose "Path - Objects to Path" and save it again using the new name. All character are now converted to pathes - and are not editable via the text edit tool anymore! But the map is expected to be rendered on every target system in the same way. Path conversion can not be undone - so store the "master file" carefully. Unfortunately the label-text in the map can not be searched anymore. - -Group the rectangle and the label first, then add the link. Otherwise the link is used only for the rectangle or the label and mouseover will not work properly. - -If you have added a link to a group, ungrouping deletes the link without a warning! Do not ungroup unless you are aware of what you will loose! - -Grouping / Link: To add a link to an object, first check that label and form are grouped before you add a link. Select the grouped object and use "Create Link" of the Context Menu. Now a new element/group is created. Rename it to something meaningful in the "Objects" window. Then use the "Objects attributes" window to add the link for this new element in the field "Href". -See also: -https://inkscape.org/doc/tutorials/tips/tutorial-tips.html -https://www.petercollingridge.co.uk/tutorials/svg/interactive/ - -Mouseover Text: Add mouseover-text to the field "Title:" in the "Objects attributes" window. - -Keep the structure of map elements clear and maintainable by using groups and proper labels for all of the objects. The name of an element or group must be changed manually in the "Objects" window. -Example elements and structure: -+---designtime group that groups all designtime elements (visible and non-visible) of the map (not visible, manually created for reasons of clarity) - +--- ... other elements - +---designtime.link group were values for interactivity (e.g. link, text, opacy effects) are assigned to (created by inkscape when you choose "Create Link") - +---designtime group for the label and rectangle (not visible, manually created, required to have interactivity for both elements - rectangle and label) - +---designtime.label label on top of the rectangle (visible, manually created) - +---designtime.form rectangle for the architecture element (visible, manually created) - -Interactive Links and Tooltip Text in "Object Attributes": -Href: -https://docs.onap.org/ -Title: -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. - -Mouse-Over Effect in "Object Properties" at "Interactivity": -onmouseover: -style.opacity = 0.6; -onmouseout: -style.opacity = 1.0; - -NOT USED - Links in "Object Properties / Interactivity": -onlick: -window.open("https://docs.onap.org/","_blank"); - -If possible, please use predefined colors from onap-architechture-colors.svg. diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst deleted file mode 100644 index 8871f211a..000000000 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ /dev/null @@ -1,902 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution -.. 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. -.. Copyright 2019 ONAP Contributors -.. Copyright 2020 ONAP Contributors -.. Copyright 2021 ONAP Contributors - -.. _ONAP-architecture: - -Introduction -============ -ONAP is a comprehensive platform for orchestration, management, and automation -of network and edge computing services for network operators, cloud providers, -and enterprises. Real-time, policy-driven orchestration and automation of -physical, virtual, and cloud native network functions enables rapid automation -of new services and complete lifecycle management critical for 5G and -next-generation networks. - -The ONAP project addresses the rising need for a common automation platform for -telecommunication, cable, and cloud service providers—and their solution -providers—to deliver differentiated network services on demand, profitably and -competitively, while leveraging existing investments. - -The challenge that ONAP meets is to help network operators 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 -on-premises customer equipment. Many are seeking to exploit SDN and NFV to -improve service velocity, simplify equipment interoperability and integration, -and to 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). These challenges are still very real now as -ONAP creates its eighth release. - -ONAP is addressing these challenges by developing global and massive scale -(multi-site and multi-VIM) automation capabilities for physical, virtual, and -cloud native network elements. It facilitates service agility by supporting -data models for rapid service and resource deployment and 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, VNFMs, SDN -Controllers, as well as legacy equipment (PNF). The Service Design & Creation -(SDC) project also offers seamless orchestration of CNFs. ONAP’s consolidated -xNF requirements publication enables commercial development of ONAP-compliant -xNFs. This approach allows network and cloud operators to optimize their -physical, virtual and cloud native infrastructure for cost and performance; -at the same time, ONAP’s use of standard models reduces integration and -deployment costs of heterogeneous equipment. All this is achieved while -minimizing management fragmentation. - -The ONAP platform allows end-user organizations and their network/cloud -providers to collaboratively instantiate network elements and services in a -rapid and dynamic way, together with supporting a closed control loop process -that supports real-time response to actionable events. In order to design, -engineer, plan, bill and assure these dynamic services, there are three major -requirements: - -- A robust design framework that allows the 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 -- An orchestration and control framework (Service Orchestrator and Controllers) - that is recipe/ policy-driven to provide an automated instantiation of the - service when needed and managing service demands in an elastic manner -- 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. - -To achieve this, ONAP decouples the details of specific services and supporting -technologies from the common information models, core orchestration platform, -and generic management engines (for discovery, provisioning, assurance etc.). - -Furthermore, it marries the speed and style of a DevOps/NetOps approach with -the formal models and processes operators require to introduce new services and -technologies. It leverages cloud-native technologies including Kubernetes to -manage and rapidly deploy the ONAP platform and related components. This is in -stark contrast to traditional OSS/Management software platform architectures, -which hardcoded services and technologies, and required lengthy software -development and integration cycles to incorporate changes. - -The ONAP Platform enables service/resource independent capabilities for design, -creation and lifecycle management, in accordance with the following -foundational principles: - -- 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 -- Scalability and distribution to support a large number of services and large - networks -- Metadata-driven and policy-driven architecture to ensure flexible and - automated ways in which capabilities are used and delivered -- The architecture shall enable sourcing best-in-class components -- Common capabilities are ‘developed’ once and ‘used’ many times -- Core capabilities shall support many diverse services and infrastructures - -Further, ONAP comes with a functional architecture with component definitions -and interfaces, which provides a force of industry alignment in addition to -the open source code. - -Architecture Overview -===================== - -The ONAP architecture consists of a design time and run time functions, as well -as functions for managing ONAP itself. - - Note: Use the interactive features of the below ONAP Architecture Overview. - Hover with your mouse over an element in the figure for a short description. - Click the element to get forwarded to a more detailed description. - -.. raw:: html - :file: media/onap-architecture-overview-interactive-path.svg - -**Figure 1: Interactive high-level view of the ONAP architecture with its -microservices-based platform components.** - -The figure below provides a simplified functional view of the architecture, -which highlights the role of a few key components: - -#. ONAP Design time environment provides onboarding services and resources - into ONAP and designing required services. -#. External API provides northbound interoperability for the ONAP Platform. -#. ONAP Runtime environment provides a model- and policy-driven orchestration - and control framework for an automated instantiation and configuration of - services and resources. Multi-VIM/Cloud provides cloud interoperability for - the ONAP workloads. Analytic framework that closely monitors the service - behavior handles closed control loop management for handling healing, - scaling and update dynamically. -#. OOM provides the ability to manage cloud-native installation and deployments - to Kubernetes-managed cloud environments. -#. ONAP Shared Services provides shared capabilities for ONAP modules. The ONAP - Optimization Framework (OOF) provides a declarative, policy-driven approach - for creating and running optimization applications like Homing/Placement, - and Change Management Scheduling Optimization. ONAP shared utilities provide - utilities for the support of the ONAP components. - -Information Model and framework utilities continue to evolve to harmonize -the topology, workflow, and policy models from a number of SDOs including -ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF, -and MEF. - -|image2| - -**Figure 2. Functional view of the ONAP architecture** - -Microservices Support -===================== -As a cloud-native application that consists of numerous services, ONAP requires -sophisticated initial deployment as well as post- deployment management. - -The ONAP deployment methodology needs to be flexible enough to suit the -different scenarios and purposes for various operator environments. Users may -also want to select a portion of the ONAP components to integrate into their -own systems. And the platform needs to be highly reliable, scalable, secure -and easy to manage. To achieve all these goals, ONAP is designed as a -microservices-based system, with all components released as Docker containers -following best practice building rules to optimize their image size. Numerous -optimizations such as shared databases and the use of standardized lightweight -container operating systems reduce the overall ONAP footprint. - -ONAP Operations Manager (OOM) ------------------------------ -The ONAP Operations Manager (OOM) is responsible for orchestrating the -end-to-end lifecycle management and monitoring of ONAP components. OOM uses -Kubernetes with IPv4 and IPv6 support to provide CPU efficiency and platform -deployment. In addition, OOM helps enhance ONAP platform maturity by providing -scalability and resiliency enhancements to the components it manages. - -OOM is the lifecycle manager of the ONAP platform and uses the Kubernetes -container management system and Consul to provide the following functionality: - -#. Deployment - with built-in component dependency management (including - multiple clusters, federated deployments across sites, and anti-affinity - rules) -#. Configuration - unified configuration across all ONAP components -#. Monitoring - real-time health monitoring feeding to a Consul GUI and - Kubernetes -#. Restart - failed ONAP components are restarted automatically -#. Clustering and Scaling - cluster ONAP services to enable seamless scaling -#. Upgrade - change out containers or configuration with little or no service - impact -#. Deletion - clean up individual containers or entire deployments - -OOM supports a wide variety of cloud infrastructures to suit your individual -requirements. - -Starting with the Istanbul-R9, as a PoC, OOM provides Service Mesh-based -mTLS (mutual TLS) between ONAP components to secure component communications, -by leveraging Istio. The goal is to substitute (unmaintained) AAF -functionalities. - -Microservices Bus (MSB) ------------------------ -Microservices Bus (MSB) provides fundamental microservices support including -service registration/ discovery, external API gateway, internal API gateway, -client software development kit (SDK), and Swagger SDK. When integrating with -OOM, MSB has a Kube2MSB registrar which can grasp services information from k8s -metafile and automatically register the services for ONAP components. - -In the spirit of leveraging the microservice capabilities, further steps -towards increased modularity have been taken. Service Orchestrator (SO) and the -controllers have increased its level of modularity. - -Portal -====== - -.. warning:: The ONAP :strong:`portal` project is :strong:`unmaintained`. - -ONAP delivers a single, consistent user experience to both design time and -runtime environments, based on the user’s role. Role changes are configured -within a single ONAP instance. - -This user experience is managed by the ONAP Portal, which provides access to -design, analytics and operational control/administration functions via a -shared, role-based menu or dashboard. The portal architecture provides -web-based capabilities such as application onboarding and management, -centralized access management through the Authentication and Authorization -Framework (AAF), and dashboards, as well as hosted application widgets. - -The portal provides an SDK to enable multiple development teams to adhere to -consistent UI development requirements by taking advantage of built-in -capabilities (Services/ API/ UI controls), tools and technologies. ONAP also -provides a Command Line Interface (CLI) for operators who require it (e.g., to -integrate with their scripting environment). ONAP SDKs enable operations/ -security, third parties (e.g., vendors and consultants), and other experts to -continually define/redefine new collection, analytics, and policies (including -recipes for corrective/remedial action) using the ONAP Design Framework Portal. - -Design Time Framework -===================== -The design time framework is a comprehensive development environment with -tools, techniques, and repositories for defining/ describing resources, -services, and products. - -The design time framework facilitates reuse of models, further improving -efficiency as more and more models become available. Resources, services, -products, and their management and control functions can all be modeled using a -common set of specifications and policies (e.g., rule sets) for controlling -behavior and process execution. Process specifications automatically sequence -instantiation, delivery and lifecycle management for resources, services, -products and the ONAP platform components themselves. Certain process -specifications (i.e., ‘recipes’) and policies are geographically distributed to -optimize performance and maximize autonomous behavior in federated cloud -environments. - -Service Design and Creation (SDC) ---------------------------------- -Service Design and Creation (SDC) provides tools, techniques, and repositories -to define/simulate/certify system assets as well as their associated processes -and policies. Each asset is categorized into one of four asset groups: Resource -, Services, Products, or Offers. SDC supports the onboarding of Network -Services packages (ETSI SOL007 with ETSI SOL001), CNF packages (Helm), -VNF packages (Heat or ETSI SOL004) and PNF packages (ETSI SOL004). SDC also -includes some capabilities to model 5G network slicing using the standard -properties (Slice Profile, Service Template). - -The SDC environment supports diverse users via common services and utilities. -Using the design studio, product and service designers onboard/extend/retire -resources, services and products. Operations, Engineers, Customer Experience -Managers, and Security Experts create workflows, policies and methods to -implement Closed Control Loop Automation/Control and manage elastic -scalability. - -To support and encourage a healthy VNF ecosystem, ONAP provides a set of VNF -packaging and validation tools in the VNF Supplier API and Software Development -Kit (VNF SDK) and VNF Validation Program (VVP) components. Vendors can -integrate these tools in their CI/CD environments to package VNFs and upload -them to the validation engine. Once tested, the VNFs can be onboarded through -SDC. In addition, the testing capability of VNFSDK is being utilized at the LFN -Compliance Verification Program to work towards ensuring a highly consistent -approach to VNF verification. ONAP supports onboarding of CNFs and PNFs as -well. - -The Policy Creation component deals with policies; these are rules, conditions, -requirements, constraints, attributes, or needs that must be provided, -maintained, and/or enforced. At a lower level, Policy involves machine-readable -rules enabling actions to be taken based on triggers or requests. Policies -often consider specific conditions in effect (both in terms of triggering -specific policies when conditions are met, and in selecting specific outcomes -of the evaluated policies appropriate to the conditions). - -Policy allows rapid modification through easily updating rules, thus updating -technical behaviors of components in which those policies are used, without -requiring rewrites of their software code. Policy permits simpler -management / control of complex mechanisms via abstraction. - -VNF SDK -------- -VND SDK provides the functionality to create VNF/PNF packages, test VNF -packages and VNF ONAP compliance and store VNF/PNF packages and upload to/from -a marketplace. - -VVP ---- -VVP provides validation for the VNF Heat package. - -Runtime Framework -================= -The runtime execution framework executes the rules and policies and other -models distributed by the design and creation environment. - -This allows for the distribution of models and policy among various ONAP -modules such as the Service Orchestrator (SO), Controllers, Data Collection, -Analytics and Events (DCAE), Active and Available Inventory (A&AI). These -components use common services that support access control. - -Orchestration -------------- -The Service Orchestrator (SO) component executes the specified processes by -automating sequences of activities, tasks, rules and policies needed for -on-demand creation, modification or removal of network, application or -infrastructure services and resources, this includes VNFs, CNFs and PNFs, -by conforming to industry standards such as ETSI, TMF. -The SO provides orchestration at a very high level, with an end-to-end view -of the infrastructure, network, and applications. Examples of this include -BroadBand Service (BBS) and Cross Domain and Cross Layer VPN (CCVPN). -The SO is modular and hierarchical to handle services and multi-level -resources and Network Slicing, by leveraging pluggable adapters and delegating -orchestration operations to NFVO (SO NFVO, VFC), VNFM, CNF Manager, NSMF -(Network Slice Management Function), NSSMF (Network Slice Subnet Management -Function). -Starting from the Guilin release, the SO provides CNF orchestration support -through integration of CNF adapter in ONAP SO: - -- Support for provisioning CNFs using an external K8S Manager -- Support the Helm-based orchestration -- Leverage the CNF Adapter to interact with the K8S Plugin in MultiCloud -- Bring in the advantage of the K8S orchestrator and -- Set stage for the Cloud Native scenarios - -3GPP (TS 28.801) defines three layer slice management function which include: - -- CSMF (Communication Service Management Function) -- NSMF (Network Slice Management Function) -- NSSMF (Network Slice Subnet Management Function) - -To realize the three layers, CSMF, NSMF and/or NSSMF are realized within ONAP, -or use the external CSMF, NSMF or NSSMF. For ONAP-based network slice -management, different choices can be made as follows. among them, ONAP -orchestration currently supports options #1 and #4. - -|image3| - -**Figure 3: ONAP Network Slicing Support Options** - - -Virtual Infrastructure Deployment (VID) ---------------------------------------- - -.. warning:: The ONAP :strong:`vid` project is :strong:`unmaintained`. - -The Virtual Infrastructure Deployment (VID) application enables users to -instantiate infrastructure services from SDC, along with their associated -components, and to execute change management operations such as scaling and -software upgrades to existing VNF instances. - -Policy-Driven Workload Optimization ------------------------------------ -The ONAP Optimization Framework (OOF) provides a policy-driven and model-driven -framework for creating optimization applications for a broad range of use -cases. OOF Homing and Allocation Service (HAS) is a policy driven workload -optimization service that enables optimized placement of services across -multiple sites and multiple clouds, based on a wide variety of policy -constraints including capacity, location, platform capabilities, and other -service specific constraints. - -ONAP Multi-VIM/Cloud (MC) and several other ONAP components such as Policy, SO, -A&AI etc. play an important role in enabling “Policy-driven Performance/ -Security-Aware Adaptive Workload Placement/ Scheduling†across cloud sites -through OOF-HAS. OOF-HAS uses cloud agnostic Intent capabilities, and real-time -capacity checks provided by ONAP MC to determine the optimal VIM/Cloud -instances, which can deliver the required performance SLAs, for workload -(VNF etc.) placement and scheduling (Homing). Operators now realize the true -value of virtualization through fine grained optimization of cloud resources -while delivering performance and security SLAs. - -Controllers ------------ -Controllers are applications which are coupled with cloud and network services -and execute the configuration, real-time policies, and control the state of -distributed components and services. Rather than using a single monolithic -control layer, operators may choose to use multiple distinct controller types -that manage resources in the execution environment corresponding to their -assigned controlled domain such as cloud computing resources (SDN-C). -The Virtual Function Controller (VF-C) and SO NFVO provide an ETSI NFV -compliant NFV-O function that is responsible for lifecycle management of -virtual services and the associated physical COTS server infrastructure. VF-C -provides a generic VNFM capability, and both VF-C and SO NFVO integrate with -external VNFMs and VIMs as part of an NFV MANO stack. - -.. warning:: The ONAP :strong:`appc` project is :strong:`unmaintained`. - -ONAP has two application level configuration and lifecycle management modules -called SDN-C and App-C. Both provide similar services (application level -configuration using NetConf, Chef, Ansible, RestConf, etc.) and lifecycle -management functions (e.g., stop, resume, health check, etc.). -They share common code from CCSDK repo. However, there are some differences -between these two modules (SDN-C uses CDS only for onboarding and -configuration / LCM flow design, whereas App-C uses CDT for the LCM functions -for self service to provide artifacts storing in App-C Database). -SDN-C has been used mainly for Layer1-3 network elements and App-C is -being used for Layer4-7 network functions. This is a very loose -distinction and we expect that over time we will get better alignment and -have common repository for controller code supporting application level -configuration and lifecycle management of all network elements (physical or -virtual, layer 1-7). Because of these overlaps, we have documented SDN-C and -App-C together. ONAP Controller Family (SDN-C / App-C) configures and maintains -the health of L1-7 Network Function (VNF, PNF, CNF) and network services -throughout their lifecycle: - -- Configures Network Functions (VNF/PNF) -- Provides programmable network application management platform: - - - Behavior patterns programmed via models and policies - - Standards based models & protocols for multi-vendor implementation - - Extensible SB adapters such as Netconf, Ansible, Rest API, etc. - - Operation control, version management, software updates, etc. -- Local source of truth - - Manages inventory within its scope - - Manages and stores state of NFs - - Supports Configuration Audits - -Controller Design Studio (CDS) ------------------------------- -The Controller Design Studio (CDS) community in ONAP has contributed a -framework to automate the resolution of resources for instantiation and any -config provisioning operation, such as day0, day1 or day2 configuration. The -essential function of CDS is to create and populate a controller blueprint, -create a configuration file from this Controller blueprint, and associate at -design time this configuration file (configlet) to a PNF/VNF/CNF during the -design phase. CDS removes dependence on code releases and the delays they cause -and puts the control of services into the hands of the service providers. Users -can change a model and its parameters with great flexibility to fetch data from -external systems (e.g., IPAM) that is required in real deployments. This makes -service providers more responsive to their customers and able to deliver -products that more closely match the needs of those customers. - -Inventory ---------- -Active and Available Inventory (A&AI) provides real-time views of a system’s -resources, services, products and their relationships with each other, and also -retains a historical view. The views provided by A&AI relate data managed by -multiple ONAP instances, Business Support Systems (BSS), Operation Support -Systems (OSS), and network applications to form a “top to bottom†view ranging -from the products end users buy, to the resources that form the raw material -for creating the products. A&AI not only forms a registry of products, -services, and resources, it also maintains up-to-date views of the -relationships between these inventory items. - -To deliver the promised dynamism of SDN/NFV, A&AI is updated in real time by -the controllers as they make changes in the network environment. A&AI is -metadata-driven, allowing new inventory types to be added dynamically and -quickly via SDC catalog definitions, eliminating the need for lengthy -development cycles. - -Policy Framework ----------------- -The Policy framework provides policy based decision making capability and -supports multiple policy engines and can distribute policies through policy -design capabilities in SDC, simplifying the design process. - -Multi Cloud Adaptation ----------------------- -Multi-VIM/Cloud provides and infrastructure adaptation layer for VIMs/Clouds -and K8s clusters in exposing advanced cloud agnostic intent capabilities, -besides standard capabilities, which are used by OOF and other components -for enhanced cloud selection and SO/VF-C for cloud agnostic workload -deployment. The K8s plugin is in charge of deploying CNFs on the Kubernetes -clusters using Kubernetes APIs. - -Data Collection Analytics and Events (DCAE) -------------------------------------------- -DCAE provides the capability to collect events, and host analytics applications -(DCAE Services) - -Closed Control Loop Automation Management Platform (CLAMP) ----------------------------------------------------------- -Closed loop control is provided by cooperation among a number of design-time -and run-time elements. The Runtime loop starts with data collectors from Data -Collection, Analytics and Events (DCAE). ONAP includes the following collectors -: VES (VNF Event Streaming) for events, HV-VES for high-volume events, SNMP -for SNMP traps, File Collector to receive files, and RESTCONF Collector to -collect the notifications. After data collection/verification phase, data move -through the loop of micro-services like Homes for event detection, Policy -for determining actions, and finally, controllers and orchestrators to -implement actions. The Policy framework is also used to monitor the loops -themselves and manage their lifecycle. DCAE also includes a number of -specialized micro-services to support some use-cases such as the Slice Analysis -or SON-Handler. Some dedicated event processor modules transform collected data -(SNMP, 3GPP XML, RESTCONF) to VES format and push the various data into data -lake. CLAMP, Policy and DCAE all have design time aspects to support the -creation of the loops. - -We refer to this automation pattern as “Closed Control loop automation†in that -it provides the necessary automation to proactively respond to network and -service conditions without human intervention. A high-level schematic of the -“closed control loop automation†and the various phases within the service -lifecycle using the automation is depicted in Figure 3. - -Closed control loop control is provided by Data Collection, Analytics and -Events (DCAE) and one or more of the other ONAP runtime components. -Collectively, they provide FCAPS (Fault Configuration Accounting Performance -Security) functionality. DCAE collects performance, usage, and configuration -data; provides computation of analytics; aids in troubleshooting; and publishes -events, data and analytics (e.g., to policy, orchestration, and the data lake). -Another component, Holmes, connects to DCAE and provides alarm correlation -for ONAP, new data collection capabilities with High Volume VES, and bulk -performance management support. - -Working with the Policy Framework (and embedded CLAMP), these components -detect problems in the network and identify the appropriate remediation. -In some cases, the action will be automatic, and they will notify the -Service Orchestrator or one of the controllers to take action. -In other cases, as configured by the operator, they will raise an alarm -but require human intervention before executing the change. The policy -framework is extended to support additional policy decision capabilities -with the introduction of adaptive policy execution. - -Starting with the Honolulu-R8 and concluding in the Istanbul-R9 release, the -CLAMP component was successfully integrated into the Policy component initially -as a PoC in the Honolulu-R8 release and then as a fully integrated component -within the Policy component in Istanbul-R9 release. -CLAMP's functional role to provision Policy has been enhanced to support -provisioning of policies outside of the context of a Control Loop and therefore -act as a Policy UI. In the Istanbul release the CLAMP integration was -officially released. - -|image4| - -**Figure 4: ONAP Closed Control Loop Automation** - -Virtual Function Controller (VFC) ---------------------------------- -VFC provides the NFVO capability to manage the lifecycle of network service and -VNFs, by conforming to ETSI NFV specification. - -Data Movement as a Platform (DMaaP) ------------------------------------ -DMaaP provides data movement service such as message routing and data routing. - -Use Case UI (UUI) ------------------ -UUI provides the capability to instantiate the blueprint User Cases and -visualize the state. - -CLI ---- -ONAP CLI provides a command line interface for access to ONAP. - -External APIs -------------- - -.. warning:: The ONAP :strong:`externalapi` project is :strong:`unmaintained`. - -External APIs provide services to expose the capability of ONAP. - -Shared Services -=============== - -.. warning:: The ONAP :strong:`logging` project is :strong:`unmaintained`. - -ONAP provides a set of operational services for all ONAP components including -activity logging, reporting, common data layer, configuration, persistence, -access control, secret and credential management, resiliency, and software -lifecycle management. - -These services provide access management and security enforcement, data backup, -configuration persistence, restoration and recovery. They support standardized -VNF interfaces and guidelines. - -Operating in a virtualized environment introduces new security challenges and -opportunities. ONAP provides increased security by embedding access controls in -each ONAP platform component, augmented by analytics and policy components -specifically designed for the detection and mitigation of security violations. - -Configuration Persistence Service (CPS) ---------------------------------------- -The Configuration Persistence Service (CPS) provides storage for real-time -run-time configuration and operational parameters that need to be used by ONAP. -Several services ranging from SDN-C, DCAE and the network slicing use case -utilize CPS for these purposes. Its details in -:ref:`CPS - Configuration Persistence Service`. - -ONAP Modeling -============= -ONAP provides models to assist with service design, the development of ONAP -service components, and with the improvement of standards interoperability. -Models are an essential part for the design time and runtime framework -development. The ONAP modeling project leverages the experience of member -companies, standard organizations and other open source projects to produce -models which are simple, extensible, and reusable. The goal is to fulfill the -requirements of various use cases, guide the development and bring consistency -among ONAP components and explore a common model to improve the -interoperability of ONAP. - -ONAP supports various models detailed in the Modeling documentation. - -The modeling project includes the ETSI catalog component, which provides the -parser functionalities, as well as additional package management -functionalities. - -Industry Alignment -================== -ONAP support and collaboration with other standards and open source communities -is evident in the architecture. - -- MEF and TMF interfaces are used in the External APIs -- In addition to the ETSI-NFV defined VNFD and NSD models mentioned above, ONAP - supports the NFVO interfaces (SOL005 between the SO and VFC, SOL003 from - either the SO or VFC to an external VNFM). -- Further collaboration includes 5G/ORAN & 3GPP Harmonization, Acumos DCAE - Integration, and CNCF Telecom User Group (TUG). - -Read this whitepaper for more information: -`The Progress of ONAP: Harmonizing Open Source and Standards `_ - -ONAP Blueprints -=============== -ONAP can support an unlimited number of use cases, within reason. However, to -provide concrete examples of how to use ONAP to solve real-world problems, the -community has created a set of blueprints. In addition to helping users rapidly -adopt the ONAP platform through end-to-end solutions, these blueprints also -help the community prioritize their work. - -5G Blueprint ------------- -The 5G blueprint is a multi-release effort, with five key initiatives around -end-to-end service orchestration, network slicing, PNF/VNF lifecycle management -, PNF integration, and network optimization. The combination of eMBB that -promises peak data rates of 20 Mbps, uRLLC that guarantees sub-millisecond -response times, MMTC that can support 0.92 devices per sq. ft., and network -slicing brings with it some unique requirements. First ONAP needs to manage the -lifecycle of a network slice from initial creation/activation all the way to -deactivation/termination. Next, ONAP needs to optimize the network around real -time and bulk analytics, place VNFs on the correct edge cloud, scale and heal -services, and provide edge automation. ONAP also provides self organizing -network (SON) services such as physical cell ID allocation for new RAN sites. -These requirements have led to the five above-listed initiatives and have been -developed in close cooperation with other standards and open source -organizations such as 3GPP, TM Forum, ETSI, and O-RAN Software Community. - -|image5| - -**Figure 5. End-to-end 5G Service** - -Read the `5G Blueprint `_ -to learn more. - -A related activity outside of ONAP is called the 5G Super Blueprint where -multiple Linux Foundation projects are collaborating to demonstrate an -end-to-end 5G network. In the short-term, this blueprint will showcase -thre major projects: ONAP, Anuket (K8S NFVI), and Magma (LTE/5GC). - -|image6| - -**Figure 6. 5G Super Blueprint Initial Integration Activity** - -In the long-term, the 5G Super Blueprint will integrate O-RAN-SC and LF Edge -projects as well. - -Residential Connectivity Blueprints ------------------------------------ -Two ONAP blueprints (vCPE and BBS) address the residential connectivity use -case. - -Virtual CPE (vCPE) -.................. -Currently, services offered to a subscriber are restricted to what is designed -into the broadband residential gateway. In the blueprint, the customer has a -slimmed down physical CPE (pCPE) attached to a traditional broadband network -such as DSL, DOCSIS, or PON (Figure 5). A tunnel is established to a data -center hosting various VNFs providing a much larger set of services to the -subscriber at a significantly lower cost to the operator. In this blueprint, -ONAP supports complex orchestration and management of open source VNFs and both -virtual and underlay connectivity. - -|image7| - -**Figure 7. ONAP vCPE Architecture** - -Read the `Residential vCPE Use Case with ONAP blueprint `_ -to learn more. - -Broadband Service (BBS) -....................... -This blueprint provides multi-gigabit residential internet connectivity -services based on PON (Passive Optical Network) access technology. A key -element of this blueprint is to show automatic re-registration of an ONT -(Optical Network Terminal) once the subscriber moves (nomadic ONT) as well as -service subscription plan changes. This blueprint uses ONAP for the design, -deployment, lifecycle management, and service assurance of broadband services. -It further shows how ONAP can orchestrate services across different locations -(e.g. Central Office, Core) and technology domains (e.g. Access, Edge). - -|image8| - -**Figure 8. ONAP BBS Architecture** - -Read the `Residential Connectivity Blueprint `_ -to learn more. - -Voice over LTE (VoLTE) Blueprint --------------------------------- -This blueprint uses ONAP to orchestrate a Voice over LTE service. The VoLTE -blueprint incorporates commercial VNFs to create and manage the underlying -vEPC and vIMS services by interworking with vendor-specific components, -including VNFMs, EMSs, VIMs and SDN controllers, across Edge Data Centers and -a Core Data Center. ONAP supports the VoLTE use case with several key -components: SO, VF-C, SDN-C, and Multi-VIM/ Cloud. In this blueprint, SO is -responsible for VoLTE end-to-end service orchestration working in collaboration -with VF-C and SDN-C. SDN-C establishes network connectivity, then the VF-C -component completes the Network Services and VNF lifecycle management -(including service initiation, termination and manual scaling) and FCAPS -(fault, configuration, accounting, performance, security) management. This -blueprint also shows advanced functionality such as scaling and change -management. - -|image9| - -**Figure 9. ONAP VoLTE Architecture Open Network Automation Platform** - -Read the `VoLTE Blueprint `_ -to learn more. - -Optical Transport Networking (OTN) ----------------------------------- -Two ONAP blueprints (CCVPN and MDONS) address the OTN use case. CCVPN addresses -Layers 2 and 3, while MDONS addresses Layers 0 and 1. - -CCVPN (Cross Domain and Cross Layer VPN) Blueprint -.................................................. -CSPs, such as CMCC and Vodafone, see a strong demand for high-bandwidth, flat, -high-speed OTN (Optical Transport Networks) across carrier networks. They also -want to provide a high-speed, flexible and intelligent service for high-value -customers, and an instant and flexible VPN service for SMB companies. - -|image10| - -**Figure 10. ONAP CCVPN Architecture** - -The CCVPN (Cross Domain and Cross Layer VPN) blueprint is a combination of SOTN -(Super high-speed Optical Transport Network) and ONAP, which takes advantage of -the orchestration ability of ONAP, to realize a unified management and -scheduling of resources and services. It achieves cross-domain orchestration -and ONAP peering across service providers. In this blueprint, SO is responsible -for CCVPN end-to-end service orchestration working in collaboration with VF-C -and SDN-C. SDN-C establishes network connectivity, then the VF-C component -completes the Network Services and VNF lifecycle management. ONAP peering -across CSPs uses an east-west API which is being aligned with the MEF Interlude -API. CCVPN, in conjunction with the IBN use case, offers intent based cloud -leased line service. The key innovations in this use case are physical network -discovery and modeling, cross-domain orchestration across multiple physical -networks, cross operator end-to-end service provisioning, close-loop reroute -for cross-domain service, dynamic changes (branch sites, VNFs) and intelligent -service optimization (including AI/ML). - -Read the `CCVPN Blueprint `_ -to learn more. - -MDONS (Multi-Domain Optical Network Service) Blueprint -...................................................... -While CCVPN addresses the automation of networking layers 2 and 3, it does not -address layers 0 and 1. Automating these layers is equally important because -providing an end-to-end service to their customers often requires a manual and -complex negotiation between CSPs that includes both the business arrangement -and the actual service design and activation. CSPs may also be structured such -that they operate multiple networks independently and require similar -transactions among their own networks and business units in order to provide an -end-to-end service. The MDONS blueprint created by AT&T, Orange, and Fujitsu -solves the above problem. MDONS and CCVPN used together can solve the OTN -automation problem in a comprehensive manner. - -|image11| - -**Figure 11. ONAP MDONS Architecture** - -Intent Based Network (IBN) Use Case ------------------------------------ -Intent technology can reduce the complexity of management without getting into -the intricate details of the underlying network infrastructure and contribute -to efficient network management. This use case performs a valuable business -function that can further reduce the operating expenses (OPEX) of network -management by shifting the paradigm from complex procedural operations to -declarative intent-driven operations - -|image12| - -**Figure 12. ONAP Intent-Based Networking Use Case** - -3GPP 28.812, Intent driven Management Service (Intent driven MnS), defines -some key concepts that are used by this initiative. The Intent Based Networking -(IBN) use case includes the development of an intent decision making. This use -case has initially been shown for a smart warehouse, where the intent is to -increase the output volume of automated guided vehicles (AVG) and the network -simply scales in response. The intent UI is implemented in UUI and the -components of the intent framework interact with many components of ONAP -including SO, A&AI, Policy, DCAE and CDS. - -vFW/vDNS Blueprint ------------------- -The virtual firewall, virtual DNS blueprint is a basic demo to verify that ONAP -has been correctly installed and to get a basic introduction to ONAP. The -blueprint consists of 5 VNFs: vFW, vPacketGenerator, vDataSink, vDNS and -vLoadBalancer. The blueprint exercises most aspects of ONAP, showing VNF -onboarding, network service creation, service deployment and closed-loop -automation. The key components involved are SDC, CLAMP, SO, APP-C, DCAE and -Policy. In the recent releases, the vFW blueprint has been demonstrated by -using a mix of a CNF and VNF and entirely using CNFs. - -Verified end to end tests -========================= -Use cases ---------- -Various use cases have been tested for the Release. Use case examples are -listed below. See detailed information on use cases, functional requirements, -and automated use cases can be found here: -:doc:`Verified Use Cases`. - -- E2E Network Slicing -- 5G OOF (ONAP Optimization Framework) SON (Self-Organized Network) -- CCVPN-Transport Slicing - -Functional requirements ------------------------ -Various functional requirements have been tested for the Release. Detailed -information can be found in the -:doc:`Verified Use Cases`. - -- xNF Integration - - - ONAP CNF orchestration - Enhancements - - PNF PreOnboarding - - PNF Plug & Play - -- Lifecycle Management - - - Policy Based Filtering - - Bulk PM / PM Data Control Extension - - Support xNF Software Upgrade in association to schema updates - - Configuration & Persistency Service - -- Security - - - CMPv2 Enhancements - -- Standard alignment - - - ETSI-Alignment for Guilin - - ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES - - Extend ORAN A1 Adapter and add A1 Policy Management - -- NFV testing Automatic Platform - - - Support for Test Result Auto Analysis & Certification - - Support for Test Task Auto Execution - - Support for Test Environment Auto Deploy - - Support for Test Topology Auto Design - -Conclusion -========== -The ONAP platform 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 lifecycle 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. - -Resources -========= -See the Resources page on `ONAP.org `_ - -.. |image1| image:: media/ONAP-architecture.png - :width: 800px -.. |image2| image:: media/ONAP-fncview.png - :width: 800px -.. |image3| image:: media/ONAP-NetworkSlicingOptions.png - :width: 800px -.. |image4| image:: media/ONAP-closedloop.png - :width: 800px -.. |image5| image:: media/ONAP-5G.png - :width: 800px -.. |image6| image:: media/ONAP-5GSuperBP-Integration.png - :width: 800px -.. |image7| image:: media/ONAP-vcpe.png - :width: 800px -.. |image8| image:: media/ONAP-bbs.png - :width: 800px -.. |image9| image:: media/ONAP-volte.png - :width: 800px -.. |image10| image:: media/ONAP-ccvpn.png - :width: 800px -.. |image11| image:: media/ONAP-mdons.png - :width: 800px -.. |image12| image:: media/ONAP-IntentBasedNetworking.png - :width: 800px diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst deleted file mode 100644 index a169c5797..000000000 --- a/docs/guides/onap-developer/architecture/references.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. This work is licensed under a -.. Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - - -.. note:: - Some high level groupings are introduced below with references to - project/repo/docs/architecture.rst or similar architecture references. - As more information is provided by each project in a docs/architecture.rst - file, it will appear here. Show source to see the references in each - grouping. - -References -========== - -User Interfaces ---------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -| :ref:`Policy/CLAMP - Closed Loop Automation Platform` -| :ref:`SDC - Service Design and Creation` -| :ref:`UUI- Usecase UI` - -Platform Components -------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -| :ref:`DCAE - Data Collection Analytics and Events` -| :ref:`Holmes` -| :ref:`Policy` -| :ref:`SDNC - SDN Controller OAM` -| :ref:`SO - Service Orchestrator` -| :ref:`VFC - Virtual Function Controller` - -Common Services ---------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -| :ref:`AAI - Active and Available Inventory` -| :ref:`CPS - Configuration Persistence Service` -| :ref:`DMAAP MR - Data Management as a Platform (Message Router)` -| :ref:`MSB - Microservices Bus` -| :ref:`Multi Cloud` -| :ref:`OOM - ONAP Operations Manager` -| :ref:`OPTF - Optimization Framework` diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst deleted file mode 100644 index ec8050f24..000000000 --- a/docs/guides/onap-developer/developing/index.rst +++ /dev/null @@ -1,262 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution -.. 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -.. index:: Developer Guides - -.. _doc_onap-developer_guide_projects: - -ONAP Components and Functionalities -=================================== -Here you will find the detailed documentation of maintained projects, -ONAP components and functionalities. - -AAI - Active and Available Inventory ------------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`aai/aai-common` - - AAI Architecture, APIs and Guides - * - :ref:`aai/sparky-be` - - Sparky - AAI Inventory UI - -CCSDK - Common Controller Software Development Kit --------------------------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`ccsdk/apps` - - Micro Services for CCSDK - * - :ref:`ccsdk/cds` - - Controller Design Studio Architecture and Guides - * - :ref:`ccsdk/distribution` - - TOSCA Orchestration Plugin, Directed Graph Support - * - :ref:`ccsdk/features` - - Software Defined Network Controller for Radio (SDNR) - * - :ref:`ccsdk/oran` - - O-RAN Support in ONAP - -CPS - Configuration Persistence Service ---------------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`cps` - - CPS Global - * - :ref:`cps/cps-temporal` - - CPS Temporal - * - :ref:`cps/ncmp/dmi-plugin` - - CPS DMI Plugin - -DCAE - Data Collection, Analysis and Events -------------------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`dcaegen2` - - DCAE (Gen2) Architecture and Guides - -DMAAP - Data Movement as a Platform ------------------------------------ - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`dmaap/buscontroller` - - Bus Controller - * - :ref:`dmaap/datarouter` - - Data Router - * - :ref:`dmaap/messagerouter/messageservice` - - Message Router - -HOLMES - Alarm Correlation and Analysis ----------------------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`holmes/rule-management` - - Architecture and APIs - * - :ref:`holmes/engine-management` - - Engine Management - -INT - Integration ------------------ - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`integration` - - Integration Project - -MOD - Modeling --------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`modeling/etsicatalog` - - ETSI Runtime Catalog - -MSB - Microservices Bus ------------------------ - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`msb/apigateway` - - Microservices Bus - * - :ref:`msb/discovery` - - - * - :ref:`msb/java-sdk` - - - * - :ref:`msb/swagger-sdk` - - Swagger Software Development Kit - -MULTICLOUD - MultiCloud Framework ---------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`multicloud/framework` - - MultiCloud Framework Architecture and Guides - * - :ref:`multicloud/k8s` - - Kubernetes Reference Deployment (KUD) - -OOM - ONAP Operations Manager ------------------------------ - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`oom` - - ONAP Operations Manager - * - :ref:`oom/offline-installer` - - OOM Offline Installer - -OOF - Optimization Framework ----------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`optf/has` - - Homing and Allocation - * - :ref:`optf/osdf` - - Optimization Service Design Framework - -POLICY - Policy Framework -------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`policy/parent` - - Policy Framework - -SDC - Service Design & Creation -------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`sdc` - - Service Design & Creation - -SDNC - Software Defined Network Controller ------------------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`sdnc/oam` - - SDNC Architecture, APIs and Guides - -SO - Service Orchestration --------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`so` - - Service Orchestration Architecture, APIs and Guides - -UUI - Usecase User Interface ------------------------------ - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`usecase-ui` - - Usecase-UI Architecture, APIs and Guides - -VFC - Virtual Function Controller ---------------------------------- - -.. list-table:: - :widths: auto - :header-rows: 1 - - * - Component - - Documentation - * - :ref:`vfc/nfvo/lcm` - - Virtual Function Controller Architecture, APIs and Guides - diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index bd7b2260e..60bdf283d 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -12,6 +12,9 @@ The following guides are provided to describe tasks that a user of ONAP may need to perform when integrating, deploying, testing and operating an instance of ONAP. +.. note:: The ONAP Portal component is no longer maintained. E2E guides + referencing the ONAP Portal had to be removed consequently. + E2E User Guides --------------- diff --git a/docs/guides/overview/index.rst b/docs/guides/overview/index.rst deleted file mode 100644 index 2b1c4bed8..000000000 --- a/docs/guides/overview/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. 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 -============= - -.. _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 deleted file mode 100644 index e90a061e6..000000000 Binary files a/docs/guides/overview/media/ONAP_architecture_high_level.des and /dev/null differ diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.png b/docs/guides/overview/media/ONAP_architecture_high_level.png deleted file mode 100644 index 8fa45e9b1..000000000 Binary files a/docs/guides/overview/media/ONAP_architecture_high_level.png and /dev/null differ diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.svg b/docs/guides/overview/media/ONAP_architecture_high_level.svg deleted file mode 100644 index d55f71c31..000000000 --- a/docs/guides/overview/media/ONAP_architecture_high_level.svg +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 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 deleted file mode 100644 index daa7b9626..000000000 Binary files a/docs/guides/overview/media/ONAP_main_functions.des and /dev/null differ diff --git a/docs/guides/overview/media/ONAP_main_functions.png b/docs/guides/overview/media/ONAP_main_functions.png deleted file mode 100644 index a3d5c6001..000000000 Binary files a/docs/guides/overview/media/ONAP_main_functions.png and /dev/null differ diff --git a/docs/guides/overview/media/ONAP_main_functions.svg b/docs/guides/overview/media/ONAP_main_functions.svg deleted file mode 100644 index 0afc78019..000000000 --- a/docs/guides/overview/media/ONAP_main_functions.svg +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 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 deleted file mode 100644 index c98934d59..000000000 --- a/docs/guides/overview/overview.rst +++ /dev/null @@ -1,208 +0,0 @@ -.. 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, analytic - 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. - - 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 | -+=================+=================+========================+ -| Jakarta | 10.0.0 | 2022, June 30th | -+-----------------+-----------------+------------------------+ -| Istanbul | 9.0.0 | 2021, November 15th | -+-----------------+-----------------+------------------------+ -| Honolulu | 8.0.0 | 2021, May 11th | -+-----------------+-----------------+------------------------+ -| Guilin | 7.0.0 | 2020, December 3rd | -+-----------------+-----------------+------------------------+ -| Frankfurt | 6.0.0 | 2020, June 11th | -+-----------------+-----------------+------------------------+ -| El Alto | 5.0.0 | 2019, October 24th | -+-----------------+-----------------+------------------------+ -| Dublin | 4.0.0 | 2019, July 9th | -+-----------------+-----------------+------------------------+ -| Casablanca | 3.0.0 | 2019, April 15th | -+-----------------+-----------------+------------------------+ -| Beijing | 2.0.0 | 2018, June 7th | -+-----------------+-----------------+------------------------+ -| Amsterdam | 1.0.0 | 2017, November 16th | -+-----------------+-----------------+------------------------+ - -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 e0bd37d89..93985b664 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,13 +21,15 @@ any product could on its own. Please find some guidance here on the content of ONAP documentation: +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | Main documentation areas | Description | + | Documentation areas | Description | +=================================================================================+===============================================================================================+ | :ref:`ONAP 'Jakarta' Release Notes ` | The Release Notes are providing general information about the ONAP release and recent changes,| | | feature enhancements, or bug fixes. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Project Specific Release Notes ` | The Project Specific Release Notes are providing information about recent changes, feature | - | | enhancements, or bug fixes on a component level. | + | :ref:`Component Release Notes ` | The Component Release Notes are providing project specific information about recent changes, | + | | features, enhancements, or bug fixes. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`ONAP Release History ` | The list contains the name and date of previous ONAP releases. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Overview ` | ONAP Overview provides generic and high-level guidance on the mission and main | | | functionalities of ONAP. Basic guidelines on license details, limitations and | @@ -53,7 +55,7 @@ Please find some guidance here on the content of ONAP documentation: | | ONAP Documentation Guide. Currently some content resides also in the Developer Guide. This is | | | subject to be reviewed, updated and migrated to the ONAP Documentation Guide. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Security ` | The current state of ONAP Security is described here. You can learn about discovered and fixed| + | :ref:`ONAP Security ` | The current state of ONAP Security is described here. You can learn about discovered and fixed| | | vulnerabilities. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ @@ -63,12 +65,39 @@ Please find some guidance here on the content of ONAP documentation: :hidden: Home + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: RELEASE + release/index - release/releaserepos - guides/overview/index - guides/onap-developer/architecture/index - guides/onap-developer/developing/index + release/component-release-notes + release/history + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: PLATFORM + + platform/overview/index + platform/architecture/index + platform/components/index + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: GUIDES + guides/onap-operator/index guides/onap-user/index guides/onap-developer/index guides/onap-documentation/index + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: SECURITY + + security/index + \ No newline at end of file diff --git a/docs/platform/architecture/index.rst b/docs/platform/architecture/index.rst new file mode 100644 index 000000000..11f7c09da --- /dev/null +++ b/docs/platform/architecture/index.rst @@ -0,0 +1,903 @@ +.. This work is licensed under a Creative Commons Attribution +.. 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017-2018 Huawei Technologies Co., Ltd. +.. Copyright 2019 ONAP Contributors +.. Copyright 2020 ONAP Contributors +.. Copyright 2021 ONAP Contributors + +.. _ONAP-architecture: + +ONAP Architecture +================= +ONAP is a comprehensive platform for orchestration, management, and automation +of network and edge computing services for network operators, cloud providers, +and enterprises. Real-time, policy-driven orchestration and automation of +physical, virtual, and cloud native network functions enables rapid automation +of new services and complete lifecycle management critical for 5G and +next-generation networks. + +The ONAP project addresses the rising need for a common automation platform for +telecommunication, cable, and cloud service providers—and their solution +providers—to deliver differentiated network services on demand, profitably and +competitively, while leveraging existing investments. + +The challenge that ONAP meets is to help network operators 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 +on-premises customer equipment. Many are seeking to exploit SDN and NFV to +improve service velocity, simplify equipment interoperability and integration, +and to 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). These challenges are still very real now as +ONAP creates its eighth release. + +ONAP is addressing these challenges by developing global and massive scale +(multi-site and multi-VIM) automation capabilities for physical, virtual, and +cloud native network elements. It facilitates service agility by supporting +data models for rapid service and resource deployment and 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, VNFMs, SDN +Controllers, as well as legacy equipment (PNF). The Service Design & Creation +(SDC) project also offers seamless orchestration of CNFs. ONAP’s consolidated +xNF requirements publication enables commercial development of ONAP-compliant +xNFs. This approach allows network and cloud operators to optimize their +physical, virtual and cloud native infrastructure for cost and performance; +at the same time, ONAP’s use of standard models reduces integration and +deployment costs of heterogeneous equipment. All this is achieved while +minimizing management fragmentation. + +The ONAP platform allows end-user organizations and their network/cloud +providers to collaboratively instantiate network elements and services in a +rapid and dynamic way, together with supporting a closed control loop process +that supports real-time response to actionable events. In order to design, +engineer, plan, bill and assure these dynamic services, there are three major +requirements: + +- A robust design framework that allows the 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 +- An orchestration and control framework (Service Orchestrator and Controllers) + that is recipe/ policy-driven to provide an automated instantiation of the + service when needed and managing service demands in an elastic manner +- 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. + +To achieve this, ONAP decouples the details of specific services and supporting +technologies from the common information models, core orchestration platform, +and generic management engines (for discovery, provisioning, assurance etc.). + +Furthermore, it marries the speed and style of a DevOps/NetOps approach with +the formal models and processes operators require to introduce new services and +technologies. It leverages cloud-native technologies including Kubernetes to +manage and rapidly deploy the ONAP platform and related components. This is in +stark contrast to traditional OSS/Management software platform architectures, +which hardcoded services and technologies, and required lengthy software +development and integration cycles to incorporate changes. + +The ONAP Platform enables service/resource independent capabilities for design, +creation and lifecycle management, in accordance with the following +foundational principles: + +- 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 +- Scalability and distribution to support a large number of services and large + networks +- Metadata-driven and policy-driven architecture to ensure flexible and + automated ways in which capabilities are used and delivered +- The architecture shall enable sourcing best-in-class components +- Common capabilities are ‘developed’ once and ‘used’ many times +- Core capabilities shall support many diverse services and infrastructures + +Further, ONAP comes with a functional architecture with component definitions +and interfaces, which provides a force of industry alignment in addition to +the open source code. + +Architecture Overview +--------------------- + +The ONAP architecture consists of a design time and run time functions, as well +as functions for managing ONAP itself. + + Note: Use the interactive features of the below ONAP Architecture Overview. + Click to enlarge it. Then hover with your mouse over an element in the + figure for a short description. Click the element to get forwarded to a more + detailed description. + +.. image:: media/onap-architecture-overview-interactive-path.svg + :width: 800 + +**Figure 1: Interactive high-level view of the ONAP architecture with its +microservices-based platform components. Click to enlarge and discover.** + +The figure below provides a simplified functional view of the architecture, +which highlights the role of a few key components: + +#. ONAP Design time environment provides onboarding services and resources + into ONAP and designing required services. +#. External API provides northbound interoperability for the ONAP Platform. +#. ONAP Runtime environment provides a model- and policy-driven orchestration + and control framework for an automated instantiation and configuration of + services and resources. Multi-VIM/Cloud provides cloud interoperability for + the ONAP workloads. Analytic framework that closely monitors the service + behavior handles closed control loop management for handling healing, + scaling and update dynamically. +#. OOM provides the ability to manage cloud-native installation and deployments + to Kubernetes-managed cloud environments. +#. ONAP Shared Services provides shared capabilities for ONAP modules. The ONAP + Optimization Framework (OOF) provides a declarative, policy-driven approach + for creating and running optimization applications like Homing/Placement, + and Change Management Scheduling Optimization. ONAP shared utilities provide + utilities for the support of the ONAP components. + +Information Model and framework utilities continue to evolve to harmonize +the topology, workflow, and policy models from a number of SDOs including +ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF, +and MEF. + +|image2| + +**Figure 2. Functional view of the ONAP architecture** + +Microservices Support +--------------------- +As a cloud-native application that consists of numerous services, ONAP requires +sophisticated initial deployment as well as post- deployment management. + +The ONAP deployment methodology needs to be flexible enough to suit the +different scenarios and purposes for various operator environments. Users may +also want to select a portion of the ONAP components to integrate into their +own systems. And the platform needs to be highly reliable, scalable, secure +and easy to manage. To achieve all these goals, ONAP is designed as a +microservices-based system, with all components released as Docker containers +following best practice building rules to optimize their image size. Numerous +optimizations such as shared databases and the use of standardized lightweight +container operating systems reduce the overall ONAP footprint. + +ONAP Operations Manager (OOM) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The ONAP Operations Manager (OOM) is responsible for orchestrating the +end-to-end lifecycle management and monitoring of ONAP components. OOM uses +Kubernetes with IPv4 and IPv6 support to provide CPU efficiency and platform +deployment. In addition, OOM helps enhance ONAP platform maturity by providing +scalability and resiliency enhancements to the components it manages. + +OOM is the lifecycle manager of the ONAP platform and uses the Kubernetes +container management system and Consul to provide the following functionality: + +#. Deployment - with built-in component dependency management (including + multiple clusters, federated deployments across sites, and anti-affinity + rules) +#. Configuration - unified configuration across all ONAP components +#. Monitoring - real-time health monitoring feeding to a Consul GUI and + Kubernetes +#. Restart - failed ONAP components are restarted automatically +#. Clustering and Scaling - cluster ONAP services to enable seamless scaling +#. Upgrade - change out containers or configuration with little or no service + impact +#. Deletion - clean up individual containers or entire deployments + +OOM supports a wide variety of cloud infrastructures to suit your individual +requirements. + +Starting with the Istanbul-R9, as a PoC, OOM provides Service Mesh-based +mTLS (mutual TLS) between ONAP components to secure component communications, +by leveraging Istio. The goal is to substitute (unmaintained) AAF +functionalities. + +Microservices Bus (MSB) +^^^^^^^^^^^^^^^^^^^^^^^ +Microservices Bus (MSB) provides fundamental microservices support including +service registration/ discovery, external API gateway, internal API gateway, +client software development kit (SDK), and Swagger SDK. When integrating with +OOM, MSB has a Kube2MSB registrar which can grasp services information from k8s +metafile and automatically register the services for ONAP components. + +In the spirit of leveraging the microservice capabilities, further steps +towards increased modularity have been taken. Service Orchestrator (SO) and the +controllers have increased its level of modularity. + +Portal +------ + +.. warning:: The ONAP :strong:`portal` project is :strong:`unmaintained`. + +ONAP delivers a single, consistent user experience to both design time and +runtime environments, based on the user’s role. Role changes are configured +within a single ONAP instance. + +This user experience is managed by the ONAP Portal, which provides access to +design, analytics and operational control/administration functions via a +shared, role-based menu or dashboard. The portal architecture provides +web-based capabilities such as application onboarding and management, +centralized access management through the Authentication and Authorization +Framework (AAF), and dashboards, as well as hosted application widgets. + +The portal provides an SDK to enable multiple development teams to adhere to +consistent UI development requirements by taking advantage of built-in +capabilities (Services/ API/ UI controls), tools and technologies. ONAP also +provides a Command Line Interface (CLI) for operators who require it (e.g., to +integrate with their scripting environment). ONAP SDKs enable operations/ +security, third parties (e.g., vendors and consultants), and other experts to +continually define/redefine new collection, analytics, and policies (including +recipes for corrective/remedial action) using the ONAP Design Framework Portal. + +Design Time Framework +--------------------- +The design time framework is a comprehensive development environment with +tools, techniques, and repositories for defining/ describing resources, +services, and products. + +The design time framework facilitates reuse of models, further improving +efficiency as more and more models become available. Resources, services, +products, and their management and control functions can all be modeled using a +common set of specifications and policies (e.g., rule sets) for controlling +behavior and process execution. Process specifications automatically sequence +instantiation, delivery and lifecycle management for resources, services, +products and the ONAP platform components themselves. Certain process +specifications (i.e., ‘recipes’) and policies are geographically distributed to +optimize performance and maximize autonomous behavior in federated cloud +environments. + +Service Design and Creation (SDC) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Service Design and Creation (SDC) provides tools, techniques, and repositories +to define/simulate/certify system assets as well as their associated processes +and policies. Each asset is categorized into one of four asset groups: Resource +, Services, Products, or Offers. SDC supports the onboarding of Network +Services packages (ETSI SOL007 with ETSI SOL001), CNF packages (Helm), +VNF packages (Heat or ETSI SOL004) and PNF packages (ETSI SOL004). SDC also +includes some capabilities to model 5G network slicing using the standard +properties (Slice Profile, Service Template). + +The SDC environment supports diverse users via common services and utilities. +Using the design studio, product and service designers onboard/extend/retire +resources, services and products. Operations, Engineers, Customer Experience +Managers, and Security Experts create workflows, policies and methods to +implement Closed Control Loop Automation/Control and manage elastic +scalability. + +To support and encourage a healthy VNF ecosystem, ONAP provides a set of VNF +packaging and validation tools in the VNF Supplier API and Software Development +Kit (VNF SDK) and VNF Validation Program (VVP) components. Vendors can +integrate these tools in their CI/CD environments to package VNFs and upload +them to the validation engine. Once tested, the VNFs can be onboarded through +SDC. In addition, the testing capability of VNFSDK is being utilized at the LFN +Compliance Verification Program to work towards ensuring a highly consistent +approach to VNF verification. ONAP supports onboarding of CNFs and PNFs as +well. + +The Policy Creation component deals with policies; these are rules, conditions, +requirements, constraints, attributes, or needs that must be provided, +maintained, and/or enforced. At a lower level, Policy involves machine-readable +rules enabling actions to be taken based on triggers or requests. Policies +often consider specific conditions in effect (both in terms of triggering +specific policies when conditions are met, and in selecting specific outcomes +of the evaluated policies appropriate to the conditions). + +Policy allows rapid modification through easily updating rules, thus updating +technical behaviors of components in which those policies are used, without +requiring rewrites of their software code. Policy permits simpler +management / control of complex mechanisms via abstraction. + +VNF SDK +^^^^^^^ +VND SDK provides the functionality to create VNF/PNF packages, test VNF +packages and VNF ONAP compliance and store VNF/PNF packages and upload to/from +a marketplace. + +VVP +^^^ +VVP provides validation for the VNF Heat package. + +Runtime Framework +----------------- +The runtime execution framework executes the rules and policies and other +models distributed by the design and creation environment. + +This allows for the distribution of models and policy among various ONAP +modules such as the Service Orchestrator (SO), Controllers, Data Collection, +Analytics and Events (DCAE), Active and Available Inventory (A&AI). These +components use common services that support access control. + +Orchestration +^^^^^^^^^^^^^ +The Service Orchestrator (SO) component executes the specified processes by +automating sequences of activities, tasks, rules and policies needed for +on-demand creation, modification or removal of network, application or +infrastructure services and resources, this includes VNFs, CNFs and PNFs, +by conforming to industry standards such as ETSI, TMF. +The SO provides orchestration at a very high level, with an end-to-end view +of the infrastructure, network, and applications. Examples of this include +BroadBand Service (BBS) and Cross Domain and Cross Layer VPN (CCVPN). +The SO is modular and hierarchical to handle services and multi-level +resources and Network Slicing, by leveraging pluggable adapters and delegating +orchestration operations to NFVO (SO NFVO, VFC), VNFM, CNF Manager, NSMF +(Network Slice Management Function), NSSMF (Network Slice Subnet Management +Function). +Starting from the Guilin release, the SO provides CNF orchestration support +through integration of CNF adapter in ONAP SO: + +- Support for provisioning CNFs using an external K8S Manager +- Support the Helm-based orchestration +- Leverage the CNF Adapter to interact with the K8S Plugin in MultiCloud +- Bring in the advantage of the K8S orchestrator and +- Set stage for the Cloud Native scenarios + +3GPP (TS 28.801) defines three layer slice management function which include: + +- CSMF (Communication Service Management Function) +- NSMF (Network Slice Management Function) +- NSSMF (Network Slice Subnet Management Function) + +To realize the three layers, CSMF, NSMF and/or NSSMF are realized within ONAP, +or use the external CSMF, NSMF or NSSMF. For ONAP-based network slice +management, different choices can be made as follows. among them, ONAP +orchestration currently supports options #1 and #4. + +|image3| + +**Figure 3: ONAP Network Slicing Support Options** + + +Virtual Infrastructure Deployment (VID) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. warning:: The ONAP :strong:`vid` project is :strong:`unmaintained`. + +The Virtual Infrastructure Deployment (VID) application enables users to +instantiate infrastructure services from SDC, along with their associated +components, and to execute change management operations such as scaling and +software upgrades to existing VNF instances. + +Policy-Driven Workload Optimization +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The ONAP Optimization Framework (OOF) provides a policy-driven and model-driven +framework for creating optimization applications for a broad range of use +cases. OOF Homing and Allocation Service (HAS) is a policy driven workload +optimization service that enables optimized placement of services across +multiple sites and multiple clouds, based on a wide variety of policy +constraints including capacity, location, platform capabilities, and other +service specific constraints. + +ONAP Multi-VIM/Cloud (MC) and several other ONAP components such as Policy, SO, +A&AI etc. play an important role in enabling “Policy-driven Performance/ +Security-Aware Adaptive Workload Placement/ Scheduling†across cloud sites +through OOF-HAS. OOF-HAS uses cloud agnostic Intent capabilities, and real-time +capacity checks provided by ONAP MC to determine the optimal VIM/Cloud +instances, which can deliver the required performance SLAs, for workload +(VNF etc.) placement and scheduling (Homing). Operators now realize the true +value of virtualization through fine grained optimization of cloud resources +while delivering performance and security SLAs. + +Controllers +^^^^^^^^^^^ +Controllers are applications which are coupled with cloud and network services +and execute the configuration, real-time policies, and control the state of +distributed components and services. Rather than using a single monolithic +control layer, operators may choose to use multiple distinct controller types +that manage resources in the execution environment corresponding to their +assigned controlled domain such as cloud computing resources (SDN-C). +The Virtual Function Controller (VF-C) and SO NFVO provide an ETSI NFV +compliant NFV-O function that is responsible for lifecycle management of +virtual services and the associated physical COTS server infrastructure. VF-C +provides a generic VNFM capability, and both VF-C and SO NFVO integrate with +external VNFMs and VIMs as part of an NFV MANO stack. + +.. warning:: The ONAP :strong:`appc` project is :strong:`unmaintained`. + +ONAP has two application level configuration and lifecycle management modules +called SDN-C and App-C. Both provide similar services (application level +configuration using NetConf, Chef, Ansible, RestConf, etc.) and lifecycle +management functions (e.g., stop, resume, health check, etc.). +They share common code from CCSDK repo. However, there are some differences +between these two modules (SDN-C uses CDS only for onboarding and +configuration / LCM flow design, whereas App-C uses CDT for the LCM functions +for self service to provide artifacts storing in App-C Database). +SDN-C has been used mainly for Layer1-3 network elements and App-C is +being used for Layer4-7 network functions. This is a very loose +distinction and we expect that over time we will get better alignment and +have common repository for controller code supporting application level +configuration and lifecycle management of all network elements (physical or +virtual, layer 1-7). Because of these overlaps, we have documented SDN-C and +App-C together. ONAP Controller Family (SDN-C / App-C) configures and maintains +the health of L1-7 Network Function (VNF, PNF, CNF) and network services +throughout their lifecycle: + +- Configures Network Functions (VNF/PNF) +- Provides programmable network application management platform: + + - Behavior patterns programmed via models and policies + - Standards based models & protocols for multi-vendor implementation + - Extensible SB adapters such as Netconf, Ansible, Rest API, etc. + - Operation control, version management, software updates, etc. +- Local source of truth + - Manages inventory within its scope + - Manages and stores state of NFs + - Supports Configuration Audits + +Controller Design Studio (CDS) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The Controller Design Studio (CDS) community in ONAP has contributed a +framework to automate the resolution of resources for instantiation and any +config provisioning operation, such as day0, day1 or day2 configuration. The +essential function of CDS is to create and populate a controller blueprint, +create a configuration file from this Controller blueprint, and associate at +design time this configuration file (configlet) to a PNF/VNF/CNF during the +design phase. CDS removes dependence on code releases and the delays they cause +and puts the control of services into the hands of the service providers. Users +can change a model and its parameters with great flexibility to fetch data from +external systems (e.g., IPAM) that is required in real deployments. This makes +service providers more responsive to their customers and able to deliver +products that more closely match the needs of those customers. + +Inventory +^^^^^^^^^ +Active and Available Inventory (A&AI) provides real-time views of a system’s +resources, services, products and their relationships with each other, and also +retains a historical view. The views provided by A&AI relate data managed by +multiple ONAP instances, Business Support Systems (BSS), Operation Support +Systems (OSS), and network applications to form a “top to bottom†view ranging +from the products end users buy, to the resources that form the raw material +for creating the products. A&AI not only forms a registry of products, +services, and resources, it also maintains up-to-date views of the +relationships between these inventory items. + +To deliver the promised dynamism of SDN/NFV, A&AI is updated in real time by +the controllers as they make changes in the network environment. A&AI is +metadata-driven, allowing new inventory types to be added dynamically and +quickly via SDC catalog definitions, eliminating the need for lengthy +development cycles. + +Policy Framework +^^^^^^^^^^^^^^^^ +The Policy framework provides policy based decision making capability and +supports multiple policy engines and can distribute policies through policy +design capabilities in SDC, simplifying the design process. + +Multi Cloud Adaptation +^^^^^^^^^^^^^^^^^^^^^^ +Multi-VIM/Cloud provides and infrastructure adaptation layer for VIMs/Clouds +and K8s clusters in exposing advanced cloud agnostic intent capabilities, +besides standard capabilities, which are used by OOF and other components +for enhanced cloud selection and SO/VF-C for cloud agnostic workload +deployment. The K8s plugin is in charge of deploying CNFs on the Kubernetes +clusters using Kubernetes APIs. + +Data Collection Analytics and Events (DCAE) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +DCAE provides the capability to collect events, and host analytics applications +(DCAE Services) + +Closed Control Loop Automation Management Platform (CLAMP) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Closed loop control is provided by cooperation among a number of design-time +and run-time elements. The Runtime loop starts with data collectors from Data +Collection, Analytics and Events (DCAE). ONAP includes the following collectors +: VES (VNF Event Streaming) for events, HV-VES for high-volume events, SNMP +for SNMP traps, File Collector to receive files, and RESTCONF Collector to +collect the notifications. After data collection/verification phase, data move +through the loop of micro-services like Homes for event detection, Policy +for determining actions, and finally, controllers and orchestrators to +implement actions. The Policy framework is also used to monitor the loops +themselves and manage their lifecycle. DCAE also includes a number of +specialized micro-services to support some use-cases such as the Slice Analysis +or SON-Handler. Some dedicated event processor modules transform collected data +(SNMP, 3GPP XML, RESTCONF) to VES format and push the various data into data +lake. CLAMP, Policy and DCAE all have design time aspects to support the +creation of the loops. + +We refer to this automation pattern as “Closed Control loop automation†in that +it provides the necessary automation to proactively respond to network and +service conditions without human intervention. A high-level schematic of the +“closed control loop automation†and the various phases within the service +lifecycle using the automation is depicted in Figure 3. + +Closed control loop control is provided by Data Collection, Analytics and +Events (DCAE) and one or more of the other ONAP runtime components. +Collectively, they provide FCAPS (Fault Configuration Accounting Performance +Security) functionality. DCAE collects performance, usage, and configuration +data; provides computation of analytics; aids in troubleshooting; and publishes +events, data and analytics (e.g., to policy, orchestration, and the data lake). +Another component, Holmes, connects to DCAE and provides alarm correlation +for ONAP, new data collection capabilities with High Volume VES, and bulk +performance management support. + +Working with the Policy Framework (and embedded CLAMP), these components +detect problems in the network and identify the appropriate remediation. +In some cases, the action will be automatic, and they will notify the +Service Orchestrator or one of the controllers to take action. +In other cases, as configured by the operator, they will raise an alarm +but require human intervention before executing the change. The policy +framework is extended to support additional policy decision capabilities +with the introduction of adaptive policy execution. + +Starting with the Honolulu-R8 and concluding in the Istanbul-R9 release, the +CLAMP component was successfully integrated into the Policy component initially +as a PoC in the Honolulu-R8 release and then as a fully integrated component +within the Policy component in Istanbul-R9 release. +CLAMP's functional role to provision Policy has been enhanced to support +provisioning of policies outside of the context of a Control Loop and therefore +act as a Policy UI. In the Istanbul release the CLAMP integration was +officially released. + +|image4| + +**Figure 4: ONAP Closed Control Loop Automation** + +Virtual Function Controller (VFC) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +VFC provides the NFVO capability to manage the lifecycle of network service and +VNFs, by conforming to ETSI NFV specification. + +Data Movement as a Platform (DMaaP) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +DMaaP provides data movement service such as message routing and data routing. + +Use Case UI (UUI) +^^^^^^^^^^^^^^^^^ +UUI provides the capability to instantiate the blueprint User Cases and +visualize the state. + +CLI +^^^ +ONAP CLI provides a command line interface for access to ONAP. + +External APIs +^^^^^^^^^^^^^ + +.. warning:: The ONAP :strong:`externalapi` project is :strong:`unmaintained`. + +External APIs provide services to expose the capability of ONAP. + +Shared Services +--------------- + +.. warning:: The ONAP :strong:`logging` project is :strong:`unmaintained`. + +ONAP provides a set of operational services for all ONAP components including +activity logging, reporting, common data layer, configuration, persistence, +access control, secret and credential management, resiliency, and software +lifecycle management. + +These services provide access management and security enforcement, data backup, +configuration persistence, restoration and recovery. They support standardized +VNF interfaces and guidelines. + +Operating in a virtualized environment introduces new security challenges and +opportunities. ONAP provides increased security by embedding access controls in +each ONAP platform component, augmented by analytics and policy components +specifically designed for the detection and mitigation of security violations. + +Configuration Persistence Service (CPS) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The Configuration Persistence Service (CPS) provides storage for real-time +run-time configuration and operational parameters that need to be used by ONAP. +Several services ranging from SDN-C, DCAE and the network slicing use case +utilize CPS for these purposes. Its details in +:ref:`CPS - Configuration Persistence Service`. + +ONAP Modeling +------------- +ONAP provides models to assist with service design, the development of ONAP +service components, and with the improvement of standards interoperability. +Models are an essential part for the design time and runtime framework +development. The ONAP modeling project leverages the experience of member +companies, standard organizations and other open source projects to produce +models which are simple, extensible, and reusable. The goal is to fulfill the +requirements of various use cases, guide the development and bring consistency +among ONAP components and explore a common model to improve the +interoperability of ONAP. + +ONAP supports various models detailed in the Modeling documentation. + +The modeling project includes the ETSI catalog component, which provides the +parser functionalities, as well as additional package management +functionalities. + +Industry Alignment +------------------ +ONAP support and collaboration with other standards and open source communities +is evident in the architecture. + +- MEF and TMF interfaces are used in the External APIs +- In addition to the ETSI-NFV defined VNFD and NSD models mentioned above, ONAP + supports the NFVO interfaces (SOL005 between the SO and VFC, SOL003 from + either the SO or VFC to an external VNFM). +- Further collaboration includes 5G/ORAN & 3GPP Harmonization, Acumos DCAE + Integration, and CNCF Telecom User Group (TUG). + +Read this whitepaper for more information: +`The Progress of ONAP: Harmonizing Open Source and Standards `_ + +ONAP Blueprints +--------------- +ONAP can support an unlimited number of use cases, within reason. However, to +provide concrete examples of how to use ONAP to solve real-world problems, the +community has created a set of blueprints. In addition to helping users rapidly +adopt the ONAP platform through end-to-end solutions, these blueprints also +help the community prioritize their work. + +5G Blueprint +^^^^^^^^^^^^ +The 5G blueprint is a multi-release effort, with five key initiatives around +end-to-end service orchestration, network slicing, PNF/VNF lifecycle management +, PNF integration, and network optimization. The combination of eMBB that +promises peak data rates of 20 Mbps, uRLLC that guarantees sub-millisecond +response times, MMTC that can support 0.92 devices per sq. ft., and network +slicing brings with it some unique requirements. First ONAP needs to manage the +lifecycle of a network slice from initial creation/activation all the way to +deactivation/termination. Next, ONAP needs to optimize the network around real +time and bulk analytics, place VNFs on the correct edge cloud, scale and heal +services, and provide edge automation. ONAP also provides self organizing +network (SON) services such as physical cell ID allocation for new RAN sites. +These requirements have led to the five above-listed initiatives and have been +developed in close cooperation with other standards and open source +organizations such as 3GPP, TM Forum, ETSI, and O-RAN Software Community. + +|image5| + +**Figure 5. End-to-end 5G Service** + +Read the `5G Blueprint `_ +to learn more. + +A related activity outside of ONAP is called the 5G Super Blueprint where +multiple Linux Foundation projects are collaborating to demonstrate an +end-to-end 5G network. In the short-term, this blueprint will showcase +thre major projects: ONAP, Anuket (K8S NFVI), and Magma (LTE/5GC). + +|image6| + +**Figure 6. 5G Super Blueprint Initial Integration Activity** + +In the long-term, the 5G Super Blueprint will integrate O-RAN-SC and LF Edge +projects as well. + +Residential Connectivity Blueprints +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Two ONAP blueprints (vCPE and BBS) address the residential connectivity use +case. + +Virtual CPE (vCPE) +"""""""""""""""""" +Currently, services offered to a subscriber are restricted to what is designed +into the broadband residential gateway. In the blueprint, the customer has a +slimmed down physical CPE (pCPE) attached to a traditional broadband network +such as DSL, DOCSIS, or PON (Figure 5). A tunnel is established to a data +center hosting various VNFs providing a much larger set of services to the +subscriber at a significantly lower cost to the operator. In this blueprint, +ONAP supports complex orchestration and management of open source VNFs and both +virtual and underlay connectivity. + +|image7| + +**Figure 7. ONAP vCPE Architecture** + +Read the `Residential vCPE Use Case with ONAP blueprint `_ +to learn more. + +Broadband Service (BBS) +""""""""""""""""""""""" +This blueprint provides multi-gigabit residential internet connectivity +services based on PON (Passive Optical Network) access technology. A key +element of this blueprint is to show automatic re-registration of an ONT +(Optical Network Terminal) once the subscriber moves (nomadic ONT) as well as +service subscription plan changes. This blueprint uses ONAP for the design, +deployment, lifecycle management, and service assurance of broadband services. +It further shows how ONAP can orchestrate services across different locations +(e.g. Central Office, Core) and technology domains (e.g. Access, Edge). + +|image8| + +**Figure 8. ONAP BBS Architecture** + +Read the `Residential Connectivity Blueprint `_ +to learn more. + +Voice over LTE (VoLTE) Blueprint +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +This blueprint uses ONAP to orchestrate a Voice over LTE service. The VoLTE +blueprint incorporates commercial VNFs to create and manage the underlying +vEPC and vIMS services by interworking with vendor-specific components, +including VNFMs, EMSs, VIMs and SDN controllers, across Edge Data Centers and +a Core Data Center. ONAP supports the VoLTE use case with several key +components: SO, VF-C, SDN-C, and Multi-VIM/ Cloud. In this blueprint, SO is +responsible for VoLTE end-to-end service orchestration working in collaboration +with VF-C and SDN-C. SDN-C establishes network connectivity, then the VF-C +component completes the Network Services and VNF lifecycle management +(including service initiation, termination and manual scaling) and FCAPS +(fault, configuration, accounting, performance, security) management. This +blueprint also shows advanced functionality such as scaling and change +management. + +|image9| + +**Figure 9. ONAP VoLTE Architecture Open Network Automation Platform** + +Read the `VoLTE Blueprint `_ +to learn more. + +Optical Transport Networking (OTN) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Two ONAP blueprints (CCVPN and MDONS) address the OTN use case. CCVPN addresses +Layers 2 and 3, while MDONS addresses Layers 0 and 1. + +CCVPN (Cross Domain and Cross Layer VPN) Blueprint +"""""""""""""""""""""""""""""""""""""""""""""""""" +CSPs, such as CMCC and Vodafone, see a strong demand for high-bandwidth, flat, +high-speed OTN (Optical Transport Networks) across carrier networks. They also +want to provide a high-speed, flexible and intelligent service for high-value +customers, and an instant and flexible VPN service for SMB companies. + +|image10| + +**Figure 10. ONAP CCVPN Architecture** + +The CCVPN (Cross Domain and Cross Layer VPN) blueprint is a combination of SOTN +(Super high-speed Optical Transport Network) and ONAP, which takes advantage of +the orchestration ability of ONAP, to realize a unified management and +scheduling of resources and services. It achieves cross-domain orchestration +and ONAP peering across service providers. In this blueprint, SO is responsible +for CCVPN end-to-end service orchestration working in collaboration with VF-C +and SDN-C. SDN-C establishes network connectivity, then the VF-C component +completes the Network Services and VNF lifecycle management. ONAP peering +across CSPs uses an east-west API which is being aligned with the MEF Interlude +API. CCVPN, in conjunction with the IBN use case, offers intent based cloud +leased line service. The key innovations in this use case are physical network +discovery and modeling, cross-domain orchestration across multiple physical +networks, cross operator end-to-end service provisioning, close-loop reroute +for cross-domain service, dynamic changes (branch sites, VNFs) and intelligent +service optimization (including AI/ML). + +Read the `CCVPN Blueprint `_ +to learn more. + +MDONS (Multi-Domain Optical Network Service) Blueprint +"""""""""""""""""""""""""""""""""""""""""""""""""""""" +While CCVPN addresses the automation of networking layers 2 and 3, it does not +address layers 0 and 1. Automating these layers is equally important because +providing an end-to-end service to their customers often requires a manual and +complex negotiation between CSPs that includes both the business arrangement +and the actual service design and activation. CSPs may also be structured such +that they operate multiple networks independently and require similar +transactions among their own networks and business units in order to provide an +end-to-end service. The MDONS blueprint created by AT&T, Orange, and Fujitsu +solves the above problem. MDONS and CCVPN used together can solve the OTN +automation problem in a comprehensive manner. + +|image11| + +**Figure 11. ONAP MDONS Architecture** + +Intent Based Network (IBN) Use Case +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Intent technology can reduce the complexity of management without getting into +the intricate details of the underlying network infrastructure and contribute +to efficient network management. This use case performs a valuable business +function that can further reduce the operating expenses (OPEX) of network +management by shifting the paradigm from complex procedural operations to +declarative intent-driven operations + +|image12| + +**Figure 12. ONAP Intent-Based Networking Use Case** + +3GPP 28.812, Intent driven Management Service (Intent driven MnS), defines +some key concepts that are used by this initiative. The Intent Based Networking +(IBN) use case includes the development of an intent decision making. This use +case has initially been shown for a smart warehouse, where the intent is to +increase the output volume of automated guided vehicles (AVG) and the network +simply scales in response. The intent UI is implemented in UUI and the +components of the intent framework interact with many components of ONAP +including SO, A&AI, Policy, DCAE and CDS. + +vFW/vDNS Blueprint +^^^^^^^^^^^^^^^^^^ +The virtual firewall, virtual DNS blueprint is a basic demo to verify that ONAP +has been correctly installed and to get a basic introduction to ONAP. The +blueprint consists of 5 VNFs: vFW, vPacketGenerator, vDataSink, vDNS and +vLoadBalancer. The blueprint exercises most aspects of ONAP, showing VNF +onboarding, network service creation, service deployment and closed-loop +automation. The key components involved are SDC, CLAMP, SO, APP-C, DCAE and +Policy. In the recent releases, the vFW blueprint has been demonstrated by +using a mix of a CNF and VNF and entirely using CNFs. + +Verified end to end tests +------------------------- +Use cases +^^^^^^^^^ +Various use cases have been tested for the Release. Use case examples are +listed below. See detailed information on use cases, functional requirements, +and automated use cases can be found here: +:doc:`Verified Use Cases`. + +- E2E Network Slicing +- 5G OOF (ONAP Optimization Framework) SON (Self-Organized Network) +- CCVPN-Transport Slicing + +Functional requirements +^^^^^^^^^^^^^^^^^^^^^^^ +Various functional requirements have been tested for the Release. Detailed +information can be found in the +:doc:`Verified Use Cases`. + +- xNF Integration + + - ONAP CNF orchestration - Enhancements + - PNF PreOnboarding + - PNF Plug & Play + +- Lifecycle Management + + - Policy Based Filtering + - Bulk PM / PM Data Control Extension + - Support xNF Software Upgrade in association to schema updates + - Configuration & Persistency Service + +- Security + + - CMPv2 Enhancements + +- Standard alignment + + - ETSI-Alignment for Guilin + - ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES + - Extend ORAN A1 Adapter and add A1 Policy Management + +- NFV testing Automatic Platform + + - Support for Test Result Auto Analysis & Certification + - Support for Test Task Auto Execution + - Support for Test Environment Auto Deploy + - Support for Test Topology Auto Design + +Conclusion +---------- +The ONAP platform 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 lifecycle 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. + +Resources +--------- +See the Resources page on `ONAP.org `_ + +.. |image1| image:: media/ONAP-architecture.png + :width: 800px +.. |image2| image:: media/ONAP-fncview.png + :width: 800px +.. |image3| image:: media/ONAP-NetworkSlicingOptions.png + :width: 800px +.. |image4| image:: media/ONAP-closedloop.png + :width: 800px +.. |image5| image:: media/ONAP-5G.png + :width: 800px +.. |image6| image:: media/ONAP-5GSuperBP-Integration.png + :width: 800px +.. |image7| image:: media/ONAP-vcpe.png + :width: 800px +.. |image8| image:: media/ONAP-bbs.png + :width: 800px +.. |image9| image:: media/ONAP-volte.png + :width: 800px +.. |image10| image:: media/ONAP-ccvpn.png + :width: 800px +.. |image11| image:: media/ONAP-mdons.png + :width: 800px +.. |image12| image:: media/ONAP-IntentBasedNetworking.png + :width: 800px diff --git a/docs/platform/architecture/media/ONAP-5G.png b/docs/platform/architecture/media/ONAP-5G.png new file mode 100644 index 000000000..9ae0b2a6a Binary files /dev/null and b/docs/platform/architecture/media/ONAP-5G.png differ diff --git a/docs/platform/architecture/media/ONAP-5GSuperBP-Integration.png b/docs/platform/architecture/media/ONAP-5GSuperBP-Integration.png new file mode 100644 index 000000000..89d24e977 Binary files /dev/null and b/docs/platform/architecture/media/ONAP-5GSuperBP-Integration.png differ diff --git a/docs/platform/architecture/media/ONAP-IntentBasedNetworking.png b/docs/platform/architecture/media/ONAP-IntentBasedNetworking.png new file mode 100644 index 000000000..327111ba3 Binary files /dev/null and b/docs/platform/architecture/media/ONAP-IntentBasedNetworking.png differ diff --git a/docs/platform/architecture/media/ONAP-NetworkSlicingOptions.png b/docs/platform/architecture/media/ONAP-NetworkSlicingOptions.png new file mode 100644 index 000000000..90859d4ca Binary files /dev/null and b/docs/platform/architecture/media/ONAP-NetworkSlicingOptions.png differ diff --git a/docs/platform/architecture/media/ONAP-architecture.png b/docs/platform/architecture/media/ONAP-architecture.png new file mode 100644 index 000000000..82a8a1b3e Binary files /dev/null and b/docs/platform/architecture/media/ONAP-architecture.png differ diff --git a/docs/platform/architecture/media/ONAP-bbs.png b/docs/platform/architecture/media/ONAP-bbs.png new file mode 100644 index 000000000..4996a066f Binary files /dev/null and b/docs/platform/architecture/media/ONAP-bbs.png differ diff --git a/docs/platform/architecture/media/ONAP-ccvpn.png b/docs/platform/architecture/media/ONAP-ccvpn.png new file mode 100644 index 000000000..c98133874 Binary files /dev/null and b/docs/platform/architecture/media/ONAP-ccvpn.png differ diff --git a/docs/platform/architecture/media/ONAP-closedloop.png b/docs/platform/architecture/media/ONAP-closedloop.png new file mode 100644 index 000000000..7d3a2cac8 Binary files /dev/null and b/docs/platform/architecture/media/ONAP-closedloop.png differ diff --git a/docs/platform/architecture/media/ONAP-fncview.png b/docs/platform/architecture/media/ONAP-fncview.png new file mode 100755 index 000000000..5497edb30 Binary files /dev/null and b/docs/platform/architecture/media/ONAP-fncview.png differ diff --git a/docs/platform/architecture/media/ONAP-mdons.png b/docs/platform/architecture/media/ONAP-mdons.png new file mode 100644 index 000000000..f58789138 Binary files /dev/null and b/docs/platform/architecture/media/ONAP-mdons.png differ diff --git a/docs/platform/architecture/media/ONAP-vcpe.png b/docs/platform/architecture/media/ONAP-vcpe.png new file mode 100644 index 000000000..02ff80f7c Binary files /dev/null and b/docs/platform/architecture/media/ONAP-vcpe.png differ diff --git a/docs/platform/architecture/media/ONAP-volte.png b/docs/platform/architecture/media/ONAP-volte.png new file mode 100644 index 000000000..bce590655 Binary files /dev/null and b/docs/platform/architecture/media/ONAP-volte.png differ diff --git a/docs/platform/architecture/media/onap-architecture-overview-colors.svg b/docs/platform/architecture/media/onap-architecture-overview-colors.svg new file mode 100644 index 000000000..5cc237822 --- /dev/null +++ b/docs/platform/architecture/media/onap-architecture-overview-colors.svg @@ -0,0 +1,350 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/platform/architecture/media/onap-architecture-overview-interactive-path.svg b/docs/platform/architecture/media/onap-architecture-overview-interactive-path.svg new file mode 100644 index 000000000..c6577e793 --- /dev/null +++ b/docs/platform/architecture/media/onap-architecture-overview-interactive-path.svg @@ -0,0 +1,6078 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/platform/architecture/media/onap-architecture-overview-interactive.svg b/docs/platform/architecture/media/onap-architecture-overview-interactive.svg new file mode 100644 index 000000000..ffd8b5d82 --- /dev/null +++ b/docs/platform/architecture/media/onap-architecture-overview-interactive.svg @@ -0,0 +1,2976 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Unmaintained ONAP Component + + + + Entirety of ONAP Components + + + + Operations + + + + Orchestration & Management + + + + Design + + + + Color Legend: + + + + + + + Managed Environment + + + + + IP + MPLS + + + + PublicCloud + + + + PrivateDC Cloud + + + + PrivateEdge Cloud + + + + + + Hypervisor / OS Layer + + + + OpenStack + + + + Commercial VIM + + + + Kubernetes + + + + Public Cloud + + + + + + Network Function Layer + + + + + PNF + + + + VNF + + + + + + External Systems + + + + 3rd Party Controllers + + + + sVNFM + + + + EMS + + + + + + + + + + + Utilities + + + + + + + ONAP Shared Utilities + + + + + + TOSCA Parser + + + + + + Model Utilities + + + + + + Common Controller SDK (CCSDK) + + + + + + + + + Manage ONAP + + + + + + ONAP Operation Manager (OOM) + + + + + + + + Design-Time + + + + + + + Service Design & Creation +(SDC) + + + + + + Catalog + + + + + + DCAE Design Studio + + + + + + Controller Design Studio (CDS) + + + + + + Workflow Designer + + + + + + xNF Onboarding + + + + + + Service/xNF Design + + + + + + + + VNF Validation + + + + + + VNF SDK + + + + + + VVP + + + + + + + + + Run-Time + + + + + + + Shared Services + + + + + + Config. Persistence Service (CPS) + + + + + + Multi-Site State (MUSIC) + + + + + + Logging + + + + + + Optimization Framework (OOF) + + + + + + Appl. Authoriz. Framework (AAF) + + + + + + + Virtual Function +Controller +(VFC) + + + + + + Application +Controller +(APPC) + + + + + + SDN +Controller (SDNC) + + + + + + Controller +Design Studio +(CDS) + + + + + + Infrastructure +Adaption +(Multi-VIM/Cloud) + + + + + + + Data Collection, +Analytics & Events (DCAE) + + + + + + Analytics + + + + + + Collectors + + + + + + + Data Movement as a Platform (DMaaP) + + + + + + Microservice Bus (MSB) + + + + + + Active & Available Inventory (AAI) + + + + + + Service Orchestration +(SO) + + + + + + Correlation Engine (Holmes) + + + + + + + Policy Framework + + + + + + CLAMP + + + + + + + + Interfaces + + + + + + CLI + + + + + + External APIs + + + + + + Use-Case UI (UUI) + + + + + + O&M Dashboard (VID) + + + + + + Portal + + + + + + + + Northbound Interface (NBI) towards OSS, BSS and other + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/platform/architecture/media/onap-architecture-overview-labels-and-links.csv b/docs/platform/architecture/media/onap-architecture-overview-labels-and-links.csv new file mode 100644 index 000000000..7f17c3efe --- /dev/null +++ b/docs/platform/architecture/media/onap-architecture-overview-labels-and-links.csv @@ -0,0 +1,86 @@ +LabelText;Href;HrefTarget;Title;Remark;ProjectState;OptionalInfo +ONAP Logo;https://docs.onap.org/en/latest/guides/overview/overview.html;Overview;The Open Network Automation Platform (ONAP) is a comprehensive platform for orchestration, management, and automation of network and edge computing services for network operators, cloud providers, and enterprises. The open source project ONAP is hosted by the Linux Foundation.;;na; +RELEASE 10 »JAKARTA«;https://docs.onap.org/en/latest/guides/overview/overview.html#onap-release-information;Overview;ONAP Release 10 »Jakarta« is not yet released.;;na; +ONAP Components (Border);https://docs.onap.org/en/latest/guides/onap-developer/architecture/index.html;Architecture;The ONAP architecture consists of functions for the design-time, run-time, for managing ONAP itself and additional utilities.;;na; +Northbound Interface (NBI) towards OSS, BSS and other;https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/architecture/architecture.html#introduction;Component;The Northbound Interface (NBI) provides a set of API that can be used by external systems as OSS or BSS for example. These APIs are based on TMF API.;"Required in this map? Because we also show the ""External APIs"" block in the map?! ";na; +Design-Time;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#design-time-framework;Architecture;The Design-time framework is a comprehensive development environment with tools, techniques and repositories for defining/describing resources, services, and products.;;na; +Service Design & Creation (SDC);https://docs.onap.org/projects/onap-sdc/en/latest/index.html;Component;Service Design & Creation (SDC) provides a well-structured organization of visual design and testing tools, templates and catalogs to model and create resources, and services. The output of the SDC is a set of models which drives the orchestration. In addition, it provides process workflow support for talking to the VNF/PNF or other resources and services through the process steps design, test and deploy.;Map update required? The elements below are a mix of tasks and ABB?! ;maintained; +Service/xNF Design;https://docs.onap.org/en/latest/guides/onap-user/design/index.html;GuideUser;The goal of the design process is to create all artifacts (models) that are required to instantiate and manage resources, services, and products on the ONAP platform.;;na;https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter7/VNF-On-boarding-and-package-management.html +xNF Onboarding;https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter7/VNF-On-boarding-and-package-management.html;VnfRequirements;The VNF provider must provide VNF packages that include a rich set of recipes, management and functional interfaces, policies, configuration parameters, and infrastructure requirements that can be utilized by the ONAP Design module to onboard and catalog these resources.;;na; +Workflow Designer;https://docs.onap.org/projects/onap-sdc/en/latest/workflow.html;Component;Workflow Designer allows a user to design a workflow, save it, and attach it to a SDC service as an artifact. Workflow Designer also manages the definitions of activities, which can be later used as parts of the designed workflows.;;na; +Controller Design Studio (CDS);https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html;Component;The design-time part of the Controller Design Studio (CDS) – the CDS Designer UI – is a framework to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1, or day2 configuration. A designer can define what actions are required for a given service, along with anything comprising the action. Its content is driven from a catalog of reusable data dictionary and component, delivering a reusable and simplified self-service experience. CDS modeling is mainly based on the TOSCA standard, using JSON as a representation. CDS is part of CCSDK.;;maintained; +DCAE Design Studio;https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.html;Component;Data Collection, Analytics and Events (DCAE) Design Studio enables to define and configure the monitoring flows of DCAE.;"Revise description? Rename ABB to ""DCAE MOD""?";maintained;"Data Collection, Analytics and Events (DCAE) Microservice Onboarding & Design (MOD) +Support automated adaptation of ML model from Acumos to DCAE design & runtime environment. +Provide simplified mS Onboarding, Service Assurance flow design, & mS configurations in DCAE. +Auto-generate blueprint at the end of the design process, not onboarded before the design process. +Support Policy onboarding & artifact distribution to Policy/CLAMP to support Self Service Control Loop. +Integrate with ONAP User Experience portals (initially ONAP portal, later SDC portal)." +Catalog;https://docs.onap.org/projects/onap-sdc/en/latest/architecture.html;Component;The key output of SDC is a set of models containing descriptions of asset capabilities and instructions to manage them. These models are stored in the SDC Master Reference Catalog for the entire enterprise to use.;Description of the SDC Catalog is missing in RTD. Link is rerouted to DevWiki / ARC Review.;na; +VNF Validation;https://docs.onap.org/en/latest/guides/onap-provider/index.html#vnf-and-pnf-requirements-and-guidelines;GuideProvider;Ensures that a network function (e.g. CNF, PNF, VNF) fits all ONAP guidelines and requirements.;;na; +VVP;https://docs.onap.org/projects/onap-vvp-documentation/en/latest/index.html;Component;The VNF Validation Platform (VVP) provides the functionality to validate that a VNF Heat package is compliant with the ONAP VNF Heat Template Requirements from the ONAP VNF Requirements (VNFRQTS) project.;;maintained; +VNF SDK;https://docs.onap.org/projects/onap-vnfsdk-model/en/latest/index.html;Component;The Virtual Network Function Software Development Kit (VNF SDK) provides the functionality to create VNF and PNF packages, test VNF and VNF ONAP compliance, and provides market place functionality to store VNF and PNF packages.;;maintained; +Run-Time;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#runtime-framework;Architecture;The Run-time execution framework executes the rules and policies and other models distributed by the design and creation environment.;;na; +Interfaces;https://docs.onap.org/en/latest/guides/onap-developer/architecture/references.html#user-interfaces;Architecture;Various ONAP components provide also a user interface.;;na; +Portal;https://docs.onap.org/projects/onap-portal/en/guilin/index.html;Component;Portal is a GUI platform that provides the ability to integrate different ONAP components GUIs into an centralized portal.;"Links to ""Guilin"" (latest available version)";unmaintained; +O&M Dashboard (VID);https://docs.onap.org/projects/onap-vid/en/latest/index.html;Component;Virtual Infrastructure Deployment (VID) is a UI interface that allows the operations and network infrastructure engineers to orchestrate and change configurations related to the infrastructure expansion and maintenance.;;unmaintained; +Use-Case UI (UUI);https://docs.onap.org/projects/onap-usecase-ui/en/latest/index.html;Component;Usecase User Interface (UUI) is an application portal which provides the ability to manage ONAP service instances. It allows customers to create, delete and update service instances, as well as to monitor the alarms and performance of these instances.;;maintained; +External APIs;https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/index.html;Component;External API exposes ONAPs capabilities through TMF standardized interfaces. It enables ONAP to hide the internal API.;;unmaintained; +CLI;https://docs.onap.org/projects/onap-cli/en/latest/index.html;Component;The Command Line Interface (CLI) provides commands to operate ONAP during design and run-time for network service functionalities. It also provides the 'Open Command Platform' which helps to orchestrate the commands from YAML and helps in agile automation.;;maintained; +Policy Framework;https://docs.onap.org/projects/onap-policy-parent/en/latest/index.html;Component;Policy Core Functions provide a logically centralized environment for the creation and management of policies, including conditional rules (e.g. create and validate policies/rules, identify overlaps, resolve conflicts, derive additional policies as needed).;;maintained; +CLAMP;https://docs.onap.org/projects/onap-policy-clamp/en/latest/index.html;Component;The Closed Loop Automation Platform (CLAMP) provides the capability to manage runtime control loops.;;maintained; +Correlation Engine (Holmes);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#holmes-holmes-alarm-correlation-and-analysis;ComponentIndex;Holmes provides the capability to analyze the relationship among different alarms (e.g. root cause, correlation).;;maintained; +Service Orchestration (SO);https://docs.onap.org/projects/onap-so/en/latest/index.html;Component;The Service Orchestration (SO) component is in charge of orchestration of network services and resources. It is based on the use of BPMN to document the Workflows.;;maintained; +Active & Available Inventory (AAI);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#aai-active-and-available-inventory;ComponentIndex;The Active and Available Inventory (AAI) provides real-time views of the resources and services in managed by and their relationships.;;maintained; +Microservice Bus (MSB);https://docs.onap.org/projects/onap-msb-apigateway/en/latest/index.html;Component;The Microservice Bus (MSB) provides service registration, discovery and communication services for microservices as well as a gateway for internal and external communication for the services.;;maintained; +Data Movement As A Platform (DMaaP);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#dmaap-data-movement-as-a-platform;ComponentIndex;Data Movement as a Platform (DMaaP) is a component that provides data movement services that transports and processes data from any source to any target.;;maintained; +Data Collection, Analytics & Events (DCAE);https://docs.onap.org/projects/onap-dcaegen2/en/latest/index.html;Component;Data Collection, Analytics & Events (DCAE) gathers performance, usage, and configuration data from the managed environment.;;maintained; +Collectors;https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html#collectors;Component;The collection layer provides the various data collectors that are needed to collect the instrumentation that is available from the cloud infrastructure. Included are both physical and virtual elements.;;na; +Analytics;https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html#analytics;Component;The gathered data from multiple streams and sources is fed to analytic applications. Those applications can be real-time – for example, analytics, anomaly detection, capacity monitoring, congestion monitoring, or alarm correlation – or non-real time, such as applications that perform analytics on previously collected data or forward synthesized, aggregated or transformed data to big data stores and other applications.;;na; +Infrastructure Adaption (Multi-VIM / Cloud);https://docs.onap.org/projects/onap-multicloud-framework/en/latest/index.html;Component;MultiCloud provides mediation capabilities to connect to different infrastructure providers (VM based, Container based). It has capabilities to discover and register infrastructure resource information. Also it relays FCAPS data from infrastructure to DCAE.;"Map update? Rename to ""Infrastructure Adaption (MultiCloud)"" (like the project name)?";maintained; +Controller Design Studio (CDS);https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html;Component;The run-time part of the Controller Design Studio (CDS) enables operators and ISPs to implement/operate hybrid network (CNF, PNF, VNF, Whitebox, etc.). The components are able to process and execute the design-time model intent defined by the users to support the lifecycle management. Included are a Self Service API, a TOSCA Workflow Engine, a Resource & Template API, a Southbound Adapter, a Python Executor and a Kotlin Executor.;;maintained; +SDN Controller (SDNC);https://docs.onap.org/projects/onap-sdnc-oam/en/latest/index.html;Component;The ONAP Controller Family (SDNC/APPC) configures and maintains the health of Layer 1-7 network functions (VNF, PNF, CNFs) and network services throughout their lifecycle. Both provide similar services (application level configuration using NetConf, Chef, Ansible, RestConf, etc.) and life cycle management functions (e.g. stop, resume, health check). SDNC is being used mainly for Layer 1-3 network elements.;;maintained; +Application Controller (APPC);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#appc-application-controller;ComponentIndex;The ONAP Controller Family (SDNC/APPC) configures and maintains the health of Layer 1-7 network functions (VNF, PNF, CNFs) and network services throughout their lifecycle. Both provide similar services (application level configuration using NetConf, Chef, Ansible, RestConf) and life cycle management functions (e.g. stop, resume, health check, etc.). APPC is being used mainly for Layer 4-7 network functions.;;unmaintained; +Virtual Function Controller (VFC);https://docs.onap.org/projects/onap-vfc-nfvo-lcm/en/latest/index.html;Component;The Virtual Function Controller (VFC) leverages the ETSI NFV MANO Architecture and information model as a reference and implements the full life cycle management and FCAPS of VNF and NS.;;maintained; +Shared Services;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#shared-services;Architecture;ONAP provides a set of operational services for all ONAP components including activity logging, reporting, common data layer, configuration, persistence, access control, secret and credential management, resiliency, and software lifecycle management.;;na; +Appl. Authoriz. Framework (AAF);https://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html;Component;The Application Authorization Framework (AAF) provides the services for authentication, authorization and certificate management to the ONAP components. It provides the services to the ONAP components to manage the lifecycle of authentication and authorization elements such as permissions, roles and credentials.;;unmaintained;Original Name: AuthN/AuthZ (AAF) +Optimization Framework (OOF);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#oof-optimization-framework;ComponentIndex;The ONAP Optimization Framework (OOF) addresses the optimization needs of ONAP. OOF is a framework that supports creating and running a suite of optimizing applications including Homing/Placement, PCI optimizer, Route optimizer, Slice selection, Change Management Scheduling Optimizer.;;maintained; +Logging;https://docs.onap.org/projects/onap-logging-analytics/en/latest/index.html;Component;Logging provides the capability to capture information required to operate, troubleshoot and report on the performance of the ONAP platform.;;unmaintained; +Multi-Site State (MUSIC);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#music-onap-multi-site-integration;ComponentIndex;Multi-Site State (MUSIC) provides a multi-site state coordination/management service (MUSIC) with a rich suite of recipes that each ONAP component can simply configure and use for their state-management needs.;;unmaintained; +Config. Persistence Service (CPS);https://docs.onap.org/projects/onap-cps/en/latest/index.html;Component;The Configuration Persistence Service (CPS) provides storage for real-time run-time configuration and operational parameters that need to be used by ONAP.;;maintained; +Manage ONAP;https://docs.onap.org/en/latest/guides/onap-operator/index.html#operations-and-administration-guides;GuideOperator;Management capabilities for the Open Network Automation Platform itself.;;na; +ONAP Operations Manager (OOM);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#oom-onap-operations-manager;ComponentIndex;The ONAP Operations Manager (OOM) is responsible for lifecycle management of the ONAP platform itself. OOM provides the ability to manage cloud-native installations and deployments of ONAP to Kubernetes-managed cloud environments.;;maintained; +Utilities;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#id1;Architecture;ONAP utilities provide support of the ONAP components.;;na; +ONAP Shared Utilities;https://docs.onap.org/en/latest/guides/onap-developer/architecture/onap-architecture.html#id1;Architecture;ONAP shared utilities provide support of the ONAP components.;;na; +Common Controller SDK (CCSDK);https://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/index.html;Component;The Common Controller Software Development Kit (CCSDK) provides a common set of reusable code that can be used across multiple controllers. For example, the SDN-C , APP-C, DCAE, ONAP Operations Manager and ONAP controller can reuse common pieces from this framework.;;maintained; +Model Utilities;https://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/;Component;[TO BE REVISED] The unified model-driven approach uses models as sources of data for generating processes/codes and following workflows (not code development as source). This way, the system can be more flexible and future proof, easy to update and use for cross-platform solutions since the “only” thing needed is a model update and manipulation through engine.;Better description required;maintained; +TOSCA Parser;https://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/;Component;[TO BE REVISED] etsicatalog provides package management service and parser service by Micro Service. It can be used to store packages distributed by the SDC, and can be consumed by other projects or components such as UUI, VFC, etc. It also includes a TOSCA parser service.;Better description required;na; +;;;;;; +Managed Environment;;;;;; +External Systems;;;;;; +3rd Party Controllers;;;;;; +sVNFM;;;;;; +EMS;;;;;; +Network Function Layer;;;;;; +VNF;;;;"""CNF"" missing?";; +PNF;;;;;; +Hypervisor / OS Layer;;;;;; +OpenStack;;;;;; +Commercial VIM;;;;;; +Kubernetes;;;;;; +Public Cloud;;;;;; +Private Edge Cloud;;;;;; +Private DC Cloud;;;;;; +Public Cloud;;;;;; +MPLS;;;;;; +IP;;;;;; +;;;;;; +LEGEND;;;;;; +Design;;;;;; +Orchestration & Management;;;;;; +Operations;;;;;; +Entirety of ONAP Components;;;;;; +Unmaintained ONAP Component;;;;;; +;;;;;; +OBSOLETE;;;;;; +Audit (POMBA);https://docs.onap.org/projects/onap-logging-analytics/en/latest/Logging_Enhancements_Project/logging_enhancements_project.html;Component;Post Orchestration Model Based Audit (POMBA) provides a event-driven audit of the operational data integrity across the NFV orchestration environment and NFV infrastructure using model driven approach. It reports discrepancies and anomalies between model and instance artifacts.;;unmaintained; +External System Register (ESR);https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#aai-active-and-available-inventory;ComponentIndex;The External System Register (ESR) provides capabilities to manage external systems (e.g. register, test, update status in AAI).;"Check if ""unmaintained"" is correct";unmaintained; diff --git a/docs/platform/architecture/media/onap-architecture-overview-notes.txt b/docs/platform/architecture/media/onap-architecture-overview-notes.txt new file mode 100644 index 000000000..a6df71bde --- /dev/null +++ b/docs/platform/architecture/media/onap-architecture-overview-notes.txt @@ -0,0 +1,70 @@ +ONAP ARCHITECTURE OVERVIEW NOTES + +Version 1.1, 2021-11-10 + +This file contains information about how the map and its interactive functions were realized and how it can be maintained. + +The map was designed in Inkscape 1.1 running on Ubuntu 20.04. + +The following fonts, styles and spacings are used: +sans-serif, bold, 18 pt +sans-serif, bold, 9 pt +sans-serif, normal, 18 pt +sans-serif, normal, 9 pt +spacing between baselines: 1,05 lines +spacing between letters: -0,35 px +spacing between words: -1,00 px + +Drawing: Rectangles have a stroke (width 2 or 4 mm). To avoid that the stroke rezizes in case you rezize the single rectangle, have a look at the Inkscape button "When scaling objects, scale the stroke width by the same proportion" and turn it off! But turn it on, if you like to scale the complete (grouped) map because you need it in a smaler size. + +Rezising: If you need to resize a grouped object (with a label) do not resize the full group because then also the label will resized and distorted. Select only the form you want to resize in the "Objects" window. Then rezize it according your needs. You do not have to ungroup label/form for this action! + +Text Alignment: Do not align text in a rectangle manually! Create a rectangle which has a stroke (2 mm, 4 mm) in the same color as the box, create text, format text, select both, box and text and choose menu "Text - Flow into Frame". Thats it! The stroke acts as a border. + +Open the "Objects" window (Objects - Objects) and use it as your central point to select objects. Try to avoid ungrouping objects. + +Open the "Objects Properties" window (Objects - Objects Properties) to see and change properties of the object. + +Naming conventions: +onap-architecture-overview-interactive.svg (editable version) +onap-architecture-overview-interactive-path.svg (all text converted to pathes; to be used in rst documentation files) + +Text to Path: To avoid display problems caused of missing fonts you should release the map only when all characters are rendered as pathes. To do so, open the "master file" of this map and save it with a new name (please note the naming conventions). Then select all elemets (STRG-A) and choose "Path - Objects to Path" and save it again using the new name. All character are now converted to pathes - and are not editable via the text edit tool anymore! But the map is expected to be rendered on every target system in the same way. Path conversion can not be undone - so store the "master file" carefully. Unfortunately the label-text in the map can not be searched anymore. + +Group the rectangle and the label first, then add the link. Otherwise the link is used only for the rectangle or the label and mouseover will not work properly. + +If you have added a link to a group, ungrouping deletes the link without a warning! Do not ungroup unless you are aware of what you will loose! + +Grouping / Link: To add a link to an object, first check that label and form are grouped before you add a link. Select the grouped object and use "Create Link" of the Context Menu. Now a new element/group is created. Rename it to something meaningful in the "Objects" window. Then use the "Objects attributes" window to add the link for this new element in the field "Href". +See also: +https://inkscape.org/doc/tutorials/tips/tutorial-tips.html +https://www.petercollingridge.co.uk/tutorials/svg/interactive/ + +Mouseover Text: Add mouseover-text to the field "Title:" in the "Objects attributes" window. + +Keep the structure of map elements clear and maintainable by using groups and proper labels for all of the objects. The name of an element or group must be changed manually in the "Objects" window. +Example elements and structure: ++---designtime group that groups all designtime elements (visible and non-visible) of the map (not visible, manually created for reasons of clarity) + +--- ... other elements + +---designtime.link group were values for interactivity (e.g. link, text, opacy effects) are assigned to (created by inkscape when you choose "Create Link") + +---designtime group for the label and rectangle (not visible, manually created, required to have interactivity for both elements - rectangle and label) + +---designtime.label label on top of the rectangle (visible, manually created) + +---designtime.form rectangle for the architecture element (visible, manually created) + +Interactive Links and Tooltip Text in "Object Attributes": +Href: +https://docs.onap.org/ +Title: +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. + +Mouse-Over Effect in "Object Properties" at "Interactivity": +onmouseover: +style.opacity = 0.6; +onmouseout: +style.opacity = 1.0; + +NOT USED - Links in "Object Properties / Interactivity": +onlick: +window.open("https://docs.onap.org/","_blank"); + +If possible, please use predefined colors from onap-architechture-colors.svg. diff --git a/docs/platform/components/index.rst b/docs/platform/components/index.rst new file mode 100644 index 000000000..ec8050f24 --- /dev/null +++ b/docs/platform/components/index.rst @@ -0,0 +1,262 @@ +.. This work is licensed under a Creative Commons Attribution +.. 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +.. index:: Developer Guides + +.. _doc_onap-developer_guide_projects: + +ONAP Components and Functionalities +=================================== +Here you will find the detailed documentation of maintained projects, +ONAP components and functionalities. + +AAI - Active and Available Inventory +------------------------------------ + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`aai/aai-common` + - AAI Architecture, APIs and Guides + * - :ref:`aai/sparky-be` + - Sparky - AAI Inventory UI + +CCSDK - Common Controller Software Development Kit +-------------------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`ccsdk/apps` + - Micro Services for CCSDK + * - :ref:`ccsdk/cds` + - Controller Design Studio Architecture and Guides + * - :ref:`ccsdk/distribution` + - TOSCA Orchestration Plugin, Directed Graph Support + * - :ref:`ccsdk/features` + - Software Defined Network Controller for Radio (SDNR) + * - :ref:`ccsdk/oran` + - O-RAN Support in ONAP + +CPS - Configuration Persistence Service +--------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`cps` + - CPS Global + * - :ref:`cps/cps-temporal` + - CPS Temporal + * - :ref:`cps/ncmp/dmi-plugin` + - CPS DMI Plugin + +DCAE - Data Collection, Analysis and Events +------------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`dcaegen2` + - DCAE (Gen2) Architecture and Guides + +DMAAP - Data Movement as a Platform +----------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`dmaap/buscontroller` + - Bus Controller + * - :ref:`dmaap/datarouter` + - Data Router + * - :ref:`dmaap/messagerouter/messageservice` + - Message Router + +HOLMES - Alarm Correlation and Analysis +---------------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`holmes/rule-management` + - Architecture and APIs + * - :ref:`holmes/engine-management` + - Engine Management + +INT - Integration +----------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`integration` + - Integration Project + +MOD - Modeling +-------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`modeling/etsicatalog` + - ETSI Runtime Catalog + +MSB - Microservices Bus +----------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`msb/apigateway` + - Microservices Bus + * - :ref:`msb/discovery` + - + * - :ref:`msb/java-sdk` + - + * - :ref:`msb/swagger-sdk` + - Swagger Software Development Kit + +MULTICLOUD - MultiCloud Framework +--------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`multicloud/framework` + - MultiCloud Framework Architecture and Guides + * - :ref:`multicloud/k8s` + - Kubernetes Reference Deployment (KUD) + +OOM - ONAP Operations Manager +----------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`oom` + - ONAP Operations Manager + * - :ref:`oom/offline-installer` + - OOM Offline Installer + +OOF - Optimization Framework +---------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`optf/has` + - Homing and Allocation + * - :ref:`optf/osdf` + - Optimization Service Design Framework + +POLICY - Policy Framework +------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`policy/parent` + - Policy Framework + +SDC - Service Design & Creation +------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`sdc` + - Service Design & Creation + +SDNC - Software Defined Network Controller +------------------------------------------ + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`sdnc/oam` + - SDNC Architecture, APIs and Guides + +SO - Service Orchestration +-------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`so` + - Service Orchestration Architecture, APIs and Guides + +UUI - Usecase User Interface +----------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`usecase-ui` + - Usecase-UI Architecture, APIs and Guides + +VFC - Virtual Function Controller +--------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`vfc/nfvo/lcm` + - Virtual Function Controller Architecture, APIs and Guides + diff --git a/docs/platform/overview/index.rst b/docs/platform/overview/index.rst new file mode 100644 index 000000000..47422502b --- /dev/null +++ b/docs/platform/overview/index.rst @@ -0,0 +1,178 @@ +.. 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 + +ONAP 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, analytic + 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. + + 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 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/platform/overview/media/ONAP_architecture_high_level.des b/docs/platform/overview/media/ONAP_architecture_high_level.des new file mode 100644 index 000000000..e90a061e6 Binary files /dev/null and b/docs/platform/overview/media/ONAP_architecture_high_level.des differ diff --git a/docs/platform/overview/media/ONAP_architecture_high_level.png b/docs/platform/overview/media/ONAP_architecture_high_level.png new file mode 100644 index 000000000..8fa45e9b1 Binary files /dev/null and b/docs/platform/overview/media/ONAP_architecture_high_level.png differ diff --git a/docs/platform/overview/media/ONAP_architecture_high_level.svg b/docs/platform/overview/media/ONAP_architecture_high_level.svg new file mode 100644 index 000000000..d55f71c31 --- /dev/null +++ b/docs/platform/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/platform/overview/media/ONAP_main_functions.des b/docs/platform/overview/media/ONAP_main_functions.des new file mode 100644 index 000000000..daa7b9626 Binary files /dev/null and b/docs/platform/overview/media/ONAP_main_functions.des differ diff --git a/docs/platform/overview/media/ONAP_main_functions.png b/docs/platform/overview/media/ONAP_main_functions.png new file mode 100644 index 000000000..a3d5c6001 Binary files /dev/null and b/docs/platform/overview/media/ONAP_main_functions.png differ diff --git a/docs/platform/overview/media/ONAP_main_functions.svg b/docs/platform/overview/media/ONAP_main_functions.svg new file mode 100644 index 000000000..0afc78019 --- /dev/null +++ b/docs/platform/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/release/component-release-notes.rst b/docs/release/component-release-notes.rst new file mode 100644 index 000000000..34b0b6942 --- /dev/null +++ b/docs/release/component-release-notes.rst @@ -0,0 +1,112 @@ +.. This work is licensed under a Creative Commons Attribution +.. 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +.. _component-release-notes: + +:orphan: + +Component Release Notes +======================= + +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 release notes and prepends to these +if/when any updated versions the project team believes are compatible with a +major release are made available. + +AAI - Active and Available Inventory +------------------------------------ +- :ref:`aai/common ` + +CCSDK - Common Controller Software Development Kit +-------------------------------------------------- +- :ref:`ccsdk/cds ` +- :ref:`ccsdk/distribution ` +- :ref:`ccsdk/oran ` + +CLI - Command Line Interface +---------------------------- +- :ref:`cli ` + +CPS - Configuration Persistence Service +--------------------------------------- +- :ref:`cps ` +- :ref:`cps/cps-temporal ` +- :ref:`cps/ncmp-dmi-plugin ` + +DCAE Gen.2 - Data Collection, Analysis and Events +------------------------------------------------- +- :ref:`dcaegen2 ` + +DMAAP - Data Movement As A Platform +----------------------------------- +- :ref:`dmaap/buscontroller ` +- :ref:`dmaap/datarouter ` +- :ref:`dmaap/messagerouter/messageservice ` + +DOC - Documentation +------------------- +- :ref:`doc ` + +HOLMES - Holmes +--------------- +- :ref:`holmes/rule-management ` + +INT - Integration +----------------- +- :ref:`integration ` + +MODELING - Modeling +------------------- +- :ref:`modeling/etsicatalog ` +- :ref:`modeling/modelspec ` + +MSB - Microservices Bus +----------------------- +- :ref:`msb/apigateway ` + +MULTICLOUD - Multi Cloud +------------------------ +- :ref:`multicloud/framework ` + +OOF - Optimization Framework +---------------------------- +- :ref:`optf/has ` +- :ref:`optf/osdf ` + +OOM - ONAP Operations Manager +----------------------------- +- :ref:`oom ` +- :ref:`oom/platform/cert-service ` + +.. - :ref:`oom/offline-installer ` ### changelog file needs at least the anchor / combine CL & RL? + +POLICY - Policy Framework +------------------------- +- :ref:`policy/parent ` + +SDC - Service Design & Creation +------------------------------- +- :ref:`sdc ` + +SDNC - Software Defined Network Controller +------------------------------------------ +- :ref:`sdnc/oam ` + +SO - Service Orchestration +-------------------------- +- :ref:`so ` + +UUI - Use Case User Interface +----------------------------- +- :ref:`usecase-ui ` + +VFC - Virtual Function Controller +--------------------------------- +- :ref:`vfc/nfvo/lcm ` + +VNFSDK - VNF Software Development Kit +------------------------------------- +- :ref:`vnfsdk/model ` diff --git a/docs/release/history.rst b/docs/release/history.rst new file mode 100644 index 000000000..e1a97cd50 --- /dev/null +++ b/docs/release/history.rst @@ -0,0 +1,35 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + Copyright 2022 by ONAP and contributors. + +.. _release-history: + +ONAP Release History +-------------------- + +ONAP is enhanced with numerous features from release to release. Each release +is named after a city. + ++-----------------+-----------------+------------------------+ +| Release Name | Release Version | Release Date | ++=================+=================+========================+ +| Jakarta | 10.0.0 | 2022, June 30th | ++-----------------+-----------------+------------------------+ +| Istanbul | 9.0.0 | 2021, November 15th | ++-----------------+-----------------+------------------------+ +| Honolulu | 8.0.0 | 2021, May 11th | ++-----------------+-----------------+------------------------+ +| Guilin | 7.0.0 | 2020, December 3rd | ++-----------------+-----------------+------------------------+ +| Frankfurt | 6.0.0 | 2020, June 11th | ++-----------------+-----------------+------------------------+ +| El Alto | 5.0.0 | 2019, October 24th | ++-----------------+-----------------+------------------------+ +| Dublin | 4.0.0 | 2019, July 9th | ++-----------------+-----------------+------------------------+ +| Casablanca | 3.0.0 | 2019, April 15th | ++-----------------+-----------------+------------------------+ +| Beijing | 2.0.0 | 2018, June 7th | ++-----------------+-----------------+------------------------+ +| Amsterdam | 1.0.0 | 2017, November 16th | ++-----------------+-----------------+------------------------+ \ No newline at end of file diff --git a/docs/release/index.rst b/docs/release/index.rst index 35e4d339a..fb66c1327 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -280,8 +280,8 @@ In the Jakarta release, - 85% projects passed the CII badge - 11% projects passed the CII Silver badge -Project specific details are in the :ref:`release notes` for -each project. +Project specific details are in the :ref:`release notes` +for each component. .. index:: maturity @@ -300,4 +300,4 @@ More details in :ref:`ONAP Integration Project` Known Issues and Limitations ---------------------------- Known Issues and limitations are documented in each -:ref:`project Release Notes `. +:ref:`project Release Notes `. diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst deleted file mode 100644 index 1f102ff3f..000000000 --- a/docs/release/releaserepos.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution -.. 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -.. _doc-releaserepos: - -:orphan: - -Project Specific Release Notes -============================== - -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 release notes and prepends to these -if/when any updated versions the project team believes are compatible with a -major release are made available. - -AAI - Active and Available Inventory ------------------------------------- -- :ref:`aai/common ` - -CCSDK - Common Controller Software Development Kit --------------------------------------------------- -- :ref:`ccsdk/cds ` -- :ref:`ccsdk/distribution ` -- :ref:`ccsdk/oran ` - -CLI - Command Line Interface ----------------------------- -- :ref:`cli ` - -CPS - Configuration Persistence Service ---------------------------------------- -- :ref:`cps ` -- :ref:`cps/cps-temporal ` -- :ref:`cps/ncmp-dmi-plugin ` - -DCAE Gen.2 - Data Collection, Analysis and Events -------------------------------------------------- -- :ref:`dcaegen2 ` - -DMAAP - Data Movement As A Platform ------------------------------------ -- :ref:`dmaap/buscontroller ` -- :ref:`dmaap/datarouter ` -- :ref:`dmaap/messagerouter/messageservice ` - -DOC - Documentation -------------------- -- :ref:`doc ` - -HOLMES - Holmes ---------------- -- :ref:`holmes/rule-management ` - -INT - Integration ------------------ -- :ref:`integration ` - -MODELING - Modeling -------------------- -- :ref:`modeling/etsicatalog ` -- :ref:`modeling/modelspec ` - -MSB - Microservices Bus ------------------------ -- :ref:`msb/apigateway ` - -MULTICLOUD - Multi Cloud ------------------------- -- :ref:`multicloud/framework ` - -OOF - Optimization Framework ----------------------------- -- :ref:`optf/has ` -- :ref:`optf/osdf ` - -OOM - ONAP Operations Manager ------------------------------ -- :ref:`oom ` -- :ref:`oom/platform/cert-service ` - -.. - :ref:`oom/offline-installer ` ### changelog file needs at least the anchor / combine CL & RL? - -POLICY - Policy Framework -------------------------- -- :ref:`policy/parent ` - -SDC - Service Design & Creation -------------------------------- -- :ref:`sdc ` - -SDNC - Software Defined Network Controller ------------------------------------------- -- :ref:`sdnc/oam ` - -SO - Service Orchestration --------------------------- -- :ref:`so ` - -UUI - Use Case User Interface ------------------------------ -- :ref:`usecase-ui ` - -VFC - Virtual Function Controller ---------------------------------- -- :ref:`vfc/nfvo/lcm ` - -VNFSDK - VNF Software Development Kit -------------------------------------- -- :ref:`vnfsdk/model ` diff --git a/docs/security/index.rst b/docs/security/index.rst new file mode 100644 index 000000000..2679de86c --- /dev/null +++ b/docs/security/index.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. Copyright 2019-2020 Samsung Electronics + +.. _onap-security-index: + +ONAP Security +============= + +Reporting Vulnerabilities +------------------------- + +If you discovered a potential vulnerability in ONAP we kindly ask you to report +it to us as soon as possible. You can do this by creating a ticket in +`OJSI jira `_ project. + +To get more details about our vulnerability management process or learn about +alternative communication channels please refer to +:ref:`ONAP Security`. + + +ONAP Security Advisories (OSA) +------------------------------ + +You can find the latest published advisories in the :ref:`OSA List` -- cgit 1.2.3-korg