aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrichomme <morgan.richomme@orange.com>2020-11-24 11:43:00 +0100
committerBartek Grzybowski <b.grzybowski@partner.samsung.com>2020-11-24 13:52:10 +0000
commit62b2475dc2eaa6270c707752b6d213144d07457e (patch)
tree10427d82081f49ce03789209a183d14801118e87
parentdcccf6e2c90ef7b079ac6a4f6258b7d550fa79c5 (diff)
Doc update for guilin
Consider only Release use cases/functional requirements in the release note part Issue-ID: INT-1786 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: Ife6fd8adf941f0de6ae3cc2dc670754954b46961
-rw-r--r--docs/docs_usecases.rst85
-rw-r--r--docs/docs_usecases_release.rst82
-rw-r--r--docs/files/csv/release-demo-features.csv4
-rw-r--r--docs/files/csv/release-integration-features.csv7
-rw-r--r--docs/files/csv/release-oparent-features.csv1
-rw-r--r--docs/files/csv/release-testsuite-features.csv1
-rw-r--r--docs/files/csv/usecases-deprecated.csv3
-rw-r--r--docs/files/csv/usecases-functional-requirements.csv41
-rw-r--r--docs/integration-s3p.rst31
-rw-r--r--docs/integration-tests.rst6
-rw-r--r--docs/release-notes.rst10
11 files changed, 140 insertions, 131 deletions
diff --git a/docs/docs_usecases.rst b/docs/docs_usecases.rst
index 95a0c67a0..cc57e13b7 100644
--- a/docs/docs_usecases.rst
+++ b/docs/docs_usecases.rst
@@ -3,76 +3,21 @@
.. _docs_usecases:
-Verified Use Cases and Functional Requirements
-==============================================
-
-Description
------------
-This session includes use cases and functional requirements which have been
-officially verified in Frankfurt release by the ONAP community.
-
-For each use case or functional requirement, you can find contact names and a
-link to the associated documentation.
-
-This documentation deals with
-
- 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
-
-Use cases
-~~~~~~~~~
-
-.. csv-table:: use case table
- :file: ./files/csv/usecases.csv
- :widths: 10,40,20,30
- :delim: ;
- :header-rows: 1
-
-Functional Requirements
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. csv-table:: functional requirements table
- :file: ./files/csv/usecases-functional-requirements.csv
- :widths: 10,40,10,10,30
- :delim: ;
- :header-rows: 1
-
-Automated Use Cases
-~~~~~~~~~~~~~~~~~~~
-
-.. csv-table:: Infrastructure Healthcheck Tests
- :file: ./files/csv/tests-infrastructure-healthcheck.csv
- :widths: 20,40,20,20
- :delim: ;
- :header-rows: 1
-
-.. csv-table:: Healthcheck Tests
- :file: ./files/csv/tests-healthcheck.csv
- :widths: 20,40,20,20
- :delim: ;
- :header-rows: 1
-
-.. csv-table:: Smoke Tests
- :file: ./files/csv/tests-smoke.csv
- :widths: 20,40,20,20
- :delim: ;
- :header-rows: 1
-
-.. csv-table:: Security Tests
- :file: ./files/csv/tests-security.csv
- :widths: 20,40,20,20
- :delim: ;
- :header-rows: 1
-
-Deprecated Use Cases
-~~~~~~~~~~~~~~~~~~~~
-
-The following use cases were included in Frankfurt 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.
+Deprecated Use Cases and Functional Requirements
+================================================
+
+Each ONAP release deals with lots of use cases and functional requirements.
+When possible, it is strongly recommended to automate the use cases.
+In this case Integration team can take over the maintenance part of the use case.
+If not automated, the use cases are fully under the responsibility of the use
+case team and usually valid for the release the team was involved in.
+However, these use cases, their artifacts remain in the repository.
+Anyone can give a try even if the use cases are no more supported.
+
+This section deals with such use cases.
+These use cases have been part of one release but have not been tested on the
+last releases. They might fully deprecated or usable through minor adaptations.
+The entry points are the use case owners.
.. csv-table:: deprecated use case table
:file: ./files/csv/usecases-deprecated.csv
diff --git a/docs/docs_usecases_release.rst b/docs/docs_usecases_release.rst
new file mode 100644
index 000000000..7450b6c4b
--- /dev/null
+++ b/docs/docs_usecases_release.rst
@@ -0,0 +1,82 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+ International License. http://creativecommons.org/licenses/by/4.0
+
+.. _docs_usecases_release:
+
+Guilin Use Cases and Functional Requirements
+=============================================
+
+Description
+-----------
+This session includes use cases and functional requirements which have been
+officially verified in Guilin release by the ONAP community.
+
+For each use case or functional requirement, you can find contact names and a
+link to the associated documentation.
+
+This documentation deals with
+
+ 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
+
+
+Use cases
+-----------
+
+Guilin New Use Cases
+~~~~~~~~~~~~~~~~~~~~
+
+.. csv-table:: use case table
+ :file: ./files/csv/usecases.csv
+ :widths: 10,40,20,30
+ :delim: ;
+ :header-rows: 1
+
+Old Use Cases Tested in Guilin
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. csv-table:: use case table
+ :file: ./files/csv/usecases-old-valid.csv
+ :widths: 50,20,30
+ :delim: ;
+ :header-rows: 1
+
+
+Functional Requirements
+-----------------------
+
+.. csv-table:: functional requirements table
+ :file: ./files/csv/usecases-functional-requirements.csv
+ :widths: 10,40,20,30
+ :delim: ;
+ :header-rows: 1
+
+
+Automated Use Cases
+-------------------
+
+.. csv-table:: Infrastructure Healthcheck Tests
+ :file: ./files/csv/tests-infrastructure-healthcheck.csv
+ :widths: 20,40,20,20
+ :delim: ;
+ :header-rows: 1
+
+.. csv-table:: Healthcheck Tests
+ :file: ./files/csv/tests-healthcheck.csv
+ :widths: 20,40,20,20
+ :delim: ;
+ :header-rows: 1
+
+.. csv-table:: Smoke Tests
+ :file: ./files/csv/tests-smoke.csv
+ :widths: 20,40,20,20
+ :delim: ;
+ :header-rows: 1
+
+.. csv-table:: Security Tests
+ :file: ./files/csv/tests-security.csv
+ :widths: 20,40,20,20
+ :delim: ;
+ :header-rows: 1
diff --git a/docs/files/csv/release-demo-features.csv b/docs/files/csv/release-demo-features.csv
index b7d99bf6e..69899d044 100644
--- a/docs/files/csv/release-demo-features.csv
+++ b/docs/files/csv/release-demo-features.csv
@@ -1,5 +1,7 @@
Issue-ID;Description
-NT-1658;vFW CNF CDS scripts update for native Helm support
+INT-1788;Add Lasse as Integration committer
+INT-1785;Create demo 1.7.0 for guilin
+INT-1658;vFW CNF CDS scripts update for native Helm support
INT-1240;ROBOT e2e test cases improvements for csar/zip tosca package validation in VNFSDK and SDC Onbarding
INT-1658;vFW CDS CNF CBA with native k8s profile upload
INT-1724;Update INFO.yaml
diff --git a/docs/files/csv/release-integration-features.csv b/docs/files/csv/release-integration-features.csv
index 9dbba01c8..484cdb07d 100644
--- a/docs/files/csv/release-integration-features.csv
+++ b/docs/files/csv/release-integration-features.csv
@@ -1,5 +1,10 @@
Issue-ID;Description
-NT-1736;Refactor Integration official documentation
+INT-1736;Update branch references
+INT-1788;Add Lasse as Integration committer
+INT-1690;Release Docs Update for CCVPN - Transport Slicing in Guilin
+INT-1736;Correct typos and grammar
+INT-1707;Fix Data Type of External RAN NSSMF simulator
+INT-1736;Refactor Integration official documentation
INT-1777;Updated docs_E2E_network_slicing.rst
INT-1776;[DOC] Adding few notes and sample outputs to the robot framework documentation
INT-1772;Update OOF PCI document
diff --git a/docs/files/csv/release-oparent-features.csv b/docs/files/csv/release-oparent-features.csv
index d97c5fd2e..8864c0bd6 100644
--- a/docs/files/csv/release-oparent-features.csv
+++ b/docs/files/csv/release-oparent-features.csv
@@ -1,4 +1,5 @@
Issue-ID;Description
+INT-1766;Upgrade latest dependencies
INT-1756;Set default to guilin
INT-1486;Bump oparent to version 3.1.1-SNAPSHOT
INT-1486;Release oparent version 3.1.0
diff --git a/docs/files/csv/release-testsuite-features.csv b/docs/files/csv/release-testsuite-features.csv
index 3d3cd0d6a..b9842892b 100644
--- a/docs/files/csv/release-testsuite-features.csv
+++ b/docs/files/csv/release-testsuite-features.csv
@@ -1,4 +1,5 @@
Issue-ID;Description
+INT-1788;Add Lasse as Integration committer
INT-1770;PNF registarte - prevent test case fail at general step Submit SDC Software Product
INT-1768;Create testsuite:1.7.2 for RC1
INT-1240;ROBOT e2e test cases improvements for csar/zip tosca package validation in VNFSDK and SDC Onbarding
diff --git a/docs/files/csv/usecases-deprecated.csv b/docs/files/csv/usecases-deprecated.csv
index 5484b47a2..05d2ed778 100644
--- a/docs/files/csv/usecases-deprecated.csv
+++ b/docs/files/csv/usecases-deprecated.csv
@@ -3,13 +3,10 @@ vCPE Use Case,:ref:`link <docs_vcpe>` ,El Alto, No resources to test on Frankfur
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
-vFirewall with closed loop,:ref:`official doc <docs_vfw>` , Frankfurt, No resources to test on Guilin but it shall still work
vFirewall/vDNS with HPA ,:ref:`official doc <docs_vfw_hpa>`,Frankfurt, No resources to test on Guilin
-Scale Out,:ref:`official doc <docs_scaleout>`,Frankfurt, No resources to test on Guilin
BBS (Broadband Service),:ref:`official doc <docs_bbs>`,Frankfurt, No resources to test on Guilin
vFirewall CNF with multicloud k8s plugin,:ref:`official doc <docs_vfw_edgex_multicloud_k8s>`, Frankfurt,No resources to test on Guilin
EdgeXFoundry CNF with multicloud k8s plugin,:ref:`official doc <docs_vfw_edgex_multicloud_k8s>`,Frankfurt, No resources to test on Guilin
vCPE with Tosca,:ref:`official doc <docs_vcpe_tosca_local>`, Frankfurt, No resources to test on Guilin
E2E Automation vLB with CDS,`wiki page <https://wiki.onap.org/pages/viewpage.action?pageId=71838891>`__, Frankfurt, No resources to test on Guilin
-vFirewall In-Place Software Upgrade with Traffic Distribution,:ref:`official doc <docs_vfw_traffic>`, Frankfurt, No resources to test on Guilin
vFirewall CNF With CDS,:ref:`official doc <docs_vFW_CNF_CDS>`, Frankfurt, No resources to test on Guilin
diff --git a/docs/files/csv/usecases-functional-requirements.csv b/docs/files/csv/usecases-functional-requirements.csv
index 9679d404e..4784f0b1b 100644
--- a/docs/files/csv/usecases-functional-requirements.csv
+++ b/docs/files/csv/usecases-functional-requirements.csv
@@ -1,21 +1,20 @@
-Issue key;Summary;Priority;Status;Created
-REQ-324;Support xNF Software Upgrade in association to schema updates;High;In Review;08/May/20 8:46 PM
-REQ-335;Support for Test Topology Auto Design (NFV Testing Automatic Platform);High;To Do;27/May/20 3:28 AM
-REQ-336;Support for Test Environment Auto Deploy(NFV Testing Automatic Platform);High;To Do;27/May/20 3:37 AM
-REQ-337;Support for Test Task Auto Execution (NFV Testing Automatic Platform);High;To Do;27/May/20 3:37 AM
-REQ-338;Support for Test Result Auto Analysis & Certification (NFV Testing Automatic Platform);High;To Do;27/May/20 3:38 AM
-REQ-352;Extend ORAN A1 Adapter and add A1 Policy Management;High;In Review;27/May/20 2:21 PM
-REQ-339;Container Network Function Test Platform (CNTP): OVP 2.0 support and Enable Network Service testing;High;To Do;27/May/20 4:06 AM
-REQ-388;Interactive documentation aligned with a deployment;High;To Do;02/Jun/20 7:05 AM
-REQ-329;Guilin-R7 - Support for Intent-based Network;High;To Do;20/May/20 2:29 AM
-REQ-334;ETSI-Alignment for Guilin and Honolulu;Medium;In Review;27/May/20 2:08 AM
-REQ-384;Define and prove the concept of model driven in the context of CPS;Medium;To Do;28/May/20 1:35 PM
-REQ-353;"xNF License Management, Guilin R7";Medium;To Do;27/May/20 2:38 PM
-REQ-320;5G Service Modeling in R7;Medium;To Do;07/May/20 6:01 PM
-REQ-327;ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES (Guilin);Medium;In Progress;19/May/20 8:43 PM
-REQ-322;Configuration & Persistency Service in R7;Medium;To Do;07/May/20 6:15 PM
-REQ-321;CMPv2 Enhancements for R7;Medium;In Progress;07/May/20 6:06 PM
-REQ-318;PNF Plug & Play in R7;Medium;To Do;07/May/20 5:36 PM
-REQ-319;PNF PreOnboarding in R7;Medium;To Do;07/May/20 5:50 PM
-REQ-417;Epic task for all logging fix tasks;Medium;To Do;10/Aug/20 12:59 PM
-REQ-326;Self Serve Control Loops;Medium;To Do;11/May/20 4:18 PM
+Issue key;Summary;Created;Contact
+REQ-352;Extend ORAN A1 Adapter and add A1 Policy Management;27/May/20 2:21 PM;JohnKeeney
+REQ-335;Support for Test Topology Auto Design (NFV Testing Automatic Platform);27/May/20 3:28 AM;Lei_Huang
+REQ-336;Support for Test Environment Auto Deploy(NFV Testing Automatic Platform);27/May/20 3:37 AM;Lei_Huang
+REQ-337;Support for Test Task Auto Execution (NFV Testing Automatic Platform);27/May/20 3:37 AM;Lei_Huang
+REQ-338;Support for Test Result Auto Analysis & Certification (NFV Testing Automatic Platform);27/May/20 3:38 AM;Lei_Huang
+REQ-339;Container Network Function Test Platform (CNTP): OVP 2.0 support and Enable Network Service testing;27/May/20 4:06 AM;mkr1481
+REQ-388;Interactive documentation aligned with a deployment;02/Jun/20 7:05 AM;eric.debeau
+REQ-329;Guilin-R7 - Support for Intent-based Network;20/May/20 2:29 AM;huangzh
+REQ-384;Define and prove the concept of model driven in the context of CPS;28/May/20 1:35 PM;tfinnerty
+REQ-334;ETSI-Alignment for Guilin and Honolulu;27/May/20 2:08 AM;byungwoojun
+REQ-341;ONAP CNF orchestration - Enhancements;27/May/20 8:15 AM;rajewluk
+REQ-353;"xNF License Management, Guilin R7";27/May/20 2:38 PM;tperala
+REQ-320;5G Service Modeling in R7;07/May/20 6:01 PM;bencheung
+REQ-327;ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES (Guilin);19/May/20 8:43 PM;marge.hillis
+REQ-322;Configuration & Persistency Service in R7;07/May/20 6:15 PM;tfinnerty
+REQ-321;CMPv2 Enhancements for R7;07/May/20 6:06 PM;baniewsk
+REQ-319;PNF PreOnboarding in R7;07/May/20 5:50 PM;bencheung
+REQ-417;Epic task for all logging fix tasks;10/Aug/20 12:59 PM;dmizyn
+REQ-326;Self Serve Control Loops;11/May/20 4:18 PM;csbford
diff --git a/docs/integration-s3p.rst b/docs/integration-s3p.rst
index 2e0f6bfce..3effe0550 100644
--- a/docs/integration-s3p.rst
+++ b/docs/integration-s3p.rst
@@ -3,41 +3,14 @@
ONAP Maturity Testing Notes
---------------------------
-Historically integration team used to execute specific stability and resilience
-tests on target release. For frankfurt a stability test was executed.
-Openlab, based on Frankfurt RC0 dockers was also observed a long duration
-period to evaluate the overall stability.
-Finally the CI daily chain created at Frankfurt RC0 was also a precious indicator
-to estimate the solution stability.
-
-No resilience or stress tests have been executed due to a lack of resources
-and late availability of the release. The testing strategy shall be amended in
-Guilin, several requirements have been created to improve the S3P testing domain.
-
Stability
=========
TODO
-
-
-Methodology
-~~~~~~~~~~~
-
+A stability test is planned on the final Guilin dockers.
CI results
==========
A daily Guilin CI chain has been created after RC0.
-
-The evolution of the full healthcheck test suite can be described as follows:
-
-|image1|
-
-
-
-Resilience
-==========
-
-
-.. |image1| image:: files/s3p/daily_frankfurt1.png
- :width: 6.5in
+Due to policy changes in dockerhub (new quotas), the chain has been unstable.
diff --git a/docs/integration-tests.rst b/docs/integration-tests.rst
index 045a44063..52a8eb357 100644
--- a/docs/integration-tests.rst
+++ b/docs/integration-tests.rst
@@ -25,7 +25,11 @@ a new feature, which is far above the project criteria in SonarCloud today.
Use Cases
---------
-The use cases are described in :ref:`Verified Use cases <docs_usecases>`.
+The use cases of the last release are described in
+:ref:`Verified Use cases <docs_usecases_release>`.
+
+The history of the different use cases accross the different releases can be
+found in :ref:`Use Cases page <docs_usecases>`.
CSIT Tests
----------
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 93de5cebc..edfe6d50e 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -36,7 +36,7 @@ Integration Repo
Version: 7.0.0 (aka Guilin)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-:Release Date: 2020-11-xx
+:Release Date: 2020-11-24
.. csv-table:: Integration Changes
:file: ./files/csv/release-integration-features.csv
@@ -48,7 +48,7 @@ Version: 7.0.0 (aka Guilin)
Robot (Testsuite)
.................
-Version: 1.7.2
+Version: 1.7.3
^^^^^^^^^^^^^^
:Release Date: 2020-11-xx
@@ -66,7 +66,7 @@ O-Parent
Version: 3.0.2
^^^^^^^^^^^^^^
-:Release Date: 2020-11-xx
+:Release Date: 2020-11-24
.. csv-table:: Oparent Changes
:file: ./files/csv/release-oparent-features.csv
@@ -80,7 +80,7 @@ Demo Artifacts (HEAT Templates)
Version: 1.7.0
^^^^^^^^^^^^^^
-:Release Date: 2020-11-**
+:Release Date: 2020-11-24
.. csv-table:: Demo Changes
:file: ./files/csv/release-demo-features.csv
@@ -106,7 +106,7 @@ New Guilin repositories:
Verified Use Cases and Functional Requirements
----------------------------------------------
-:ref:`Use Cases page <docs_usecases>`
+:ref:`Use Cases page <docs_usecases_release>`
ONAP Maturity Testing Notes
---------------------------