From 6d284b3c71fb5edf4b167a2408c78b49f108cb9a Mon Sep 17 00:00:00 2001 From: yangyan Date: Tue, 9 Apr 2019 18:38:48 +0800 Subject: update vfc doc Issue-ID: VFC-1345 Change-Id: I06f1ebe49d702c2ed3dc9191164f834c103b4d7b Signed-off-by: yangyan --- docs/platform/APIs/index.rst | 31 +++++++++++++++++++++ docs/platform/APIs/vfc-api.png | Bin 0 -> 9630 bytes docs/platform/architecture.rst | 30 +++++++++++++++++++- docs/platform/gvnfm.png | Bin 96065 -> 0 bytes docs/platform/image2018-12-10_12-1-36.png | Bin 12304 -> 0 bytes docs/platform/index.rst | 10 +++++-- docs/platform/installation/index.rst | 4 +-- docs/platform/installation/installation/index.rst | 2 +- docs/platform/installation/user-guide/gvnfm.png | Bin 0 -> 96065 bytes .../user-guide/image2018-12-10_12-1-36.png | Bin 0 -> 12304 bytes .../user-guide/ns-instantiate-guide.rst | 13 +++++---- docs/platform/installation/user-guide/vim.png | Bin 0 -> 21949 bytes docs/platform/onap-arc.png | Bin 0 -> 61824 bytes docs/platform/vfc-dependence.png | Bin 0 -> 19929 bytes docs/platform/vfc-internal-component.png | Bin 0 -> 17279 bytes docs/platform/vim.png | Bin 21949 -> 0 bytes 16 files changed, 79 insertions(+), 11 deletions(-) create mode 100644 docs/platform/APIs/vfc-api.png delete mode 100644 docs/platform/gvnfm.png delete mode 100644 docs/platform/image2018-12-10_12-1-36.png create mode 100644 docs/platform/installation/user-guide/gvnfm.png create mode 100644 docs/platform/installation/user-guide/image2018-12-10_12-1-36.png create mode 100644 docs/platform/installation/user-guide/vim.png create mode 100644 docs/platform/onap-arc.png create mode 100644 docs/platform/vfc-dependence.png create mode 100644 docs/platform/vfc-internal-component.png delete mode 100644 docs/platform/vim.png (limited to 'docs/platform') diff --git a/docs/platform/APIs/index.rst b/docs/platform/APIs/index.rst index ad31664d..86eddffc 100644 --- a/docs/platform/APIs/index.rst +++ b/docs/platform/APIs/index.rst @@ -11,7 +11,38 @@ VF-C Offered APIs Now VF-C provides the NS life cycle management APIs to UUI,SO,Policy and package management APIs to UUI. For VNFM vendor, VF-C also provides the VNFM integration APIs, they can reference these APIs to implmemet their VNFMDriver to integrate with VF-C and ONAP. + |image0| + .. |image0| image:: nfvo-api.png + :width: 1000px + :height: 600px + +NFVO provided interfaces: + +* Network Service LCM interface + + Provides Network Service LCM interface(NS instantiate/scale/heal/terminate/query/…) + +* VNF Operation Granting interface + + Provides VNF Operation Granting interface and make granting decision + +* NS package management interface + + Provides runtime NS package management interface + +* VNF package management interface + + Provides runtime VNF package management interface + + +GVNFM provided interfaces: + +* VNF LCM interface + + Provides the VNF LCM interface(VNF instantiate/terminate/query/…) + +More interface defination can be found in the following part. VFC Northbound API ------------------ diff --git a/docs/platform/APIs/vfc-api.png b/docs/platform/APIs/vfc-api.png new file mode 100644 index 00000000..1f8478bb Binary files /dev/null and b/docs/platform/APIs/vfc-api.png differ diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index ca015792..d0115f77 100644 --- a/docs/platform/architecture.rst +++ b/docs/platform/architecture.rst @@ -9,7 +9,34 @@ VF-C High Level Architecture. |image0| -.. |image0| image:: vfc-arc.png +.. |image0| image:: vfc-internal-component.png + :width: 5.97047in + :height: 4.63208in + +This shows all VF-C components, each component is a standalone microservice, these microservice including: + +* nslcm is the core components, mainly responsible for network service management. +* catalog is used to package management, including NS/VNF/PNF package management. +* Resource Manager is used to management the instance created by VF-C and also responsible for resource granting. +* SVNFM Driver, now VF-C has three vendor's Specific VNFM driver, including nokia/huawei/zte driver, each driver is a microservice. +* GVNFM Driver, now have two generic VNFM driver, including gvnfm driver and juju driver. +* SFC Driver, it migrate from Open-O seed code and now haven't been used in any usecase in ONAP. +* Wfengine-mgrservice, it provides the workflow management service, now it has been integrated with activiti workflow and provide the unified interface to external components. +* Wfengine-activiti, it is as the activiti work flow microservice. +* Multivim-proxy,provide the multivim indirect mode proxy which can forward virtual resource requests to multivim and do some resource checking. +* EMS Driver, used for VNF performance and alarm data collection and report to DCAE VES collector. +* GVNFM, it includes three micorservice: vnflcm, vnfmgr and vnfres and the core is vnflcm which responsible for VNF life cycle management. +* DB, provide database services for each VF-C component. + +Note: + a. SFC Driver migrated from Open-O seed code and now haven't been used in any usecase in ONAP. + 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. + + +|image1| + +.. |image1| image:: vfc-dependence.png :width: 5.97047in :height: 4.63208in @@ -23,3 +50,4 @@ 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 diff --git a/docs/platform/gvnfm.png b/docs/platform/gvnfm.png deleted file mode 100644 index b59c8ed1..00000000 Binary files a/docs/platform/gvnfm.png and /dev/null differ diff --git a/docs/platform/image2018-12-10_12-1-36.png b/docs/platform/image2018-12-10_12-1-36.png deleted file mode 100644 index 334bae7b..00000000 Binary files a/docs/platform/image2018-12-10_12-1-36.png and /dev/null differ diff --git a/docs/platform/index.rst b/docs/platform/index.rst index 37378f2b..d0484c40 100644 --- a/docs/platform/index.rst +++ b/docs/platform/index.rst @@ -6,6 +6,12 @@ ONAP VF-C ========= +|image0| + +.. |image0| image:: onap-arc.png + :width: 3.97047in + :height: 2.63208in + As part of the integration between OpenECOMP and OPEN-O, VF-C leverages ETSI NFV MANO architecture and information model as a reference, and implements life cycle management and FCAPS of VNF and NS. * support NS and VNF lifecycle management based on the ONAP tosca and yang data model and workflow @@ -15,9 +21,9 @@ As part of the integration between OpenECOMP and OPEN-O, VF-C leverages ETSI NFV * support microservice architecture and model driven resource orchestration and management -|image0| +|image1| -.. |image0| image:: vfc-component.png +.. |image1| image:: vfc-component.png :width: 3.97047in :height: 2.63208in diff --git a/docs/platform/installation/index.rst b/docs/platform/installation/index.rst index 0750831c..d64172c2 100644 --- a/docs/platform/installation/index.rst +++ b/docs/platform/installation/index.rst @@ -8,13 +8,13 @@ VF-C Installation and User Guide :depth: 2 -VFC Insta1llation over OOM +VFC Installation over OOM -------------------------- .. toctree:: :maxdepth: 1 - installation/index + installation/index diff --git a/docs/platform/installation/installation/index.rst b/docs/platform/installation/installation/index.rst index 2fd14246..25fd89fa 100644 --- a/docs/platform/installation/installation/index.rst +++ b/docs/platform/installation/installation/index.rst @@ -1,5 +1,5 @@ VFC Insta1llation over OOM ------------------------ +-------------------------- .. toctree:: :titlesonly: diff --git a/docs/platform/installation/user-guide/gvnfm.png b/docs/platform/installation/user-guide/gvnfm.png new file mode 100644 index 00000000..b59c8ed1 Binary files /dev/null and b/docs/platform/installation/user-guide/gvnfm.png differ diff --git a/docs/platform/installation/user-guide/image2018-12-10_12-1-36.png b/docs/platform/installation/user-guide/image2018-12-10_12-1-36.png new file mode 100644 index 00000000..334bae7b Binary files /dev/null and b/docs/platform/installation/user-guide/image2018-12-10_12-1-36.png differ diff --git a/docs/platform/installation/user-guide/ns-instantiate-guide.rst b/docs/platform/installation/user-guide/ns-instantiate-guide.rst index c8bd1fe8..12c40a19 100644 --- a/docs/platform/installation/user-guide/ns-instantiate-guide.rst +++ b/docs/platform/installation/user-guide/ns-instantiate-guide.rst @@ -8,6 +8,7 @@ VF-C supports vCPE use case in R3, all VNFs are deployed through VF-C GVNFM . This page describes how to use VF-C to instantiate NS Before you try, please prepare two csar file: + * VNF csar * NS csar @@ -77,6 +78,7 @@ ESR Registration Before we instantiate a service, we need to register vim and vnfm which is used to deploy vnfs. + 1.VIM Registration |image1| @@ -97,9 +99,10 @@ Before we instantiate a service, we need to register vim and vnfm which is used :height: 600px -Note: type should be gvnfmdriver which is the same with gvnfmdriver microservice -url is the msb-iag NodeIp:port -vim corresponds to cloudowner_cloudregionid which registered in step1 +Note: + a. type should be gvnfmdriver which is the same with gvnfmdriver microservice. + b. url is the msb-iag NodeIp:port. + c. vim corresponds to cloudowner_cloudregionid which registered in step1. Package Onboarding ++++++++++++++++++ @@ -140,8 +143,8 @@ Note: -F 'file=@C:\ONAP\Integration\R3\vCPE\vnf-vsn.csar' Note: - a.38037a12-a0d4-4aa4-ac50-cd6b05ce0b24 is the vnf_pkg_id which we get from the first step. - b.-F is used to specify the local vnf package file + a. 38037a12-a0d4-4aa4-ac50-cd6b05ce0b24 is the vnf_pkg_id which we get from the first step. + b. -F is used to specify the local vnf package file 3. Create NS package record in catalog DB diff --git a/docs/platform/installation/user-guide/vim.png b/docs/platform/installation/user-guide/vim.png new file mode 100644 index 00000000..31073be4 Binary files /dev/null and b/docs/platform/installation/user-guide/vim.png differ diff --git a/docs/platform/onap-arc.png b/docs/platform/onap-arc.png new file mode 100644 index 00000000..756fe56d Binary files /dev/null and b/docs/platform/onap-arc.png differ diff --git a/docs/platform/vfc-dependence.png b/docs/platform/vfc-dependence.png new file mode 100644 index 00000000..f4c74ba1 Binary files /dev/null and b/docs/platform/vfc-dependence.png differ diff --git a/docs/platform/vfc-internal-component.png b/docs/platform/vfc-internal-component.png new file mode 100644 index 00000000..61ded572 Binary files /dev/null and b/docs/platform/vfc-internal-component.png differ diff --git a/docs/platform/vim.png b/docs/platform/vim.png deleted file mode 100644 index 31073be4..00000000 Binary files a/docs/platform/vim.png and /dev/null differ -- cgit 1.2.3-korg