summaryrefslogtreecommitdiffstats
path: root/docs/guides
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/onap-developer/apiref/index.rst2
-rw-r--r--docs/guides/onap-developer/architecture/references.rst2
-rw-r--r--docs/guides/onap-developer/developing/index.rst3
-rw-r--r--docs/guides/onap-developer/index.rst5
-rw-r--r--docs/guides/onap-developer/settingup/onap_individual.rst9
-rw-r--r--docs/guides/onap-developer/use-cases/index.rst15
-rw-r--r--docs/guides/onap-developer/use-cases/vfw.rst74
-rw-r--r--docs/guides/onap-user/index.rst4
-rw-r--r--docs/guides/onap-user/vnfcertifier.rst2
9 files changed, 106 insertions, 10 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 53b075b8f..f1a1171fd 100644
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -47,7 +47,7 @@ Common Services
:titlesonly:
AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
- AAI ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.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>
diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst
index beaed5cde..520f8f988 100644
--- a/docs/guides/onap-developer/architecture/references.rst
+++ b/docs/guides/onap-developer/architecture/references.rst
@@ -31,7 +31,7 @@ User Interfaces
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
+ PORTAL <../../../submodules/portal.git/docs/platform/architecture.rst>
SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>
UUI- Usecase UI <../../../submodules/usecase-ui.git/docs/platform/architecture.rst>
VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst>
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index a7877d449..a34afa908 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -139,8 +139,9 @@ 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>`.
+ refer to :ref:`Setting Up ONAP <demo-installing-running-onap-requirements>`.
Logging Analytics
-----------------
diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst
index 8ef2c0a10..8ed4eaee6 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 @@ understanding or contribute to the ONAP open source.
developing/index
how-to-use-docs/index
apiref/index
+ use-cases/index
diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst
index faac85ad7..8bd92d8a9 100644
--- a/docs/guides/onap-developer/settingup/onap_individual.rst
+++ b/docs/guides/onap-developer/settingup/onap_individual.rst
@@ -23,8 +23,13 @@ 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 or Git at https://git.onap.org/.
+* 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/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst
new file mode 100644
index 000000000..d9dc0d202
--- /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 000000000..2f83102a9
--- /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-user/index.rst b/docs/guides/onap-user/index.rst
index 189d34fd3..24cfcf134 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.
diff --git a/docs/guides/onap-user/vnfcertifier.rst b/docs/guides/onap-user/vnfcertifier.rst
index 76a96be4f..4387d0c0c 100644
--- a/docs/guides/onap-user/vnfcertifier.rst
+++ b/docs/guides/onap-user/vnfcertifier.rst
@@ -4,6 +4,6 @@ VNF Certifier
==============
.. toctree::
- :maxdepth:2
+ :maxdepth: 2
../../../submodules/vvp/documentation.git/docs/index.rst