update the integration doc for vCPE

Issue-ID: VFC-1668
Change-Id: I5fc41873f7a31e4c67669ea8bb07b674bc434cec
Signed-off-by: zhaoliping123 <zhaoliping@chinamobile.com>

16 files changed, 125 insertions, 102 deletions

diff --git a/docs/docs_vCPE_with_Tosca_VNF.rst b/docs/docs_vCPE_with_Tosca_VNF.rst
index 69db4de34..ba4403bb8 100644
--- a/docs/docs_vCPE_with_Tosca_VNF.rst
+++ b/docs/docs_vCPE_with_Tosca_VNF.rst
@@ -5,13 +5,10 @@ vCPE with Tosca VNF
 
 VNF Packages and NS Packages
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE
+vCPE tosca file url: https://git.onap.org/demo/tree/tosca/
 
 5 VNFs are here for the ONAP vCPE use case. This VNFD is transformed manually from vCPE heat template.
-Please run "./generate_csar.sh" to create the CSAR package files for these 5 VNFS. CSAR package file is just a zip formatted file. If you want to use SRIOV SRIOV-NIC", please run "./generate_csar.sh sriov" to create the CSAR package files for SRIOV.
-All the generated VNF packges can be found in the following link:
-- VNF packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide
-- NS packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide
+The vnf csar file includes Infra, vGW, vBNG, vBRGEMU and vGMUX, and the ns csar file is ns.
 
 Description
 ~~~~~~~~~~~
@@ -26,134 +23,160 @@ How to Use
 Configuration:
 ~~~~~~~~~~~~~~
 1) VIM Configuration
-If you want to use SRIOV-NIC, you need first config SRIOV NIC to refer to [1].
-[1] https://docs.openstack.org/ocata/networking-guide/config-sriov.html
 
-ONAP managing 1 cloud-region which have three flavors.
-Flavor 11:
-2 vcpus, 1 Gbytes of memory, 20Gb disk
-Numa page size: 2Mbytes and number pages 512
-::
+   Prepare openstack test environment.
 
-  openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2
+   * Create project(tenant) and user on openstack
 
-Flavor 12:
-2 vcpus, 2 Gbytes of memory, 20Gb disk
-Numa page size: 2Mbytes and number pages 1024
-::
+   Openstack Horizon--Identity--Projects page
 
-  openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2
+   .. image:: files/vcpe_tosca/create_project.png
 
-Flavor 13:
-2 vcpus, 4 Gbytes of memory, 20Gb disk
-Huge page size: 2Mbytes and number pages 2048
-1 SRIOV-NIC VF
-::
+   Openstack Horizon--Identity--Users page
 
-  openstack flavor create onap.hpa.flavor13 -id auto --ram 4096 --disk 20 -vcpus 2
-  openstack flavor set onap.hpa.flavor11 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-1234-5678-physnet1:1
-  openstack aggregate create --property sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 hpa_aggr11
+   .. image:: files/vcpe_tosca/create_user.png
 
-comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network.
+   Manage Project Members
 
-2)Policy Configuration
-After the patch https://gerrit.onap.org/r/73502/ is merged. With the generated policy and do some manually update as follows, the service could be distributed successfully and the Policy/VFC/OOF could work as excepted.
+   .. image:: files/vcpe_tosca/manage_project_user.png
 
-- Need manually modify policy item because the “vendor id” and “PCI device id” and “architecture” must be changed in different VIMs since we have different PCI devices in different VIMs
-- The value of mandatory in CSAR is “true”, OOF is case intensive, it needs to use “True”. Have to update it. suggest OOF to use ignoreCase in R4.
-- The attribute key in CSAR is pciNumDevices, but the responding one in OOF/Mutlicloud is pciCount.  Suggest keeping alignment in R4.
-- The policy scope has to add a value “us” into it which is a configuration issue in OOF side. Policy side also need do improvement to deal with policy scope automatically append instead of replacement so such policy could be used by several services at the same time.
+   * Create and upload image for VNF
+
+   * Register VIM using CLI command or ESR GUI
+
+   .. image:: files/vcpe_tosca/vim.png
+
+2) VNFM Configuration
+
+   Register vnfm using CLI command or ESR GUI
+
+   .. image:: files/vcpe_tosca/vnfm.png
 
 Design Time:
 ~~~~~~~~~~~~
