Merge "Update vCPE with Tosca INT doc"

2 files changed, 116 insertions, 155 deletions

diff --git a/docs/docs_vCPE with Tosca VNF.rst b/docs/docs_vCPE with Tosca VNF.rst
index 75aefdad2..4a5b6fc69 100644
--- a/docs/docs_vCPE with Tosca VNF.rst
+++ b/docs/docs_vCPE with Tosca VNF.rst
@@ -4,25 +4,73 @@ vCPE with Tosca VNF
 ----------------------------
 
 VNF Packages and NS Packages 
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE
 
+5 VNFs are here for the ONAP vCPE use case. This VNFD is transformed manually from vCPE heat template.
+Please run "./generate_csar.sh" to create the CSAR package files for these 5 VNFS. CSAR package file is just a zip formatted file. If you want to use SRIOV SRIOV-NIC", please run "./generate_csar.sh sriov" to create the CSAR package files for SRIOV.
+All the generated VNF packges can be found in the following link:
 - VNF packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide
 - NS packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide
 
 Description
 ~~~~~~~~~~~
 The vCPE with Tosca VNF shows how to use ONAP to deploy tosca based vCPE. ONAP Casablanca release supports deployment,termination and manual heal Tosca based vCPE. User can trigger the above operation via UUI. and User can first chose Network serivce type and conrresponding service template in UUI and then UUI will directly invoke VF-C Northbound interfaces to do the life cycle management. In Casablanca release, we bypass SO, in the following release, we can add SO to the workflow. The main projects involved in this use case include: SDC, A&AI, UUI，VF-C, Multicloud，MSB, Policy，OOF.
-
+The use case is composed of five virtual functions (VFs): Infrastructure including vDNS, vDHCP, vAAA(Authorization, Authentication, Accounting) and vWEB, vBNG(Virtual Broadband Network Gateway), vGMUX(Virtual Gateway Multiplexer), vBRGEMU(Bridged Residential Gateway) and vGW(Virtual Gateway). Infrastructure VF run in one VM. the other VFs run in separate four VMs. We will send much data from vBRGEMU to vGW. we need to accelarate it using SRIOV-NIC.
 The original vCPE Use Case Wiki Page can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=3246168
 
 How to Use
 ~~~~~~~~~~
-Design Time:
 
+
+Configuration:
+~~~~~~~~~~~~~~
+1) VIM Configuration
+If you want to use SRIOV-NIC, you need first config SRIOV NIC to refer to [1].
+[1] https://docs.openstack.org/ocata/networking-guide/config-sriov.html
+
+ONAP managing 1 cloud-region which have three flavors.
+Flavor 11:
+2 vcpus, 1 Gbytes of memory, 20Gb disk
+Numa page size: 2Mbytes and number pages 512
+::
+
+  openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2
+
+Flavor 12:
+2 vcpus, 2 Gbytes of memory, 20Gb disk
+Numa page size: 2Mbytes and number pages 1024
+::
+
+  openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2
+
+Flavor 13:
+2 vcpus, 4 Gbytes of memory, 20Gb disk
+Huge page size: 2Mbytes and number pages 2048
+1 SRIOV-NIC VF
+::
+
+  openstack flavor create onap.hpa.flavor13 -id auto --ram 4096 --disk 20 -vcpus 2
+  openstack flavor set onap.hpa.flavor11 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-1234-5678-physnet1:1
+  openstack aggregate create --property sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 hpa_aggr11
+
+comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network.
+
+2)Policy Configuration
+After the patch https://gerrit.onap.org/r/#/c/73502/ is merged. With the generated policy and do some manually update as follows, the service could be distributed successfully and the Policy/VFC/OOF could work as excepted.
+
+- Need manually modify policy item because the “vendor id” and “PCI device id” and “architecture” must be changed in different VIMs since we have different PCI devices in different VIMs
+- The value of mandatory in CSAR is “true”, OOF is case intensive, it needs to use “True”. Have to update it. suggest OOF to use ignoreCase in R4.
+- The attribute key in CSAR is pciNumDevices, but the responding one in OOF/Mutlicloud is pciCount.  Suggest keeping alignment in R4.
+- The policy scope has to add a value “us” into it which is a configuration issue in OOF side. Policy side also need do improvement to deal with policy scope automatically append instead of replacement so such policy could be used by several services at the same time.
+
+Design Time:
+~~~~~~~~~~~
 1) Because SDC doesn't export ETSI aigned VNF package and NS package, so in this release, we put the real ETSI aligned package as package artifact.
 2) When design Network service in SDC, should assign "gvnfmdriver" as the value of nf_type in Properties Assignment. so that VF-C can know will use gvnfm to manage VNF life cycle.
 
 Run Time:
