a. Service Design
==================
-The ONAP Design Time Framework provides the ability to design NFV
-resources including VNFs, services, and products. The vendor must
-provide VNF packages that include a rich set of recipes, management and
-functional interfaces, policies, configuration parameters, and
-infrastructure requirements that can be utilized by the ONAP Design
-module to onboard and catalog these resources. Initially this
-information may be provided in documents, but in the near future a
-method will be developed to automate as much of the transfer of data as
-possible to satisfy its long term requirements.
-
-The current VNF Package Requirement is based on a subset of the
-Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1
-and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization
-(NFV), Management and Orchestration, VNF Packaging Specification.
-
-Table 1. VNF Package
-
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| **Principle** | **Description** | **Type** | **ID #** |
-+========================+===================================================================================================================================================================================================================================================================================================================================================================+============+============+
-| 2.0.1 | The VNF Vendor must provide a Manifest File that contains a list of all the components in the VNF package. | Must | 10010 |
-| | | | |
-| Resource | | | |
-| | | | |
-| Description | | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The package must include VNF Identification Data to uniquely identify the resource for a given Vendor. The identification data must include: an identifier for the VNF, the name of the VNF as was given by the VNF Vendor, VNF description, VNF Vendor, and version. | Must | 10020 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide documentation describing VNF Management APIs. The document must include information and tools for: | Optional | 10030 |
-| | | | |
-| | - ONAP to deploy and configure (initially and ongoing) the VNF application(s) (e.g., NETCONF APIs). Includes description of configurable parameters for the VNF and whether the parameters can be configured after VNF instantiation. | | |
-| | | | |
-| | - ONAP to monitor the health of the VNF (conditions that require healing and/or scaling responses). Includes a description of: | | |
-| | | | |
-| | - Parameters that can be monitored for the VNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the VNF after instantiation. | | |
-| | | | |
-| | - Runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the VNF. | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF package must include documentation describing VNF Functional APIs that are utilized to build network and application services. Provides the externally exposed functional inputs and outputs for the VNF, including interface format and protocols supported. | Must | 10040 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide documentation describing VNF Functional Capabilities that are utilized to operationalize the VNF and compose complex services. | Must | 10050 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide information regarding any dependency with other VNFs and resources. | Must | 10060 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| 2.0.2 | The VNF Vendor must provide a Resource/Device YANG model as a foundation for creating the YANG model for configuration. This will include VNF attributes/parameters and valid values/attributes configurable by policy. | Optional | 10070 |
-| | | | |
-| Resource | | | |
-| | | | |
-| Configuration | | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Package must include configuration scripts for boot sequence and configuration. | Must | 10080 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide configurable parameters (if unable to conform to YANG model) including VNF attributes/parameters and valid values, dynamic attributes and cross parameter dependencies (e.g., customer provisioning data). | Optional | 10090 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| 2.0.3 | The VNF Vendor must provide documentation for the VNF Policy Description to manage the VNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the VNF. | Must | 10100 |
-| | | | |
-| Resource | | | |
-| | | | |
-| Control Loop | | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Package must include documentation describing the fault, performance, capacity events/alarms and other event records that are made available by the VNF. The document must include: | Must | 10110 |
-| | | | |
-| | - A unique identification string for the specific VNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue. | | |
-| | | | |
-| | - All events, severity level (e.g., informational, warning, error) and descriptions including causes/fixes if applicable for the event. | | |
-| | | | |
-| | - All events (fault, measurement for VNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, VNFC (defined in *VNF Guidelines for Network Cloud and ONAP*) and for the overall VNF. | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide documentationthat contains a list of VNF error codes, descriptions of the error, and possible causes/corrective action. | Optional | 10120 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | Provide documentation describing all parameters that are available to monitor the VNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc., that must be collected for reporting purposes. The documentation must include a list of: | Optional | 10130 |
-| | | | |
-| | - Monitoring parameters/counters exposed for virtual resource management and VNF application management. | | |
-| | | | |
-| | - KPIs and metrics that need to be collected at each VM for capacity planning purposes. | | |
-| | | | |
-| | - For each KPI, provide lower and upper limits. | | |
-| | | | |
-| | - When relevant, provide a threshold crossing alert point for each KPI at which time scaling rules will apply. | | |
-| | | | |
-| | - For each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded. | | |
-| | | | |
-| | - Describe any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the VNF. | | |
-| | | | |
-| | - When applicable, provide calculators needed to convert raw data into appropriate reporting artifacts. | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Package must include documentation describing supported VNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls). | Optional | 10140 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Package must include documentation describing the characteristics for the VNF reliability and high availability. | Must | 10150 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| 2.0.4 | The VNF Package must include VNF topology that describes basic network and application connectivity internal and external to the VNF including Link type, KPIs, Bandwidth, QoS (if applicable) for each interface. | Must | 10160 |
-| | | | |
-| Compute, | | | |
-| | | | |
-| Network, | | | |
-| | | | |
-| Storage | | | |
-| | | | |
-| Requirements | | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Package must include VM requirements via a Heat template that provides the necessary data for: | Optional | 10170 |
-| | | | |
-| | - VM specifications for all VNF components - for hypervisor, CPU, memory, storage. | | |
-| | | | |
-| | - Network connections, interface connections, internal and external to VNF. | | |
-| | | | |
-| | - High availability redundancy model. | | |
-| | | | |
-| | - Static scaling/growth VM specifications. | | |
-| | | | |
-| | Note1: Must comply with the *Heat Template Requirements for Virtual Network Functions*. | | |
-| | | | |
-| | Note2: Must comply with the Network Cloud Specifications defined in *Example Implementation of Network Cloud.* | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide the binaries and images needed to instantiate the VNF (VNF and VNFC images). | Must | 10180 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must describe scaling capabilities to manage scaling characteristics of the VNF. | Must | 10190 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| 2.0.5 | The VNF Package must include documentation describing the tests that were conducted by the Vendor and the test results. | Must | 10200 |
-| | | | |
-| Testing | | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide their testing scripts to support testing. | Must | 10210 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The VNF Vendor must provide software components that can be packaged with/near the VNF, if needed, to simulate any functions or systems that connect to the VNF system under test. This component is necessary only if the existing testing environment does not have the necessary simulators. | Must | 10220 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| 2.0.6 | VNFs must provide metrics (e.g., number of sessions, number of subscribers, number of seats, etc.) to ONAP for tracking every license. | Must | 10230 |
-| | | | |
-| Licensing Guidelines | | | |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | Contract shall define the reporting process and the available reporting tools. The vendor will have to agree to the process that can be met by Service Provider reporting infrastructure. | Must | 10240 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | VNF vendors shall enumerate all of the open source licenses their VNF(s) incorporate. | Must | 10250 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | Audits of Service Provider’s business must not be required. | Must | 10260 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | Vendor functions and metrics that require additional infrastructure such as a vendor license server for deployment shall not be supported. | Must | 10270 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | Provide clear measurements for licensing purposes to allow automated scale up/down by the management system. | Must | 10280 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | The vendor must provide the ability to scale up a vendor supplied product during growth and scale down a vendor supplied product during decline without “real-time” restrictions based upon vendor permissions. | Must | 10290 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | A universal license key must be provided per VNF to be used as needed by services (i.e., not tied to a VM instance) as the recommended solution. The vendor may provide pools of Unique VNF License Keys, where there is a unique key for each VNF instance as an alternate solution. Licensing issues should be resolved without interrupting in-service VNFs. | Must | 10300 |
-+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-
b. VNF On-boarding and package management
==========================================
Code Review / vnfrqts / requirements.git / commitdiff