docs/docs_vCPE_tosca_local.rst

   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.
   4
   5 .. _docs_vcpe_tosca_local:
   6
   7 :orphan:
   8
   9 vCPE Tosca Local Mode Use Case
  10 ------------------------------
  11
  12 Description
  13 ~~~~~~~~~~~
  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.
  15
  16 More details on the vCPE Use Case can be found on wiki page https://wiki.onap.org/pages/viewpage.action?pageId=3246168
  17
  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.
  19
  20 Source Code
  21 ~~~~~~~~~~~
  22 vcpe tosca local test scripts: https://git.onap.org/integration/tree/test/vcpe_tosca/local/vcpe_tosca_test.py
  23
  24 How to Use
  25 ~~~~~~~~~~
  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:
  27
  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.
  30
  31 2) Prepare openstack test environment.
  32
  33    * Create project(tenant) and user on openstack
  34
  35    Openstack Horizon--Identity--Projects page
  36
  37    .. image:: files/vcpe_tosca/create_project.png
  38
  39    Openstack Horizon--Identity--Users page
  40
  41    .. image:: files/vcpe_tosca/create_user.png
  42
  43    Manage Project Members
  44
  45    .. image:: files/vcpe_tosca/manage_project_user.png
  46
  47    * Create and upload image for VNF
  48
  49    Identify the version of the lab server, my lab server is Ubuntu 16.04.3 LTS.
  50
  51    ::
  52
  53       root@onap-dengyuanhong-master:~# cat /etc/lsb-release
  54       DISTRIB_ID=Ubuntu
  55       DISTRIB_RELEASE=16.04
  56       DISTRIB_CODENAME=xenial
  57       DISTRIB_DESCRIPTION="Ubuntu 16.04.3 LTS"
  58
  59
  60    Download the related ubuntu image from https://cloud-images.ubuntu.com/
  61
  62    .. image:: files/vcpe_tosca/image.png
  63
  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.
  65
  66    .. image:: files/vcpe_tosca/create_image.png
  67
  68 3) Update the configuration file vcpe_config.json under https://git.onap.org/integration/tree/test/vcpe_tosca/local/config
  69
  70    You should update the values if you want to run in your environment.
  71
  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.
  73
  74    ::
  75
  76       [wrsroot@controller-0 ~(keystone_admin)]$ openstack region list
  77       +-----------+---------------+-------------+
  78       | Region    | Parent Region | Description |
  79       +-----------+---------------+-------------+
  80       | RegionOne | None          |             |
  81       +-----------+---------------+-------------+
  82
  83
  84    Secondly, update the values according to your environment.
  85
  86    ::
  87
  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,
  93
  94       "complex_name": set to any complex name you want to use, the name must be unique
  95
  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"
 111            }
 112       }
 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
 117
 118       "vfc-url": set to msb ip and port you used,
 119       "vnfs": {
 120           "vgw": {
 121               "path": "/csar/vgw.csar", set to you vgw csar file path
 122               "key": "key2",
 123               "value": "value2"
 124           },
 125           "infra": {
 126               "path": "/csar/infra.csar", set to you infra csar file path
 127               "key": "key2",
 128               "value": "value2"
 129           },
 130           "vbng": {
 131               "path": "/csar/vbng.csar", set to you vbng csar file path
 132               "key": "key2",
 133               "value": "value2"
 134           },
 135           "vbrgemu": {
 136               "path": "/csar/vbrgemu.csar", set to you vbrgemu csar file path
 137               "key": "key2",
 138               "value": "value2"
 139           },
 140           "vgmux": {
 141               "path": "/csar/vgmux.csar", set to you vgmux csar file path
 142               "key": "key2",
 143               "value": "value2"
 144           }
 145       },
 146       "ns": {
 147            "key": "key1",
 148            "value": "value1",
 149            "path": "ns_vgw.csar", set to you ns csar file path
 150            "name": "vcpe11"
 151       },
 152       "location": "VCPE22_RegionOne", set to CloudOwner_CloudRegion
 153       "vnfm_params": {
 154            "GVNFMDRIVER": {
 155                "type": "gvnfmdriver",
 156                "vendor": "vfc",
 157                "version": "v1.0",
 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"
 163            }
 164       }
 165
 166
 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
 168
 169
 170 5) The key test script is vcpe_tosca_test.py which is under https://git.onap.org/integration/tree/test/vcpe_tosca/local
 171
 172    Run command is
 173
 174    ::
 175
 176       python3 -m unittest vcpe_tosca_test.py
 177
 178    Before run the command, you should install requests: pip install requests, and update the path of configuration file vcpe_config.json.
 179
 180 5) Release of our environment
 181
 182    ::
 183
 184       vfc-nslcm: 1.3.8
 185       vfc-vnflcm: 1.3.8
 186       vfc-gvnfm: 1.3.8
 187       modeling-etsicatalog: 1.0.5
 188       multicloud-framework: 1.5.1
 189       multicloud-windriver: 1.5.5
 190       cli: onap-dublin
 191
 192
 193 Note
 194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 195 1) You must authorize admin to vcpe_case when managing project members in openstack.
 196
 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.
 198
 199 3) You should install ONAP CLI before running the script.
 200
 201
 202 Known Issues and Workaround
 203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 204 1) There is time out issue when terminating vnf, the solution is refer to
 205
 206    https://gerrit.onap.org/r/c/vfc/nfvo/driver/vnfm/gvnfm/+/105192
 207
 208 2) The process of terminating job is chaotic, the solution is refer to
 209
 210    https://gerrit.onap.org/r/c/vfc/nfvo/lcm/+/105449