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