+~~~~~~~~
 1) First onboard VNF/NS package from SDC to VF-C catalog in sequence.
 2) Trigger the NS operation via UUI
 
@@ -30,17 +78,78 @@ More details can be fonud here: https://wiki.onap.org/display/DW/vCPE+with+Tosca
 
 Test Status and Plans
 ~~~~~~~~~~~~~~~~~~~~~
+The test plan 3 in https://wiki.onap.org/pages/viewpage.action?pageId=41421112.
+Test Plan 3: VF-C HPA testing
+This test plan covers the tests related to testing
+Support for the vCPE use case in VF-C
+Use vCPE (Infra, vGW, vBNG, vBRGEMU and vGMUX)
+
+Infra part of  policy asking for:
+::
+
+  2 vcpus
+  >= 2Gbytes of memory
+  > 40Gbytes of disk
+
+vGW part of policy asking for:
+::
+
+  2 vcpus
+  >=4Gbytes of memory
+  >= 40Gbytes of disk
+  Numa page size: 2Mbytes and pages 1024
+  with one SRIOV-NIC
+
+vBNG part of policy asking for:
+::
+
+  2 vcpus
+  >= 2Gbytes of memory
+  > 40Gbytes of disk
+  Numa page size: 2Mbytes and pages 1024
+  with one SRIOV-NIC
+
+vBGREMU part of policy asking for:
+::
+
+  2 vcpus
+  >= 2Gbytes of memory
+  >= 40Gbytes of disk
+  Numa page size: 2Mbytes and pages 1024
+  with one SRIOV-NIC
+
+vGMUX part of policy asking for:
+::
+
+  2 vcpus
+  >= 2Gbytes of memory
+  > 40Gbytes of disk
+  Numa page size: 2Mbytes and pages 1024
+  with one SRIOV-NIC
+
+Instantiate the VNF
+Check for results:
+It would have selected flavor13 for vGW, vBNG, vBRGEMU and vGMUX VMs. It would have selected flavor13 and flavor12 for Infrastructure.
+
 This case completed all tests as found here: https://wiki.onap.org/display/DW/vCPE+with+TOSCA+VNF+Integration+Test++-+Test+status
 
 Known Issues and Resolutions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-1) VF-C catalog config should be updated with the right SDC URL and user/pwd
 
+- Some SDC NS data model is not aligned to VFC NS data model, VFC NS also according to ETSI SOL0001. we also can refer to https://jira.onap.org/browse/SDC-1897. we have a workaround for this issue, we put the service as artifact file and distribute to VFC.
+- NFV Tosca parser bug https://jira.opnfv.org/browse/PARSER-187. we also filed a bug in VFC https://jira.onap.org/browse/VFC-1196.
+- 'artifacts' definition is missing in the exported csar's VDU node, we also can refer to https://jira.onap.org/browse/SDC-1900. It’s a very hacky workaround in VFC’s GVFNM. Because currently the only use case will use GVFNM is vCPE, which only uses the ubuntu16.04 image, so GVFNM just makes the ubuntu16.04 image as the default if the "sw_image" artifact is missing in the SDC’s exported CSAR.
+- OOF patch https://gerrit.onap.org/r/#/c/73332/ is not accepted by 1.2.4 image. 1.2.5 is available in nexus3 repo. But not available in Casablanca release. If you want to use it, you can use 1.2.5-SNAPSHOT-latest. If you use 1.2.4 image, you also need to modify code according to the patch.
+- vnflcm notification error patch  https://gerrit.onap.org/r/#/c/73852/
+- grant error patch not merged into VF-C 1.2.2 image: https://gerrit.onap.org/r/#/c/73833/  and https://gerrit.onap.org/r/#/c/73770/
+- VF-C catalog config should be updated with the right SDC URL and user/pwd
 Resolution: Disable VFC catalog livenessprobe and update configuration
 
