Create use case example and structure
[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 and vDNS VNF Onboarding (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
19    ONAP_User -> SDC : vFW_vDNS resource onboarding  (HEAT)
20    note right : vFW ( vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\nCLAMP not shown
21    ONAP_User -> SDC : vFW_vDNS service onboarding
22    ONAP_User -> SDC : vFW_vDNS distribution
23    |||
24    ONAP_User -> SDC : vFW2_vDNS2 resource onboarding (TOSCA)
25    ONAP_User -> SDC : vFW2_vDNS2 service onboarding
26    ONAP_User -> SDC : vFW2_vDNS2 distribution
27    |||
28    SDC -> SO : artifact distribution
29    SDC -> AAI : artifact distribution
30    SDC -> APPC : artifact distribution
31    SDC -> SDNC : VNF preload data (vFW_vDNS and vFW2_vDNS2) ?
32    SDC -> DCAE : Telemetry to Collect and CLAMP triggers
33    SDC -> Policy : Control Loop Policies (see CLAMP flow)
34    note left: policy may cut through to Policy GUI
35    @enduml
36
37 Instantiation
38 -------------
39
40 .. uml::
41
42    @startuml
43    title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
44    participant UseCaseUI
45    participant ONAP_User
46    Participant SDC
47    Participant VID
48    Participant SO
49    UseCaseUI -> AAI : populate cloud inventory
50    ONAP_User -> VID : vFW_vDNS deployment
51    VID -> SDC : Lookup VNF artifacts
52    VID -> AAI : Lookup cloud locations, subscriber
53    VID -> SO : vFW_vDNS instantiation\n(base modules)
54    SO -> AAI : inventory update
55    SO -> SDNC : Generic VNF API\n(reserved)
56    SO -> Multi_VIM : vFW_vDNS Heat template + ENV file
57    Multi_VIM -> CloudAPI : vFW_vDNS Heat template + ENV file or\n ARM Tempalte + Parameters + LinuxExtensionScripts
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 right : 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 competion
69    SO -> Multi_VIM : Replaces Robot HEATBridge to pull data from cloud
70    Multi_VIM -> CloudAPI : VM data from cloud\n(public cloud will be less than if owner operated)
71    Multi_VIM -> SO : cloud data
72    SO -> AAI : Update with cloud data
73    |||
74    ONAP_User -> VID : vFW2_vDNS2 deployment (TOCA based)
75    VID -> SDC : Lookup VNF artifacts
76    VID -> AAI : Lookup cloud locations, subscriber
77    VID -> SO : vFW2_vDNS2 instantiation\n(base modules)
78    SO -> AAI : inventory update
79    SO -> SDNC : Generic VNF API\n(reserved)
80    SO -> Multi_VIM : vFW2_vDNS2 TOSCA template + ENV file
81    Multi_VIM -> CloudAPI : vFW_vDNS TOSCA template + ENV file or\n ARM Template + Parameters + LinuxExtensionScripts
82    CloudAPI -> Hypervisor : vFW2_vDNS2 Infrastructure instantiation
83    Hypervisor -> vFW2_vDNS2 : Nova/Neutron Instantiation
84    Hypervisor -> CloudAPI : complete
85    CloudAPI -> Multi_VIM : complete
86    Multi_VIM -> SO : complete
87    note right : SO may poll for completion
88    SO -> SDNC:  Generic VNF API\n(activated)
89    note right : on failure from Openstack SO issues rollback to SDNC
90    SDNC -> AAI : L3 Network resource update
91    SO -> VID : complete
92    note right : VID will poll for competion
93    SO -> Multi_VIM : Replaces Robot HEATBridge to pull data from cloud
94    Multi_VIM -> CloudAPI : VM data from cloud\n(public cloud will be less than if owner operated)
95    Multi_VIM -> SO : cloud data
96    SO -> AAI : Update with cloud data
97    @enduml
98
99