Merge "Integration doc for 5g pnp pnf use case"
[integration.git] / docs / docs_vcpe_tosca.rst
1 vCPE of Tosca Use Case
2 ----------------------
3
4 Source files
5 ~~~~~~~~~~~
6
7 vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE
8
9 5 VNFs are here for the ONAP vCPE use case. This VNFD is transformed manually from vCPE heat template.
10 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.
11
12
13 Description
14 ~~~~~~~~~~
15
16 The use case is composed of five virtual functions (VFs): Infrastructure including vDNS, vDHCP, vAAA(Authorization, Authentication, Accounting) and
17 vWEB, vBNG(Virtual Broadband Network Gateway), vGMUX(Virtual Gateway Multiplexer), vBRGEMU(Bridged Residential Gateway) and vGW(Virtual Gateway).
18 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.
19
20
21 Test Plan:
22 ~~~~~~~~~~~~~~~~~~
23
24 The test plan 3 in https://wiki.onap.org/pages/viewpage.action?pageId=41421112.
25 Test Plan 3: VF-C HPA testing
26 This test plan covers the tests related to testing
27 Support for the vCPE use case in VF-C
28
29 Use vCPE (Infra, vGW, vBNG, vBRGEMU and vGMUX)
30
31 Infra part of  policy asking for:
32 ::
33
34   2 vcpus
35   >= 2Gbytes of memory
36   > 40Gbytes of disk
37
38 vGW part of policy asking for:
39 ::
40
41   2 vcpus
42   >=4Gbytes of memory
43   >= 40Gbytes of disk
44   Numa page size: 2Mbytes and pages 1024
45   with one SRIOV-NIC
46
47 vBNG part of policy asking for:
48 ::
49
50   2 vcpus
51   >= 2Gbytes of memory
52   > 40Gbytes of disk
53   Numa page size: 2Mbytes and pages 1024
54   with one SRIOV-NIC
55
56 vBGREMU part of policy asking for:
57 ::
58
59   2 vcpus
60   >= 2Gbytes of memory
61   >= 40Gbytes of disk
62   Numa page size: 2Mbytes and pages 1024
63   with one SRIOV-NIC
64
65 vGMUX part of policy asking for:
66 ::
67
68   2 vcpus
69   >= 2Gbytes of memory
70   > 40Gbytes of disk
71   Numa page size: 2Mbytes and pages 1024
72   with one SRIOV-NIC
73
74 Instantiate the VNF
75 Check for results:
76 It would have selected flavor13 for vGW, vBNG, vBRGEMU and vGMUX VMs. It would have selected flavor13 and flavor12 for Infrastructure.
77
78 Test Steps:
79 ~~~~~~~~~~
80
81 VIM Configuration:
82 ^^^^^^^^^^^^^^^^^^
83
84 If you want to use SRIOV-NIC, you need first config SRIOV NIC to refer to [1].
85 [1] https://docs.openstack.org/ocata/networking-guide/config-sriov.html
86
87 ONAP managing 1 cloud-region which have three flavors.
88 Flavor 11:
89 2 vcpus, 1 Gbytes of memory, 20Gb disk
90 Numa page size: 2Mbytes and number pages 512
91 ::
92
93   openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2
94
95 Flavor 12:
96 2 vcpus, 2 Gbytes of memory, 20Gb disk
97 Numa page size: 2Mbytes and number pages 1024
98 ::
99
100   openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2
101
102 Flavor 13:
103 2 vcpus, 4 Gbytes of memory, 20Gb disk
104 Huge page size: 2Mbytes and number pages 2048
105 1 SRIOV-NIC VF
106 ::
107
108   openstack flavor create onap.hpa.flavor13 -id auto --ram 4096 --disk 20 -vcpus 2
109   openstack flavor set onap.hpa.flavor11 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-1234-5678-physnet1:1
110   openstack aggregate create --property sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 hpa_aggr11
111
112 comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network.
113
114 Policy Configuration:
115 ^^^^^^^^^^^^^^^^^^^^^
116
117 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.
118
119 - 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
120 - 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.
121 - The attribute key in CSAR is pciNumDevices, but the responding one in OOF/Mutlicloud is pciCount.  Suggest keeping alignment in R4.
122 - 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.
123
124
125 Running the Use Case
126 ~~~~~~~~~~~~~~~~~~~
127
128 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.
129
130 Known issues and resolution
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~
132
133 - 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.
134 - 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.
135 - '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.
136 - 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.