docs/docs_vCPE_with_Tosca_VNF.rst

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