Update git submodules
[doc.git] / docs / use-cases / vfw.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
4
5 vFirewall
6 =========
7
8 Description
9 -----------
10
11 Onboarding
12 ----------
13
14
15 .. uml::
16
17    @startuml
18    title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services
19    ONAP_User -> SDC : vFW_vDNS resource onboarding  (HEAT)
20    note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\
21    ONAP_User -> SDC : vFW_vDNS service onboarding
22    ONAP_User -> SDC : vFW_vDNS distribution
23    |||
24    SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
25    SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
26    SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
27    @enduml
28
29 Instantiation
30 -------------
31
32 .. uml::
33
34  @startuml
35    title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
36    participant ONAP_User
37    participant Robot
38    Participant SDC
39    Participant VID
40    Participant SO
41    ONAP_User -> AAI : populate cloud inventory
42    note left of AAI:  manual via curl or POSTMAN
43    |||
44    ONAP_User -> VID : vFW_vDNS deployment
45    VID -> SDC : Lookup VNF artifacts
46    VID -> AAI : Lookup cloud locations, subscriber
47    VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules)
48    SO -> AAI : inventory update
49    VID -> SO : vFW_vDNS VNF Instantiation\n(base modules)
50    note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice
51    SO -> AAI : inventory update
52    ONAP_User -> SDNC : VNF API Preload VNF/VF data
53    VID -> SO : vFW_vDNS VF Instantiation\n(base modules)
54    SO -> AAI : inventory update
55    SO -> SDNC : Generic VNF API\n(assign)
56    SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters
57    Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or
58    CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation
59    Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation
60    Hypervisor -> CloudAPI : complete
61    CloudAPI -> Multi_VIM : complete
62    Multi_VIM -> SO : complete
63    note right : SO may poll for completion
64    SO -> SDNC:  Generic VNF API\n(activated)
65    note left : on failure from Openstack SO issues rollback to SDNC
66    SDNC -> AAI : L3 Network resource update
67    SO -> VID : complete
68    note right : VID will poll for completion
69    ONAP_User -> Robot : run Heat Bridge
70    Robot -> CloudAPI  :  retrieve cloud data 
71    Robot -> AAI :  Update with cloud data
72    |||
73    @enduml
74