Cherry pick beijing improvements to master
Replicating changes made when finalizing Beijing branch
in the doc master branch.
Change-Id: Ib1da658aef8cb84f896c6abac23631579ec0b80c
Issue-ID: DOC-280
Signed-off-by: Rich Bennett <rb2745@att.com>
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 8ae5aab..f1a1171 100644
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -35,9 +35,9 @@
DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
+ SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/offeredapis.html>
SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst>
VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
- NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
Common Services
---------------
@@ -46,13 +46,15 @@
:maxdepth: 1
:titlesonly:
- AAI - Active and Available Inventory Common <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
- AAI - Active and Available Inventory ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst>
- DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+ AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
+ AAI ESR <../../../submodules/aai/esr-server.git/docs/offeredapis.rst>
+ DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+ ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
- MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
- Music <../../../submodules/music.git/docs/offeredapis.rst>
+ Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
+ MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst>
+ OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst>
VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
SDK
diff --git a/docs/guides/onap-developer/architecture/blueprint-enr.rst b/docs/guides/onap-developer/architecture/blueprint-enr.rst
index 8c1616d..a3018a1 100644
--- a/docs/guides/onap-developer/architecture/blueprint-enr.rst
+++ b/docs/guides/onap-developer/architecture/blueprint-enr.rst
@@ -1,5 +1,5 @@
ONAP Blueprint Enrichment
-~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------
The ONAP Beijing release includes four functional enhancements in the
areas of manually triggered scaling, change management, and hardware
@@ -9,7 +9,7 @@
manner, they have been incorporated into VoLTE and vCPE blueprints.
Manually Triggered Scaling
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~
Scale-out and scale-in are two primary benefits of NFV. Scaling can be
triggered manually (e.g., by a user or OSS/BSS) or automatically via a
@@ -27,7 +27,7 @@
The community has implemented manually triggered scale-out and scale-in
in combination with a specific VNF manager (sVNFM) and demonstrated this
with the VoLTE blueprint. An operator uses the Usecase UI (UUI) project
-to trigger a scaling operation. UUI communicates with the Service
+to trigger a scaleing operation. UUI communicates with the Service
Orchestrator (SO). SO uses the VF-C controller, which in turn instructs
a vendor-provided sVNFM to implement the scale-out action.
@@ -41,7 +41,7 @@
scale out action on the requested VNF.
Change Management
-^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~
NFV will bring with it an era of continuous, incremental changes instead
of periodic step-function software upgrades, in addition to a constant
@@ -69,7 +69,7 @@
upgrade through Ansible playbooks.
Hardware Platform Awareness (HPA)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Many VNFs have specific hardware requirements to achieve their
performance and security goals. These hardware requirements may range
diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst
index 3f5fb8e..520f8f9 100644
--- a/docs/guides/onap-developer/architecture/references.rst
+++ b/docs/guides/onap-developer/architecture/references.rst
@@ -28,10 +28,12 @@
:maxdepth: 1
:titlesonly:
+ APPC CDT - Application Controller Design Tool <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst>
CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst>
CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst>
+ PORTAL <../../../submodules/portal.git/docs/platform/architecture.rst>
SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>
- ../../../submodules/usecase-ui.git/docs/platform/architecture.rst
+ UUI- Usecase UI <../../../submodules/usecase-ui.git/docs/platform/architecture.rst>
VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst>
Platform Components
@@ -41,11 +43,13 @@
:maxdepth: 1
:titlesonly:
+ APPC - Application Controller <../../../submodules/appc.git/docs/APPC User Guide/APPC User Guide.rst>
DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst>
Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst>
- SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst>
- ../../../submodules/so.git/docs/architecture.rst
- NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/architecture/architecture.rst>
+ Policy <../../../submodules/policy/engine.git/docs/platform/architecture.rst>
+ SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst>
+ SO - Service Orchestrator <../../../submodules/so.git/docs/architecture.rst>
+ VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/architecture.rst>
Common Services
---------------
@@ -54,27 +58,16 @@
:maxdepth: 1
:titlesonly:
+ AAF - Application Authorization Framework <../../../submodules/aaf/authz.git/docs/sections/architecture.rst>
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>
+ AAI ESR <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst>
+ DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture/architecture.rst>
+ ExtAPI - External API/NBI <../../../submodules/externalapi/nbi.git/docs/architecture/architecture.rst>
+ Logging Framework - <../../../submodules/logging-analytics.git/docs/Logging_User_Guide/Logging_User_Guide.rst>
MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst>
+ Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-Administration-Guide.rst>
+ MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/architecture.rst>
+ OOM - ONAP Operations Manager <../../../submodules/oom.git/docs/oom_project_description.rst>
+ OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/architecture.rst>
+ VNF SDK <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>
VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/architecture.rst>
-
-
-SDKs
-----
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst>
-
-
-VNFs
-----
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index 3524cf6..41e3c70 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -1,4 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
@@ -33,6 +34,25 @@
../../../submodules/appc/deployment.git/docs/index
../../../submodules/appc.git/docs/index
+Application Authorization Framework
+-----------------------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ ../../../submodules/aaf/authz.git/docs/index
+
+Command Line Interface
+----------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ ../../../submodules/cli.git/docs/index
+
+
Closed Loop Automation Platform
-------------------------------
@@ -116,11 +136,15 @@
Integration
-----------
-* ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest<doc-release-manifest>`.
-* To install the whole ONAP (from a complete demo solution perspective) refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
+* ONAP Beijing release content is specified within a list of project
+ artifact versions available in the form of
+ a :ref:`manifest<doc-release-manifest>`.
-Logging Enhancements Project
-----------------------------
+* To install the whole ONAP (from a complete demo solution perspective)
+ refer to :ref:`Setting Up ONAP <demo-installing-running-onap-requirements>`.
+
+Logging Analytics
+-----------------
.. toctree::
:maxdepth: 2
@@ -171,18 +195,8 @@
../../../submodules/music.git/docs/index
-
-ONAP Command Line Interface
----------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/cli.git/docs/index
-
-ONAP Operations Manager (experimental)
---------------------------------------
+ONAP Operations Manager
+-----------------------
.. toctree::
:maxdepth: 2
@@ -190,8 +204,8 @@
../../../submodules/oom.git/docs/index
-ONAP Optimization Framework
---------------------------------------
+Optimization Framework
+----------------------
.. toctree::
:maxdepth: 2
@@ -200,16 +214,6 @@
../../../submodules/optf/has.git/docs/index
../../../submodules/optf/osdf.git/docs/index
-
-ONAP Use Case User Interface
-----------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/usecase-ui.git/docs/index
-
Policy Framework
----------------
@@ -273,6 +277,15 @@
../../../submodules/sdnc/parent.git/docs/index
../../../submodules/sdnc/plugins.git/docs/index
+Use Case User Interface
+-----------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ ../../../submodules/usecase-ui.git/docs/index
+
User Interface Applications
---------------------------
diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst
index 8ef2c0a..8ed4eae 100644
--- a/docs/guides/onap-developer/index.rst
+++ b/docs/guides/onap-developer/index.rst
@@ -4,8 +4,8 @@
.. _onap_developer_guides:
-ONAP Developer Guides
-=====================
+Developer Guides
+================
The following guides are provided for developers who want to
understanding or contribute to the ONAP open source.
@@ -18,4 +18,5 @@
developing/index
how-to-use-docs/index
apiref/index
+ use-cases/index
diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst
index f9b4881..d905a79 100644
--- a/docs/guides/onap-developer/settingup/index.rst
+++ b/docs/guides/onap-developer/settingup/index.rst
@@ -7,11 +7,30 @@
Setting Up ONAP
===============
-ONAP can be deployed using 2 different solutions:
+ONAP can be deployed using 3 different solutions:
+
+* Installation using Kubernetes (aka OOM). Recommended method.
+* Installation using Heat template.
+* Advanced installation to install individual components.
+
+The following table presents the required resources to deploy ONAP.
+
+ ============ === ==== =========== ============
+ Installation VM vCPU Memory (GB) Storage (GB)
+ ============ === ==== =========== ============
+ Kubernetes 4 32 128 160
+ Heat 20 88 176 1760
+ Individual 1* 1* 2* 20*
+ ============ === ==== =========== ============
+
+(*) For individual deployment, it depends on the components.
+
+The various installations can be found here:
.. toctree::
:maxdepth: 1
:titlesonly:
- onap_heat.rst
onap_oom.rst
+ onap_heat.rst
+ onap_individual.rst
diff --git a/docs/guides/onap-developer/settingup/onap_heat.rst b/docs/guides/onap-developer/settingup/onap_heat.rst
index afbbd6b..f3b545a 100644
--- a/docs/guides/onap-developer/settingup/onap_heat.rst
+++ b/docs/guides/onap-developer/settingup/onap_heat.rst
@@ -10,18 +10,17 @@
.. index:: Setting Up Full ONAP using Virtual Machines
+==============================
+**Setting Up ONAP using Heat**
+==============================
-===============================================
-**Setting Up Full ONAP using Virtual Machines**
-===============================================
-
-.. _demo-installing-running-onap:
+.. _installing-onap-heat:
**Context**
===========
ONAP may be deployed in different contexts depending on your requirements.
The recommended installation for Beijng Release over virtual machines is based
-on OpenStack HEAT Template.
+on OpenStack Heat Template.
The VNFs managed by ONAP may be deployed in different OpenStack tenants or
based on top of VMware based infrastructure. For details, refer
@@ -30,6 +29,11 @@
The current installation is based on the single tenant deployment (all the ONAP
components will be hosted in a unique tenant).
+.. note::
+ Prior to deployment of ONAP, there is no need to download manually any Docker Container.
+ The Heat deployment takes care to automatically download the Docker Containers.
+
+
.. _demo-installing-running-onap-requirements:
**Requirements**
@@ -148,9 +152,9 @@
configuration:
- Template file:
- https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml
+ https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml?h=beijing
- Environment file:
- https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env
+ https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env?h=beijing
The environment file must be customized as described in the following sections.
@@ -408,7 +412,7 @@
========================
The current ONAP installation is using the *onap.org* domain.
To use the portal on your desktop, you must configure the following information
-in your *host* file (located in /etc/hosts for Linux or
+in your *hosts* file (located in /etc/hosts for Linux or
/windows/system32/drivers/etc/hosts for Windows):
.. code-block:: bash
diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst
new file mode 100644
index 0000000..8bd92d8
--- /dev/null
+++ b/docs/guides/onap-developer/settingup/onap_individual.rst
@@ -0,0 +1,35 @@
+.. This work is licensed undera Creative Commons Attribution 4.0
+.. International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017-2018 ONAP
+
+
+.. index:: Setting Up ONAP individual components
+
+
+=========================================
+**Setting Up ONAP individual components**
+=========================================
+
+.. _installing-onap-individual:
+
+**Context**
+===========
+From a developer perspective, ONAP can be installed component per component.
+For details, refer to :ref:`the installation procedure available for each
+component<index-setting-individual-components>`.
+The advanced installation procedure is recommended only for experienced
+developers who desire to focus their attention on a few components and who
+have a deep understanding of dependencies between components.
+This type of installation is not recommended to fully install ONAP.
+
+* The list of ports used by default within ONAP is documented
+ in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
+
+* The ONAP Source Code is available through Gerrit
+ at https://gerrit.onap.org/r/#/admin/projects or Git at https://git.onap.org/.
+
+* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
+
+* ONAP Docker releases are specified by a list of project artifact versions
+ in a :ref:`manifest<doc-release-manifest>`.
diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst
index d793376..813168f 100644
--- a/docs/guides/onap-developer/settingup/onap_oom.rst
+++ b/docs/guides/onap-developer/settingup/onap_oom.rst
@@ -3,23 +3,58 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018 ONAP
-
-.. contents::
- :depth: 2
-..
-
.. index:: Setting Up Full ONAP using Containers
+====================================
+**Setting Up ONAP using Kubernetes**
+====================================
-=========================================
-**Setting Up Full ONAP using Containers**
-=========================================
+.. _installing-onap-k8s:
+
+**Context**
+===========
+
+The recommended ONAP deployment is based on Kubernetes and Docker containers.
+This method is also called deployment through OOM.
+
+The following is the recommended component version.
+
+ =========== =========
+ Software Version
+ =========== =========
+ Kubernetes 1.8.10
+ Helm 2.8.2
+ kubectl 1.8.10
+ Docker 17.03.x
+ =========== =========
+
+Creation of Kubernetes cluster is described here:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018 ONAP
+The ONAP full installation requires the following footprint:
+ - 4 VM
+ - 32 vCPU
+ - 128 GB RAM
+ - 160 GB Storage
+ONAP installation is described here:
-.. contents::
\ No newline at end of file
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
+
+.. note::
+ Prior to deployment of ONAP, there is no need to download manually any Docker container.
+ The OOM deployment takes care to automatically download the Docker containers.
+
+ It is also possible to deploy a subset of ONAP components on a single VM.
+ The VM flavor to be used depends on the number of ONAP components to be
+ deployed.
diff --git a/docs/guides/onap-developer/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst
new file mode 100644
index 0000000..d9dc0d2
--- /dev/null
+++ b/docs/guides/onap-developer/use-cases/index.rst
@@ -0,0 +1,15 @@
+.. 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.
+
+Use Cases
+=========
+
+Example uses case descriptions and sequence diagrams illustrating
+interactions between platform components.
+
+.. toctree::
+ :maxdepth: 1
+
+ vfw.rst
+ volte.rst
diff --git a/docs/guides/onap-developer/use-cases/vfw.rst b/docs/guides/onap-developer/use-cases/vfw.rst
new file mode 100644
index 0000000..2f83102
--- /dev/null
+++ b/docs/guides/onap-developer/use-cases/vfw.rst
@@ -0,0 +1,74 @@
+.. 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.
+
+vFirewall Use Case
+==================
+
+Description
+-----------
+
+Onboarding
+----------
+
+
+.. uml::
+
+ @startuml
+ title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services
+ ONAP_User -> SDC : vFW_vDNS resource onboarding (HEAT)
+ note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\
+ ONAP_User -> SDC : vFW_vDNS service onboarding
+ ONAP_User -> SDC : vFW_vDNS distribution
+ |||
+ SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+ SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+ SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+ @enduml
+
+Instantiation
+-------------
+
+.. uml::
+
+ @startuml
+ title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
+ participant ONAP_User
+ participant Robot
+ Participant SDC
+ Participant VID
+ Participant SO
+ ONAP_User -> AAI : populate cloud inventory
+ note left of AAI: manual via curl or POSTMAN
+ |||
+ ONAP_User -> VID : vFW_vDNS deployment
+ VID -> SDC : Lookup VNF artifacts
+ VID -> AAI : Lookup cloud locations, subscriber
+ VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules)
+ SO -> AAI : inventory update
+ VID -> SO : vFW_vDNS VNF Instantiation\n(base modules)
+ note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice
+ SO -> AAI : inventory update
+ ONAP_User -> SDNC : VNF API Preload VNF/VF data
+ VID -> SO : vFW_vDNS VF Instantiation\n(base modules)
+ SO -> AAI : inventory update
+ SO -> SDNC : Generic VNF API\n(assign)
+ SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters
+ Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or
+ CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation
+ Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation
+ Hypervisor -> CloudAPI : complete
+ CloudAPI -> Multi_VIM : complete
+ Multi_VIM -> SO : complete
+ note right : SO may poll for completion
+ SO -> SDNC: Generic VNF API\n(activated)
+ note left : on failure from Openstack SO issues rollback to SDNC
+ SDNC -> AAI : L3 Network resource update
+ SO -> VID : complete
+ note right : VID will poll for completion
+ ONAP_User -> Robot : run Heat Bridge
+ Robot -> CloudAPI : retrieve cloud data
+ Robot -> AAI : Update with cloud data
+ |||
+ @enduml
+
diff --git a/docs/guides/onap-provider/index.rst b/docs/guides/onap-provider/index.rst
index 4978d3c..55702a1 100644
--- a/docs/guides/onap-provider/index.rst
+++ b/docs/guides/onap-provider/index.rst
@@ -4,8 +4,8 @@
-ONAP VNF Requirements and Guidelines
-=====================================
+VNF Requirements and Guidelines
+===============================
The following includes guides and requirements are provided to
describe tasks that an xNF provider of ONAP may need to properly
diff --git a/docs/guides/onap-provider/vnfvalidator.rst b/docs/guides/onap-provider/vnfvalidator.rst
index 5c0c032..193edc7 100644
--- a/docs/guides/onap-provider/vnfvalidator.rst
+++ b/docs/guides/onap-provider/vnfvalidator.rst
@@ -1,9 +1,9 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
VNF Validation Documentation
-===========================
+============================
.. toctree::
- :maxdepth:2
+ :maxdepth: 2
../../../submodules/vvp/documentation.git/docs/index.rst
diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index aabc755..af9f6df 100644
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -4,8 +4,8 @@
-ONAP User Guides
-================
+User Guides
+===========
The following guides are provided to describe tasks that a user of
ONAP may need to perform when integrating, deploying, and operating
an instance of ONAP.