1 .. This work is licensed under a Creative Commons Attribution 4.0
2 International License. http://creativecommons.org/licenses/by/4.0
3 Copyright 2020 CMCC Technologies Co., Ltd. All rights reserved.
5 .. _docs_vcpe_tosca_local:
9 vCPE Tosca Local Mode Use Case
10 ------------------------------
14 vCPE tosca use case is based on Network Enhanced Residential Gateway architecture specified in Technical Report 317 (TR-317), which defines how service providers deploy residential broadband services like High Speed Internet Access. The use case implementation has infrastructure services and customer service. The common infrastructure services are deployed first and shared by all customers. The use case demonstrates ONAP capabilities to design, deploy, configure and control sophisticated services.
16 More details on the vCPE Use Case can be found on wiki page https://wiki.onap.org/pages/viewpage.action?pageId=3246168
18 Local is the way how to distribute the network elements. Here we use local means we want upload the csar file to distribute the vnf and ns configurations.
22 vcpe tosca local test scripts: https://git.onap.org/integration/tree/test/vcpe_tosca/local/vcpe_tosca_test.py
26 The use case has been automated by vcpe_tosca_test scripts. The followings are the main steps to run the use case in Integration lab environment:
28 1) Install ONAP CLI environment, open_cli_product is onap-dublin.
29 Use https://git.onap.org/integration/tree/test/vcpe_tosca/local/scripts/install-alpine.sh to install ONAP CLI.
31 2) Prepare openstack test environment.
33 * Create project(tenant) and user on openstack
35 Openstack Horizon--Identity--Projects page
37 .. image:: files/vcpe_tosca/create_project.png
39 Openstack Horizon--Identity--Users page
41 .. image:: files/vcpe_tosca/create_user.png
43 Manage Project Members
45 .. image:: files/vcpe_tosca/manage_project_user.png
47 * Create and upload image for VNF
49 Identify the version of the lab server, my lab server is Ubuntu 16.04.3 LTS.
53 root@onap-dengyuanhong-master:~# cat /etc/lsb-release
56 DISTRIB_CODENAME=xenial
57 DISTRIB_DESCRIPTION="Ubuntu 16.04.3 LTS"
60 Download the related ubuntu image from https://cloud-images.ubuntu.com/
62 .. image:: files/vcpe_tosca/image.png
64 Openstack Horizon--Project--Compute--Images page, create an image named image, the name must be the same with image which is defined in vnf csar file.
66 .. image:: files/vcpe_tosca/create_image.png
68 3) Update the configuration file vcpe_config.json under https://git.onap.org/integration/tree/test/vcpe_tosca/local/config
70 You should update the values if you want to run in your environment.
72 Firstly, identify the Region name you used on your openstack environment, our Region name is RegionOne, it will be used by the configuration file.
76 [wrsroot@controller-0 ~(keystone_admin)]$ openstack region list
77 +-----------+---------------+-------------+
78 | Region | Parent Region | Description |
79 +-----------+---------------+-------------+
80 | RegionOne | None | |
81 +-----------+---------------+-------------+
84 Secondly, update the values according to your environment.
88 "open_cli_product": set to CLI product you installed, onap-dublin is OK for this test.
89 "open_cli_home": set to the oclip home path,
90 "aai_url": set to msb ip and port you used,
91 "msb_url": set to msb ip and port you used,
92 "multicloud_url": set to msb ip and port you used,
94 "complex_name": set to any complex name you want to use, the name must be unique
96 "cloud_region_data": {
97 "RegionOne":(update to your Region name) {
98 "cloud-region-version": the cloud region version of your Cloud region, you can keep "titanium_cloud"
99 "esr-system-info-id": "1111ce1f-aa78-4ebf-8d6f-4b62773e9b01",
100 "service-url": the ip change to your openstack ip address,
101 "user-name": the user name you created on openstack,
102 "password": the user password you created on openstack,
103 "system-type": "VIM",
104 "ssl-insecure": true,
105 "cloud-domain": "Default",
106 "default-tenant": the project name you created on openstack,
107 "tenant-id": the project id you created on openstack,
108 "cloud-type": "openstack",
109 "identity-url": the ip change to your openstack ip address,
110 "system-status": "active"
113 "cloud-owner": set to any cloud name you want to use, , the name must be unique
114 "service_name": set to any service name you want to use, the name must be unique
115 "customer_name": set to any customer name you want to use, the name must be unique
116 "subscriber_name": set to any subscriber name you want to use, the name must be unique
118 "vfc-url": set to msb ip and port you used,
121 "path": "/csar/vgw.csar", set to you vgw csar file path
126 "path": "/csar/infra.csar", set to you infra csar file path
131 "path": "/csar/vbng.csar", set to you vbng csar file path
136 "path": "/csar/vbrgemu.csar", set to you vbrgemu csar file path
141 "path": "/csar/vgmux.csar", set to you vgmux csar file path
149 "path": "ns_vgw.csar", set to you ns csar file path
152 "location": "VCPE22_RegionOne", set to CloudOwner_CloudRegion
155 "type": "gvnfmdriver",
158 "url": set to msb ip and port you used,
159 "vim-id": "VCPE22_RegionOne", set to CloudOwner_CloudRegion
160 "user-name": "admin",
161 "user-password": "admin",
162 "vnfm-version": "v1.0"
167 4) The vnf csar file include Infra, vGW, vBNG, vBRGEMU and vGMUX, and the ns csar file is ns. https://git.onap.org/integration/tree/test/vcpe_tosca/local/csar
170 5) The key test script is vcpe_tosca_test.py which is under https://git.onap.org/integration/tree/test/vcpe_tosca/local
176 python3 -m unittest vcpe_tosca_test.py
178 Before run the command, you should install requests: pip install requests, and update the path of configuration file vcpe_config.json.
180 5) Release of our environment
187 modeling-etsicatalog: 1.0.5
188 multicloud-framework: 1.5.1
189 multicloud-windriver: 1.5.5
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
195 1) You must authorize admin to vcpe_case when managing project members in openstack.
197 2) You should create an image named image before running the test script, the name must be the same with image which is defined in vnf csar file.
199 3) You should install ONAP CLI before running the script.
202 Known Issues and Workaround
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
204 1) There is time out issue when terminating vnf, the solution is refer to
206 https://gerrit.onap.org/r/c/vfc/nfvo/driver/vnfm/gvnfm/+/105192
208 2) The process of terminating job is chaotic, the solution is refer to
210 https://gerrit.onap.org/r/c/vfc/nfvo/lcm/+/105449