docs/docs_vCPE_with_Tosca_VNF.rst

   1 .. _docs_vcpe_tosca:
   2
   3 vCPE with Tosca VNF
   4 ----------------------------
   5
   6 VNF Packages and NS Packages
   7 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8 vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE_F
   9
  10 5 VNFs are here for the ONAP vCPE use case. The vnf csar file includes Infra, vGW, vBNG, vBRGEMU and vGMUX, and the ns csar file is ns.
  11
  12 Description
  13 ~~~~~~~~~~~
  14 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.
  15 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.
  16 The original vCPE Use Case Wiki Page can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=3246168
  17
  18 How to Use
  19 ~~~~~~~~~~
  20
  21
  22 Configuration:
  23 ~~~~~~~~~~~~~~
  24 1) VIM Configuration
  25
  26    Prepare openstack test environment.
  27
  28    * Create project(tenant) and user on openstack
  29
  30    Openstack Horizon--Identity--Projects page
  31
  32    .. image:: files/vcpe_tosca/create_project.png
  33
  34    Openstack Horizon--Identity--Users page
  35
  36    .. image:: files/vcpe_tosca/create_user.png
  37
  38    Manage Project Members
  39
  40    .. image:: files/vcpe_tosca/manage_project_user.png
  41
  42    * Create and upload image for VNF
  43
  44    * Register VIM using CLI command or ESR GUI
  45
  46    .. image:: files/vcpe_tosca/vim.png
  47
  48 2) VNFM Configuration
  49
  50    Register vnfm using CLI command or ESR GUI.
  51
  52    .. image:: files/vcpe_tosca/vnfm.png
  53
  54 Design Time:
  55 ~~~~~~~~~~~~
  56 1) We put the real ETSI aligned package as package artifact.
  57 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.
  58
  59    .. image:: files/vcpe_tosca/sdc.png
  60
  61 Run Time:
  62 ~~~~~~~~~
  63 1) First onboard VNF/NS package from SDC to modeling etsicatalog in sequence.
  64 2) Trigger the NS operation via UUI guide
  65
  66 a) VNF/NS csar package on-boarded guide
  67
  68    Note:
  69
  70    * VNF/NS csar package can be distributed from SDC.
  71    * VNF csar package should be distributed first, then NS csar package can be distributed.
  72    * The csar package list page shows both the on-boarded/distributed csar package and the package from SDC.
  73    * When the package from SDC is on-boarded, it will be dropped from the list, and the on-boarded package will be displayed in the list.
  74
  75    The following shows the guide of on-boarded a NS csar package via UUI:
  76
  77    Step 1. Select the SDC NS csar package vcpe_test_001 in csar package list package, and click the onboard button, the SDC NS csar package will be on-boarded to Modeling:
  78
  79    .. image:: files/vcpe_tosca/ns_package_list.png
  80
  81    Step 2. When the onboard is completed, the SDC csar vcpe_test_001 is dropped from the list, and the on-boarded csar info(vcpe) will be displayed in the csar file list:
  82
  83    .. image:: files/vcpe_tosca/ns_package_onboard.png
  84
  85    You can also onboard a VNF csar package by click the VNF tab in the csar package list page, then follow the upper two steps. You should onboard vnfs before ns.
  86
  87 b) NS Instantiate guide
  88
  89    Note:
  90
  91    * When an NS package is on-boarded or distributed,  you can start NS Instantiating.
  92
  93    The following steps show the guide of Instantiating NS:
  94
  95    Step 1. Open the service list page, first select Customer and Service Type, then click Create button.
  96
  97    .. image:: files/vcpe_tosca/customer_service.png
  98
  99    Step 2. First select the Service with Network Service, then select the TEMPLATE, then click OK button:
 100
 101    .. image:: files/vcpe_tosca/ns_create.png
 102
 103    Step 3. First input the NS Name and Description, then select the vf_location of each vnf, then click Create button:
 104
 105    .. image:: files/vcpe_tosca/ns_create_input.png
 106
 107    Step 4. A new record will be added to the list package, the Status column will show the Instantiating progress.
 108
 109    .. image:: files/vcpe_tosca/ns_instance.png
 110
 111    Step 5. When NS Instantiating is completed, the Status will updated to completed, and you can refresh the package, the Status will be updated to Active.
 112
 113    .. image:: files/vcpe_tosca/ns_active.png
 114
 115 c) NS heal guide
 116
 117    Note:
 118
 119    * VF-C R3 healing only suport restart a vm of an VNF.
 120
 121    The following shows the guide of healing an VNF of  an Instantiated NS:
 122
 123    Step 1. Click + button of an  an Instantiated NS, the VNF list of the NS will be displayed:
 124
 125    .. image:: files/vcpe_tosca/ns_vnf_list.png
 126
 127    Step 2. Click the heal button of a VNF, select the vm of the VNF, and click OK button:
 128
 129    .. image:: files/vcpe_tosca/ns_vnf_heal.png
 130
 131    Step 3. When VNF healing is started, the Status of VNF will shows the progress of healing.
 132
 133    .. image:: files/vcpe_tosca/ns_vnf_healing.png
 134
 135    Step 4. When VNF healing is completed, the Status will be updated to completed, you can refresh the page, the Status will be updated to Active again.
 136
 137    .. image:: files/vcpe_tosca/ns_vnf_healed.png
 138
 139 d) NS delete guide
 140
 141    The following shows the guide of deleting an VNF of an Instantiated NS:
 142
 143    Step 1. Select an Instantiated NS record in the list page, then click the delete button:
 144
 145    .. image:: files/vcpe_tosca/ns_active.png
 146
 147    Step 2. Select the termination Type and the graceful Termination Timeout, then click OK button:
 148
 149    .. image:: files/vcpe_tosca/ns_delete.png
 150
 151    Step 3. When the deleting is started, the Status will be updated to the progress of deleting.
 152
 153    .. image:: files/vcpe_tosca/ns_deleting.png
 154
 155    when deleting is completed, the Status will be update to completed, and soon it will be drop from the list.
 156
 157    .. image:: files/vcpe_tosca/ns_deleted.png
 158
 159 Test Status and Plans
 160 ~~~~~~~~~~~~~~~~~~~~~
 161 This case completed all tests as found here: https://wiki.onap.org/display/DW/vCPE%28tosca%29+-++Integration+test+cases
 162
 163 Known Issues and Resolutions
 164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 165
 166 1) There is time out issue when terminating vnf, the solution is refer to
 167
 168    https://gerrit.onap.org/r/c/vfc/nfvo/driver/vnfm/gvnfm/+/105192
 169
 170 2) The process of terminating job is chaotic, the solution is refer to
 171
 172    https://gerrit.onap.org/r/c/vfc/nfvo/lcm/+/105449
 173
 174 3) Failed to fetch NS package from SDC when having VL resource, the solution is refer to
 175
 176    https://gerrit.onap.org/r/c/modeling/etsicatalog/+/106074
 177
 178 4) The model msg is error when deleting the vnf package via UUI, the solution is refer to
 179
 180    https://gerrit.onap.org/r/c/usecase-ui/+/106729
 181
 182 5) Wrong number of services displayed for services-list via UUI, the solution is refer to
 183
 184    https://gerrit.onap.org/r/c/usecase-ui/+/106719
 185
 186 6) The picture cannot be displayed of ns create model page via UUI, the solution is refer to
 187
 188    https://gerrit.onap.org/r/c/usecase-ui/+/106715