summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2020-11-25 13:38:38 +0000
committerGerrit Code Review <gerrit@onap.org>2020-11-25 13:38:38 +0000
commita0a263a26b220494a6efc9621507912715986cb6 (patch)
tree39b168610f47727d7edacdefc53ad0c64a529181
parentba9b727fd04fbab8b321e885fcc5cec4187b99e3 (diff)
parent01570f3299cde3eaaa2b33ef5bf777645de8e099 (diff)
Merge "Cleanup use case part in doc repo" into guilin
-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/use-cases/index.rst14
-rw-r--r--docs/use-cases/vfw.rst74
4 files changed, 0 insertions, 177 deletions
diff --git a/docs/guides/onap-developer/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst
deleted file mode 100644
index d9dc0d202..000000000
--- a/docs/guides/onap-developer/use-cases/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. 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
deleted file mode 100644
index 2f83102a9..000000000
--- a/docs/guides/onap-developer/use-cases/vfw.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-.. 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/use-cases/index.rst b/docs/use-cases/index.rst
deleted file mode 100644
index cc076b1c5..000000000
--- a/docs/use-cases/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. 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.
-
-ONAP Use Cases
-==============
-
-Example uses case descriptions and sequence diagrams illustrating
-interactions between platform components.
-
-.. toctree::
- :maxdepth: 1
-
- vfw.rst
diff --git a/docs/use-cases/vfw.rst b/docs/use-cases/vfw.rst
deleted file mode 100644
index beef17caa..000000000
--- a/docs/use-cases/vfw.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-.. 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_usecase:
-
-vFirewall
-=========
-
-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