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