From 80455a5d969d7ca773c9c5a9bba1f19986071574 Mon Sep 17 00:00:00 2001
From: Rich Bennett <rb2745@att.com>
Date: Wed, 8 Nov 2017 05:17:00 -0500
Subject: Integrate architecture overview
Adjusted headings to fit index
Corrected references to images
Made architecture provided by projects a reference list
Added build time and dropped the sphinx version on footers
Change-Id: I411ff51c5de2ad65c3c276d363d2fd3ed1ba35a7
Issue-ID: DOC-148
Signed-off-by: Rich Bennett <rb2745@att.com>
---
docs/guides/onap-developer/architecture/index.rst | 113 +------------------
.../architecture/onap-architecture.rst | 53 ++++-----
.../onap-developer/architecture/references.rst | 120 +++++++++++++++++++++
3 files changed, 152 insertions(+), 134 deletions(-)
create mode 100644 docs/guides/onap-developer/architecture/references.rst
(limited to 'docs/guides')
diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst
index bc392893c..960cda23b 100644
--- a/docs/guides/onap-developer/architecture/index.rst
+++ b/docs/guides/onap-developer/architecture/index.rst
@@ -8,115 +8,8 @@
Architecture
============
-.. 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.
-
-Models
-------
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- Model Specifications <../../../submodules/modeling/modelspec.git/docs/ONAP release 1 spec/index>
-
-User Interfaces
----------------
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst>
- CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst>
- SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>
- ../../../submodules/sdc/jtosca.git/docs/architecture.rst
- ../../../submodules/sdc/sdc-distribution-client.git/docs/architecture.rst
- ../../../submodules/sdc/sdc-docker-base.git/docs/architecture.rst
- ../../../submodules/sdc/sdc-titan-cassandra.git/docs/architecture.rst
- ../../../submodules/sdc/sdc-tosca.git/docs/architecture.rst
- ../../../submodules/sdc/sdc-workflow-designer.git/docs/architecture.rst
- ../../../submodules/usecase-ui.git/docs/architecture.rst
- ../../../submodules/vid/asdcclient.git/docs/architecture.rst
- VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/intro/index>
-
-Platform Components
--------------------
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- ../../../submodules/appc/deployment.git/docs/architecture.rst
- ../../../submodules/appc.git/docs/architecture.rst
- DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst>
- ../../../submodules/holmes/engine-management.git/docs/architecture.rst
- Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst>
- ../../../submodules/policy/engine.git/docs/architecture.rst
- ../../../submodules/sdnc/adaptors.git/docs/architecture.rst
- ../../../submodules/sdnc/architecture.git/docs/architecture.rst
- ../../../submodules/sdnc/core.git/docs/architecture.rst
- ../../../submodules/sdnc/features.git/docs/architecture.rst
- SDN Northbound <../../../submodules/sdnc/northbound.git/docs/architecture.rst
- SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst>
- ../../../submodules/sdnc/parent.git/docs/architecture.rst
- ../../../submodules/sdnc/plugins.git/docs/architecture.rst
- ../../../submodules/so/libs.git/docs/architecture.rst
- ../../../submodules/so.git/docs/architecture.rst
- ../../../submodules/vfc/lcm.git/docs/architecture.rst
- ../../../submodules/vfc/nfvo/lcm.git/docs/architecture.rst
-
-Common Services
----------------
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst>
- AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst>
- AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst>
- ../../../submodules/aai/sparky-be.git/docs/architecture.rst
- ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst
- MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst>
- ../../../submodules/msb/discovery.git/docs/architecture.rst
- ../../../submodules/msb/java-sdk.git/docs/architecture.rst
- ../../../submodules/msb/swagger-sdk.git/docs/architecture.rst
-
-SDKs
-----
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- ../../../submodules/ccsdk/dashboard.git/docs/architecture.rst
- ../../../submodules/ccsdk/distribution.git/docs/architecture.rst
- ../../../submodules/ccsdk/parent.git/docs/architecture.rst
- ../../../submodules/ccsdk/platform/blueprints.git/docs/architecture.rst
- ../../../submodules/ccsdk/platform/nbapi.git/docs/architecture.rst
- ../../../submodules/ccsdk/platform/plugins.git/docs/architecture.rst
- CCSDK SLI Adaptors <../../../submodules/ccsdk/sli/adaptors.git/docs/architecture.rst>
- CCSDK SLI Service Logic Intrepreter <../../../submodules/ccsdk/sli/core.git/docs/architecture.rst>
- CCSDK SLI Northbound Interface <../../../submodules/ccsdk/sli/northbound.git/docs/architecture.rst>
- CCSDK SLI Plugins <../../../submodules/ccsdk/sli/plugins.git/docs/architecture.rst>
- ../../../submodules/ccsdk/storage/esaas.git/docs/architecture.rst
- ../../../submodules/ccsdk/storage/pgaas.git/docs/architecture.rst
- ../../../submodules/ccsdk/utils.git/docs/architecture.rst
- Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst>
- ../../../submodules/vnfsdk/model.git/docs/architecture.rst
-
-Other
------
-
.. toctree::
- :maxdepth: 1
- :titlesonly:
+ :maxdepth: 2
- ../../../submodules/integration.git/docs/architecture.rst
- ../../../submodules/optf/has.git/docs/architecture.rst
- ../../../submodules/vnfrqts/guidelines.git/docs/architecture.rst
- ../../../submodules/vnfrqts/requirements.git/docs/architecture.rst
+ onap-architecture.rst
+ references.rst
diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst
index 54ba6b728..903303fef 100644
--- a/docs/guides/onap-developer/architecture/onap-architecture.rst
+++ b/docs/guides/onap-developer/architecture/onap-architecture.rst
@@ -1,11 +1,12 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-**Introducing the ONAP Architecture (Amsterdam Release)**
-=========================================================
-**Introduction **
------------------
+Introducing the ONAP Architecture (Amsterdam Release)
+=====================================================
+
+Introduction
+-------------
The ONAP project was formed in March, 2017 in response to a rising need
for a common platform for telecommunication, cable, and cloud
@@ -102,8 +103,8 @@ following foundational principles:
**Figure 1:** ONAP Platform
-**ONAP Architecture**
-=====================
+ONAP Architecture
+-----------------
Figure 2 provides a high-level view of the ONAP architecture and
microservices-based platform components. The platform provides the
@@ -116,7 +117,8 @@ the ONAP Design Framework Portal.
|image1|\ **Figure 2:** ONAP Platform components (Amsterdam Release)
-1. **Portal**
+Portal
+++++++
ONAP delivers a single, consistent user experience to both design time
and run time environments, based on the user’s role; role changes to be
@@ -138,8 +140,8 @@ vendors and consultants), and other experts to continually define/refine
new collection, analytics, and policies (including recipes for
corrective/remedial action) using the ONAP Design Framework Portal.
-**Design time Framework**
-=========================
+Design time Framework
++++++++++++++++++++++
The design time framework is a comprehensive development environment
with tools, techniques, and repositories for defining/describing
@@ -194,8 +196,8 @@ network service, then deploy and decommission it. Once deployed, a user
can also update the loop with new parameters during runtime, as well as
suspend and restart it.
-**Runtime Framework**
-=====================
+Runtime Framework
++++++++++++++++++
The runtime execution framework executes the rules and policies
distributed by the design and creation environment. This allows us to
@@ -206,7 +208,8 @@ a Security Framework. These components use common services that support
logging, access control, and data management.
Orchestration
--------------
++++++++++++++
+
The Service Orchestrator (SO) component executes the
specified processes and automates sequences of activities, tasks, rules
and policies needed for on-demand creation, modification or removal of
@@ -215,7 +218,8 @@ provides orchestration at a very high level, with an end to end view of
the infrastructure, network, and applications.
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
@@ -230,7 +234,8 @@ infrastructure. While it provides a generic VNFM, it also integrates
with external VNFMs and VIMs as part of a NFV MANO stack.
Inventory
----------
++++++++++
+
Active and Available Inventory (A&AI) provides real-time views of a
system’s resources, services, products and their relationships with each
other. The views provided by A&AI relate data managed by multiple ONAP
@@ -247,8 +252,8 @@ is metadata-driven, allowing new inventory types to be added dynamically
and quickly via SDC catalog definitions, eliminating the need for
lengthy development cycles.
-**Closed-Loop Automation**
-==========================
+Closed-Loop Automation
+----------------------
The following sections describe the ONAP frameworks designed to address
these major requirements. The key pattern that these frameworks help
@@ -283,8 +288,8 @@ human intervention before executing the change.
\ **Figure 3:** ONAP Closed Loop Automation
-**Common Services**
-===================
+Common Services
+---------------
ONAP provides common operational services for all ONAP components
including activity logging, reporting, common data layer, access
@@ -298,8 +303,8 @@ 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.
-**Amsterdam Use Cases**
-=======================
+Amsterdam Use Cases
+-------------------
The ONAP project uses real-world use cases to help focus our releases.
For the first release of ONAP (“Amsterdam”), we introduce two use cases:
@@ -383,15 +388,15 @@ By unifying member resources, ONAP will accelerate the development of a vibrant
.. |image0| image:: media/ONAP-DTRT.png
:width: 6in
:height: 2.6in
-.. |image1| image:: media/toplevel.png
+.. |image1| image:: media/ONAP-toplevel.png
:width: 6.5in
:height: 3.13548in
-.. |image2| image:: media/closedloop.jpeg
+.. |image2| image:: media/ONAP-closedloop.png
:width: 6in
:height: 2.6in
-.. |image3| image:: media/vcpe.png
+.. |image3| image:: media/ONAP-vcpe.png
:width: 6.5in
:height: 3.28271in
-.. |image4| image:: media/volte.png
+.. |image4| image:: media/ONAP-volte.png
:width: 6.5in
:height: 3.02431in
diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst
new file mode 100644
index 000000000..f00d610f3
--- /dev/null
+++ b/docs/guides/onap-developer/architecture/references.rst
@@ -0,0 +1,120 @@
+.. 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
+==========
+
+Models
+------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ Model Specifications <../../../submodules/modeling/modelspec.git/docs/ONAP release 1 spec/index>
+
+User Interfaces
+---------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst>
+ CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst>
+ SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>
+ ../../../submodules/sdc/jtosca.git/docs/architecture.rst
+ ../../../submodules/sdc/sdc-distribution-client.git/docs/architecture.rst
+ ../../../submodules/sdc/sdc-docker-base.git/docs/architecture.rst
+ ../../../submodules/sdc/sdc-titan-cassandra.git/docs/architecture.rst
+ ../../../submodules/sdc/sdc-tosca.git/docs/architecture.rst
+ ../../../submodules/sdc/sdc-workflow-designer.git/docs/architecture.rst
+ ../../../submodules/usecase-ui.git/docs/architecture.rst
+ ../../../submodules/vid/asdcclient.git/docs/architecture.rst
+ VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/intro/index>
+
+Platform Components
+-------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../submodules/appc/deployment.git/docs/architecture.rst
+ ../../../submodules/appc.git/docs/architecture.rst
+ DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst>
+ ../../../submodules/holmes/engine-management.git/docs/architecture.rst
+ Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst>
+ ../../../submodules/policy/engine.git/docs/architecture.rst
+ ../../../submodules/sdnc/adaptors.git/docs/architecture.rst
+ ../../../submodules/sdnc/architecture.git/docs/architecture.rst
+ ../../../submodules/sdnc/core.git/docs/architecture.rst
+ ../../../submodules/sdnc/features.git/docs/architecture.rst
+ SDN Northbound <../../../submodules/sdnc/northbound.git/docs/architecture.rst
+ SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst>
+ ../../../submodules/sdnc/parent.git/docs/architecture.rst
+ ../../../submodules/sdnc/plugins.git/docs/architecture.rst
+ ../../../submodules/so/libs.git/docs/architecture.rst
+ ../../../submodules/so.git/docs/architecture.rst
+ ../../../submodules/vfc/lcm.git/docs/architecture.rst
+ ../../../submodules/vfc/nfvo/lcm.git/docs/architecture.rst
+
+Common Services
+---------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst>
+ AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst>
+ AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst>
+ ../../../submodules/aai/sparky-be.git/docs/architecture.rst
+ ../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture.rst
+ MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst>
+ ../../../submodules/msb/discovery.git/docs/architecture.rst
+ ../../../submodules/msb/java-sdk.git/docs/architecture.rst
+ ../../../submodules/msb/swagger-sdk.git/docs/architecture.rst
+
+SDKs
+----
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../submodules/ccsdk/dashboard.git/docs/architecture.rst
+ ../../../submodules/ccsdk/distribution.git/docs/architecture.rst
+ ../../../submodules/ccsdk/parent.git/docs/architecture.rst
+ ../../../submodules/ccsdk/platform/blueprints.git/docs/architecture.rst
+ ../../../submodules/ccsdk/platform/nbapi.git/docs/architecture.rst
+ ../../../submodules/ccsdk/platform/plugins.git/docs/architecture.rst
+ CCSDK SLI Adaptors <../../../submodules/ccsdk/sli/adaptors.git/docs/architecture.rst>
+ CCSDK SLI Service Logic Intrepreter <../../../submodules/ccsdk/sli/core.git/docs/architecture.rst>
+ CCSDK SLI Northbound Interface <../../../submodules/ccsdk/sli/northbound.git/docs/architecture.rst>
+ CCSDK SLI Plugins <../../../submodules/ccsdk/sli/plugins.git/docs/architecture.rst>
+ ../../../submodules/ccsdk/storage/esaas.git/docs/architecture.rst
+ ../../../submodules/ccsdk/storage/pgaas.git/docs/architecture.rst
+ ../../../submodules/ccsdk/utils.git/docs/architecture.rst
+ Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst>
+ ../../../submodules/vnfsdk/model.git/docs/architecture.rst
+
+Other
+-----
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../submodules/integration.git/docs/architecture.rst
+ ../../../submodules/optf/has.git/docs/architecture.rst
+ ../../../submodules/vnfrqts/guidelines.git/docs/architecture.rst
+ ../../../submodules/vnfrqts/requirements.git/docs/architecture.rst
--
cgit