From e26a0d78084d175e7c4612657857ca2f9030f1f4 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Wed, 2 Dec 2020 23:29:24 +0100 Subject: [PATCH] Add functional and non-functional requirements lists As decided in PTL meeting (30 november 2020), add list of functional and non-functional requirements Add :orphan: to avoid remaining warnings during Documentation build Issue-ID: DOC-687 Signed-off-by: Eric Debeau Change-Id: I305057e0de909e0165d0ca8a05b426e97ed1b111 --- docs/release-notes.rst | 2 + docs/release/index.rst | 102 ++++++++++++++++++++++++++++++++++++++++-- docs/release/releaserepos.rst | 2 + 3 files changed, 102 insertions(+), 4 deletions(-) diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 67141c5a7..1f0f6b595 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,6 +5,8 @@ .. _doc_release_notes: +:orphan: + Release Notes ============= diff --git a/docs/release/index.rst b/docs/release/index.rst index 9f9a5dcb3..7c81596c7 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -47,7 +47,7 @@ Release data Guilin Features =============== -ONAP Gulin focusses on: +ONAP Guilin focusses on: * 5G network automation and services such as network slicing through RAN, core and transport @@ -93,7 +93,101 @@ Event Stream (VES) event for Fault Management (FM) / Performance Management (PM) Data Collection, the first use of Machine Learning in Self-Organizing Networks (SON), and greater support for 5G RAN Wireless Network Resource Model (NRM) with Service Modeling and Definition and Intent Based Network supporting -intent-drive 5G slice creation. +intent-drive 5G slice creation. The Cross Domain and Cross Layer VPN (CC-VPN) +includes transport slicing and the MDONS (Multi-Domain Optical Network Service +) has been extended. + +Functional Requirements +----------------------- +The following requirements have been introduced in the Guilin Release: + +xNF Integration +............... + +- ONAP CNF orchestration - Enhancements +- Extension of PNF Pre-onboarding/onboarding +- Enhancements for PNF Plug & Play' +- xNF License Management + +Lifecycle Management +.................... + +- Policy Based Filtering +- CLAMP Deployment of Native policies +- Bulk PM / PM Data Control Extension +- Support xNF Software Upgrade in association to schema updates +- Configuration & Persistency Service + +Security +........ + +- CMPv2 Enhancements + +Standard alignment +.................. + +- ETSI-Alignment for Guilin +- ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES +- Extend ORAN A1 Adapter and add A1 Policy Management + +NFV testing Automatic Platform +............................... + +- Test Result Auto Analysis & Certification +- Test Task Auto Execution +- Test Environment Auto Deploy +- Test Topology Auto Design + +Non-Functional Requirements +--------------------------- +The following 'non-functional' requirements have been introduced in the Guilin +Release: + +Best Practice +............. + +- ONAP shall use STDOUT for logs collection +- IPv4/IPv6 dual stack support in ONAP (Guilin) +- Containers must crash properly when a failure occurs +- Containers must have no more than one main process +- Application config should be fully prepared before starting the + application container +- No root (superuser) access to database from application container + +Code Quality +............ + +- Each ONAP project shall improve its CII Badging score by improving input + validation and documenting it in their CII Badging site +- Each ONAP project shall define code coverage improvements and achieve at + least 55% code coverage + +Security +........ + +- ONAP must complete update of the Python language (from 2.7 -> 3.8) +- ONAP must complete update of the java language (from v8 -> v11) +- All containers must run as non-root user +- Continue hardcoded passwords removal +- Flow management must be activated for ONAP. +- Each project will update the vulnerable direct dependencies in their code + base + +Tests +..... + +- More tests integrated in CI/CD but enhancements expected in Honolulu +- ONAP shall increase the number of Docker Benchmark tests + +Others +...... + +- ONAP to support Multi - tenancy + +.. important:: + Some non-functional requirements are not fully finalized. Please, check details + on the :ref:`Integration` + Project Specific Release Notes ============================== @@ -126,9 +220,9 @@ ONAP has adopted the `CII Best Practice Badge Program ` for each project. diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index c421bcc01..986694de0 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -5,6 +5,8 @@ .. _doc-releaserepos: +:orphan: + Project Specific Release Notes ++++++++++++++++++++++++++++++ -- 2.16.6