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 vCPE Tosca Local Mode Use Case
   8 ------------------------------
   9
  10 Description
  11 ~~~~~~~~~~~
  12 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.
  13
  14 More details on the vCPE Use Case can be found on wiki page https://wiki.onap.org/pages/viewpage.action?pageId=3246168
  15
  16 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.
  17
  18 Source Code
  19 ~~~~~~~~~~~
  20 vcpe tosca local test scripts: https://git.onap.org/integration/tree/test/vcpe_tosca/local/vcpe_tosca_test.py
  21
  22 How to Use
  23 ~~~~~~~~~~
  24 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:
  25
  26 1) Install ONAP CLI environment, open_cli_product is onap-dublin.
  27
  28
  29 2) Prepare openstack test environment.
  30
  31    * Create project(tenant) and user on openstack
  32
  33    Openstack Horizon--Identity--Projects page
  34
  35    .. image:: files/vcpe_tosca/create_project.png
  36
  37    Openstack Horizon--Identity--Users page
  38
  39    .. image:: files/vcpe_tosca/create_user.png
  40
  41    Manage Project Members
  42
  43    .. image:: files/vcpe_tosca/manage_project_user.png
  44
  45    * Create and upload image for VNF
  46
  47    Identify the version of the lab server, my lab server is Ubuntu 16.04.3 LTS.
  48
  49    ::
  50
  51       root@onap-dengyuanhong-master:~# cat /etc/lsb-release
  52       DISTRIB_ID=Ubuntu
  53       DISTRIB_RELEASE=16.04
  54       DISTRIB_CODENAME=xenial
  55       DISTRIB_DESCRIPTION="Ubuntu 16.04.3 LTS"
  56
  57
  58    Download the related ubuntu image from https://cloud-images.ubuntu.com/
  59
  60    .. image:: files/vcpe_tosca/image.png
  61
  62    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.
  63
  64    .. image:: files/vcpe_tosca/create_image.png
  65
  66 3) Update the configuration file vcpe_config.json under https://git.onap.org/integration/tree/test/vcpe_tosca/local/config
  67
  68    You should update the values if you want to run in your environment.
  69
  70    Firstly, identify the Region name you used on your openstack environment, our Region name is RegionOne, it will be used by the configuration file.
  71
  72    ::
  73
  74       [wrsroot@controller-0 ~(keystone_admin)]$ openstack region list
  75       +-----------+---------------+-------------+
  76       | Region    | Parent Region | Description |
  77       +-----------+---------------+-------------+
  78       | RegionOne | None          |             |
  79       +-----------+---------------+-------------+
  80
  81
  82    Secondly, update the values according to your environment.
  83
  84    ::
  85
  86       "open_cli_home": set to the oclip home path,
  87       "aai_url": set to msb ip and port you used,
  88       "msb_url": set to msb ip and port you used,
  89       "multicloud_url": set to msb ip and port you used,
  90
  91       "cloud_region_data": {
  92            "RegionOne":(update to your Region name) {
  93                "cloud-region-version": the cloud region version of your Cloud region,
  94                 "esr-system-info-id": "1111ce1f-aa78-4ebf-8d6f-4b62773e9b01",
  95                 "service-url": the ip change to your openstack ip address,
  96                 "user-name": the user name you created on openstack,
  97                 "password": the user password you created on openstack,
  98                 "system-type": "VIM",
  99                 "ssl-insecure": true,
 100                 "cloud-domain": "Default",
 101                 "default-tenant": the project name you created on openstack,
 102                 "tenant-id": the project id you created on openstack,
 103                 "cloud-type": "openstack",
 104                 "identity-url": the ip change to your openstack ip address,
 105                 "system-status": "active"
 106            }
 107       }
 108       "vfc-url": set to msb ip and port you used,
 109       "vnfs": {
 110            "vgw": {
 111                "path": "vgw.csar", set to your vnf csar file path
 112                 "key": "key2",
 113                 "value": "value2"
 114            }
 115         },
 116        "ns": {
 117            "key": "key1",
 118            "value": "value1",
 119            "path": "ns_vgw.csar", set to you ns csar file path
 120            "name": "vcpe11"
 121        },
 122       "location": "VCPE22_RegionOne", set to CloudOwner_CloudRegion
 123        "vnfm_params": {
 124            "GVNFMDRIVER": {
 125                "type": "gvnfmdriver",
 126                "vendor": "vfc",
 127                "version": "v1.0",
 128                 "url": set to msb ip and port you used,
 129                 "vim-id": "VCPE22_RegionOne", set to CloudOwner_CloudRegion
 130                 "user-name": "admin",
 131                 "user-password": "admin",
 132                 "vnfm-version": "v1.0"
 133             }
 134         }
 135
 136
 137 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
 138
 139
 140 5) The key test script is vcpe_tosca_test.py which is under https://git.onap.org/integration/tree/test/vcpe_tosca/local
 141
 142    Run command is
 143
 144    ::
 145
 146       python3 -m unittest vcpe_tosca_test.py
 147
 148    Before run the command, you should install requests: pip install requests, and update the path of configuration file vcpe_config.json.
 149
 150 5) Release of our environment
 151
 152    ::
 153
 154       vfc-nslcm: 1.3.8
 155       vfc-vnflcm: 1.3.8
 156       vfc-gvnfm: 1.3.8
 157       modeling-etsicatalog: 1.0.5
 158       multicloud-framework: 1.5.1
 159       multicloud-windriver: 1.5.5
 160       cli: onap-dublin
 161
 162
 163 Note
 164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 165 1) 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.
 166
 167 2) You should install ONAP CLI before running the script.
 168
 169
 170 Known Issues and Workaround
 171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 172 1) There is time out issue when terminating vnf, the solution is refer to
 173
 174    https://gerrit.onap.org/r/c/vfc/nfvo/driver/vnfm/gvnfm/+/105192
 175
 176 2) The process of terminating job is chaotic, the solution is refer to
 177
 178    https://gerrit.onap.org/r/c/vfc/nfvo/lcm/+/105449