From 59305b4e52464023a6350a1d69ced2eb23dee73e Mon Sep 17 00:00:00 2001 From: mrichomme Date: Tue, 1 Dec 2020 18:23:57 +0100 Subject: [PATCH] Add non functional requirement table for guilin Issue-ID: INT-1776 Signed-off-by: mrichomme Change-Id: Iff17dc50cefb9c4fc5a9e752c560b98b35974129 [Update status of my requirements] Signed-off-by: Krzysztof Opasiak --- docs/conf.py | 3 + docs/docs_usecases.rst | 23 +------- docs/docs_usecases_release.rst | 65 +++------------------- docs/files/csv/tests-healthcheck.csv | 3 + docs/files/csv/tests-smoke.csv | 3 - .../files/csv/usecases-functional-requirements.csv | 36 ++++++------ .../csv/usecases-non-functional-requirements.csv | 46 ++++++--------- docs/onap-oom-heat.rst | 2 +- docs/release-notes.rst | 7 +-- docs/usecases/deprecated_usecases.rst | 28 ++++++++++ docs/usecases/release_automated_usecases.rst | 36 ++++++++++++ .../release_non_functional_requirements.rst | 15 +++++ docs/usecases/release_requirements.rst | 15 +++++ docs/usecases/release_usecases.rst | 46 +++++++++++++++ 14 files changed, 195 insertions(+), 133 deletions(-) create mode 100644 docs/usecases/deprecated_usecases.rst create mode 100644 docs/usecases/release_automated_usecases.rst create mode 100644 docs/usecases/release_non_functional_requirements.rst create mode 100644 docs/usecases/release_requirements.rst create mode 100644 docs/usecases/release_usecases.rst diff --git a/docs/conf.py b/docs/conf.py index adf15cc4a..d042f2ce5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,6 +3,8 @@ from docs_conf.conf import * branch = 'latest' master_doc = 'index' +doc_url = 'https://docs.onap.org/projects' + linkcheck_ignore = [ r'http://localhost:.*', 'http://CONSUL_SERVER_UI:30270/ui/#/dc1/services', @@ -18,6 +20,7 @@ linkcheck_ignore = [ ] intersphinx_mapping = {} +intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) html_last_updated_fmt = '%d-%b-%y %H:%M' diff --git a/docs/docs_usecases.rst b/docs/docs_usecases.rst index f86fc6b11..a8efb0d63 100644 --- a/docs/docs_usecases.rst +++ b/docs/docs_usecases.rst @@ -5,24 +5,7 @@ :orphan: -Deprecated Use Cases and Functional Requirements -================================================ +.. toctree:: + :maxdepth: 1 -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 - :widths: 50,20,10,20 - :header-rows: 1 - :delim: ; + usecases/deprecated_usecases.rst diff --git a/docs/docs_usecases_release.rst b/docs/docs_usecases_release.rst index 9e662a5a4..ffd954617 100644 --- a/docs/docs_usecases_release.rst +++ b/docs/docs_usecases_release.rst @@ -5,8 +5,8 @@ :orphan: -Guilin Use Cases and Functional Requirements -============================================= +Guilin Use Cases and Requirements +================================= Description ----------- @@ -24,59 +24,10 @@ This documentation deals with links to download the related assets and resources 3. Known issues and workarounds -Use cases ---------- +.. toctree:: + :maxdepth: 1 -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 + usecases/release_usecases.rst + usecases/release_automated_usecases.rst + usecases/release_requirements.rst + usecases/release_non_functional_requirements.rst diff --git a/docs/files/csv/tests-healthcheck.csv b/docs/files/csv/tests-healthcheck.csv index 0df88a94b..51eddde63 100644 --- a/docs/files/csv/tests-healthcheck.csv +++ b/docs/files/csv/tests-healthcheck.csv @@ -3,3 +3,6 @@ core;Robot healthcheck tests of the core components (AA&I, DMAAP, Portal, SDC, S full;Robot healthcheck tests for all the components;`robot tests `__;`robotframework `__ healthdist;Check the onboarding and distribution of the vFW;`robot tests `__;`robotframework `__ postinstall;Check dmaap and AA&I Design model DB tests;`robot tests `__;`robotframework `__ +cmpv2 (new);CMPv2 Usecase functionality;`code `__;`robotframework `__ +ves-collector (new);Suite for checking handling events by VES Collector;`code `__;`robotframework `__ +hv-ves;HV-VES 'Sunny Scenario' Robot Framework test - message is sent to the collector and Kafka topic is checked if the message has been published. Content is decoded and checked.;`code `__;`robotframework `__ diff --git a/docs/files/csv/tests-smoke.csv b/docs/files/csv/tests-smoke.csv index bff73f2b3..a83b5375c 100644 --- a/docs/files/csv/tests-smoke.csv +++ b/docs/files/csv/tests-smoke.csv @@ -2,8 +2,5 @@ Tests;Description;Code;Comments basic_vm;Onboard, distribute and instantiate an Openstack VM using à la carte BPMN, replaced the former basic_vm test;`code `__;`onap_pythonsdk `__, `pythonsdk-tests `__ basic_network (new);Onboard, distribute and instantiate a Neutron network;`code `__;`onap_pythonsdk `__, `pythonsdk-tests `__ basic_cnf;Onboard (new), distribute and instantiate a Kubernetes pods;`code `__;`onap_pythonsdk `__, `pythonsdk-tests `__ -cmpv2 (new);CMPv2 Usecase functionality;`code `__;`robotframework `__ -ves-collector (new);Suite for checking handling events by VES Collector;`code `__;`robotframework `__ -hv-ves;HV-VES 'Sunny Scenario' Robot Framework test - message is sent to the collector and Kafka topic is checked if the message has been published. Content is decoded and checked.;`code `__;`robotframework `__ 5gbulkpm;5G Bulk PM Usecase functionality;`code `__;`robotframework `__ pnf-registrate;Executes the PNF registration test cases including setup and teardown;`code `__;`robotframework `__ diff --git a/docs/files/csv/usecases-functional-requirements.csv b/docs/files/csv/usecases-functional-requirements.csv index 4784f0b1b..dbfc561c3 100644 --- a/docs/files/csv/usecases-functional-requirements.csv +++ b/docs/files/csv/usecases-functional-requirements.csv @@ -1,20 +1,16 @@ -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 +Issue key;Summary;Contact;Comment +REQ-381;Bulk PM / PM Data Control Extension;Mark Scott; +REQ-352;Extend ORAN A1 Adapter and add A1 Policy Management;John Keeney; +REQ-341;ONAP CNF orchestration - Enhancements;Lukasz Rajewski; +REQ-338;Support for Test Result Auto Analysis & Certification （NFV Testing Automatic Platform）;Lei Huang; +REQ-337;Support for Test Task Auto Execution （NFV Testing Automatic Platform）;Lei Huang; +REQ-336;Support for Test Environment Auto Deploy（NFV Testing Automatic Platform）;Lei Huang; +REQ-335;Support for Test Topology Auto Design （NFV Testing Automatic Platform）;Lei Huang; +REQ-334;ETSI-Alignment for Guilin and Honolulu;Byung-Woo Jun; +REQ-331;Policy Based Filtering;Pam Dragosh; +REQ-327;ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES (Guilin);Marge Hillis; +REQ-324;Support xNF Software Upgrade in association to schema updates;Zu Qiang; +REQ-322;Configuration & Persistency Service in R7;Tony Finnerty; +REQ-321;CMPv2 Enhancements for R7;Pawel Baniewski;cmpv2 automated test integrated in CI/CD, see :ref:`automated test page ` +REQ-319;PNF PreOnboarding in R7;Ben Cheung; +REQ-318;PNF Plug & Play in R7;Ben Cheung; diff --git a/docs/files/csv/usecases-non-functional-requirements.csv b/docs/files/csv/usecases-non-functional-requirements.csv index 58574194d..82f4c1614 100644 --- a/docs/files/csv/usecases-non-functional-requirements.csv +++ b/docs/files/csv/usecases-non-functional-requirements.csv @@ -1,28 +1,18 @@ -Issue key;Issue id;Summary;Priority;Status;Created -REQ-402;53055;PoC - TOSCA Defined Control Loop ;High;To Do;01/Jul/20 9:46 AM -REQ-350;52019;Each ONAP project shall improve its CII Badging score by improving input validation and documenting it in their CII Badging site. ;High;To Do;27/May/20 1:56 PM -REQ-358;52034;No root (superuser) access to database from application container;High;To Do;27/May/20 4:09 PM -REQ-376;52056;Flow management must be activated for ONAP.;High;To Do;27/May/20 5:16 PM -REQ-379;52059;ONAP projects must use only approved and verified base images for their containers;High;To Do;27/May/20 6:41 PM -REQ-380;52060;ONAP container repository (nexus) must not contain upstream docker images;High;To Do;27/May/20 6:44 PM -REQ-360;52036;Application config should be fully prepared before starting the application container;High;To Do;27/May/20 4:11 PM -REQ-361;52037;Continue hardcoded passwords removal;High;To Do;27/May/20 4:12 PM -REQ-362;52038;All containers must run as non-root user;High;To Do;27/May/20 4:12 PM -REQ-365;52041;Containers must have no more than one main process;High;To Do;27/May/20 4:14 PM -REQ-366;52042;Containers must crash properly when a failure occurs;High;To Do;27/May/20 4:14 PM -REQ-369;52045;Replace nfs share with storage class as a default deployment option;High;To Do;27/May/20 4:15 PM -REQ-373;52053;ONAP must complete update of the Python language (from 2.7 -> 3.8);High;In Progress;27/May/20 5:07 PM -REQ-374;52054;ONAP shall use STDOUT for logs collection;High;To Do;27/May/20 5:09 PM -REQ-382;52069;"Support Pylog repository used by VF-C, Modeling, MultiCloud and OOF";High;To Do;27/May/20 11:22 PM -REQ-385;52108;IPv4/IPv6 dual stack support in ONAP (Guilin);High;In Progress;28/May/20 2:49 PM -REQ-351;52020;ONAP must complete update of the java language (from v8 -> v11) ;High;In Progress;27/May/20 1:59 PM -REQ-359;52035;Container rootfs must be mounted readOnly;High;To Do;27/May/20 4:11 PM -REQ-364;52040;Replace NodePorts with ingress controller as a default deployment option;High;To Do;27/May/20 4:13 PM -REQ-377;52057;ONAP must implement IAM solutions.;High;In Progress;27/May/20 5:18 PM -REQ-363;52039;ONAP components should be able to run without AAF and MSB;High;To Do;27/May/20 4:13 PM -REQ-370;52046;Components may use HTTP as server and client;High;To Do;27/May/20 4:16 PM -REQ-348;52017;Requirements about ONAP installation result for Guilin release;High;To Do;27/May/20 1:48 PM -REQ-368;52044;Service mesh PoC;High;To Do;27/May/20 4:15 PM -REQ-340;51957;ONAP to support Multi - tenancy ;Medium;To Do;27/May/20 8:08 AM -REQ-386;52109;Apply common Swagger style and documentation generation tools to create robust ONAP API documentation;Medium;To Do;28/May/20 3:01 PM -REQ-416;54263;Harbor POC with LNF Team;Medium;To Do;31/Jul/20 7:57 AM +Issue key;Summary;Contact;Comment +REQ-386;Apply common Swagger style and documentation generation tools to create robust ONAP API documentation;Andy Mayer; +REQ-385;IPv4/IPv6 dual stack support in ONAP (Guilin);Damian Nowak; +REQ-376;Flow management must be activated for ONAP.;Fabian Rouzaut;Marginal progress, it was not possible to collect the flow to setup a matrix flow +REQ-374;ONAP shall use STDOUT for logs collection;Krzysztof Opasiak; Most components (that are not in maintenance mode) are using now stdout for logs collection. We hope to finish this in next release. +REQ-373;ONAP must complete update of the Python language (from 2.7 -> 3.8);Pawel Pawlak;Significant progress done in Guilin tracked by weekly version test integrated in CI/CD +REQ-366;Containers must crash properly when a failure occurs;Sylvain Desbureaux;Good progress to be completed in Honolulu +REQ-365;Containers must have no more than one main process;Sylvain Desbureaux; +REQ-362;All containers must run as non-root user;Krzysztof Opasiak;The list of waivers has been significantly reduced in Guilin, progress tracker with root test integrated in all CI/CD chains +REQ-361;Continue hardcoded passwords removal;Krzysztof Opasiak; Majority of projects use certInitializer for certificate generation. Next subset of passwords removed. +REQ-360;Application config should be fully prepared before starting the application container;Sylvain Desbureaux; +REQ-358;No root (superuser) access to database from application container;Krzysztof Opasiak; Nice progress but still some of projects access DB as root. +REQ-357;ONAP shall increase the number of Docker Benchmark tests;Sylvain Desbureaux;More tests integrated in CI/CD but enhancements expected in Honolulu +REQ-351;ONAP must complete update of the java language (from v8 -> v11) ;Pawel Pawlak;Significant progress done in Guilin tracked by weekly version test integrated in CI/CD +REQ-350;Each ONAP project shall improve its CII Badging score by improving input validation and documenting it in their CII Badging site ;Tony L Hansen; +REQ-349;Each ONAP project shall define code coverage improvements and achieve at least 55% code coverage;Amy Zwarico; +REQ-340;ONAP to support Multi - tenancy ;Olivier Phenix; +REQ-323;Each project will update the vulnerable direct dependencies in their code base;Amy Zwarico; diff --git a/docs/onap-oom-heat.rst b/docs/onap-oom-heat.rst index d3c82790b..54c226114 100644 --- a/docs/onap-oom-heat.rst +++ b/docs/onap-oom-heat.rst @@ -35,7 +35,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, see :ref:`OOM` for details. +OOM documentation, see :ref:`OOM ` for details. 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 6b00bbb30..db31f8fe8 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -14,7 +14,6 @@ Integration Release Notes .. important:: - - Creation of a Guilin Daily CI/CD chain - Setup of a staging lab on Azure - Setup of a staging lab on Windriver/Intel lab (with performance audit of the Windriver/Intel labs) @@ -115,10 +114,10 @@ New Guilin repositories: - robot-utils -Verified Use Cases and Functional Requirements ----------------------------------------------- +Use Cases and Requirements +-------------------------- -:ref:`Use Cases page ` +See dedicated :ref:`Guilin Use Cases and requirements page ` ONAP Maturity Testing Notes --------------------------- diff --git a/docs/usecases/deprecated_usecases.rst b/docs/usecases/deprecated_usecases.rst new file mode 100644 index 000000000..6d82140db --- /dev/null +++ b/docs/usecases/deprecated_usecases.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + +.. _deprecated_usecases: + +:orphan: + +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 + :widths: 50,20,10,20 + :header-rows: 1 + :delim: ; diff --git a/docs/usecases/release_automated_usecases.rst b/docs/usecases/release_automated_usecases.rst new file mode 100644 index 000000000..a53d0c1b4 --- /dev/null +++ b/docs/usecases/release_automated_usecases.rst @@ -0,0 +1,36 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + +.. _release_automated_usecases: + +:orphan: + +Automated Use Cases +------------------- + +These use cases have been run on the Daily Guilin CI chains and are used to +validate the integration of any new dockers in OOM. + +.. 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/usecases/release_non_functional_requirements.rst b/docs/usecases/release_non_functional_requirements.rst new file mode 100644 index 000000000..b3f5a0b54 --- /dev/null +++ b/docs/usecases/release_non_functional_requirements.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + +.. _release_non_functional_requirements: + +:orphan: + +Non Functional Requirements +---------------------------- + +.. csv-table:: non functional requirements table + :file: ../files/csv/usecases-non-functional-requirements.csv + :widths: 5,45,12,38 + :delim: ; + :header-rows: 1 diff --git a/docs/usecases/release_requirements.rst b/docs/usecases/release_requirements.rst new file mode 100644 index 000000000..0ec4b1b95 --- /dev/null +++ b/docs/usecases/release_requirements.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + +.. _release_requirements: + +:orphan: + +Functional Requirements +----------------------- + +.. csv-table:: functional requirements table + :file: ../files/csv/usecases-functional-requirements.csv + :widths: 5,45,12,38 + :delim: ; + :header-rows: 1 diff --git a/docs/usecases/release_usecases.rst b/docs/usecases/release_usecases.rst new file mode 100644 index 000000000..d28a653b3 --- /dev/null +++ b/docs/usecases/release_usecases.rst @@ -0,0 +1,46 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. http://creativecommons.org/licenses/by/4.0 + +.. _release_usecases: + +:orphan: + +Guilin Use Cases +================ + +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:: + :file: ../files/csv/usecases.csv + :widths: 10,40,20,30 + :delim: ; + :header-rows: 1 + +Old Use Cases Tested in Guilin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. csv-table:: + :file: ../files/csv/usecases-old-valid.csv + :widths: 50,20,30 + :delim: ; + :header-rows: 1 -- 2.16.6