diff options
| -rw-r--r-- | docs/platform/APIs/index.rst | 2 | ||||
| -rw-r--r-- | docs/platform/architecture.rst | 105 | ||||
| -rw-r--r-- | docs/platform/consumedapis.rst | 29 | ||||
| -rw-r--r-- | docs/platform/installation/installation/index.rst | 2 | ||||
| -rw-r--r-- | docs/platform/installation/installation/vfc-over-oom.rst | 2 | ||||
| -rw-r--r-- | docs/platform/vfc-heal.png | bin | 0 -> 49733 bytes | |||
| -rw-r--r-- | docs/platform/vfc-instantiate.png | bin | 0 -> 90967 bytes | |||
| -rw-r--r-- | docs/platform/vfc-terminate.png | bin | 0 -> 82687 bytes |
8 files changed, 125 insertions, 15 deletions
diff --git a/docs/platform/APIs/index.rst b/docs/platform/APIs/index.rst index 86eddffc..3d58652f 100644 --- a/docs/platform/APIs/index.rst +++ b/docs/platform/APIs/index.rst @@ -13,7 +13,7 @@ For VNFM vendor, VF-C also provides the VNFM integration APIs, they can referenc |image0| - .. |image0| image:: nfvo-api.png + .. |image0| image:: vfc-api.png :width: 1000px :height: 600px diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index d0115f77..78f7938e 100644 --- a/docs/platform/architecture.rst +++ b/docs/platform/architecture.rst @@ -3,14 +3,18 @@ VF-C Architecture ------------------ -VF-C High Level Architecture. +================== +.. contents:: + :depth: 2 + +VF-C Internal Component +----------------------- |image0| .. |image0| image:: vfc-internal-component.png - :width: 5.97047in + :width: 6.97047in :height: 4.63208in This shows all VF-C components, each component is a standalone microservice, these microservice including: @@ -33,11 +37,14 @@ Note: b. Resource resmanagement is used to do the resource granting, but now VF-C has been integrated with OOF, this component will be deprecated in the future release. c. DB provides the stand-alone database microservice in casablanca release, but now VF-C leverages OOM shared MariaDB-Gelera cluster. This repo still has redis to be used by VF-C component. - + +VF-C External Dependency +------------------------ + |image1| .. |image1| image:: vfc-dependence.png - :width: 5.97047in + :width: 6.97047in :height: 4.63208in As you can see in this picture, VF-C has many dependencies with other projects, such as SO, Policy, A&AI, SDC, DCAE, Multi-cloud and so on. @@ -50,4 +57,90 @@ As you can see in this picture, VF-C has many dependencies with other projects, * In addition, VF-C also provides interface to Policy and works with DCAE for Close Loop Automation. -* In Casablanca release, VF-C also integrated with OOF to do the resource homing and placement.
\ No newline at end of file +* In Casablanca release, VF-C also integrated with OOF to do the resource homing and placement. + + +VF-C Usecase and Workflow +------------------------- + +VF-C support VoLTE use case, vCPE use case in last three release and will support CCVPN use case in Dublin release. + + - VoLTE usecase information can be found : https://wiki.onap.org/pages/viewpage.action?pageId=6593603 + - vCPE usecase information can be found : https://wiki.onap.org/pages/viewpage.action?pageId=3246168 + - CCVPN usecase information can be found : https://wiki.onap.org/pages/viewpage.action?pageId=45296665 + +Taking VoLTE as an example to describe the VF-C internal workflow: + +1. VF-C Instantiate + +|image2| + +.. |image2| image:: vfc-instantiate.png + :width: 6.97047in + :height: 4.63208in + +The workflow: + +* SO send request to LCM to deploy vIMS+vEPC network service. +* LCM talk with Res Manager and then A&AI to create NS instances in A&AI inventory. +* LCM get NSD from VF-C catalog. +* LCM parse the NS model via TOSCA parser to decompose NS to VNFs and recognize the relationship between VNFs. +* LCM init workflow context and execute NS instantiation. +* Workflow will invoke LCM to instantiate VLs between VNFs. +* LCM talk with Multi-VIM to create virtual network connections between VNFs if needed. +* LCM talk with Res manager to create related virtual link instances to A&AI inventory(Not included in R1). +* When VL created ,workflow will invoke LCM to instantiate VNFs. +* LCM send request to S-VNFM Driver and wok with S-VNFM to deploy each VNFs. +* Aligned with ETSI specs work flow, VNFM need to send granting resource request to LCM,LCM transfer this request to Res manager and then response the granting result and related VIM information(such as url/username/password, etc) to VNFM. +* VNFM call VIM API to deploy VNF into VIM. +* VNFM send notification to LCM to notify the changes of virtual resources, including VDU/VL/CP/VNFC, etc. +* LCM talk to Res manager to create/update related records in A&AI inventory + +2.VF-C Terminate + +|image3| + +.. |image3| image:: vfc-terminate.png + :width: 6.97047in + :height: 4.63208in + +The workflow: + +* SO talk with VF-C to request deletion of vIMS/vEPC network services +* Lcm work with Res manager to check all vIMS/vEPC instances in A&AI +* LCM invoke workflow to delete NS instance +* First, workflow will execute deleting VNFs by invoke LCM +* LCM talk with S-VNFM Driver o request deletion of VNFs and related resources +* Aligned with ETSI specs work flow, VNFM will delete/release virtual resources with the granting to LCM +* LCM transfer the grant request to Res Manager and then response the granting result and related VIM information(such as url/username/password, etc) to VNFM. +* VNFM delete VNFs and related resources and notify the changes(releasing) of virtual resources to LCM +* Lcm talk with Res Manager to update/delete related resource instances in A&AI inventory +* When above work finish, workflow will delete VLs +* LCM talk with Multi-VIM to request deletion of virtual network connected to VNFs +* Multi-VIM delete related virtual network resources, such as network, sub-network and port, etc. +* LCM talk with Res Manager to update/delete related VL resource instances in A&AI inventory(Not included in R1) +* LCM talk with Res Manager to update/delete related NS instances in A&AI inventory + +3. VF-C Healing + +|image4| + +.. |image4| image:: vfc-heal.png + :width: 6.97047in + :height: 4.63208in + +The workflow: + +* EMS Driver collects VNF service level FCAPS in real-time or period. +* EMS Driver will transfe VNF service level FCAPS metrics to DCAE with VES data format. +* Data filtering/cleaning inside DCAE, DCAE can send related events to data bus. Holmes can keep track the events published to data bus and do the alarm correlation analysis based on the imported rules and Holmes send the result, the root cause, to the event bus. +* Policy engine subscribe related topic on event bus. After receiving auto-healing triggering events, matching the events with exist rules. +* Policy invoke VF-C APIs to do the action of auto-healing once matching events with healing rules. +* LCM talk with VNFM driver to restart VNF and receive the changes of virtual resources. +* LCM talk with Res manager to update/create related instances information to A&AI inventory according to the changes of resources. + + +If you would like to know more details about vCPE, you can refer https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide + + +
\ No newline at end of file diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index 08439551..5a125d16 100644 --- a/docs/platform/consumedapis.rst +++ b/docs/platform/consumedapis.rst @@ -5,12 +5,29 @@ Consumed APIs ============= References to APIs offered by other components - - A&AI: Use A&AI API to operate the instance data stored in A&AI, this opration includes CURL - - SDC: Use Catalog external API to query csar package - - DCAE: Use DCAE Ves collector API to report FCAPS data to DCAE - - MSB: Use MSB to register and find microservice - - Modeling: Use nfvparser API to parse tosca template - - Multicloud: Use Multicloud API to CRUD virtual resource +NFVO consumed interfaces: + + - VNF LCM Interface, from: Generic VNFM controller, SVNFM + - Inventory Service Interface, from: Available and Active Inventory + - Catalog Synchronization Interface, from: SDC + - Generic VIM Interface, From: Multi-cloud + - Data report Interface, From: DCAE + - Tosca parser Interface, From: Modeling + - Service registration and discovery, From: MSB + - Homing Request Interface, from: Optimization Framework + + +GVNFM consumed interfaces: + + - Catalog and notification Interface, from: NFVO + - Inventory Interface, from: A&AI + - Tosca parser Interface, From: Modeling + - Generic VIM Interface, From: Multi-cloud + - Service registration and discovery, From: MSB + + + + diff --git a/docs/platform/installation/installation/index.rst b/docs/platform/installation/installation/index.rst index 25fd89fa..ec17859a 100644 --- a/docs/platform/installation/installation/index.rst +++ b/docs/platform/installation/installation/index.rst @@ -1,4 +1,4 @@ -VFC Insta1llation over OOM +VFC Installation over OOM -------------------------- .. toctree:: diff --git a/docs/platform/installation/installation/vfc-over-oom.rst b/docs/platform/installation/installation/vfc-over-oom.rst index 29a01a21..119b0700 100644 --- a/docs/platform/installation/installation/vfc-over-oom.rst +++ b/docs/platform/installation/installation/vfc-over-oom.rst @@ -2,7 +2,7 @@ :depth: 3 .. - **VFC Insta1llation over OOM** + **VFC Installation over OOM** **V0.1** **1 Scope** diff --git a/docs/platform/vfc-heal.png b/docs/platform/vfc-heal.png Binary files differnew file mode 100644 index 00000000..213553bf --- /dev/null +++ b/docs/platform/vfc-heal.png diff --git a/docs/platform/vfc-instantiate.png b/docs/platform/vfc-instantiate.png Binary files differnew file mode 100644 index 00000000..3d76785a --- /dev/null +++ b/docs/platform/vfc-instantiate.png diff --git a/docs/platform/vfc-terminate.png b/docs/platform/vfc-terminate.png Binary files differnew file mode 100644 index 00000000..4859500f --- /dev/null +++ b/docs/platform/vfc-terminate.png |
