update vfc doc
[vfc/nfvo/lcm.git] / docs / platform / architecture.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4
5 VF-C Architecture
6 -----------------
7 VF-C High Level Architecture.
8
9
10 |image0|
11
12 .. |image0| image:: vfc-internal-component.png
13    :width: 5.97047in
14    :height: 4.63208in
15
16 This shows all VF-C components, each component is a standalone microservice, these microservice including:
17
18 * nslcm is the core components, mainly responsible for network service management.
19 * catalog is used to package management, including NS/VNF/PNF package management.
20 * Resource Manager is used to management the instance created by VF-C and also responsible for resource granting.
21 * SVNFM Driver, now VF-C has three vendor's Specific VNFM driver, including nokia/huawei/zte driver, each driver is a microservice.
22 * GVNFM Driver, now have two generic VNFM driver, including gvnfm driver and juju driver. 
23 * SFC Driver, it migrate from Open-O seed code and now haven't been used in any usecase in ONAP. 
24 * Wfengine-mgrservice, it provides the workflow management service, now it has been integrated with activiti workflow and provide the unified interface to external components.
25 * Wfengine-activiti, it is as the activiti work flow microservice.
26 * Multivim-proxy,provide the multivim indirect mode proxy which can forward virtual resource requests to multivim and do some resource checking.  
27 * EMS Driver, used for VNF performance and alarm data collection and report to DCAE VES collector.
28 * GVNFM, it includes three micorservice: vnflcm, vnfmgr and vnfres and the core is vnflcm which responsible for VNF life cycle management.
29 * DB, provide database services for each VF-C component.  
30
31 Note:
32   a. SFC Driver migrated from Open-O seed code and now haven't been used in any usecase in ONAP. 
33   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.
34   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. 
35
36  
37 |image1|
38
39 .. |image1| image:: vfc-dependence.png
40    :width: 5.97047in
41    :height: 4.63208in
42    
43 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.
44
45 * NFVO provides north bound interface to SO to take part in fulfilling the orchestration and operation of end2end service.And provides standard south bound interface to VNFMs. 
46
47 * GVNFM provides LCM for VNFs which do not require a vendor VNFM and works with NFV-O component to take part in fulfilling the LCM of NS.
48
49 * VF-C provides VNFM driver interfaces, vendor can implement these integrates to integrate with VF-C. Now, VF-C has integrated with three vendor VNFM, including ZTE, Huawe, Nokia. 
50
51 * In addition, VF-C also provides interface to Policy and works with DCAE for Close Loop Automation.
52    
53 * In Casablanca release, VF-C also integrated with OOF to do the resource homing and placement.