diff options
Diffstat (limited to 'docs/docs_usecases.rst')
| -rw-r--r-- | docs/docs_usecases.rst | 82 |
1 files changed, 48 insertions, 34 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 |