aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docs_5G_Bulk_PM.rst26
-rw-r--r--docs/docs_5G_PNF_Software_Upgrade.rst56
-rw-r--r--docs/docs_5g_rtpm.rst29
-rw-r--r--docs/docs_CCVPN.rst127
-rw-r--r--docs/docs_scaleout.rst2
-rw-r--r--docs/docs_usecases.rst24
-rw-r--r--docs/docs_vCPE with Tosca VNF.rst (renamed from docs/docs_vcpe_tosca.rst)153
-rw-r--r--docs/docs_vCPE.rst36
-rw-r--r--docs/docs_vfw.rst2
-rw-r--r--docs/docs_vfwHPA.rst830
-rw-r--r--docs/docs_vlb.rst2
-rw-r--r--docs/release-notes.rst114
12 files changed, 1336 insertions, 65 deletions
diff --git a/docs/docs_5G_Bulk_PM.rst b/docs/docs_5G_Bulk_PM.rst
new file mode 100644
index 000000000..909ba3149
--- /dev/null
+++ b/docs/docs_5G_Bulk_PM.rst
@@ -0,0 +1,26 @@
+5G Bulk PM Use Case
+----------------------------
+
+5G Bulk PM Package
+~~~~~~~~~~~~
+- 5G Bulk PM Package: https://wiki.onap.org/display/DW/5G+-+Bulk+PM+-+Integration+Test+Case
+
+Description
+~~~~~~~~~~~
+The Bulk PM feature consists of an event-driven bulk transfer of monitoring data from an xNF to ONAP/DCAE. A micro-service will listen for 'FileReady' VES events sent from an xNF via the VES collector. Once files become available the collector micro-service will fetch them using protocol such as FTPES (committed) or SFTP. The collected data files are published internally on a DMaaP Data Router (DR) feed.
+The ONAP 5G Bulk PM Use Case Wiki Page can be found here:
+https://wiki.onap.org/display/DW/5G+-+Bulk+PM
+
+How to Use
+~~~~~~~~~~
+See the following instructions on how to manually test the feature. https://wiki.onap.org/display/DW/5G+Bulk+PM+Usecase+Testing+@+Ericsson+Lab+-+Casablanca
+The tests can also be executed using the Robot framework, information can be found https://wiki.onap.org/display/DW/5G+-+Bulk+PM+-+Integration+Test+Cases
+
+Test Status and Plans
+~~~~~~~~~~~~~~~~~~~~~
+To see information on the status of the test see https://wiki.onap.org/display/DW/5G+-+Bulk+PM+-+Test+Status
+
+Known Issues and Resolutions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+none.
+
diff --git a/docs/docs_5G_PNF_Software_Upgrade.rst b/docs/docs_5G_PNF_Software_Upgrade.rst
new file mode 100644
index 000000000..75977d8c8
--- /dev/null
+++ b/docs/docs_5G_PNF_Software_Upgrade.rst
@@ -0,0 +1,56 @@
+5G PNF Software Upgrade
+----------------------------
+
+Description
+~~~~~~~~~~~
+The 5G PNF Software upgrade use case shows how users/network operators can modify the software running on an existing PNF. This use case is one aspect of Software Management. This could be used to update the PNF software to a newer or older version of software.
+
+The Casablanca 5G PNF Software Upgrade Use Case Wiki Page can be found here: https://wiki.onap.org/display/DW/5G+-+PNF+Software+Update
+
+How to Use
+~~~~~~~~~~
+Upgrading PNF (instance) software requires the user/network operator to trigger the upgrade operation from the UI, e.g. VID or UUI. In Cacablanca, users need use ONAP Controllers GUI to trigger the LCM opeations, like pre-check, post-check and upgrade. After receiving the API requests, the ONAP controllers will communicate to the external controller(EC) through south-bound adaptors, which is Ansible in R3.
+
+Note that, both APPC and SDNC in R3 supported Ansible. Taking SDNC and Prechecking as an example, the steps are as follows:
+
+1) In ansible server container, prepare the ssh connection conditions to the external controller, both ssh key file and ansible inventory configuration;
+
+2) In sdnc controller container, update the dg configuration file: lcm-dg.properties.
+For example:
+::
+lcm.pnf.upgrade-pre-check.playbookname=ansible_huawei_precheck
+lcm.pnf.upgrade-post-check.playbookname=ansible_huawei_postcheck
+lcm.pnf.upgrade-software.playbookname=ansible_huawei_upgrade
+
+3) Login controller UI, access the pre-check LCM operation and send request.
+Post upgrade-pre-check with the following request body:
+::
+{
+ "input": {
+ "common-header": {
+ "timestamp": "2018-10-10T09:40:04.244Z",
+ "api-ver": "2.00",
+ "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced203",
+ "request-id":"664be3d2-6c12-4f4b-a3e7-c349acced203",
+ "sub-request-id": "1",
+ "flags": {
+ "force" : "TRUE",
+ "ttl" : 60000
+ }
+ },
+ "action": "UpgradePreCheck",
+ "action-identifiers": {
+ "vnf-id":"5gDU0001"
+ },
+ "payload": "{\"pnf-flag\":\"true\", \"pnf-name\": \"5gDU0001\",\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"EC_IP_address\",\"oldSwVersion\": \"v1\", \"targetSwVersion\": \"v2\", \"ruleName\": \"r001\", \"Id\": \"10\", \"additionalData\":\"{}\"}"}}
+
+4) The HTTP API response code 200 and LCM retured code 400 (See APPC return code design specification) indicate success, otherwise failed.
+
+Test Status and Plans
+~~~~~~~~~~~~~~~~~~~~~
+To see information on the status of the test see: https://wiki.onap.org/display/DW/5G+-+PNF+Software+Update+Test+Status
+
+Known Issues and Resolutions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+None
+
diff --git a/docs/docs_5g_rtpm.rst b/docs/docs_5g_rtpm.rst
new file mode 100644
index 000000000..47547c673
--- /dev/null
+++ b/docs/docs_5g_rtpm.rst
@@ -0,0 +1,29 @@
+5G - Real Time PM and High Stream Data Collection
+-------------------------------------------------
+
+Source files
+~~~~~~~~~~~~
+
+- Optional in case of use xNF simulator: https://git.onap.org/integration/tree/test/mocks/hvvessimulator/hvves_sim.yaml
+
+Description
+~~~~~~~~~~~
+
+Component and API descriptions can be found under:
+
+- `High Volume VNF Event Streaming (HV-VES) Collector <https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/services/ves-hv/index.html>`_
+- `HV-VES (High Volume VES) <https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/apis/ves-hv/index.html#hv-ves-high-volume-ves>`_
+
+How to verif
+~~~~~~~~~~~~~
+
+Follow instructions under below links to send data to HV-VES collector and verify messages published on Kafka topic:
+
+- `HV-VES xNF simulator integration to ONAP <https://wiki.onap.org/display/DW/HV-VES+simulator#HV-VESsimulator-HV-VESxNFsimulatorintegrationtoONAP>`_
+- `HV-VES xNF message simulation from shell <https://wiki.onap.org/display/DW/HV-VES+simulator#HV-VESsimulator-HV-VESxNFmessagesimulationfromshell>`_
+
+Useful links
+~~~~~~~~~~~~
+
+- `5G - Real Time PM and High Volume Stream Data Collection <https://wiki.onap.org/display/DW/5G+-+Real+Time+PM+and+High+Volume+Stream+Data+Collection>`_
+- `5G - Real Time PM and High Volume Stream Data Collection - Integration Test Cases <https://wiki.onap.org/display/DW/5G+-+Real+Time+PM+and+High+Volume+Stream+Data+Collection+-+Integration+Test+Cases>`_
diff --git a/docs/docs_CCVPN.rst b/docs/docs_CCVPN.rst
new file mode 100644
index 000000000..f9fb501c9
--- /dev/null
+++ b/docs/docs_CCVPN.rst
@@ -0,0 +1,127 @@
+CCVPN
+----------------------------
+
+Sevice used for CCVPN
+~~~~~~~~~~~~
+
+- SOTNVPNInfraService, SDWANVPNInfraService and SIteService: https://wiki.onap.org/display/DW/CCVPN+Service+Design
+- WanConnectionService ( Another way to describe CCVPN in a single service form which based on ONF CIM ): https://wiki.onap.org/display/DW/CCVPN+Wan+Connection+Service+Design
+
+Description
+~~~~~~~~~~~
+Cross-domain, cross-layer VPN (CCVPN) is one of the use cases of the ONAP Casablanca release. This release demonstrates cross-operator ONAP orchestration and interoperability with third party SDN controllers and enables cross-domain, cross-layer and cross-operator service creation and assurance.
+
+The demonstration includes two ONAP instances, one deployed by Vodafone and one by China Mobile, both of which orchestrate the respective operator underlay OTN networks and overlay SD-WAN networks and peer to each other for cross-operator VPN service delivery.
+
+The CCVPN Use Case Wiki Page can be found here: https://wiki.onap.org/display/DW/CCVPN%28Cross+Domain+and+Cross+Layer+VPN%29+USE+CASE.
+
+The projects covered by this use case include: SDC, A&AI, UUI, SO, SDNC, OOF, Policy, DCAE(Holmes), External API, MSB
+
+How to Use
+~~~~~~~~~~
+Design time
+SOTNVPNInfraService, SDWANVPNInfraService and SIteService service Design steps can be found here: https://wiki.onap.org/display/DW/CCVPN+Service+Design
+WanConnectionService ( Another way to describe CCVPN in a single service form which based on ONF CIM ): https://wiki.onap.org/display/DW/CCVPN+Wan+Connection+Service+Design
+
+Run Time:
+All opertion will be triggerd by UUI, inlcuding service creation and termination, link management and topology network display.
+
+
+More details can be fonud here: https://wiki.onap.org/display/DW/CCVPN+Test+Guide
+
+Test Status and Plans
+~~~~~~~~~~~~~~~~~~~~~
+All test case covered by this use case: https://wiki.onap.org/display/DW/CCVPN+Integration+Test+Case
+
+And the test status can be found: https://wiki.onap.org/display/DW/CCVPN++-Test+Status
+
+Known Issues and Resolutions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1) AAI-1923. Link Management, UUI can't delete the link to external onap otn domain.
+
+For the manual steps provided by A&AI team, we should follow the steps as follow
+the only way to delete is using the forceDeleteTool shell script in the graphadmin container.
+First we will need to find the vertex id, you should be able to get the id by making the following GET request.
+
+GET /aai/v14/network/ext-aai-networks/ext-aai-network/createAndDelete/esr-system-info/test-esr-system-info-id-val-0?format=raw
+
+::
+
+{
+"results": [
+{
+"id": "20624",
+"node-type": "pserver",
+"url": "/aai/v13/cloud-infrastructure/pservers/pserver/pserverid14503-as988q",
+"properties": {
+}
+}
+]
+}
+
+Same goes for the ext-aai-network:
+
+GET /aai/v14/network/ext-aai-networks/ext-aai-network/createAndDelete?format=raw
+
+Retrieve the id from the above output as that will be the vertex id that you want to remove.
+
+Run the following command multiple times for both the esr-system-info and ext-aai-network:
+
+::
+
+kubectl exec -it $(kubectl get pods -lapp=aai-graphadmin -n onap --template 'range .items.metadata.name"\n"end' | head -1) -n onap gosu aaiadmin /opt/app/aai-graphadmin/scripts/forceDeleteTool.sh -action DELETE_NODE -userId YOUR_ID_ANY_VALUE -vertexId VERTEX_ID
+
+From the above, remove the YOUR_ID_ANY_VALUE and VERTEX_ID with your info.
+
+2) SDC-1955. Site service Distribution
+
+To overcome the Service distribution, the SO catalog has to be populated with the model information of the services and resources.
+a) Refering to the Csar that is generated in the SDC designed as per the detailes mentioned in the below link: https://wiki.onap.org/display/DW/CCVPN+Service+Design
+b) Download the Csar from SDC thus generated.
+c) copy the csar to SO sdc controller pod and bpmn pod
+ kubectl -n onap get pod|grep so
+ kubectl -n onap exec -it dev-so-so-sdc-controller-c949f5fbd-qhfbl /bin/sh
+
+ mkdir null/ASDC
+ mkdir null/ASDC/1
+ kubectl -n onap cp service-Sdwanvpninfraservice-csar.csar dev-so-so-bpmn-infra-58796498cf-6pzmz:null/ASDC/1/service-Sdwanvpninfraservice-csar.csar
+ kubectl -n onap cp service-Sdwanvpninfraservice-csar.csar dev-so-so-bpmn-infra-58796498cf-6pzmz:ASDC/1/service-Sdwanvpninfraservice-csar.csar
+
+d) populate model information to SO db
+ the db script example can be seen in https://wiki.onap.org/display/DW/Manual+steps+for+CCVPN+Integration+Testing
+
+The same would also be applicable for the integration of the client to create the service and get the details.
+Currently the testing has been performed using the postman calls to the corresponding APIs.
+
+3) SDC-1955 & SDC-1958. Site serivce parsing Error
+
+UUI: stored the csar which created based on beijing release under a fixed directory, If site serive can't parsed by SDC tosca parser, UUI will parse this default csar and get the input parameter
+a) Make an available csar file for CCVPN use case.
+b) Replace uuid of available files with what existing in SDC.
+c) Put available csar files in UUI local path (/home/uui).
+
+4) SO-1248. Csar needs to be manually placed into the bpmn corresponding directory
+
+After SDC distribution success, copy all csar files from so-sdc-controller:
+ connect to so-sdc-controller( eg: kubectl.exe exec -it -n onap dev-so-so-sdc-controller-77df99bbc9-stqdz /bin/sh )
+ find out all csar files ( eg: find / -name '*.csar' )
+ the csar files should be in this path: /app/null/ASDC/ ( eg: /app/null/ASDC/1/service-Sotnvpninfraservice-csar.csar )
+ exit from the so-sdc-controller ( eg: exit )
+ copy all csar files to local derectory ( eg: kubectl.exe cp onap/dev-so-so-sdc-controller-6dfdbff76c-64nf9:/app/null/ASDC/tmp/service-DemoService-csar.csar service-DemoService-csar.csar -c so-sdc-controller )
+
+Copy csar files, which got from so-sdc-controller, to so-bpmn-infra
+ connect to so-bpmn-infra ( eg: kubectl.exe -n onap exec -it dev-so-so-bpmn-infra-54db5cd955-h7f5s -c so-bpmn-infra /bin/sh )
+ check the /app/ASDC deretory, if doesn't exist, create it ( eg: mkdir /app/ASDC -p )
+ exit from the so-bpmn-infra ( eg: exit )
+ copy all csar files to so-bpmn-infra ( eg: kubectl.exe cp service-Siteservice-csar.csar onap/dev-so-so-bpmn-infra-54db5cd955-h7f5s:/app/ASDC/1/service-Siteservice-csar.csar )
+
+5) Manual steps in closed loop Scenario:
+Following steps were undertaken for the closed loop testing.
+a. Give controller ip, username and password, trust store and key store file in restconf collector collector.properties
+b. Updated DMAAP ip in cambria.hosts in DmaapConfig.json in restconf collector and run restconf collector
+c. Followed the steps provided in this link(https://wiki.onap.org/display/DW/Holmes+User+Guide+-+Casablanca#HolmesUserGuide-Casablanca-Configurations) to push CCVPN rules to holmes
+d. Followed the steps provided in this link(https://wiki.onap.org/display/DW/ONAP+Policy+Framework%3A+Installation+of+Amsterdam+Controller+and+vCPE+Policy) as reference to push CCVPN policies to policy module and updated sdnc.url, username and password in environment(/opt/app/policy/config/controlloop.properties.environment)
+As per wiki (Policy on OOM), push-policied.sh script is used to install policies. but I observed that CCVPN policy is not added in this script. So merged CCVPN policy using POLICY-1356 JIRA ticket. but policy is pushed by using push-policy_casablanca.sh script during integration test.
+It is found that the changes made were overwritten and hence had to patch the DG manually. This will be tracked by the JIRA SDNC-540.
+
+all above manual steps can be found https://wiki.onap.org/display/DW/Manual+steps+for+CCVPN+Integration+Testing \ No newline at end of file
diff --git a/docs/docs_scaleout.rst b/docs/docs_scaleout.rst
index 184bee29d..0d4e38777 100644
--- a/docs/docs_scaleout.rst
+++ b/docs/docs_scaleout.rst
@@ -1,3 +1,5 @@
+.. _docs_scaleout:
+
VF Module Scale Out Use Case
----------------------------
diff --git a/docs/docs_usecases.rst b/docs/docs_usecases.rst
new file mode 100644
index 000000000..1d649bc86
--- /dev/null
+++ b/docs/docs_usecases.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _docs_usecases:
+
+Use Cases Verified at Casablanca Release
+----------------------------------------
+
+Description
+~~~~~~~~~~~
+This session includes use cases have been tested in Casablanca release by Integration team:
+ 1. How to run them
+ 2. Known issues and workaround
+
+Use Cases
+~~~~~~~~~
+:ref:`vFirewall Use Case <docs_vfw>`
+
+:ref:`vLoadBalancer Use Case <docs_vlb>`
+
+:ref:`vCPE with Tosca VNF Use Case <docs_vcpe_tosca>`
+
+:ref:`vFW with HPA Use Case <docs_vfw_hpa>`
+
+:ref:`VF Module Scale Out Use Case <docs_scaleout>` \ No newline at end of file
diff --git a/docs/docs_vcpe_tosca.rst b/docs/docs_vCPE with Tosca VNF.rst
index faa4e7590..4a5b6fc69 100644
--- a/docs/docs_vcpe_tosca.rst
+++ b/docs/docs_vCPE with Tosca VNF.rst
@@ -1,31 +1,87 @@
-vCPE of Tosca Use Case
-----------------------
+.. _docs_vcpe_tosca:
-Source files
-~~~~~~~~~~~
+vCPE with Tosca VNF
+----------------------------
+VNF Packages and NS Packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE
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
Description
+~~~~~~~~~~~
+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.
+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.
+The original vCPE Use Case Wiki Page can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=3246168
+
+How to Use
~~~~~~~~~~
-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.
+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
-Test Plan:
-~~~~~~~~~~~~~~~~~~
+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
+::
+ openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2
+
+Flavor 12:
+2 vcpus, 2 Gbytes of memory, 20Gb disk
+Numa page size: 2Mbytes and number pages 1024
+::
+
+ openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2
+
+Flavor 13:
+2 vcpus, 4 Gbytes of memory, 20Gb disk
+Huge page size: 2Mbytes and number pages 2048
+1 SRIOV-NIC VF
+::
+
+ 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
+
+comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network.
+
+2)Policy Configuration
+After the patch https://gerrit.onap.org/r/#/c/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.
+
+- 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.
+
+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.
+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
+
+More details can be fonud here: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+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)
Infra part of policy asking for:
@@ -75,62 +131,29 @@ 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.
-Test Steps:
-~~~~~~~~~~
-
-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
-::
+This case completed all tests as found here: https://wiki.onap.org/display/DW/vCPE+with+TOSCA+VNF+Integration+Test++-+Test+status
- openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2
-
-Flavor 12:
-2 vcpus, 2 Gbytes of memory, 20Gb disk
-Numa page size: 2Mbytes and number pages 1024
-::
-
- openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2
-
-Flavor 13:
-2 vcpus, 4 Gbytes of memory, 20Gb disk
-Huge page size: 2Mbytes and number pages 2048
-1 SRIOV-NIC VF
-::
-
- 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
-
-comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network.
-
-Policy Configuration:
-^^^^^^^^^^^^^^^^^^^^^
-
-After the patch https://gerrit.onap.org/r/#/c/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.
-
-- 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.
-
-
-Running the Use Case
-~~~~~~~~~~~~~~~~~~~
-
-We design vCPE in SDC and distribute it to VFC and Policy and UUI. We can click onboarding VNF and onboarding NS. we can instance it.
-
-Known issues and resolution
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+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 https://jira.opnfv.org/browse/PARSER-187. we also filed a 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/#/c/73332/ is not accepted by 1.2.4 image.It will be accepted by 1.2.5 image. but 1.2.5 image is not 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.
+- OOF patch https://gerrit.onap.org/r/#/c/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/#/c/73852/
+- grant error patch not merged into VF-C 1.2.2 image: https://gerrit.onap.org/r/#/c/73833/ and https://gerrit.onap.org/r/#/c/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"
+
diff --git a/docs/docs_vCPE.rst b/docs/docs_vCPE.rst
new file mode 100644
index 000000000..b7e67173c
--- /dev/null
+++ b/docs/docs_vCPE.rst
@@ -0,0 +1,36 @@
+vCPE Use Case
+----------------------------
+
+Description
+~~~~~~~~~~~
+vCPE 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.
+
+More details on the vCPE Use Case can be found on wiki page https://wiki.onap.org/pages/viewpage.action?pageId=3246168
+
+Source Code
+~~~~~~~~~~~
+vcpe test scripts: https://gerrit.onap.org/r/gitweb?p=integration.git;a=tree;f=test/vcpe;h=76572f4912e7b375e1e4d0177a0e50a61691dc4a;hb=refs/heads/casablanca
+
+How to Use
+~~~~~~~~~~
+Most part of the use case has been automated by vcpe scripts. For the details on how to run the scripts, please refer to the use case tutorial on https://wiki.onap.org/display/DW/vCPE+Use+Case+Tutorial%3A+Design+and+Deploy+based+on+ONAP.
+
+Test Status
+~~~~~~~~~~~~~~~~~~~~~
+The use case has been tested for Casablanca release, the test report can be found on https://wiki.onap.org/display/DW/vCPE+-+Test+Status
+
+Known Issues and Workaround
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1) Firewalls are installed on BRG and vBNG. In order to allow SDNC to send BRG configuration message through vBNG, SDNC host VM IP address is preloaded on BRG and vBNG, and provisioned into the firewalls. If SDNC changes its host VM, SDNC host VM IP changes and we need to manually update the IP in /opt/config/sdnc_ip.txt. Then run:
+
+::
+
+ root>vppctl tap delete tap-0
+ root>vppctl tap delete tap-1
+ root>/opt/nat_service.sh
+ root>vppctl restart
+
+2) APPC has a bug which prevents DG from reading AAI info. We needs an DG update. See the JIRA on https://jira.onap.org/browse/APPC-1249
+
+3) In closed loop, APPC fails to send response back to Policy via an DMAAP message. Policy will keep sending reboot action request until timed out or ABATED message is received. User may see 3 or 4 vGMUX reboots before service returns normal. See the JIRA on https://jira.onap.org/browse/APPC-1247
+
diff --git a/docs/docs_vfw.rst b/docs/docs_vfw.rst
index af47c464b..a722c67d5 100644
--- a/docs/docs_vfw.rst
+++ b/docs/docs_vfw.rst
@@ -1,3 +1,5 @@
+.. _docs_vfw:
+
vFirewall Use Case
------------------
diff --git a/docs/docs_vfwHPA.rst b/docs/docs_vfwHPA.rst
new file mode 100644
index 000000000..87661c12b
--- /dev/null
+++ b/docs/docs_vfwHPA.rst
@@ -0,0 +1,830 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2018 ONAP
+
+.. _docs_vfw_hpa:
+
+vFW with HPA Tutorial: Setting Up and Configuration
+----------------------------------------------------
+
+Description
+~~~~~~~~~~~
+This use case makes modifications to the regular vFW use case in ONAP by giving the VMs certain hardware features (such as SRIOV NIC, CPU pinning, pci passthrough.. etc.) in order to enhance their performance. Multiple cloud regions with flavors that have HPA features are registered with ONAP. We then create policies that specify the HPA requirements of each VM in the use case. When a service instance is created with OOF specified as the homing solution, OOF responds with the homing solution (cloud region) and flavor directives that meet the requirements specified in the policy.
+This tutorial covers enhancements 1 to 5 in Background of https://wiki.onap.org/pages/viewpage.action?pageId=41421112. It focuses on Test Plan 1.
+
+**Useful Links**
+
+`HPA Test Plan Page <https://wiki.onap.org/pages/viewpage.action?pageId=41421112>`_
+
+`HPA Enhancements Page <https://wiki.onap.org/pages/viewpage.action?pageId=34376310>`_
+
+`vFW with HPA Test Status Page <https://wiki.onap.org/display/DW/vFW+with+HPA+Integration+Test+-+Test+Status>`_
+
+
+`Hardware Platform Enablement in ONAP <https://wiki.onap.org/display/DW/Hardware+Platform+Enablement+In+ONAP>`_
+
+
+
+Setting Up and Installation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Some fixes for HPA support were made subsequent to the release of the Casablanca images. Several updated docker images need to be used to utilize the fixes. The details of the docker images that need to be used and the issues that are fixed are described at this link https://wiki.onap.org/display/DW/Docker+image+updates+for+HPA+vFW+testing
+
+Instructions for updating the manifest of ONAP docker images can be found here: https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/#deploying-an-updated-docker-manifest
+
+Install OOM ONAP using the deploy script in the integration repo. Instructions for this can be found in this link https://wiki.onap.org/display/DW/OOM+Component. When the installation is complete (all the pods are either in running or completed state) Do the following;
+
+
+1. Check that all the required components were deployed;
+
+ ``oom-rancher# helm list``
+
+2. Check the state of the pods;
+
+ ``oom-rancher# kubectl get pods -n onap``
+
+3. Run robot health check
+
+ ``oom-rancher# cd oom/kubernetes/robot``
+
+ ``oom-rancher# ./ete-k8s.sh onap health``
+
+ Ensure all the required components pass the health tests
+4. Modify the SO bpmn configmap to change the SO vnf adapter endpoint to v2
+
+ ``oom-rancher# kubectl -n onap edit configmap dev-so-so-bpmn-infra-app-configmap``
+
+ ``- vnf:``
+
+           ``endpoint: http://so-openstack-adapter.onap:8087/services/VnfAdapter``
+
+           ``rest:``
+
+             ``endpoint: http://so-openstack-adapter.onap:8087/services/rest/v1/vnfs``
+  
+ ``+ vnf:``
+
+           ``endpoint: http://so-openstack-adapter.onap:8087/services/VnfAdapter``
+
+           ``rest:``
+
+             ``endpoint: http://so-openstack-adapter.onap:8087/services/rest/v2/vnfs`` 
+
+ Then delete the bpmn pod
+
+ ``oom-rancher# kubectl delete <pod-name> -n onap``
+
+5. Run robot healthdist
+
+ ``oom-rancher# ./ete-k8s.sh onap healthdist``
+6. Run robot demo init, this initializes the default Demonstration customer and distributes the default models
+
+ ``oom-rancher# ./demo-k8s.sh onap init``
+
+7. Create HPA flavors in cloud regions to be registered with ONAP. All HPA flavor names must start with onap. During our tests, 3 cloud regions were registered and we created flavors in each cloud. The flavors match the flavors described in the test plan `here <https://wiki.onap.org/pages/viewpage.action?pageId=41421112>`_.
+
+- **Cloud Region One**
+
+ **Flavor11**
+ ``#nova flavor-create onap.hpa.flavor11 111 8 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor11 set hw:mem_page_size=2048``
+
+ **Flavor12**
+ ``#nova flavor-create onap.hpa.flavor12 112 12 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor12 set hw:mem_page_size=2048``
+
+ ``#openstack aggregate create --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-shared-1:3 aggr121``
+
+ ``#openstack flavor set onap.hpa.flavor12 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-shared-1:3``
+
+ **Flavor13**
+ ``#nova flavor-create onap.hpa.flavor13 113 12 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor13 set hw:mem_page_size=2048``
+
+ ``#openstack aggregate create --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-private-1:1 aggr131``
+
+ ``#openstack flavor set onap.hpa.flavor13 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-private-1:1``
+
+- **Cloud Region Two**
+
+ **Flavor21**
+ ``#nova flavor-create onap.hpa.flavor21 221 8 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor21 set hw:mem_page_size=2048``
+
+ ``#nova flavor-key onap.hpa.flavor21 set hw:cpu_policy=dedicated``
+
+ ``#nova flavor-key onap.hpa.flavor21 set hw:cpu_thread_policy=isolate``
+
+ **Flavor22**
+ ``#nova flavor-create onap.hpa.flavor22 222 12 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor22 set hw:mem_page_size=2048``
+
+ ``#openstack aggregate create --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-shared-1:2 aggr221``
+
+ ``#openstack flavor set onap.hpa.flavor22 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-shared-1:2``
+
+ **Flavor23**
+ ``#nova flavor-create onap.hpa.flavor23 223 12 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor23 set hw:mem_page_size=2048``
+
+ ``#openstack aggregate create --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-private-1:2 aggr231``
+
+ ``#openstack flavor set onap.hpa.flavor23 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-private-1:2``
+
+- **Cloud Region Three**
+
+ **Flavor31**
+ ``#nova flavor-create onap.hpa.flavor31 331 8 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor31 set hw:mem_page_size=2048``
+
+ ``#nova flavor-key onap.hpa.flavor31 set hw:cpu_policy=dedicated``
+
+ ``#nova flavor-key onap.hpa.flavor31 set hw:cpu_thread_policy=isolate``
+
+ **Flavor32**
+ ``#nova flavor-create onap.hpa.flavor32 332 8192 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor32 set hw:mem_page_size=1048576``
+
+ **Flavor33**
+ ``#nova flavor-create onap.hpa.flavor33 333 12 20 2``
+
+ ``#nova flavor-key onap.hpa.flavor33 set hw:mem_page_size=2048``
+
+ ``#openstack aggregate create --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-shared-1:1 aggr331``
+
+ ``#openstack flavor set onap.hpa.flavor33 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-8086-154C-shared-1:1``
+
+
+8. Check that the cloud complex has the right values and update if it does not. Required values are;
+
+ "elevation": "example-elevation-val-28399",
+
+ "lata": "example-lata-val-28399",
+
+ "country": "USA",
+
+ "latitude": "32.89948",
+
+ "longitude": "97.045443",
+
+ "postal-code": "00000
+
+
+If an update is needed, the update can be done via rest using curl or postman
+
+::
+
+ curl -X PUT \
+ https://$ONAP_AAI_IP:$ONAP_AAI_PORT/aai/v14/cloud-infrastructure/complexes/complex/clli1 \
+ -H 'Accept: application/json' \
+ -H 'Authorization: Basic QUFJOkFBSQ==' \
+ -H 'Cache-Control: no-cache' \
+ -H 'Content-Type: application/json' \
+ -H 'Postman-Token: 2b272126-aa65-41e6-aa5d-46bc70b9eb4f' \
+ -H 'Real-Time: true' \
+ -H 'X-FromAppId: jimmy-postman' \
+ -H 'X-TransactionId: 9999' \
+ -d '{
+ "physical-location-id": "clli1",
+ "data-center-code": "example-data-center-code-val-5556",
+ "complex-name": "clli1",
+ "identity-url": "example-identity-url-val-56898",
+ "resource-version": "1543284556407",
+ "physical-location-type": "example-physical-location-type-val-7608",
+ "street1": "example-street1-val-34205",
+ "street2": "example-street2-val-99210",
+ "city": "example-city-val-27150",
+ "state": "example-state-val-59487",
+ "postal-code": "00000",
+ "country": "USA",
+ "region": "example-region-val-13893",
+ "latitude": "32.89948",
+ "longitude": "97.045443",
+ "elevation": "example-elevation-val-28399",
+ "lata": "example-lata-val-28399"
+
+ }'
+
+9. Register new cloud regions. This can be done using instructions (Step 1 to Step 3) on this `page <https://onap.readthedocs.io/en/latest/submodules/multicloud/framework.git/docs/multicloud-plugin-windriver/UserGuide-MultiCloud-WindRiver-TitaniumCloud.html#tutorial-onboard-instance-of-wind-river-titanium-cloud>`_. The already existing CloudOwner and cloud complex can be used. If step 3 does not work using the k8s ip and external port. It can be done using the internal ip address and port. Exec into any pod and run the command from the pod.
+
+- Get msb-iag internal ip address and port
+
+ ``oom-rancher# kubectl get services -n onap |grep msb-iag``
+
+- Exec into any pod (oof in this case) and run curl command, you may need to install curl
+
+ ``oom-rancher# kubectl exec dev-oof-oof-6c848594c5-5khps -it -- bash``
+
+10. Put required subscription list into tenant for all the newly added cloud regions. An easy way to do this is to do a get on the default cloud region, copy the tenant information with the subscription. Then paste it in your put command and modify the region id, tenant-id, tenant-name and resource-version.
+
+**GET COMMAND**
+
+::
+
+ curl -X GET \
+ https://$ONAP_AAI_IP:$ONAP_AAI_PORT/aai/v14/cloud-infrastructure/cloud-regions/cloud-region/${CLOUD_OWNER}/${CLOUD_REGION_ID}?depth=all \
+ -H 'Accept: application/json' \
+ -H 'Authorization: Basic QUFJOkFBSQ==' \
+ -H 'Cache-Control: no-cache' \
+ -H 'Content-Type: application/json' \
+ -H 'Postman-Token: 2899359f-871b-4e61-a307-ecf8b3144e3f' \
+ -H 'Real-Time: true' \
+ -H 'X-FromAppId: jimmy-postman' \
+ -H 'X-TransactionId: 9999'
+
+**PUT COMMAND**
+::
+
+ curl -X PUT \
+ https://{{AAI1_PUB_IP}}:{{AAI1_PUB_PORT}}/aai/v14/cloud-infrastructure/cloud-regions/cloud-region/{{cloud-owner}}/{{cloud-region-id}}/tenants/tenant/{{tenant-id}} \
+ -H 'Accept: application/json' \
+ -H 'Authorization: Basic QUFJOkFBSQ==' \
+ -H 'Cache-Control: no-cache' \
+ -H 'Content-Type: application/json' \
+ -H 'Postman-Token: 2b272126-aa65-41e6-aa5d-46bc70b9eb4f' \
+ -H 'Real-Time: true' \
+ -H 'X-FromAppId: jimmy-postman' \
+ -H 'X-TransactionId: 9999' \
+ -d '{
+ "tenant-id": "709ba629fe194f8699b12f9d6ffd86a0",
+ "tenant-name": "Integration-HPA",
+ "resource-version": "1542650451856",
+ "relationship-list": {
+ "relationship": [
+ {
+ "related-to": "service-subscription",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v14/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vFWCL",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vFWCL"
+ }
+ ]
+ },
+ {
+ "related-to": "service-subscription",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v14/business/customers/customer/Demonstration/service-subscriptions/service-subscription/gNB",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "gNB"
+ }
+ ]
+ },
+ {
+ "related-to": "service-subscription",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v14/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vFW",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vFW"
+ }
+ ]
+ },
+ {
+ "related-to": "service-subscription",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v14/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vCPE",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vCPE"
+ }
+ ]
+ },
+ {
+ "related-to": "service-subscription",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v14/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vFW_HPA",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vFW_HPA"
+ }
+ ]
+ },
+ {
+ "related-to": "service-subscription",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v14/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vLB",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vLB"
+ }
+ ]
+ },
+ {
+ "related-to": "service-subscription",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v14/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vIMS",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vIMS"
+ }
+ ]
+ }
+ ]
+ }
+ }'
+
+
+11. Onboard the vFW HPA template. The templates can be gotten from the `demo <https://github.com/onap/demo>`_ repo. The heat and env files used are located in demo/heat/vFW_HPA/vFW/. Create a zip file using the files. For onboarding instructions see steps 4 to 9 of `vFWCL instantiation, testing and debugging <https://wiki.onap.org/display/DW/vFWCL+instantiation%2C+testing%2C+and+debuging>`_. Note that in step 5, only one VSP is created. For the VSP the option to submit for testing in step 5cii was not shown. So you can check in and certify the VSP and proceed to step 6.
+
+12. Get the parameters (model info, model invarant id...etc) required to create a service instance via rest. This can be done by creating a service instance via VID as in step 10 of `vFWCL instantiation, testing and debugging <https://wiki.onap.org/display/DW/vFWCL+instantiation%2C+testing%2C+and+debuging>`_. After creating the service instance, exec into the SO bpmn pod and look into the /app/logs/bpmn/debug.log file. Search for the service instance and look for its request details. Then populate the parameters required to create a service instance via rest in step 13 below.
+
+13. Create a service instance rest request but do not create service instance yet. Specify OOF as the homing solution and multicloud as the orchestrator. Be sure to use a service instance name that does not exist and populate the parameters with values gotten from step 12.
+
+::
+
+ curl -k -X POST \
+ http://{{k8s}}:30277/onap/so/infra/serviceInstances/v6 \
+ -H 'authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA== \
+ -H 'content-type: application/json' \
+
+ -d '{
+
+ "requestDetails":{
+
+ "modelInfo":{
+
+ "modelInvariantId":"b7564cb9-4074-4c9b-95d6-39d4191e80d9",
+
+ "modelType":"service",
+
+ "modelName":"vfw_HPA",
+
+ "modelVersion":"1.0",
+
+ "modelVersionId":"35d184e8-1cba-46e3-9311-a17ace766eb0",
+
+ "modelUuid":"35d184e8-1cba-46e3-9311-a17ace766eb0",
+
+ "modelInvariantUuid":"b7564cb9-4074-4c9b-95d6-39d4191e80d9"
+
+ },
+
+ "requestInfo":{
+
+ "source":"VID",
+
+ "instanceName":"oof-12-homing",
+
+ "suppressRollback":false,
+
+ "requestorId":"demo"
+
+ },
+
+ "subscriberInfo":{
+
+ "globalSubscriberId":"Demonstration"
+
+ },
+
+ "requestParameters":{
+
+ "subscriptionServiceType":"vFW",
+
+ "aLaCarte":true,
+
+ "testApi":"VNF_API",
+
+ "userParams":[
+
+ {
+
+ "name":"Customer_Location",
+
+ "value":{
+
+ "customerLatitude":"32.897480",
+
+ "customerLongitude":"97.040443",
+
+ "customerName":"some_company"
+
+ }
+
+ },
+
+ {
+
+ "name":"Homing_Solution",
+
+ "value":"oof"
+
+ },
+
+ {
+
+ "name":"orchestrator",
+
+ "value":"multicloud"
+
+ }
+
+ ]
+
+ },
+
+ "project":{
+
+ "projectName":"Project-Demonstration"
+
+ },
+
+ "owningEntity":{
+
+ "owningEntityId":"e1564fc9-b9d0-44f9-b5af-953b4aad2f40",
+
+ "owningEntityName":"OE-Demonstration"
+
+ }
+
+ }
+
+ }'
+
+14. Get the resourceModuleName to be used for creating policies. This can be gotten from the CSAR file of the service model created. However, an easy way to get the resourceModuleName is to send the service instance create request in step 13 above. This will fail as there are no policies but you can then go into the bpmn debug.log file and get its value by searching for resourcemodulename.
+
+15. Create policies. For instructions to do this, look in **method 2 (Manual upload)** of `OOF - HPA guide for integration testing <https://wiki.onap.org/display/DW/OOF+-+HPA+guide+for+integration+testing>`_. Put in the correct resouceModuleName. This is located in the resources section of the rest request. For example the resourceModuleName in the distance policy is 7400fd06C75f4a44A68f.
+
+16. Do a get to verify all the polcies have been put in correctly. This can be done by doing an exec into the policy-pdp pod and running the following curl command.
+
+::
+
+ curl -k -v -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'ClientAuth: cHl0aG9uOnRlc3Q=' -H 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' -H 'Environment: TEST' -X POST -d '{"policyName": "OSDF_CASABLANCA.*", "configAttributes": {"policyScope": "us"}}' 'https://pdp:8081/pdp/api/getConfig' | python -m json.tool
+
+To Update a policy, use the following curl command. Modify the policy as required
+
+::
+
+ curl -k -v -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "configBody": "{\"service\":\"hpaPolicy\",\"guard\":\"False\",\"content\":{\"flavorFeatures\":[{\"directives\":[{\"attributes\":[{\"attribute_value\":\"\",\"attribute_name\":\"firewall_flavor_name\"}],\"type\":\"flavor_directives\"}],\"type\":\"vnfc\",\"flavorProperties\":[{\"mandatory\":\"True\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"2\",\"unit\":\"\",\"operator\":\"=\",\"hpa-attribute-key\":\"numVirtualCpu\"},{\"hpa-attribute-value\":\"8\",\"unit\":\"MB\",\"operator\":\"=\",\"hpa-attribute-key\":\"virtualMemSize\"}],\"directives\":[],\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"hpa-feature\":\"basicCapabilities\"},{\"mandatory\":\"True\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"2\",\"unit\":\"MB\",\"operator\":\"=\",\"hpa-attribute-key\":\"memoryPageSize\"}],\"directives\":[],\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"hpa-feature\":\"hugePages\"},{\"hpa-feature\":\"localStorage\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"diskSize\",\"hpa-attribute-value\":\"10\",\"operator\":\">=\",\"unit\":\"GB\"}]},{\"mandatory\":\"False\",\"score\":\"100\",\"directives\":[],\"hpa-version\":\"v1\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"1\",\"unit\":\"\",\"operator\":\"=\",\"hpa-attribute-key\":\"pciCount\"},{\"hpa-attribute-value\":\"8086\",\"unit\":\"\",\"operator\":\"=\",\"hpa-attribute-key\":\"pciVendorId\"},{\"hpa-attribute-value\":\"37c9\",\"unit\":\"\",\"operator\":\"=\",\"hpa-attribute-key\":\"pciDeviceId\"}],\"architecture\":\"vf\",\"hpa-feature\":\"pciePassthrough\"}],\"id\":\"vfw\"},{\"directives\":[{\"attributes\":[{\"attribute_value\":\"\",\"attribute_name\":\"packetgen_flavor_name\"}],\"type\":\"flavor_directives\"}],\"type\":\"vnfc\",\"flavorProperties\":[{\"mandatory\":\"True\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"1\",\"operator\":\">=\",\"hpa-attribute-key\":\"numVirtualCpu\"},{\"hpa-attribute-value\":\"7\",\"unit\":\"GB\",\"operator\":\">=\",\"hpa-attribute-key\":\"virtualMemSize\"}],\"directives\":[],\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"hpa-feature\":\"basicCapabilities\"},{\"hpa-feature\":\"localStorage\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"diskSize\",\"hpa-attribute-value\":\"10\",\"operator\":\">=\",\"unit\":\"GB\"}]}],\"id\":\"vgenerator\"},{\"directives\":[{\"attributes\":[{\"attribute_value\":\"\",\"attribute_name\":\"sink_flavor_name\"}],\"type\":\"flavor_directives\"}],\"id\":\"vsink\",\"type\":\"vnfc\",\"flavorProperties\":[{\"mandatory\":\"True\",\"directives\":[],\"hpa-version\":\"v1\",\"hpa-feature-attributes\":[],\"architecture\":\"generic\",\"hpa-feature\":\"basicCapabilities\"}]}],\"policyType\":\"hpa\",\"policyScope\":[\"vfw\",\"us\",\"international\",\"ip\"],\"identity\":\"hpa-vFW\",\"resources\":[\"vFW\",\"A5ece5a02e86450391d6\"]},\"priority\":\"3\",\"templateVersion\":\"OpenSource.version.1\",\"riskLevel\":\"2\",\"description\":\"HPApolicyforvFW\",\"policyName\":\"OSDF_CASABLANCA.hpa_policy_vFW_1\",\"version\":\"test1\",\"riskType\":\"test\"}",
+ "policyName": "OSDF_CASABLANCA.hpa_policy_vFW_1",
+ "policyConfigType": "MicroService",
+ "onapName": "SampleDemo",
+ "policyScope": "OSDF_CASABLANCA"
+ }' 'https://pdp:8081/pdp/api/updatePolicy'
+
+
+To delete a policy, use two commands below to delete from PDP and PAP
+
+**DELETE POLICY INSIDE PDP**
+
+::
+
+ curl -k -v -H 'Content-Type: application/json' \
+ -H 'Accept: application/json' \
+ -H 'ClientAuth: cHl0aG9uOnRlc3Q=' \
+ -H 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' \
+ -H 'Environment: TEST' \
+ -X DELETE \
+ -d '{"policyName": "OSDF_CASABLANCA.Config_MS_vnfPolicy_vFWHPA.1.xml","policyComponent":"PDP","policyType":"MicroService","pdpGroup":"default"}' https://pdp:8081/pdp/api/deletePolicy
+
+
+**DELETE POLICY INSIDE PAP**
+
+::
+
+ curl -k -v -H 'Content-Type: application/json' \
+ -H 'Accept: application/json' \
+ -H 'ClientAuth: cHl0aG9uOnRlc3Q=' \
+ -H 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' \
+ -H 'Environment: TEST' \
+ -X DELETE \
+ -d '{"policyName": "OSDF_CASABLANCA.Config_MS_vnfPolicy_vFWHPA.1.xml","policyComponent":"PAP","policyType":"Optimization","deleteCondition":"ALL"}' https://pdp:8081/pdp/api/deletePolicy
+
+Below are the 3 HPA policies for test cases in the `test plan <https://wiki.onap.org/pages/viewpage.action?pageId=41421112>`_
+
+**Test 1 (Basic)**
+
+Create Policy
+
+::
+
+ curl -k -v -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "configBody": "{\"service\":\"hpaPolicy\",\"guard\":\"False\",\"content\":{\"flavorFeatures\":[{\"directives\":[{\"attributes\":[{\"attribute_value\":\"\",\"attribute_name\":\"firewall_flavor_name\"}],\"type\":\"flavor_directives\"}],\"type\":\"vnfc\",\"flavorProperties\":[{\"mandatory\":\"True\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"2\",\"unit\":\"\",\"operator\":\"=\",\"hpa-attribute-key\":\"numVirtualCpu\"},{\"hpa-attribute-value\":\"8\",\"unit\":\"MB\",\"operator\":\"=\",\"hpa-attribute-key\":\"virtualMemSize\"}],\"directives\":[],\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"hpa-feature\":\"basicCapabilities\"},{\"mandatory\":\"True\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"2\",\"unit\":\"MB\",\"operator\":\"=\",\"hpa-attribute-key\":\"memoryPageSize\"}],\"directives\":[],\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"hpa-feature\":\"hugePages\"},{\"hpa-feature\":\"localStorage\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"diskSize\",\"hpa-attribute-value\":\"10\",\"operator\":\">=\",\"unit\":\"GB\"}]},{\"mandatory\":\"False\",\"score\":\"100\",\"directives\":[],\"hpa-version\":\"v1\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"isolate\",\"unit\":\"\",\"operator\":\"=\",\"hpa-attribute-key\":\"logicalCpuThreadPinningPolicy\"},{\"hpa-attribute-value\":\"dedicated\",\"unit\":\"\",\"operator\":\"=\",\"hpa-attribute-key\":\"logicalCpuPinningPolicy\"}],\"architecture\":\"generic\",\"hpa-feature\":\"cpuPinning\"}],\"id\":\"vfw\"},{\"directives\":[{\"attributes\":[{\"attribute_value\":\"\",\"attribute_name\":\"packetgen_flavor_name\"}],\"type\":\"flavor_directives\"}],\"type\":\"vnfc\",\"flavorProperties\":[{\"mandatory\":\"True\",\"hpa-feature-attributes\":[{\"hpa-attribute-value\":\"1\",\"operator\":\">=\",\"hpa-attribute-key\":\"numVirtualCpu\"},{\"hpa-attribute-value\":\"7\",\"unit\":\"GB\",\"operator\":\">=\",\"hpa-attribute-key\":\"virtualMemSize\"}],\"directives\":[],\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"hpa-feature\":\"basicCapabilities\"},{\"hpa-feature\":\"localStorage\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"diskSize\",\"hpa-attribute-value\":\"10\",\"operator\":\">=\",\"unit\":\"GB\"}]}],\"id\":\"vgenerator\"},{\"directives\":[{\"attributes\":[{\"attribute_value\":\"\",\"attribute_name\":\"sink_flavor_name\"}],\"type\":\"flavor_directives\"}],\"id\":\"vsink\",\"type\":\"vnfc\",\"flavorProperties\":[{\"mandatory\":\"True\",\"directives\":[],\"hpa-version\":\"v1\",\"hpa-feature-attributes\":[],\"architecture\":\"generic\",\"hpa-feature\":\"basicCapabilities\"}]}],\"policyType\":\"hpa\",\"policyScope\":[\"vfw\",\"us\",\"international\",\"ip\"],\"identity\":\"hpa-vFW\",\"resources\":[\"vFW\",\"VfwHpa\"]},\"priority\":\"3\",\"templateVersion\":\"OpenSource.version.1\",\"riskLevel\":\"2\",\"description\":\"HPApolicyforvFW\",\"policyName\":\"OSDF_CASABLANCA.hpa_policy_vFWHPA_1\",\"version\":\"test1\",\"riskType\":\"test\"}",
+ "policyName": "OSDF_CASABLANCA.hpa_policy_vFWHPA_1",
+ "policyConfigType": "MicroService",
+ "onapName": "SampleDemo",
+ "policyScope": "OSDF_CASABLANCA"
+ }' 'https://pdp:8081/pdp/api/createPolicy'
+
+
+Push Policy
+
+::
+
+ curl -k -v -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "pdpGroup": "default",
+ "policyName": "OSDF_CASABLANCA.hpa_policy_vFWHPA_1",
+ "policyType": "MicroService"
+ }' 'https://pdp:8081/pdp/api/pushPolicy'
+
+
+
+
+**Test 2: (to test SRIOV-NIC feature) (to ensure that right cloud-region is selected based on score)**
+
+Create Policy
+
+::
+
+ curl -k -v -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "configBody": "{\"service\":\"hpaPolicy\",\"guard\":\"False\",\"content\":{\"flavorFeatures\":[{\"id\":\"vfw\",\"type\":\"vnfc\",\"directives\":[{\"type\":\"flavor_directives\",\"attributes\":[{\"attribute_name\":\"firewall_flavor_name\",\"attribute_value\":\"\"}]}],\"flavorProperties\":[{\"hpa-feature\":\"sriovNICNetwork\",\"hpa-version\":\"v1\",\"architecture\":\"intel\",\"mandatory\":\"True\",\"directives\":[{\"type\":\"sriovNICNetwork_directives\",\"attributes\":[{\"attribute_name\":\"vfw_private_0_port_vnic_type\",\"attribute_value\":\"direct\"}]}],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"pciCount\",\"hpa-attribute-value\":\"1\",\"operator\":\"=\"},{\"hpa-attribute-key\":\"pciVendorId\",\"hpa-attribute-value\":\"8086\",\"operator\":\"=\"},{\"hpa-attribute-key\":\"pciDeviceId\",\"hpa-attribute-value\":\"154C\",\"operator\":\"=\"},{\"hpa-attribute-key\":\"physicalNetwork\",\"hpa-attribute-value\":\"private-1\",\"operator\":\"=\"}]}]},{\"id\":\"vgenerator\",\"type\":\"vnfc\",\"directives\":[{\"type\":\"flavor_directives\",\"attributes\":[{\"attribute_name\":\"packetgen_flavor_name\",\"attribute_value\":\"\"}]}],\"flavorProperties\":[{\"hpa-feature\":\"sriovNICNetwork\",\"hpa-version\":\"v1\",\"architecture\":\"intel\",\"mandatory\":\"True\",\"directives\":[{\"type\":\"sriovNICNetwork_directives\",\"attributes\":[{\"attribute_name\":\"vpg_private_0_port_vnic_type\",\"attribute_value\":\"direct\"}]}],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"pciCount\",\"hpa-attribute-value\":\"3\",\"operator\":\"=\",\"unit\":\"\"},{\"hpa-attribute-key\":\"pciVendorId\",\"hpa-attribute-value\":\"8086\",\"operator\":\"=\",\"unit\":\"\"},{\"hpa-attribute-key\":\"pciDeviceId\",\"hpa-attribute-value\":\"154C\",\"operator\":\"=\",\"unit\":\"\"},{\"hpa-attribute-key\":\"physicalNetwork\",\"hpa-attribute-value\":\"shared-1\",\"operator\":\"=\"}]}]},{\"id\":\"vsink\",\"type\":\"vnfc\",\"directives\":[{\"type\":\"flavor_directives\",\"attributes\":[{\"attribute_name\":\"sink_flavor_name\",\"attribute_value\":\"\"}]}],\"flavorProperties\":[{\"hpa-feature\":\"sriovNICNetwork\",\"hpa-version\":\"v1\",\"architecture\":\"intel\",\"mandatory\":\"True\",\"directives\":[{\"type\":\"sriovNICNetwork_directives\",\"attributes\":[{\"attribute_name\":\"vsn_private_0_port_vnic_type\",\"attribute_value\":\"direct\"}]}],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"pciCount\",\"hpa-attribute-value\":\"1\",\"operator\":\"=\",\"unit\":\"\"},{\"hpa-attribute-key\":\"pciVendorId\",\"hpa-attribute-value\":\"8086\",\"operator\":\"=\",\"unit\":\"\"},{\"hpa-attribute-key\":\"pciDeviceId\",\"hpa-attribute-value\":\"154C\",\"operator\":\"=\",\"unit\":\"\"},{\"hpa-attribute-key\":\"physicalNetwork\",\"hpa-attribute-value\":\"private-1\",\"operator\":\"=\"}]}]}],\"policyType\":\"hpa\",\"policyScope\":[\"vfw\",\"us\",\"international\",\"ip\"],\"identity\":\"hpa-vFW\",\"resources\":[\"vFW\",\"A5ece5a02e86450391d6\"]},\"priority\":\"3\",\"templateVersion\":\"OpenSource.version.1\",\"riskLevel\":\"2\",\"description\":\"HPApolicyforvFW\",\"policyName\":\"OSDF_CASABLANCA.hpa_policy_vFW_2\",\"version\":\"test1\",\"riskType\":\"test\"}",
+ "policyName": "OSDF_CASABLANCA.hpa_policy_vFW_2",
+ "policyConfigType": "MicroService",
+ "onapName": "SampleDemo",
+ "policyScope": "OSDF_CASABLANCA"
+ }' 'https://pdp:8081/pdp/api/createPolicy'
+
+
+Push Policy
+
+::
+
+ curl -k -v -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "pdpGroup": "default",
+ "policyName": "OSDF_CASABLANCA.hpa_policy_vFW_2",
+ "policyType": "MicroService"
+ }' 'https://pdp:8081/pdp/api/pushPolicy'
+
+
+**Test 3 (to ensure that right cloud-region is selected based on score)**
+
+Create Policy
+
+::
+
+ curl -k -v -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "configBody": "{\"service\":\"hpaPolicy\",\"guard\":\"False\",\"content\":{\"flavorFeatures\":[{\"id\":\"vfw\",\"type\":\"vnfc\",\"directives\":[{\"type\":\"flavor_directives\",\"attributes\":[{\"attribute_name\":\"firewall_flavor_name\",\"attribute_value\":\"\"}]}],\"flavorProperties\":[{\"hpa-feature\":\"sriovNICNetwork\",\"hpa-version\":\"v1\",\"architecture\":\"intel\",\"mandatory\":\"False\",\"score\":\"100\",\"directives\":[{\"type\":\"sriovNICNetwork_directives\",\"attributes\":[{\"attribute_name\":\"vfw_private_0_port_vnic_type\",\"attribute_value\":\"direct\"}]}],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"pciCount\",\"hpa-attribute-value\":\"1\",\"operator\":\"=\"},{\"hpa-attribute-key\":\"pciVendorId\",\"hpa-attribute-value\":\"8086\",\"operator\":\"=\"},{\"hpa-attribute-key\":\"pciDeviceId\",\"hpa-attribute-value\":\"154C\",\"operator\":\"=\"},{\"hpa-attribute-key\":\"physicalNetwork\",\"hpa-attribute-value\":\"shared-1\",\"operator\":\"=\"}]},{\"hpa-feature\":\"localStorage\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"diskSize\",\"hpa-attribute-value\":\"10\",\"operator\":\">=\",\"unit\":\"GB\"}]},{\"hpa-feature\":\"hugePages\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"memoryPageSize\",\"hpa-attribute-value\":\"2\",\"operator\":\"=\",\"unit\":\"MB\"}]},{\"hpa-feature\":\"basicCapabilities\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"numVirtualCpu\",\"hpa-attribute-value\":\"2\",\"operator\":\"=\"},{\"hpa-attribute-key\":\"virtualMemSize\",\"hpa-attribute-value\":\"8\",\"operator\":\"=\",\"unit\":\"MB\"}]}]},{\"id\":\"vgenerator\",\"type\":\"vnfc\",\"directives\":[{\"type\":\"flavor_directives\",\"attributes\":[{\"attribute_name\":\"packetgen_flavor_name\",\"attribute_value\":\"\"}]}],\"flavorProperties\":[{\"hpa-feature\":\"hugePages\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"False\",\"score\":\"200\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"memoryPageSize\",\"hpa-attribute-value\":\"1\",\"operator\":\"=\",\"unit\":\"GB\"}]},{\"hpa-feature\":\"localStorage\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"diskSize\",\"hpa-attribute-value\":\"10\",\"operator\":\">=\",\"unit\":\"GB\"}]},{\"hpa-feature\":\"basicCapabilities\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[{\"hpa-attribute-key\":\"numVirtualCpu\",\"hpa-attribute-value\":\"1\",\"operator\":\">=\"},{\"hpa-attribute-key\":\"virtualMemSize\",\"hpa-attribute-value\":\"2\",\"operator\":\">=\",\"unit\":\"GB\"}]}]},{\"id\":\"vsink\",\"type\":\"vnfc\",\"directives\":[{\"type\":\"flavor_directives\",\"attributes\":[{\"attribute_name\":\"sink_flavor_name\",\"attribute_value\":\"\"}]}],\"flavorProperties\":[{\"hpa-feature\":\"basicCapabilities\",\"hpa-version\":\"v1\",\"architecture\":\"generic\",\"mandatory\":\"True\",\"directives\":[],\"hpa-feature-attributes\":[]}]}],\"policyType\":\"hpa\",\"policyScope\":[\"vfw\",\"us\",\"international\",\"ip\"],\"identity\":\"hpa-vFW\",\"resources\":[\"vFW\",\"A5ece5a02e86450391d6\"]},\"priority\":\"3\",\"templateVersion\":\"OpenSource.version.1\",\"riskLevel\":\"2\",\"description\":\"HPApolicyforvFW\",\"policyName\":\"OSDF_CASABLANCA.hpa_policy_vFW_3\",\"version\":\"test1\",\"riskType\":\"test\"}",
+ "policyName": "OSDF_CASABLANCA.hpa_policy_vFW_3",
+ "policyConfigType": "MicroService",
+ "onapName": "SampleDemo",
+ "policyScope": "OSDF_CASABLANCA"
+ }' 'https://pdp:8081/pdp/api/createPolicy'
+
+Push Policy
+
+::
+
+ curl -k -v -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "pdpGroup": "default",
+ "policyName": "OSDF_CASABLANCA.hpa_policy_vFW_3",
+ "policyType": "MicroService"
+ }' 'https://pdp:8081/pdp/api/pushPolicy'
+
+17. Create Service Instance using step 13 above
+
+18. Check bpmn logs to ensure that OOF sent homing response and flavor directives.
+
+19. Create vnf using VID as in 10f and 10g in `vFWCL instantiation, testing and debugging <https://wiki.onap.org/display/DW/vFWCL+instantiation%2C+testing%2C+and+debuging>`_.
+
+20. Do SDNC Preload. Instructions for this can be found in this `video <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos?preview=/1015891/16010290/vFW_closed_loop.mp4>`_ (Fast forward to 3:55 in the video). The contents of my preload file are shown below;
+
+::
+
+ {
+ "input": {
+ "request-information": {
+ "notification-url": "openecomp.org",
+ "order-number": "1",
+ "order-version": "1",
+ "request-action": "PreloadVNFRequest",
+ "request-id": "test"
+ },
+ "sdnc-request-header": {
+ "svc-action": "reserve",
+ "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
+ "svc-request-id": "test"
+ },
+ "vnf-topology-information": {
+ "vnf-assignments": {
+ "availability-zones": [],
+ "vnf-networks": [],
+ "vnf-vms": []
+ },
+
+
+ "vnf-parameters": [
+ {
+ "vnf-parameter-name": "vfw_image_name",
+ "vnf-parameter-value": "ubuntu-16.04"
+ },
+ {
+ "vnf-parameter-name": "firewall_flavor_name",
+ "vnf-parameter-value": "m1.large"
+ },
+ {
+ "vnf-parameter-name": "sink_flavor_name",
+ "vnf-parameter-value": "m1.medium"
+ },
+ {
+ "vnf-parameter-name": "packetgen_flavor_name",
+ "vnf-parameter-value": "m1.large"
+ },
+ {
+ "vnf-parameter-name": "public_net_id",
+ "vnf-parameter-value": "external"
+ },
+ {
+ "vnf-parameter-name": "unprotected_private_net_id",
+ "vnf-parameter-value": "unprotected_private_net"
+ },
+ {
+ "vnf-parameter-name": "protected_private_net_id",
+ "vnf-parameter-value": "protected_private_net"
+ },
+ {
+ "vnf-parameter-name": "onap_private_net_id",
+ "vnf-parameter-value": "oam_onap_vnf_test"
+ },
+ {
+ "vnf-parameter-name": "onap_private_subnet_id",
+ "vnf-parameter-value": "oam_onap_vnf_test"
+ },
+ {
+ "vnf-parameter-name": "unprotected_private_net_cidr",
+ "vnf-parameter-value": "192.168.10.0/24"
+ },
+ {
+ "vnf-parameter-name": "protected_private_net_cidr",
+ "vnf-parameter-value": "192.168.20.0/24"
+ },
+ {
+ "vnf-parameter-name": "onap_private_net_cidr",
+ "vnf-parameter-value": "10.0.0.0/16"
+ },
+ {
+ "vnf-parameter-name": "vfw_private_ip_0",
+ "vnf-parameter-value": "192.168.10.100"
+ },
+ {
+ "vnf-parameter-name": "vfw_private_ip_1",
+ "vnf-parameter-value": "192.168.20.100"
+ },
+ {
+ "vnf-parameter-name": "vfw_private_ip_2",
+ "vnf-parameter-value": "10.0.100.1"
+ },
+ {
+ "vnf-parameter-name": "vpg_private_ip_0",
+ "vnf-parameter-value": "192.168.10.200"
+ },
+ {
+ "vnf-parameter-name": "vpg_private_ip_1",
+ "vnf-parameter-value": "10.0.100.2"
+ },
+ {
+ "vnf-parameter-name": "vsn_private_ip_0",
+ "vnf-parameter-value": "192.168.20.250"
+ },
+ {
+ "vnf-parameter-name": "vsn_private_ip_1",
+ "vnf-parameter-value": "10.0.100.3"
+ },
+
+ {
+ "vnf-parameter-name": "vfw_name_0",
+ "vnf-parameter-value": "vfw"
+ },
+ {
+ "vnf-parameter-name": "vpg_name_0",
+ "vnf-parameter-value": "vpktgen"
+ },
+ {
+ "vnf-parameter-name": "vsn_name_0",
+ "vnf-parameter-value": "vsink"
+ },
+ {
+ "vnf-parameter-name": "vfw_private_0_port_vnic_type",
+ "vnf-parameter-value": "normal"
+ },
+ {
+ "vnf-parameter-name": "vfw_private_1_port_vnic_type",
+ "vnf-parameter-value": "normal"
+ },
+ {
+ "vnf-parameter-name": "vfw_private_2_port_vnic_type",
+ "vnf-parameter-value": "normal"
+ },
+ {
+ "vnf-parameter-name": "vpg_private_0_port_vnic_type",
+ "vnf-parameter-value": "normal"
+ },
+ {
+ "vnf-parameter-name": "vpg_private_1_port_vnic_type",
+ "vnf-parameter-value": "normal"
+ },
+ {
+ "vnf-parameter-name": "vsn_private_0_port_vnic_type",
+ "vnf-parameter-value": "normal"
+ },
+ {
+ "vnf-parameter-name": "vsn_private_1_port_vnic_type",
+ "vnf-parameter-value": "normal"
+ },
+ {
+ "vnf-parameter-name": "vf_module_id",
+ "vnf-parameter-value": "VfwHpa..base_vfw..module-0"
+ },
+ {
+ "vnf-parameter-name": "sec_group",
+ "vnf-parameter-value": "default"
+ },
+ {
+ "vnf-parameter-name": "sdnc_model_name",
+ "vnf-parameter-value": ""
+ },
+ {
+ "vnf-parameter-name": "sdnc_model_version",
+ "vnf-parameter-value": ""
+ },
+ {
+ "vnf-parameter-name": "sdnc_artifact_name",
+ "vnf-parameter-value": ""
+ },
+
+ {
+ "vnf-parameter-name": "oof_directives",
+ "vnf-parameter-value": "{\"directives\": [{\"id\": \"vfw\", \"type\": \"vnfc\", \"directives\": [{\"attributes\": [{\"attribute_name\": \"firewall_flavor_name\", \"attribute_value\": \"onap.hpa.flavor31\"}, {\"attribute_name\": \"flavorId\", \"attribute_value\": \"2297339f-6a89-4808-a78f-68216091f904\"}, {\"attribute_name\": \"flavorId\", \"attribute_value\": \"2297339f-6a89-4808-a78f-68216091f904\"}, {\"attribute_name\": \"flavorId\", \"attribute_value\": \"2297339f-6a89-4808-a78f-68216091f904\"}], \"type\": \"flavor_directives\"}]}, {\"id\": \"vgenerator\", \"type\": \"vnfc\", \"directives\": [{\"attributes\": [{\"attribute_name\": \"packetgen_flavor_name\", \"attribute_value\": \"onap.hpa.flavor32\"}, {\"attribute_name\": \"flavorId\", \"attribute_value\": \"2297339f-6a89-4808-a78f-68216091f904\"}], \"type\": \"flavor_directives\"}]}, {\"id\": \"vsink\", \"type\": \"vnfc\", \"directives\": [{\"attributes\": [{\"attribute_name\": \"sink_flavor_name\", \"attribute_value\": \"onap.large\"}, {\"attribute_name\": \"flavorId\", \"attribute_value\": \"2297339f-6a89-4808-a78f-68216091f904\"}], \"type\": \"flavor_directives\"}]}]}"
+ },
+
+ {
+ "vnf-parameter-name": "sdnc_directives",
+ "vnf-parameter-value": "{}"
+ },
+
+ {
+ "vnf-parameter-name": "template_type",
+ "vnf-parameter-value": "heat"
+ }
+
+
+ ],
+ "vnf-topology-identifier": {
+ "generic-vnf-name": "oof-12-vnf-3",
+ "generic-vnf-type": "vfw_hpa 0",
+ "service-type": "6b17354c-0fae-4491-b62e-b41619929c54",
+ "vnf-name": "vfwhpa_stack",
+ "vnf-type": "VfwHpa..base_vfw..module-0"
+
+ }
+ }
+ }}
+
+
+Change parameters based on your environment.
+
+**Note**
+
+::
+
+ "generic-vnf-name": "oof-12-vnf-3", <-- NAME GIVEN TO VNF
+ "generic-vnf-type": "vfw_hpa 0", <-- can be found on VNF dialog screen get the part of the VNF-TYPE after the '/'
+ "service-type": "6b17354c-0fae-4491-b62e-b41619929c54", <-- same as Service Instance ID
+ "vnf-name": "vfwhpa_stack", <-- name to be given to the vf module
+ "vnf-type": "VfwHpa..base_vfw..module-0" <-- can be found on the VID - VF Module dialog screen - Model Name
+
+21. Create vf module (11g of `vFWCL instantiation, testing and debugging <https://wiki.onap.org/display/DW/vFWCL+instantiation%2C+testing%2C+and+debuging>`_). If everything worked properly, you should see the stack created in your VIM(WR titanium cloud openstack in this case).
diff --git a/docs/docs_vlb.rst b/docs/docs_vlb.rst
index 07671cd75..ded308f05 100644
--- a/docs/docs_vlb.rst
+++ b/docs/docs_vlb.rst
@@ -1,3 +1,5 @@
+.. _docs_vlb:
+
vLoadBalancer Use Case
----------------------
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 000000000..d746a32f5
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,114 @@
+
+.. This work is licensed under a Creative Commons Attribution 4.0
+ International License. http://creativecommons.org/licenses/by/4.0
+ Copyright 2018 Huawei Technologies Co., Ltd. All rights reserved.
+
+.. _doc-release-notes:
+
+Integration Release Notes
+=============
+
+
+Integration Repo
+================
+
+Version: 3.0.0
+--------------
+
+:Release Date: 2018-11-30
+
+**New Features**
+
+* Enahanced deployment scripts and HEAT template for automated deployment of OOM onto a HA-enabled Kubernetes cluster
+* Updated scripts for OOM daily automated deployment tests
+* Added various helper scripts and configuration files for assisting the ONAP community's work on the various OpenLab test environments
+* Updated docker and java artifact versions for ONAP Casablanca release
+* Additional enhancements to automation test scripts for vCPE use case
+* Moved CSIT content to a separate integration/csit repo
+* Updates and enhancements to the CSIT test plans across projects to support the ONAP Casablanca use cases
+
+**Security Notes**
+
+Integration code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release.
+The Integration open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298876>`_.
+
+Quick Links:
+ - `Integration project page <https://wiki.onap.org/display/DW/Integration+Project>`_
+
+ - `Project Vulnerability Review Table for Integration <https://wiki.onap.org/pages/viewpage.action?pageId=45298876>`_
+
+
+O-Parent
+========
+
+Version: 1.2.2
+--------------
+
+:Release Date: 2018-11-11
+
+**Bug Fixes**
+
+* Updated Spring dependency version to fix CLM issues
+* Remove hard-coding of ONAP nexus repos
+
+
+Version: 1.2.1
+--------------
+
+:Release Date: 2018-09-14
+
+**New Features**
+
+* Refactor oparent pom to support running builds against local nexus
+ repos without having to modify oparent source code
+* Standardize 3rd party library versions
+
+Version: 1.2.0
+--------------
+
+:Release Date: 2018-08-24
+
+**New Features**
+
+* Add depedencyManagement sub-module to declare dependecies
+
+
+Demo Artifacts (HEAT Templates)
+==============
+
+Version: 1.3.0
+--------------
+
+:Release Date: 2018-11-15
+
+**New Features**
+
+The main changes for this release are the additional templates and
+other changes to support Use Cases such as HPA, vCPE, Scale-out,
+and TOSCA templates.
+
+
+Robot Test Suite
+===========
+
+Version: 1.3.2
+--------------
+
+:Release Date: 2018-11-20
+
+**New Features**
+
+* Fully automated vFW Closed Loop instantiation and testing
+* Instantiaion of 5 new vCPE models
+
+
+Version: 1.3.1
+--------------
+
+:Release Date: 2018-11-14
+
+**New Features**
+
+* Additional health checks for new ONAP components in Casablanca
+* New ETE test suite to test Portal functionality
+* Various enhancements to improve stability of Robot tests