diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/_static/css/ribbon.css | 2 | ||||
-rw-r--r-- | docs/guides/onap-developer/architecture/index.rst | 17 | ||||
-rw-r--r-- | docs/guides/onap-developer/architecture/references.rst | 55 | ||||
-rw-r--r-- | docs/guides/onap-user/index.rst | 3 | ||||
-rw-r--r-- | docs/guides/overview/index.rst | 16 | ||||
-rw-r--r-- | docs/index.rst | 45 | ||||
-rw-r--r-- | docs/platform/architecture/index.rst (renamed from docs/guides/onap-developer/architecture/onap-architecture.rst) | 105 | ||||
-rw-r--r-- | docs/platform/architecture/media/ONAP-5G.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-5G.png) | bin | 81553 -> 81553 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-5GSuperBP-Integration.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-5GSuperBP-Integration.png) | bin | 218568 -> 218568 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-IntentBasedNetworking.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-IntentBasedNetworking.png) | bin | 245495 -> 245495 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-NetworkSlicingOptions.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-NetworkSlicingOptions.png) | bin | 420474 -> 420474 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-architecture.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-architecture.png) | bin | 133346 -> 133346 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-bbs.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-bbs.png) | bin | 115218 -> 115218 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-ccvpn.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-ccvpn.png) | bin | 260011 -> 260011 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-closedloop.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-closedloop.png) | bin | 220944 -> 220944 bytes | |||
-rwxr-xr-x | docs/platform/architecture/media/ONAP-fncview.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-fncview.png) | bin | 441038 -> 441038 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-mdons.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-mdons.png) | bin | 106265 -> 106265 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-vcpe.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-vcpe.png) | bin | 155109 -> 155109 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/ONAP-volte.png (renamed from docs/guides/onap-developer/architecture/media/ONAP-volte.png) | bin | 182747 -> 182747 bytes | |||
-rw-r--r-- | docs/platform/architecture/media/onap-architecture-overview-colors.svg (renamed from docs/guides/onap-developer/architecture/media/onap-architecture-overview-colors.svg) | 0 | ||||
-rw-r--r-- | docs/platform/architecture/media/onap-architecture-overview-interactive-path.svg (renamed from docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive-path.svg) | 0 | ||||
-rw-r--r-- | docs/platform/architecture/media/onap-architecture-overview-interactive.svg (renamed from docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg) | 0 | ||||
-rw-r--r-- | docs/platform/architecture/media/onap-architecture-overview-labels-and-links.csv (renamed from docs/guides/onap-developer/architecture/media/onap-architecture-overview-labels-and-links.csv) | 0 | ||||
-rw-r--r-- | docs/platform/architecture/media/onap-architecture-overview-notes.txt (renamed from docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt) | 0 | ||||
-rw-r--r-- | docs/platform/components/index.rst (renamed from docs/guides/onap-developer/developing/index.rst) | 0 | ||||
-rw-r--r-- | docs/platform/overview/index.rst (renamed from docs/guides/overview/overview.rst) | 42 | ||||
-rw-r--r-- | docs/platform/overview/media/ONAP_architecture_high_level.des (renamed from docs/guides/overview/media/ONAP_architecture_high_level.des) | bin | 20734 -> 20734 bytes | |||
-rw-r--r-- | docs/platform/overview/media/ONAP_architecture_high_level.png (renamed from docs/guides/overview/media/ONAP_architecture_high_level.png) | bin | 256914 -> 256914 bytes | |||
-rw-r--r-- | docs/platform/overview/media/ONAP_architecture_high_level.svg (renamed from docs/guides/overview/media/ONAP_architecture_high_level.svg) | 0 | ||||
-rw-r--r-- | docs/platform/overview/media/ONAP_main_functions.des (renamed from docs/guides/overview/media/ONAP_main_functions.des) | bin | 16198 -> 16198 bytes | |||
-rw-r--r-- | docs/platform/overview/media/ONAP_main_functions.png (renamed from docs/guides/overview/media/ONAP_main_functions.png) | bin | 60229 -> 60229 bytes | |||
-rw-r--r-- | docs/platform/overview/media/ONAP_main_functions.svg (renamed from docs/guides/overview/media/ONAP_main_functions.svg) | 0 | ||||
-rw-r--r-- | docs/release/component-release-notes.rst (renamed from docs/release/releaserepos.rst) | 6 | ||||
-rw-r--r-- | docs/release/history.rst | 35 | ||||
-rw-r--r-- | docs/release/index.rst | 6 | ||||
-rw-r--r-- | docs/security/index.rst | 24 |
36 files changed, 165 insertions, 191 deletions
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/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<onap-policy-parent:clamp-label>` -| :ref:`SDC - Service Design and Creation<onap-sdc:architecture>` -| :ref:`UUI- Usecase UI<onap-usecase-ui:architecture>` - -Platform Components -------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -| :ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:architecture>` -| :ref:`Holmes<onap-holmes-rule-management:architecture>` -| :ref:`Policy<onap-policy-parent:architecture-label>` -| :ref:`SDNC - SDN Controller OAM<onap-sdnc-oam:architecture>` -| :ref:`SO - Service Orchestrator<onap-so:architecture>` -| :ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:architecture>` - -Common Services ---------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -| :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:architecture>` -| :ref:`CPS - Configuration Persistence Service<onap-cps:architecture>` -| :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:architecture>` -| :ref:`MSB - Microservices Bus<onap-msb-apigateway:architecture>` -| :ref:`Multi Cloud<onap-multicloud-framework:multicloud-administrator-guide>` -| :ref:`OOM - ONAP Operations Manager<onap-oom:oom_project_description>` -| :ref:`OPTF - Optimization Framework<onap-optf-osdf:architecture>` 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/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 <onap-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 <doc-releaserepos>` | The Project Specific Release Notes are providing information about recent changes, feature | - | | enhancements, or bug fixes on a component level. | + | :ref:`Component Release Notes <component-release-notes>` | The Component Release Notes are providing project specific information about recent changes, | + | | features, enhancements, or bug fixes. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`ONAP Release History <release-history>` | The list contains the name and date of previous ONAP releases. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main | | | functionalities of ONAP. Basic guidelines on license details, limitations and | @@ -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 <onap-security>` | The current state of ONAP Security is described here. You can learn about discovered and fixed| + | :ref:`ONAP Security <onap-security-index>` | 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 <self> + +.. 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/guides/onap-developer/architecture/onap-architecture.rst b/docs/platform/architecture/index.rst index 8871f211a..11f7c09da 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/platform/architecture/index.rst @@ -8,8 +8,8 @@ .. _ONAP-architecture: -Introduction -============ +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 @@ -103,20 +103,21 @@ 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. + 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. -.. raw:: html - :file: media/onap-architecture-overview-interactive-path.svg +.. 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.** +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: @@ -148,7 +149,7 @@ and MEF. **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. @@ -163,7 +164,7 @@ 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 @@ -194,7 +195,7 @@ 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 @@ -206,7 +207,7 @@ 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`. @@ -231,7 +232,7 @@ 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. @@ -248,7 +249,7 @@ 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 @@ -289,17 +290,17 @@ 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. @@ -309,7 +310,7 @@ 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 @@ -349,7 +350,7 @@ orchestration currently supports options #1 and #4. Virtual Infrastructure Deployment (VID) ---------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. warning:: The ONAP :strong:`vid` project is :strong:`unmaintained`. @@ -359,7 +360,7 @@ 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 @@ -379,7 +380,7 @@ 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 @@ -425,7 +426,7 @@ throughout their lifecycle: - 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 @@ -440,7 +441,7 @@ 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 @@ -458,13 +459,13 @@ 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 @@ -473,12 +474,12 @@ 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 @@ -534,32 +535,32 @@ officially released. **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`. @@ -578,7 +579,7 @@ 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 @@ -586,7 +587,7 @@ utilize CPS for these purposes. Its details in :ref:`CPS - Configuration Persistence Service<onap-cps:architecture>`. 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 @@ -604,7 +605,7 @@ 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. @@ -619,7 +620,7 @@ Read this whitepaper for more information: `The Progress of ONAP: Harmonizing Open Source and Standards <https://www.onap.org/wp-content/uploads/sites/20/2019/04/ONAP_HarmonizingOpenSourceStandards_032719.pdf>`_ 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 @@ -627,7 +628,7 @@ 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 @@ -663,12 +664,12 @@ 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 @@ -686,7 +687,7 @@ Read the `Residential vCPE Use Case with ONAP blueprint <https://www.onap.org/wp 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 @@ -704,7 +705,7 @@ Read the `Residential Connectivity Blueprint <https://www.onap.org/wp-content/up 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, @@ -727,12 +728,12 @@ Read the `VoLTE Blueprint <https://www.onap.org/wp-content/uploads/sites/20/2018 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 @@ -762,7 +763,7 @@ Read the `CCVPN Blueprint <https://www.onap.org/wp-content/uploads/sites/20/2019 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 @@ -779,7 +780,7 @@ automation problem in a comprehensive manner. **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 @@ -801,7 +802,7 @@ 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 @@ -812,9 +813,9 @@ 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: @@ -825,7 +826,7 @@ and automated use cases can be found here: - 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<onap-integration:docs_usecases_release>`. @@ -861,7 +862,7 @@ information can be found in the - 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 @@ -873,7 +874,7 @@ automation—with an open standards focus— faster than any one product could o its own. Resources -========= +--------- See the Resources page on `ONAP.org <https://www.onap.org/resources>`_ .. |image1| image:: media/ONAP-architecture.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-5G.png b/docs/platform/architecture/media/ONAP-5G.png Binary files differindex 9ae0b2a6a..9ae0b2a6a 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-5G.png +++ b/docs/platform/architecture/media/ONAP-5G.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-5GSuperBP-Integration.png b/docs/platform/architecture/media/ONAP-5GSuperBP-Integration.png Binary files differindex 89d24e977..89d24e977 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-5GSuperBP-Integration.png +++ b/docs/platform/architecture/media/ONAP-5GSuperBP-Integration.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-IntentBasedNetworking.png b/docs/platform/architecture/media/ONAP-IntentBasedNetworking.png Binary files differindex 327111ba3..327111ba3 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-IntentBasedNetworking.png +++ b/docs/platform/architecture/media/ONAP-IntentBasedNetworking.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-NetworkSlicingOptions.png b/docs/platform/architecture/media/ONAP-NetworkSlicingOptions.png Binary files differindex 90859d4ca..90859d4ca 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-NetworkSlicingOptions.png +++ b/docs/platform/architecture/media/ONAP-NetworkSlicingOptions.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png b/docs/platform/architecture/media/ONAP-architecture.png Binary files differindex 82a8a1b3e..82a8a1b3e 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png +++ b/docs/platform/architecture/media/ONAP-architecture.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-bbs.png b/docs/platform/architecture/media/ONAP-bbs.png Binary files differindex 4996a066f..4996a066f 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-bbs.png +++ b/docs/platform/architecture/media/ONAP-bbs.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-ccvpn.png b/docs/platform/architecture/media/ONAP-ccvpn.png Binary files differindex c98133874..c98133874 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-ccvpn.png +++ b/docs/platform/architecture/media/ONAP-ccvpn.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-closedloop.png b/docs/platform/architecture/media/ONAP-closedloop.png Binary files differindex 7d3a2cac8..7d3a2cac8 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-closedloop.png +++ b/docs/platform/architecture/media/ONAP-closedloop.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png b/docs/platform/architecture/media/ONAP-fncview.png Binary files differindex 5497edb30..5497edb30 100755 --- a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png +++ b/docs/platform/architecture/media/ONAP-fncview.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-mdons.png b/docs/platform/architecture/media/ONAP-mdons.png Binary files differindex f58789138..f58789138 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-mdons.png +++ b/docs/platform/architecture/media/ONAP-mdons.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-vcpe.png b/docs/platform/architecture/media/ONAP-vcpe.png Binary files differindex 02ff80f7c..02ff80f7c 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-vcpe.png +++ b/docs/platform/architecture/media/ONAP-vcpe.png diff --git a/docs/guides/onap-developer/architecture/media/ONAP-volte.png b/docs/platform/architecture/media/ONAP-volte.png Binary files differindex bce590655..bce590655 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-volte.png +++ b/docs/platform/architecture/media/ONAP-volte.png diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-colors.svg b/docs/platform/architecture/media/onap-architecture-overview-colors.svg index 5cc237822..5cc237822 100644 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-colors.svg +++ b/docs/platform/architecture/media/onap-architecture-overview-colors.svg diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive-path.svg b/docs/platform/architecture/media/onap-architecture-overview-interactive-path.svg index c6577e793..c6577e793 100644 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive-path.svg +++ b/docs/platform/architecture/media/onap-architecture-overview-interactive-path.svg diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg b/docs/platform/architecture/media/onap-architecture-overview-interactive.svg index ffd8b5d82..ffd8b5d82 100644 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg +++ b/docs/platform/architecture/media/onap-architecture-overview-interactive.svg diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-labels-and-links.csv b/docs/platform/architecture/media/onap-architecture-overview-labels-and-links.csv index 7f17c3efe..7f17c3efe 100644 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-labels-and-links.csv +++ b/docs/platform/architecture/media/onap-architecture-overview-labels-and-links.csv diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt b/docs/platform/architecture/media/onap-architecture-overview-notes.txt index a6df71bde..a6df71bde 100644 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt +++ b/docs/platform/architecture/media/onap-architecture-overview-notes.txt diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/platform/components/index.rst index ec8050f24..ec8050f24 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/platform/components/index.rst diff --git a/docs/guides/overview/overview.rst b/docs/platform/overview/index.rst index c98934d59..47422502b 100644 --- a/docs/guides/overview/overview.rst +++ b/docs/platform/overview/index.rst @@ -4,8 +4,8 @@ .. Copyright 2019 Nokia; Copyright 2017-2018 Huawei Technologies Co., Ltd.; .. Copyright 2017 AT&T Intellectual Property -Open Network Automation Platform Overview -========================================= +ONAP Overview +============= The Open Network Automation Platform (ONAP) project addresses the rising need for a **common automation platform for telecommunication, cable, @@ -99,7 +99,7 @@ principles: 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: @@ -137,7 +137,7 @@ These service design activities are built up of the following subtasks: b. Collecting and evaluating event data Benefits of ONAP -================ +---------------- Open Network Automation Platform provides the following benefits: @@ -154,38 +154,8 @@ Open Network Automation Platform provides the following benefits: * 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. @@ -198,7 +168,7 @@ ONAP has been tested in the following network environments: * Broadband Service (BBS) Licenses -======== +-------- Open Network Automation Platform (ONAP) is an open source project hosted by the Linux Foundation. diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.des b/docs/platform/overview/media/ONAP_architecture_high_level.des Binary files differindex e90a061e6..e90a061e6 100644 --- a/docs/guides/overview/media/ONAP_architecture_high_level.des +++ b/docs/platform/overview/media/ONAP_architecture_high_level.des diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.png b/docs/platform/overview/media/ONAP_architecture_high_level.png Binary files differindex 8fa45e9b1..8fa45e9b1 100644 --- a/docs/guides/overview/media/ONAP_architecture_high_level.png +++ b/docs/platform/overview/media/ONAP_architecture_high_level.png diff --git a/docs/guides/overview/media/ONAP_architecture_high_level.svg b/docs/platform/overview/media/ONAP_architecture_high_level.svg index d55f71c31..d55f71c31 100644 --- a/docs/guides/overview/media/ONAP_architecture_high_level.svg +++ b/docs/platform/overview/media/ONAP_architecture_high_level.svg diff --git a/docs/guides/overview/media/ONAP_main_functions.des b/docs/platform/overview/media/ONAP_main_functions.des Binary files differindex daa7b9626..daa7b9626 100644 --- a/docs/guides/overview/media/ONAP_main_functions.des +++ b/docs/platform/overview/media/ONAP_main_functions.des diff --git a/docs/guides/overview/media/ONAP_main_functions.png b/docs/platform/overview/media/ONAP_main_functions.png Binary files differindex a3d5c6001..a3d5c6001 100644 --- a/docs/guides/overview/media/ONAP_main_functions.png +++ b/docs/platform/overview/media/ONAP_main_functions.png diff --git a/docs/guides/overview/media/ONAP_main_functions.svg b/docs/platform/overview/media/ONAP_main_functions.svg index 0afc78019..0afc78019 100644 --- a/docs/guides/overview/media/ONAP_main_functions.svg +++ b/docs/platform/overview/media/ONAP_main_functions.svg diff --git a/docs/release/releaserepos.rst b/docs/release/component-release-notes.rst index 1f102ff3f..34b0b6942 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/component-release-notes.rst @@ -3,12 +3,12 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. -.. _doc-releaserepos: +.. _component-release-notes: :orphan: -Project Specific Release Notes -============================== +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 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<doc-releaserepos>` for -each project. +Project specific details are in the :ref:`release notes<component-release-notes>` +for each component. .. index:: maturity @@ -300,4 +300,4 @@ More details in :ref:`ONAP Integration Project<onap-integration:master_index>` Known Issues and Limitations ---------------------------- Known Issues and limitations are documented in each -:ref:`project Release Notes <doc-releaserepos>`. +:ref:`project Release Notes <component-release-notes>`. 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 <https://jira.onap.org/projects/OJSI>`_ project. + +To get more details about our vulnerability management process or learn about +alternative communication channels please refer to +:ref:`ONAP Security<onap-osa:vm-process>`. + + +ONAP Security Advisories (OSA) +------------------------------ + +You can find the latest published advisories in the :ref:`OSA List<onap-osa:osa-list>` |