-1) Because SDC doesn't export ETSI aigned VNF package and NS package, so in this release, we put the real ETSI aligned package as package artifact.
+1) We put the real ETSI aligned package as package artifact.
 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.
 
 Run Time:
 ~~~~~~~~~
-1) First onboard VNF/NS package from SDC to VF-C catalog in sequence.
-2) Trigger the NS operation via UUI
+1) First onboard VNF/NS package from SDC to modeling etsicatalog in sequence.
+2) Trigger the NS operation via UUI guide
 
-More details can be fonud here: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide
+a) VNF/NS csar package on-boarded guide
 
-Test Status and Plans
-~~~~~~~~~~~~~~~~~~~~~
-The test plan 3 in https://wiki.onap.org/pages/viewpage.action?pageId=41421112.
-Test Plan 3: VF-C HPA testing
-This test plan covers the tests related to testing
-Support for the vCPE use case in VF-C
-Use vCPE (Infra, vGW, vBNG, vBRGEMU and vGMUX)
+   Note:
+
+   - VNF/NS csar package can be distributed from SDC.
+   - VNF csar package should be distributed first, then NS csar package can be distributed.
+   - The csar package list page shows both the on-boarded/distributed csar package and the package from SDC.
+   - 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.
+
+   The following shows the guide of on-boarded a NS csar package via UUI:
+
+   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:
+
+   .. image:: files/vcpe_tosca/ns_package_list.png
+
+   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:
+
+   .. image:: files/vcpe_tosca/ns_package_onboard.png
+
+   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.
+
+b) NS Instantiate guide
+
+   Note:
+
+   - When an NS package is on-boarded or distributed,  you can start NS Instantiating.
+
+   The following shows the guide of Instantiating NS:
+
+   Step 1. Open the service list page, first select Customer and Service Type, then click Create button.
+   Step 2. First select the Service with Network Service, then select the TEMPLATE, then click OK button:
+
+   .. image:: files/vcpe_tosca/ns_create.png
+
+   Step 3. First input the NS Name and Description, then select the vf_location of each vnf, then click Create button:
+
+   .. image:: files/vcpe_tosca/ns_create_input.png
+
+   Step 4. A new record will be added to the list package, the Status column will show the Instantiating progress.
+
+   .. image:: files/vcpe_tosca/ns_instance.png
 
-Infra part of  policy asking for:
-::
+   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.
 
-  2 vcpus
-  >= 2Gbytes of memory
-  > 40Gbytes of disk
+   .. image:: files/vcpe_tosca/ns_active.png
 
-vGW part of policy asking for:
-::
+c) NS heal guide
 
-  2 vcpus
-  >=4Gbytes of memory
-  >= 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
+   Note:
 
-vBNG part of policy asking for:
-::
+   - VF-C R3 healing only suport restart a vm of an VNF.
 
-  2 vcpus
-  >= 2Gbytes of memory
-  > 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
+   The following shows the guide of healing an VNF of  an Instantiated NS:
+   Step 1. Click + button of an  an Instantiated NS, the VNF list of the NS will be displayed:
 
-vBGREMU part of policy asking for:
-::
+   .. image:: files/vcpe_tosca/ns_vnf_list.png
 
-  2 vcpus
-  >= 2Gbytes of memory
-  >= 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
+   Step 2. Click the heal button of a VNF, select the vm of the VNF, and click OK button:
 
-vGMUX part of policy asking for:
-::
+   .. image:: files/vcpe_tosca/ns_vnf_heal.png
 
