aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/docs_usecases.rst82
-rw-r--r--docs/functional-requirements-5g.csv11
-rw-r--r--docs/functional-requirements.csv11
-rw-r--r--docs/index.rst30
-rw-r--r--docs/onap-integration-ci.rst7
-rw-r--r--docs/onap-oom-heat.rst10
-rw-r--r--docs/release-notes.rst229
-rw-r--r--docs/usecases-deprecated.csv5
-rw-r--r--docs/usecases.csv13
9 files changed, 159 insertions, 239 deletions
diff --git a/docs/docs_usecases.rst b/docs/docs_usecases.rst
index 6eccb59d9..bdb39cedb 100644
--- a/docs/docs_usecases.rst
+++ b/docs/docs_usecases.rst
@@ -8,57 +8,71 @@ Verified Use Cases and Functional Requirements
Description
~~~~~~~~~~~
-This session includes use cases and functional requirements which have been verified in Frankfurt release by the Integration team:
- 1. What has been implemented
- 2. Step by step instruction on how to deploy them, including the links to download the related assets and resources
- 3. Known issues and workaround
+This session includes use cases and functional requirements which have been
+officially verified in Frankfurt release by the ONAP community.
-The final testing status can be found at `Frankfurt Release Integration Testing Status <https://wiki.onap.org/display/DW/2%3A+Frankfurt+Release+Integration+Testing+Status>`_
+For each use case or functional requirement, you can find contact names and a
+link to the associated documentation.
-Use Cases
-~~~~~~~~~
-:ref:`vFirewall Use Case <docs_vfw>`
-
-:ref:`VF Module Scale Out Use Case (vLoadBalancer/vDNS example) <docs_scaleout>`
-
-:ref:`vCPE Use Case <docs_vcpe>`
-
-:ref:`CCVPN (Cross Domain and Cross Layer VPN) Use Case <docs_ccvpn>`
+This documentation deals with
-:ref:`vFirewall/vDNS with HPA Use Case <docs_vfw_hpa>`
+ 1. What has been implemented
+ 2. Step by step instructions to deploy and execute the tests, including the
+ links to download the related assets and resources
+ 3. Known issues and workarounds
-:ref:`vFirewall Traffic Distribution Use Case <docs_vfw_traffic>`
+The final testing status can be found at `Frankfurt Release Integration Testing
+Status <https://wiki.onap.org/display/DW/2%3A+Frankfurt+Release+Integration+Testing+Status>`_
-:ref:`BBS (Broadband Service) Use Case <docs_bbs>`
+31 use cases/functional requirements have been considered for the Frankfurt release.
-:ref:`vIPsec with HPA Use Case <docs_vipsec_hpa>`
-
-:ref:`vFirewall/edgex with multicloud kubernetes plugin <docs_vfw_edgex_multicloud_k8s>`
-
-:ref:`vFirewall CNF (Container Network Function) With CDS Use Case <docs_vFW_CNF_CDS>`
+Use cases
+~~~~~~~~~
-:ref:`vCPE Tosca Local Mode Use Case <docs_vcpe_tosca_local>`
+.. csv-table:: use case table
+ :file: usecases.csv
+ :widths: 60,20,20
+ :header-rows: 1
Functional Requirements
~~~~~~~~~~~~~~~~~~~~~~~
-:ref:`5G - Real Time PM and High Volume Stream Data Collection <docs_realtime_pm>`
-:ref:`5G - Bulk PM <docs_5g_bulk_pm>`
+.. csv-table:: functional requirements table
+ :file: functional-requirements.csv
+ :widths: 60,20,20
+ :header-rows: 1
+
-:ref:`5G - Configuration over NETCONF <docs_5G_Configuration_over_NETCONF>`
+.. csv-table:: 5G functional requirements table
+ :file: functional-requirements-5g.csv
+ :widths: 60,20,20
+ :header-rows: 1
-:ref:`5G - OOF and PCI <docs_5G_oof_pci>`
+Automated Use Cases
+~~~~~~~~~~~~~~~~~~~
-:ref:`5G - E2E Network Slicing <docs_E2E_network_slicing>`
+Most of the use cases include some automation through robot or bash scripts.
+These scripts are detailed in the documentation.
-:ref:`5G - NRM Configuration <docs_5G_NRM_Configuration>`
+Some use cases have been integrated in ONAP gates. It means the tests are run on
+each daily or gating CI chain. The goal is to detect any regression as soon as
+possible and demonstrate the ability to automate the use cases.
-:ref:`5G - A1 Adaptor <docs_5g_a1_adaptor>`
+The frankfurt use cases integrated in gates are:
-:ref:`PNF Support - PNF Plug and Play <docs_5g_pnf_pnp>`
+- pnf-regitrate
+- 5gbulkpm
+- hv-ves
-:ref:`PNF Support - PNF Software Upgrade <docs_5g_pnf_software_upgrade>`
+Deprecated Use Cases
+~~~~~~~~~~~~~~~~~~~~
-:ref:`Change Management Flexible Designer and Orchestrator <docs_CM_flexible_designer_orchestrator>`
+The following use cases were included in El Alto or previous release but have
+not been tested in Frankfurt, usually due to a lack of resources.
+The resources are still available in previous branches, some adaptations may
+however be needed for Frankfurt.
-:ref:`Change Management Schedule Optimization <docs_CM_schedule_optimizer>`
+.. csv-table:: deprecated use case table
+ :file: usecases-deprecated.csv
+ :widths: 50,20,10,20
+ :header-rows: 1
diff --git a/docs/functional-requirements-5g.csv b/docs/functional-requirements-5g.csv
new file mode 100644
index 000000000..02ae1b95a
--- /dev/null
+++ b/docs/functional-requirements-5g.csv
@@ -0,0 +1,11 @@
+5G functional requirement,Link,Contacts
+5G Realtime PM and High Volume Stream Data Collection, :ref:`official doc <docs_realtime_pm>`,M.Przybysz
+5G PNF Plug and Play, :ref:`official doc <docs_5g_pnf_pnp>`, M.Przybysz K.Kuzmicki
+5G Bulk PM, :ref:`official doc <docs_5g_bulk_pm>`, J.Cuddy
+5G OOF and PCI,:ref:`official doc <docs_5G_oof_pci>`, Reshmasree c
+5G NRM Network Resource Model (Configuration management),:ref:`official doc <docs_5G_NRM_Configuration>`,Y.Wang C.Huang
+5G NETCONF configuration,:ref:`official doc <docs_5G_Configuration_over_NETCONF>`, A.D.Singh
+5G PNF Pre-Onboarding & Onboarding,,M.Przybysz K.Kuzmicki D.Melia A.Walshe
+5G OOF SON,:ref:`official doc <docs_5G_oof_pci>`,Reshmasree c
+5G E2E Network Slicing ,:ref:`official doc<docs_E2E_network_slicing>`,C.Chen Z.Min Swaminathan S
+5G ORAN A1 Adapter (SDNR),:ref:`official doc <docs_5g_a1_adaptor>`,SandeepShah
diff --git a/docs/functional-requirements.csv b/docs/functional-requirements.csv
new file mode 100644
index 000000000..7ccd835d4
--- /dev/null
+++ b/docs/functional-requirements.csv
@@ -0,0 +1,11 @@
+Functional requirement,Link,Contacts
+PNF Software Upgrade using direct Netconf Yang interface with PNF,:ref:`official doc <docs_5g_pnf_software_upgrade>`,R.Gumma R.Tyagi
+PNF Software Upgrade with EM with Ansible,:ref:`official doc <docs_5G_PNF_Software_Upgrade_ansible_with_EM>`, Y.Wang E.Wang
+PNF Software Upgrade with EM with Netconf, :ref:`official doc <docs_5g_pnf_software_upgrade_netconf_with_EM>`, Y.Wang E.Wang
+VSP Compliance and Validation Check within SDC,`wiki page <https://wiki.onap.org/display/DW/VSP+Compliance+and+Validation+Check+within+SDC+%28Frankfurt%29+-+Phase+2#VSPComplianceandValidationCheckwithinSDC(Frankfurt)Phase2-VSPComplianceCheckwithinSDC-IntegrationTestPlan>`__,P.Balan
+Enable PNF software version at onboarding,`wiki page <https://jira.onap.org/browse/REQ-88?src=confmacro>`__,A.Schmid
+xNF communication security enhancements, `wiki page <https://wiki.onap.org/display/DW/xNF+communication+security+enhancements+-+Tests+Description+and+Status>`__,M.Przybysz
+ETSI Alignment SO plugin to support SOL003 to connect to an external VNFM,,F.Oliveira Byung-Woo Jun
+Integration of CDS as an Actor, `wiki page <https://docs.onap.org/en/latest/submodules/policy/parent.git/docs/development/actors/cds/cds.html>`__, B.Sakoto R.K.Verma Y.Malakov
+3rd Party Operational Domain Manager, `wiki page <https://wiki.onap.org/display/DW/Third-party+Operational+Domain+Manager>`__, D.Patel
+Configuration & persistency, `wiki page <https://wiki.onap.org/pages/viewpage.action?pageId=64003184>`__,Reshmasree c Swaminathan S
diff --git a/docs/index.rst b/docs/index.rst
index 81c630d2a..a82a8a733 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,12 +3,34 @@
INTEGRATION
===========
-The Integration project provides the following artifacts:
-- Heat template to deploy the virtual ressources needed for the ONAP deployment
-- Test suites and tools to check the various ONAP components based on Robot Framework
-- Artifacts and documentation for the use-case deployments
+The Integration project is in charge of:
+
+- Providing testing environment and support for the release use cases
+- Executing Cross-project Continuous System Integration Testing (CSIT)
+- Managing full ONAP CI chains (daily master, staging, stable) to ensure the
+ stability of the integration
+- Developing and performing tests within full ONAP context (healthcheck, End to
+ End, performance, robustness...)
+- Validating the ONAP release
+
+For each release, the integration team provides the following artifacts:
+
+- Test suites and tools to check the various ONAP components
+- Use-case documentation and artifacts
+- a testsuite docker ncluded in ONAP cluster to execute the tests
+- Configuration fiales and Heat templates to simplify the creation of the virtual
+ ressources needed for the ONAP deployment and the use cases.
+
+The integration team manages several official ONAP repositories:
+
+- integration/*
+- testsuite/*
+- demo/*
+- oparent/*.
+
.. include:: onap-oom-heat.rst
+
.. include:: onap-integration-ci.rst
diff --git a/docs/onap-integration-ci.rst b/docs/onap-integration-ci.rst
index cbbac6686..621e2992c 100644
--- a/docs/onap-integration-ci.rst
+++ b/docs/onap-integration-ci.rst
@@ -22,7 +22,6 @@ Overview
The global ecosystem can de described as follows:
.. figure:: files/CI/ONAP_CI_10.png
- :scale: 100 %
:align: center
Several chains are run in ONAP.
@@ -65,7 +64,6 @@ The procedure to submit new feature in CI is done in 3 steps as described in the
figure below:
.. figure:: files/CI/ONAP_CI_0.png
- :scale: 100 %
:align: center
@@ -78,7 +76,6 @@ can be used to visualize them.
A web site has been created to centralize the links on http://testresults.opnfv.org/onap-integration/index.html
.. figure:: files/CI/ONAP_CI_3.png
- :scale: 100 %
:align: center
For Gating and gitlab.com based CI chains, the pipelines consist in pipelines of
@@ -88,27 +85,23 @@ A visualization tool is available to list all your chains as described in the
figure below:
.. figure:: files/CI/ONAP_CI_1.png
- :scale: 100 %
:align: center
If you click on any element of the chain, you will open a new window:
.. figure:: files/CI/ONAP_CI_2.png
- :scale: 100 %
:align: center
In order to provide the logs to the developer an additional web page has been
created to summarize the tests and grant access to their associated logs:
.. figure:: files/CI/ONAP_CI_8.png
- :scale: 100 %
:align: center
Additionnaly, for the daily chain, another page displays the results as time
series, allowing to see the evolution of the tests over time.
.. figure:: files/CI/ONAP_CI_9.png
- :scale: 100 %
:align: center
diff --git a/docs/onap-oom-heat.rst b/docs/onap-oom-heat.rst
index 288ef770b..a727a9d56 100644
--- a/docs/onap-oom-heat.rst
+++ b/docs/onap-oom-heat.rst
@@ -20,10 +20,10 @@ must be adapted according to your context.
Source files
~~~~~~~~~~~~
-- HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke?h=elalto
-- Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc?h=elalto
-- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=elalto
-- Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh?h=elalto
+- HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke?h=frankfurt
+- Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc?h=frankfurt
+- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=frankfurt
+- Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh?h=frankfurt
Heat Template Description
@@ -31,7 +31,7 @@ Heat Template Description
The ONAP Integration Project provides a sample HEAT template that
fully automates the deployment of ONAP using OOM as described in
-OOM documentation (https://docs.onap.org/en/elalto/guides/onap-developer/settingup/index.html#installing-onap).
+OOM documentation (https://docs.onap.org/en/frankfurt/guides/onap-developer/settingup/index.html#installing-onap).
The ONAP OOM HEAT template deploys the entire ONAP platform. It spins
up an HA-enabled Kubernetes cluster, and deploys ONAP using OOM onto
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 6910131ce..990d70d11 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -10,228 +10,79 @@ Integration Release Notes
Integration Repo
----------------
-Version: 4.0.0
+Version: 6.0.0
..............
-:Release Date: 2019-10-21
+:Release Date: 2020-06-15
**New Features**
-* Add new integration labs
-* Introduction of OOM Gating
-* Updated scripts for OOM daily automated deployment tests
-* Refactoring of the Integration wiki home page
-* Automation script for use cases
-* Updated java artifact versions for ONAP El Alto release
-* Cleaning of CSIT jobs
-* Update oparent library to fix security Vulnerabilities
-* Update Postman collection for test
+- provide a new testsuite docker version (1.6.2) including several test updates
+ for the different tests
+- Creation of new repositories to host the use cases: bbs, mdons
+- Creation of new repositories to host the simulators: dc-simulator, ran-simulator,
+ pnf-simulator
+- Creation of new repositories to host baseline images: java11, python
+- Update oparent library to fix security Vulnerabilities
+- Support new use cases (mdons, vCPE_tosca,..)
+- Creation of a web page to host CI daily results
+- Creation and Integration in CI of new security tests (http public end points,
+ rooted pods, kubernetes CIS verification, jdpw ports)
+- Update of the onap-k8s use case to report the full status of the cluster after
+ the installation and provide a dashboard
+- Include healthdist and postinstall robot tests in healthcheck tests
+- Add new smoke use cases in CI (pnf-registrate, 5gbulkpm,...)
Quick Links:
+
- `Integration project page <https://wiki.onap.org/display/DW/Integration+Project>`_
- - ` El Alto use testing status page <https://wiki.onap.org/display/DW/2%3A+El+Alto+Release+Integration+Testing+Status>`
+ - ` Frankfurt use testing status page <https://wiki.onap.org/display/DW/2%3A+Frankfurt+Release+Integration+Testing+Status>`
ONAP Maturity Testing Notes
---------------------------
-For El Alto release, ONAP continues to improve in multiple areas of
-Scalability, Security, Stability and Performance (S3P) metrics.
-
-In addition of the windriver lab, Master and El Alto use cases have been tested
-on Ericcson (Daily Master CI chain), Orange (Daily Master chain, Gating) and
-windriver labs (use cases, daily, long duration). See `Integration Lab portal
-<http://testresults.opnfv.org/onap-integration>`
-
-
-A gating chain has been setup for OOM. This CI chain provides feedback to the
-integration team. For each OOM change, a full ONAP deployment is triggered then
-several tests are executed (k8s verification, helm chart verification, 61 robot
-healthcheck, healthdist and end to end basic VNF tests).
-For El Alto, more than 1000 pipelines have been executed (gating, daily master
-and stable).
-The results of the tests for the OOM gating can be found ` here
-<https://orange-opensource.gitlab.io/lfn/onap/xtesting-onap-view/index.html>`
-
-Tests dealing with more than 25 test cases are executed on Windriver
-environment.
-
-The Integration team ran the 72 hours stability testing (xx% passing rate) and
-full resilience testing (xx% passing rate) at ONAP OpenLabs.
-More details in :ref:`ONAP Maturity Testing Notes <integration-s3p>`.
-
+A Frankfurt daily CI chain has bee put in place after the RC0 milestone. This CI
+chain is used to track the stability of the release from the RC0. it will be
+maintained as the latest stable CI branch and replaces the El Alto branch.
+The daily results can be found in <https://gating-results.onap.eu/results/>
Verified Use Cases and Functional Requirements
----------------------------------------------
-The Integration team verified 22 use cases and functional requirements.
+The Integration team verified 31 use cases.
The details can be found at
:ref:`Verified Use Cases and Functional Requirements <docs_usecases>` session.
O-Parent
--------
-Version: 2.2.0
-..............
-
-:Release Date: 2019-09-03
-
-**New Features**
-
-* Updated oparent POM files to support LF's new global job template.
-* commons-beanutils 1.9.4
-* tomcat-embed-core 9.0.24
-* jquery 3.4.1
-
-
-Version: 2.0.0
+Version: 3.0.2
..............
-:Release Date: 2019-03-08
+:Release Date: 2020-05-08
**New Features**
-* Updated oparent POM files to support LF's new global job template.
-
-Version: 1.2.3
-..............
-
-:Release Date: 2019-02-11
-
-**Bug Fixes**
-
-* Updated various library dependency versions per SECCOM input
-* Fixed Checkstyle configuration issues
-
-
-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.5.0
-..............
-
-:Release Date: 2019-10-11
-
-**New Features**
-
-* vFW DT tutorial improvement
-* Helm chart for visualization operator
-* bug fixes
-* Robot enhancements for various use cases
-
-
-Version: 1.4.0
-..............
-
-:Release Date: 2019-06-13
-
-**New Features**
-
-The main changes for this release are the additional templates and
-other changes to support Use Cases such as vFWCL, vFWDT, vCPE, Scale-out,
-and TOSCA 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.
+- Update tomcat 9.0.30
+- Update latest security dependencies
+- Update settings.xml to use https maven
+- Update sonar configuration
+- Update checkstyle rules to exclude methods
+- Upgrade oparent to checkstyle 8.27
+- Revert "update version of checkstyle for latest google style and jdk 8"
+- update version of checkstyle for latest google style and jdk 8
+- Add compiler-plugin example
+- Uprev to 3.0.0 for Java 11
+- qos logback to 1.2.3
Robot Test Suites
-----------------
-Version: 1.5.4
-
-:Release Date: 2019-10-24
-
-**New Features**
-
-* bug Fixes(Teardown, control loop, alotteed properties)
-* Add repush Policy
-* CDS support
-* HV-VES SSL support
-* Add testsuite for VNF Lifecycle validation
-* Cleaning (remaining openecomp ref, ocata and lenovo healthcheck, unused or
- redundant variables and scripts)
-
-
-Version: 1.4.1
-
-:Release Date: 2019-06-09
-
-**New Features**
-
-* Update vFWCL use case test script
-
-
-Version: 1.4.0
-
-:Release Date: 2019-05-24
-
-**New Features**
-
-* Update vFWCL use case closed loop policy
-* Fix vCPE use case test bugs
-* Support resource VL type in test script
-* Add test script for new use cases
-* Enhance existing use cases test script
-
-Version: 1.3.2
-..............
-
-:Release Date: 2018-11-20
-
-**New Features**
-
-* Fully automated vFW Closed Loop instantiation and testing
-* Instantiation of 5 new vCPE models
-
-
-Version: 1.3.1
-..............
+Version: 1.6.2
-:Release Date: 2018-11-14
+:Release Date: 2020-06-15
**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
+- bug Fixes(Teardown, control loop, alotteed properties)
diff --git a/docs/usecases-deprecated.csv b/docs/usecases-deprecated.csv
new file mode 100644
index 000000000..e7a5250e7
--- /dev/null
+++ b/docs/usecases-deprecated.csv
@@ -0,0 +1,5 @@
+Use Case,Link,Last Valid Version, Comments
+vCPE Use Case,:ref:`link <docs_vcpe>` ,El Alto, No resources to test on Frankfurt
+vIPsec with HPA Use Case ,:ref:`link<docs_vipsec_hpa>` ,El Alto, No resources to test on Frankfurt
+Change Management Schedule Optimization,:ref:`link<docs_CM_schedule_optimizer>` ,El Alto, No resources to test on Frankfurt
+Change Management Flexible Designer and Orchestrator ,:ref:`link<docs_CM_flexible_designer_orchestrator>` ,El Alto, No resources to test on Frankfurt
diff --git a/docs/usecases.csv b/docs/usecases.csv
new file mode 100644
index 000000000..920c1251e
--- /dev/null
+++ b/docs/usecases.csv
@@ -0,0 +1,13 @@
+Use Case,Link,Contacts
+vFirewall with closed loop,:ref:`official doc <docs_vfw>` ,M.Platania B.Freeman
+vFirewall/vDNS with HPA ,:ref:`official doc <docs_vfw_hpa>`,E.Multanen
+vFirewall In-Place Software Upgrade with Traffic Distribution,:ref:`official doc <docs_vfw_traffic>`,L.Rajewski
+vFirewall CNF With CDS,:ref:`official doc <docs_vFW_CNF_CDS>`,K.Bańka L.Rajewski
+Scale Out,:ref:`official doc <docs_scaleout>`,M.Platania S.Blandford
+CCVPN-E LINE over OTN NNI,:ref:`official doc <docs_ccvpn>`,G.Agrawal
+CCVPN - MDONS ,:ref:`official doc <docs_CCVPN>`,X.Miao
+BBS (Broadband Service),:ref:`official doc <docs_bbs>`,D.Perez Caparros D.Balsiger
+vFirewall CNF with multicloud k8s plugin,:ref:`official doc <docs_vfw_edgex_multicloud_k8s>`,E.Multanen R.Sood
+EdgeXFoundry CNF with multicloud k8s plugin,:ref:`official doc <docs_vfw_edgex_multicloud_k8s>`,E.Multanen
+vCPE with Tosca,:ref:`official doc <docs_vcpe_tosca_local>`, H.Haibin L.Zhao
+E2E Automation vLB with CDS,`wiki page <https://wiki.onap.org/pages/viewpage.action?pageId=71838891>`__,A.Seaudi Y.Malakov