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_vCPE.rst36
-rw-r--r--docs/docs_vfwHPA.rst17
-rw-r--r--docs/release-notes.rst105
4 files changed, 178 insertions, 6 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_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_vfwHPA.rst b/docs/docs_vfwHPA.rst
index bbd62c037..072b25294 100644
--- a/docs/docs_vfwHPA.rst
+++ b/docs/docs_vfwHPA.rst
@@ -7,7 +7,7 @@ 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 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**
@@ -25,8 +25,13 @@ This tutorial covers enhancements 1 to 5 in Background of https://wiki.onap.org/
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``
@@ -42,7 +47,7 @@ Install OOM ONAP using the deploy script in the integration repo. Instructions f
``oom-rancher# ./ete-k8s.sh onap health``
Ensure all the required components pass the health tests
-4. Modify so bpmn configmap to change the so vnf adapter endpoint to v2
+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``
@@ -73,7 +78,7 @@ Install OOM ONAP using the deploy script in the integration repo. Instructions f
``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>`_.
+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**
@@ -363,7 +368,7 @@ If an update is needed, the update can be done via rest using curl or postman
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.
+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.
@@ -614,7 +619,7 @@ Push Policy
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. Instrcutions 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;
+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;
::
@@ -820,4 +825,4 @@ Change parameters based on your environment.
"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). \ No newline at end of file
+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/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 000000000..3da3edda3
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,105 @@
+
+.. 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-29
+
+**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
+
+
+
+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