-- edit dev-vfc-catalog deployment
-- remove livenessprobe section
-- enter into catalog pod and update configuration
+a) edit dev-vfc-catalog deployment
+b) remove livenessprobe section
+c) enter into catalog pod and update configuration
+::
+
 kubectl -n onap exec -it dev-vfc-catalog-6978b76c86-87722  /bin/bash
 config file location: service/vfc/nfvo/catalog/catalog/pub/config/config.py 
 Update the SDC configuration as follows:
@@ -48,15 +157,3 @@ SDC_BASE_URL = "http://msb-iag:80/api"
 SDC_USER = "aai"
 SDC_PASSWD = "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U"
 
-2) nfvtosca parser bug
-
-nfvtoscaparse has error when parse sdc distribution package.
-To ignore that error, we need either apply the patch at https://jira.opnfv.org/browse/PARSER-187 locally in nfv-toscaparser which VFC uses or wait for nfv-toscaparser got that fixed. 
-
-3) grant error patch
-https://gerrit.onap.org/r/#/c/73833/
-https://gerrit.onap.org/r/#/c/73770/
-
-4) vnflcm notification error patch
-https://gerrit.onap.org/r/#/c/73852/
-
diff --git a/docs/docs_vcpe_tosca.rst b/docs/docs_vcpe_tosca.rst
deleted file mode 100644
index faa4e7590..000000000
--- a/docs/docs_vcpe_tosca.rst
+++ /dev/null
@@ -1,136 +0,0 @@
-vCPE of Tosca Use Case
-----------------------
-
-Source files
-~~~~~~~~~~~
-
-vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE
-
-5 VNFs are here for the ONAP vCPE use case. This VNFD is transformed manually from vCPE heat template.
-Please run "./generate_csar.sh" to create the CSAR package files for these 5 VNFS. CSAR package file is just a zip formatted file. If you want to use SRIOV SRIOV-NIC", please run "./generate_csar.sh sriov" to create the CSAR package files for SRIOV.
-
-
-Description
-~~~~~~~~~~
-
-The use case is composed of five virtual functions (VFs): Infrastructure including vDNS, vDHCP, vAAA(Authorization, Authentication, Accounting) and
-vWEB, vBNG(Virtual Broadband Network Gateway), vGMUX(Virtual Gateway Multiplexer), vBRGEMU(Bridged Residential Gateway) and vGW(Virtual Gateway).
-Infrastructure VF run in one VM. the other VFs run in separate four VMs. We will send much data from vBRGEMU to vGW. we need to accelarate it using SRIOV-NIC.
-
-
-Test Plan:
-~~~~~~~~~~~~~~~~~~
-
-The test plan 3 in https://wiki.onap.org/pages/viewpage.action?pageId=41421112.
-Test Plan 3: VF-C HPA testing
-This test plan covers the tests related to testing
-Support for the vCPE use case in VF-C
-
-Use vCPE (Infra, vGW, vBNG, vBRGEMU and vGMUX)
-
-Infra part of  policy asking for:
-::
-
-  2 vcpus
-  >= 2Gbytes of memory
-  > 40Gbytes of disk
-
-vGW part of policy asking for:
-::
-
-  2 vcpus
-  >=4Gbytes of memory
-  >= 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
-
-vBNG part of policy asking for:
-::
-
-  2 vcpus
-  >= 2Gbytes of memory
-  > 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
-
-vBGREMU part of policy asking for:
-::
-
-  2 vcpus
-  >= 2Gbytes of memory
-  >= 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
-
-vGMUX part of policy asking for:
-::
-
-  2 vcpus
-  >= 2Gbytes of memory
-  > 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
-
-Instantiate the VNF
-Check for results:
-It would have selected flavor13 for vGW, vBNG, vBRGEMU and vGMUX VMs. It would have selected flavor13 and flavor12 for Infrastructure.
-
-Test Steps:
-~~~~~~~~~~
-
-VIM Configuration:
-^^^^^^^^^^^^^^^^^^
-
-If you want to use SRIOV-NIC, you need first config SRIOV NIC to refer to [1].
-[1] https://docs.openstack.org/ocata/networking-guide/config-sriov.html
-
-ONAP managing 1 cloud-region which have three flavors.
-Flavor 11:
-2 vcpus, 1 Gbytes of memory, 20Gb disk
-Numa page size: 2Mbytes and number pages 512
-::
-
-  openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2
-
-Flavor 12:
-2 vcpus, 2 Gbytes of memory, 20Gb disk
-Numa page size: 2Mbytes and number pages 1024
-::
-
-  openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2
-
-Flavor 13:
-2 vcpus, 4 Gbytes of memory, 20Gb disk
-Huge page size: 2Mbytes and number pages 2048
-1 SRIOV-NIC VF
-::
-
-  openstack flavor create onap.hpa.flavor13 -id auto --ram 4096 --disk 20 -vcpus 2
-  openstack flavor set onap.hpa.flavor11 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-1234-5678-physnet1:1
-  openstack aggregate create --property sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 hpa_aggr11
-
-comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network.
-
-Policy Configuration:
-^^^^^^^^^^^^^^^^^^^^^
-
-After the patch https://gerrit.onap.org/r/#/c/73502/ is merged. With the generated policy and do some manually update as follows, the service could be distributed successfully and the Policy/VFC/OOF could work as excepted.
-
-- Need manually modify policy item because the “vendor id” and “PCI device id” and “architecture” must be changed in different VIMs since we have different PCI devices in different VIMs
-- The value of mandatory in CSAR is “true”, OOF is case intensive, it needs to use “True”. Have to update it. suggest OOF to use ignoreCase in R4.
-- The attribute key in CSAR is pciNumDevices, but the responding one in OOF/Mutlicloud is pciCount.  Suggest keeping alignment in R4.
-- The policy scope has to add a value “us” into it which is a configuration issue in OOF side. Policy side also need do improvement to deal with policy scope automatically append instead of replacement so such policy could be used by several services at the same time.
-
-
-Running the Use Case
-~~~~~~~~~~~~~~~~~~~
-
-We design vCPE in SDC and distribute it to VFC and Policy and UUI. We can click onboarding VNF and onboarding NS. we can instance it.
-
-Known issues and resolution
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- Some SDC NS data model is not aligned to VFC NS data model, VFC NS also according to ETSI SOL0001. we also can refer to https://jira.onap.org/browse/SDC-1897. we have a workaround for this issue, we put the service as artifact file and distribute to VFC.
-- NFV Tosca parser bug https://jira.opnfv.org/browse/PARSER-187. we also filed a bug in VFC https://jira.onap.org/browse/VFC-1196.
-- 'artifacts' definition is missing in the exported csar's VDU node, we also can refer to https://jira.onap.org/browse/SDC-1900. It’s a very hacky workaround in VFC’s GVFNM. Because currently the only use case will use GVFNM is vCPE, which only uses the ubuntu16.04 image, so GVFNM just makes the ubuntu16.04 image as the default if the "sw_image" artifact is missing in the SDC’s exported CSAR.
-- OOF patch https://gerrit.onap.org/r/#/c/73332/ is not accepted by 1.2.4 image.It will be accepted by 1.2.5 image. but 1.2.5 image is not release. If you want to use it, you can use 1.2.5-SNAPSHOT-latest. If you use 1.2.4 image, you also need to modify code according to the patch.