-  2 vcpus
-  >= 2Gbytes of memory
-  > 40Gbytes of disk
-  Numa page size: 2Mbytes and pages 1024
-  with one SRIOV-NIC
+   Step 3. When VNF healing is started, the Status of VNF will shows the progress of healing.
 
-Instantiate the VNF
-Check for results:
-It would have selected flavor13 for vGW, vBNG, vBRGEMU and vGMUX VMs. It would have selected flavor13 and flavor12 for Infrastructure.
+   .. image:: files/vcpe_tosca/ns_vnf_healing.png
 
-This case completed all tests as found here: https://wiki.onap.org/display/DW/vCPE+with+TOSCA+VNF+Integration+Test++-+Test+status
+   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.
+
+   .. image:: files/vcpe_tosca/ns_vnf_healed.png
+
+d) NS delete guide
+
+   The following shows the guide of deleting an VNF of an Instantiated NS:
+   Step 1. Select an Instantiated NS record in the list page, then click the delete button:
+
+   .. image:: files/vcpe_tosca/ns_active.png
+
+   Step 2. Select the termination Type and the graceful Termination Timeout, then click OK button:
+
+   .. image:: files/vcpe_tosca/ns_delete.png
+
+   Step 3. When the deleting is started, the Status will be updated to the progress of deleting.
+
+   .. image:: files/vcpe_tosca/ns_deleting.png
+
+   when deleting is completed, the Status will be update to completed, and soon it will be drop from the list.
+
+   .. image:: files/vcpe_tosca/ns_deleted.png
+
+Test Status and Plans
+~~~~~~~~~~~~~~~~~~~~~
+This case completed all tests as found here: https://wiki.onap.org/display/DW/vCPE%28tosca%29+-++Integration+test+cases
 
 Known Issues and Resolutions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Some SDC NS data model is not aligned to VFC NS data model, VFC NS also according to ETSI SOL0001. we also can refer to https://jira.onap.org/browse/SDC-1897. we have a workaround for this issue, we put the service as artifact file and distribute to VFC.
