7.2. VNF and PNF On-boarding and package management
7.2.1. Design Definition
The ONAP Design Time Framework provides the ability to design NFV resources including VNFs, Services, and products. The VNF provider 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.
7.2.2. Resource Description
Requirement: R-66070
  |
For HEAT package, the VNF Package MUST include VNF Identification Data to uniquely identify the resource for a given VNF provider. The identification data must include: an identifier for the VNF, the name of the VNF as was given by the VNF provider, VNF description, VNF provider, and version. |
Requirement: R-69565
|
The VNF or PNF Documentation Package MUST describe the VNF or PNF Management APIs, which must include information and tools for ONAP to deploy and configure (initially and ongoing) the VNF or PNF application(s) (e.g., NETCONF APIs) which includes a description of configurable parameters for the VNF or PNF and whether the parameters can be configured after VNF or PNF instantiation. |
Requirement: R-00156
|
The VNF or PNF Documentation Package MUST describe the VNF or PNF Management APIs, which must include information and tools for ONAP to monitor the health of the VNF or PNF (conditions that require healing and/or scaling responses). |
Requirement: R-00068
|
The VNF or PNF Documentation Package MUST include a description of parameters that can be monitored for the VNF or PNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the VNF or PNF after instantiation. |
Requirement: R-12678
|
The VNF or PNF Documentation Package MUST include a description of runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the VNF or PNF. |
Requirement: R-84366
|
The VNF or PNF Documentation Package MUST describe the VNF or PNF Functional APIs that are utilized to build network and application services. This document describes the externally exposed functional inputs and outputs for the VNF or PNF, including interface format and protocols supported. |
Requirement: R-36280
|
The VNF or PNF Documentation Package MUST describe the VNF or PNF Functional Capabilities that are utilized to operationalize the VNF or PNF and compose complex services. |
Requirement: R-98617
|
The VNF Provider MUST provide documentation regarding any dependency (e.g. affinity, anti-affinity) the VNF has on other VNFs and resources. |
Requirement: R-22346
|
The VNF or PNF Provider MUST provide VES Event Registration for all VES events provided by that VNF or PNF. |
Requirement: R-384337
|
The VNF Documentation Package MUST contain a list of the files within the VNF package that are static during the VNF’s runtime. |
Requirement: R-025941
|
The VNF or PNF PROVIDER MUST provide FM Meta Data to support the analysis of fault events delivered to DCAE. The metadata must be included in the VES Registration YAML file for each fault event supported by that VNF or PNF at onboarding time. The metadata must follow the VES Event Listener Specifications for Fault domain and VES Event Registration Specifications for YAML registration file format. |
Requirement: R-816745
|
THe VNF or PNF PROVIDER MUST provide PM Meta Data (PM Dictionary) to support the analysis of PM data delivered to DCAE. The PM Dictionary is to be provided as a separate YAML artifact at onboarding and must follow the VES Event Registration Specification which contain the format and content required. |
7.2.3. Resource Configuration
Requirement: R-89571
|
The VNF or PNF PROVIDER MUST provide artifacts for configuration management using at least one of the following technologies; a) Netconf/YANG, b) Chef, or c) Ansible. |
7.2.3.1. Configuration Management via NETCONF/YANG
Requirement: R-30278
|
The VNF or PNF PROVIDER SHOULD provide a Resource/Device YANG model as a foundation for creating the YANG model for configuration. |
7.2.3.2. Configuration Management via Chef
Requirement: R-13390
|
The VNF or PNF provider MUST provide cookbooks to be loaded on the appropriate Chef Server. |
Requirement: R-18525
|
The VNF or PNF provider MUST provide a JSON file for each supported action for the VNF or PNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Tables A1 and A2 in the Appendix. Note: Chef support in ONAP is not currently available and planned for 4Q 2017. |
7.2.3.3. Configuration Management via Ansible
Requirement: R-75608
|
The VNF or PNF provider MUST provide playbooks to be loaded on the appropriate Ansible Server. |
Requirement: R-16777
|
The VNF or PNF provider MUST provide a JSON file for each supported action for the VNF or PNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Table B1 in the Appendix. |
Requirement: R-46567
|
The VNF or PNF Package MUST include configuration scripts for boot sequence and configuration. |
Requirement: R-16065
|
The VNF or PNF provider MUST provide configurable parameters (if unable to conform to YANG model) including VNF or PNF attributes/parameters and valid values, dynamic attributes and cross parameter dependencies (e.g., customer provisioning data). |
7.2.4. Resource Control Loop
Requirement: R-22888
|
The VNF or PNF Documentation Package MUST provide the VNF or PNF Policy Description to manage the VNF or PNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the VNF or PNF. |
Requirement: R-01556
|
The VNF or PNF Documentation Package MUST describe the fault, performance, capacity events/alarms and other event records that are made available by the VNF or PNF. |
Requirement: R-16875
|
The VNF or PNF Documentation Package MUST include documentation which must include a unique identification string for the specific VNF or PNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue. |
Requirement: R-35960
|
The VNF or PNF Package MUST include documentation which must include all events, severity level (e.g., informational, warning, error) and descriptions including causes/fixes if applicable for the event. |
Requirement: R-42018
|
The VNF or PNF Package MUST include documentation which must include all events (fault, measurement for VNF or PNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, VNFC (defined in VNF Guidelines ) and for the overall VNF or PNF. |
Requirement: R-01478
|
The VNF or PNF Documentation Package MUST describe all parameters that are available to monitor the VNF or PNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected for reporting purposes. |
Requirement: R-73560
|
The VNF or PNF Package MUST include documentation about monitoring parameters/counters exposed for virtual resource management and VNF or PNF application management. |
Requirement: R-90632
|
The VNF Package MUST include documentation about KPIs and metrics that need to be collected at each VM for capacity planning and performance management purposes. |
Requirement: R-86235
|
The VNF or PNF Package MUST include documentation about the monitoring parameters that must include latencies, success rates, retry rates, load and quality (e.g., DPM) for the key transactions/functions supported by the VNF or PNF and those that must be exercised by the VNF or PNF in order to perform its function. |
Requirement: R-33904
|
The VNF or PNF Package MUST include documentation for each KPI, provide lower and upper limits. |
Requirement: R-53598
|
The VNF or PNF Documentation Package MUST, when relevant, provide a threshold crossing alert point for each KPI and describe the significance of the threshold crossing. |
Requirement: R-69877
|
The VNF or PNF Package MUST include documentation for each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded. |
Requirement: R-22680
|
The VNF or PNF Documentation Package MUST describe any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the VNF or PNF. |
Requirement: R-33694
|
The VNF or PNF Package MUST include documentation to when applicable, provide calculators needed to convert raw data into appropriate reporting artifacts. |
Requirement: R-56815
|
The VNF or PNF Documentation Package MUST describe supported VNF or PNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls). |
Requirement: R-48596
|
The VNF or PNF Documentation Package MUST describe the characteristics for the VNF or PNF reliability and high availability. |
7.2.5. Compute, Network, and Storage Requirements
Requirement: R-35851
|
The VNF HEAT Package MUST include VNF topology that describes basic network and application connectivity internal and external to the VNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable) for each interface. |
Requirement: R-97102
|
The VNF Package MUST include VM requirements via a Heat template that provides the necessary data for VM specifications for all VNF components - for hypervisor, CPU, memory, storage. |
Requirement: R-20204
|
The VNF Package MUST include VM requirements via a Heat template that provides the necessary data for network connections, interface connections, internal and external to VNF. |
Requirement: R-44896
|
The VNF Package MUST include VM requirements via a Heat template that provides the necessary data for high availability redundancy model. |
Requirement: R-55802
|
The VNF Package MUST include VM requirements via a Heat template that provides the necessary data for scaling/growth VM specifications. Note: Must comply with the Heat requirements in 5.b. |
Requirement: R-26881
|
The VNF provider MUST provide the binaries and images needed to instantiate the VNF (VNF and VNFC images). |
Requirement: R-96634
|
The VNF or PNF Provider MUST provide human readable documentation (not in the on-boarding package) to describe scaling capabilities to manage scaling characteristics of the VNF or PNF. |
7.2.6. Testing
Requirement: R-43958
|
The VNF Documentation Package MUST describe the tests that were conducted by the VNF provider and the test results. |
Requirement: R-04298
|
The VNF provider MUST provide their testing scripts to support testing. |
Requirement: R-58775
|
The VNF provider 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. |
7.2.7. Licensing Requirements
ONAP can support external licensing management solutions. For example, a vendor-specific solution where the VNF or PNF obtains its licenses from an external source and ONAP licensing management solution is not used. If the licensing management solution is provided by ONAP, then ONAP operators will build the VNF license using SDC during onboarding. Refer to the ONAP User Guide for details. The operators require certain information regarding VNF licences. This information currently is delivered out of band. HEAT or TOSCA VNF packages may support such information in future. VNF licensing behavior also has some constraints.
Requirement: R-85653
|
If ONAP licensing management solution is used, then the VNF or PNF MUST provide metrics (e.g., number of sessions, number of subscribers, number of seats, etc.) to ONAP for tracking every license. |
Requirement: R-40827
|
The VNF or PNF provider MUST enumerate all of the open source licenses their VNF or PNF(s) incorporate. |
Requirement: R-44569
|
If ONAP licensing management solution is used, then the VNF or PNF provider MUST NOT require additional infrastructure such as a VNF or PNF provider license server for VNF or PNF provider functions and metrics. |
Requirement: R-13613
|
The VNF MUST provide clear measurements for licensing purposes if needed to allow automated scale up/down by the management system. |
Requirement: R-27511
|
The VNF provider MUST provide the ability to scale up a VNF provider supplied product during growth and scale down a VNF provider supplied product during decline without “real-time” restrictions based upon VNF provider permissions. |
Requirement: R-85991
|
If the VNF or PNF requires a license then the VNF or PNF provider MUST provide a universal license key per VNF or PNF to be used as needed by services (i.e., not tied to a VM instance) as the recommended solution. The VNF or PNF provider may provide pools of Unique VNF or PNF License Keys, where there is a unique key for each VNF or PNF instance as an alternate solution. In all cases, licensing issues should be resolved without interrupting in-service VNFs or PNFs. |
Requirement: R-47849
|
If ONAP licensing management solution is used, then the VNF or PNF provider MUST support the metadata about licenses (and their applicable entitlements) as defined in the ONAP License Management Information Model, and any license keys required to authorize use of the VNF or PNF software. This metadata will be used to facilitate onboarding the VNF or PNF into the ONAP environment and automating processes for putting the licenses into use and managing the full lifecycle of the licenses. |