From 259bf4d16dd04ce6ad4537ed1616be6397215523 Mon Sep 17 00:00:00 2001
From: Rich Bennett <rb2745@att.com>
Date: Thu, 14 Jun 2018 00:15:29 -0400
Subject: Correct references and add release notes

Correct gerrit URL, architecture, and API refrences
Position Use Case Diagrams in Developer Section

Change-Id: I149aad66844e343697771a7a3e4db14ff3a3daea
Issue-ID: DOC-278
Signed-off-by: Rich Bennett <rb2745@att.com>
---
 docs/guides/onap-developer/use-cases/index.rst | 15 ++++++
 docs/guides/onap-developer/use-cases/vfw.rst   | 74 ++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 docs/guides/onap-developer/use-cases/index.rst
 create mode 100644 docs/guides/onap-developer/use-cases/vfw.rst

(limited to 'docs/guides/onap-developer/use-cases')

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
+
-- 
cgit 1.2.3-korg