-- NFV Tosca parser bug. See bug in VFC https://jira.onap.org/browse/VFC-1196.
-- 'artifacts' definition is missing in the exported csar's VDU node, we also can refer to https://jira.onap.org/browse/SDC-1900. It’s a very hacky workaround in VFC’s GVFNM. Because currently the only use case will use GVFNM is vCPE, which only uses the ubuntu16.04 image, so GVFNM just makes the ubuntu16.04 image as the default if the "sw_image" artifact is missing in the SDC’s exported CSAR.
-- OOF patch https://gerrit.onap.org/r/73332/ is not accepted by 1.2.4 image. 1.2.5 is available in nexus3 repo. But not available in Casablanca release. If you want to use it, you can use 1.2.5-SNAPSHOT-latest. If you use 1.2.4 image, you also need to modify code according to the patch.
-- vnflcm notification error patch  https://gerrit.onap.org/r/73852/
-- grant error patch not merged into VF-C 1.2.2 image: https://gerrit.onap.org/r/73833/  and https://gerrit.onap.org/r/73770/
-- VF-C catalog config should be updated with the right SDC URL and user/pwd
-  Resolution: Disable VFC catalog livenessprobe and update configuration
-
-a) edit dev-vfc-catalog deployment
-b) remove livenessprobe section
-c) enter into catalog pod and update configuration
-
-::
-
-  kubectl -n onap exec -it dev-vfc-catalog-6978b76c86-87722  /bin/bash
-  config file location: service/vfc/nfvo/catalog/catalog/pub/config/config.py
-  Update the SDC configuration as follows:
-  SDC_BASE_URL = "http://msb-iag:80/api"
-  SDC_USER = "aai"
-  SDC_PASSWD = "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U"
+1) There is time out issue when terminating vnf, the solution is refer to
+
+   https://gerrit.onap.org/r/c/vfc/nfvo/driver/vnfm/gvnfm/+/105192
+
+2) The process of terminating job is chaotic, the solution is refer to
+
+   https://gerrit.onap.org/r/c/vfc/nfvo/lcm/+/105449
+
+3) Failed to fetch NS package from SDC when having VL resource, the solution is refer to
+
+   https://gerrit.onap.org/r/c/modeling/etsicatalog/+/106074
+
+4) The model msg is error when deleting the vnf package via UUI, the solution is refer to
+
+   https://gerrit.onap.org/r/c/usecase-ui/+/106729
+
+5) Wrong number of services displayed for services-list via UUI, the solution is refer to
+
+   https://gerrit.onap.org/r/c/usecase-ui/+/106719
+
+6) The picture cannot be displayed of ns create model page via UUI, the solution is refer to
+
+   https://gerrit.onap.org/r/c/usecase-ui/+/106715
diff --git a/docs/files/vcpe_tosca/ns_active.png b/docs/files/vcpe_tosca/ns_active.png
new file mode 100644
index 000000000..4d24e29a5
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_active.png
diff --git a/docs/files/vcpe_tosca/ns_create.png b/docs/files/vcpe_tosca/ns_create.png
new file mode 100644
index 000000000..7fe2fd91b
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_create.png
diff --git a/docs/files/vcpe_tosca/ns_create_input.png b/docs/files/vcpe_tosca/ns_create_input.png
new file mode 100644
index 000000000..f6d2c88a8
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_create_input.png
diff --git a/docs/files/vcpe_tosca/ns_delete.png b/docs/files/vcpe_tosca/ns_delete.png
new file mode 100644
index 000000000..931334e81
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_delete.png
diff --git a/docs/files/vcpe_tosca/ns_deleted.png b/docs/files/vcpe_tosca/ns_deleted.png
new file mode 100644
index 000000000..2663fbe97
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_deleted.png
diff --git a/docs/files/vcpe_tosca/ns_deleting.png b/docs/files/vcpe_tosca/ns_deleting.png
new file mode 100644
index 000000000..977d771d0
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_deleting.png
diff --git a/docs/files/vcpe_tosca/ns_instance.png b/docs/files/vcpe_tosca/ns_instance.png
new file mode 100644
index 000000000..32e47da91
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_instance.png
diff --git a/docs/files/vcpe_tosca/ns_package_list.png b/docs/files/vcpe_tosca/ns_package_list.png
new file mode 100644
index 000000000..29f0426d4
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_package_list.png
diff --git a/docs/files/vcpe_tosca/ns_package_onboard.png b/docs/files/vcpe_tosca/ns_package_onboard.png
new file mode 100644
index 000000000..0ecce911e
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_package_onboard.png
diff --git a/docs/files/vcpe_tosca/ns_vnf_heal.png b/docs/files/vcpe_tosca/ns_vnf_heal.png
new file mode 100644
index 000000000..aded069f9
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_vnf_heal.png
diff --git a/docs/files/vcpe_tosca/ns_vnf_healed.png b/docs/files/vcpe_tosca/ns_vnf_healed.png
new file mode 100644
index 000000000..7fa669ce1
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_vnf_healed.png
diff --git a/docs/files/vcpe_tosca/ns_vnf_healing.png b/docs/files/vcpe_tosca/ns_vnf_healing.png
new file mode 100644
index 000000000..140e00b74
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_vnf_healing.png
diff --git a/docs/files/vcpe_tosca/ns_vnf_list.png b/docs/files/vcpe_tosca/ns_vnf_list.png
new file mode 100644
index 000000000..77af139da
--- /dev/null
+++ b/docs/files/vcpe_tosca/ns_vnf_list.png
diff --git a/docs/files/vcpe_tosca/vim.png b/docs/files/vcpe_tosca/vim.png
new file mode 100644
index 000000000..a9b9cde10
--- /dev/null
+++ b/docs/files/vcpe_tosca/vim.png
diff --git a/docs/files/vcpe_tosca/vnfm.png b/docs/files/vcpe_tosca/vnfm.png
new file mode 100644
index 000000000..01e4ece63
--- /dev/null
+++ b/docs/files/vcpe_tosca/vnfm.png