From cb0256a2e85cb929f145509b46fa56cbd4f07e62 Mon Sep 17 00:00:00 2001 From: mrichomme Date: Tue, 19 May 2020 23:00:34 +0200 Subject: Update Doc for frankfurt Issue-ID: INT-1551 Signed-off-by: mrichomme Change-Id: I8cd83775001a125c11a0408d05a4dacb54f2c1c9 Signed-off-by: mrichomme --- docs/docs_usecases.rst | 82 +++++++++++++++++++++++++++++--------------------- 1 file changed, 48 insertions(+), 34 deletions(-) (limited to 'docs/docs_usecases.rst') 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 `_ +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 ` - -:ref:`VF Module Scale Out Use Case (vLoadBalancer/vDNS example) ` - -:ref:`vCPE Use Case ` - -:ref:`CCVPN (Cross Domain and Cross Layer VPN) Use Case ` +This documentation deals with -:ref:`vFirewall/vDNS with HPA Use Case ` + 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 ` +The final testing status can be found at `Frankfurt Release Integration Testing +Status `_ -:ref:`BBS (Broadband Service) Use Case ` +31 use cases/functional requirements have been considered for the Frankfurt release. -:ref:`vIPsec with HPA Use Case ` - -:ref:`vFirewall/edgex with multicloud kubernetes plugin ` - -:ref:`vFirewall CNF (Container Network Function) With CDS Use Case ` +Use cases +~~~~~~~~~ -:ref:`vCPE Tosca Local Mode Use Case ` +.. 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 ` -:ref:`5G - Bulk PM ` +.. csv-table:: functional requirements table + :file: functional-requirements.csv + :widths: 60,20,20 + :header-rows: 1 + -:ref:`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 ` +Automated Use Cases +~~~~~~~~~~~~~~~~~~~ -:ref:`5G - 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 ` +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 ` +The frankfurt use cases integrated in gates are: -:ref:`PNF Support - PNF Plug and Play ` +- pnf-regitrate +- 5gbulkpm +- hv-ves -:ref:`PNF Support - PNF Software Upgrade ` +Deprecated Use Cases +~~~~~~~~~~~~~~~~~~~~ -:ref:`Change Management Flexible Designer and 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 ` +.. csv-table:: deprecated use case table + :file: usecases-deprecated.csv + :widths: 50,20,10,20 + :header-rows: 1 -- cgit 1.2.3-korg