7.2. VNF 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
updated: dublin
target: VNF Package
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF PROVIDER
keyword: MUST

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
updated: dublin
validation_mode: static
target: VNF or PNF PACKAGE
keyword: MUST
introduced: casablanca

The VNF or PNF package MUST provide VES Event Registration for all VES events provided by that VNF or PNF.

Requirement: R-384337
updated: dublin
target: VNF DOCUMENTATION PACKAGE
keyword: MUST
introduced: casablanca

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
impacts: DCAE,Documentation,Integration,SDC
validation_mode: static
target: VNF PROVIDER
keyword: MUST
introduced: dublin

The VNF or PNF PROVIDER MUST provide FM Meta Data to support the analysis of fault events delivered to DCAE. The Meta Data must be included in the VES Registration YAML file with each fault event supported by that NF at onboarding time and the Meta Data must follow the VES Event Listener and VES Event Registration Specifications.

Requirement: R-816745
impacts: DCAE,Documentation,Integration,SDC
validation_mode: static
target: VNF or PNF PROVIDER
keyword: MUST
introduced: dublin

The VNF or PNF PROVIDER MUST provide the Service Provider with PM Meta Data (PM Dictionary) to support the analysis of PM events delivered to DCAE. The PM Dictionary is to be provided as a separate YAML artifact at onboarding and must follow the VES Event Listener Specification and VES Event Registration Specification which contain the format and content required.

7.2.3. Resource Configuration

Requirement: R-89571
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF MUST support and provide artifacts for configuration management using at least one of the following technologies; a) Netconf/YANG, b) Chef, or c) Ansible.

Note: The requirements for Netconf/YANG, Chef, and Ansible protocols are provided separately and must be supported only if the corresponding protocol option is provided by the VNF or PNF providor.

7.2.3.1. Configuration Management via NETCONF/YANG

Requirement: R-30278
updated: dublin
target: VNF or PNF
keyword: SHOULD

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
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF provider MUST provide cookbooks to be loaded on the appropriate Chef Server.

Requirement: R-18525
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF provider MUST provide playbooks to be loaded on the appropriate Ansible Server.

Requirement: R-16777
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF Package MUST include configuration scripts for boot sequence and configuration.

Requirement: R-16065
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF Package MUST include documentation for each KPI, provide lower and upper limits.

Requirement: R-53598
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF or PNF DOCUMENTATION PACKAGE
keyword: MUST

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
updated: dublin
target: VNF HEAT PACKAGE
keyword: MUST

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
target: VNF
keyword: MUST

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
target: VNF
keyword: MUST

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
target: VNF
keyword: MUST

The VNF Package MUST include VM requirements via a Heat template that provides the necessary data for high availability redundancy model.

Requirement: R-55802
target: VNF
keyword: MUST

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
updated: dublin
target: VNF
keyword: MUST

The VNF provider MUST provide the binaries and images needed to instantiate the VNF (VNF and VNFC images).

Requirement: R-96634
updated: dublin
target: VNF or PNF PROVIDER
keyword: MUST

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
updated: dublin
target: VNF DOCUMENTATION PACKAGE
keyword: MUST

The VNF Documentation Package MUST describe the tests that were conducted by the VNF provider and the test results.

Requirement: R-04298
updated: dublin
target: VNF
keyword: MUST

The VNF provider MUST provide their testing scripts to support testing.

Requirement: R-58775
updated: dublin
target: VNF
keyword: MUST

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

Requirement: R-85653
updated: dublin
target: VNF or PNF
keyword: MUST

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-44125
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF provider MUST agree to the process that can be met by Service Provider reporting infrastructure. The Contract shall define the reporting process and the available reporting tools.

Requirement: R-40827
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF provider MUST enumerate all of the open source licenses their VNF or PNF(s) incorporate.

Requirement: R-97293
updated: dublin
target: VNF or PNF
keyword: MUST NOT

The VNF or PNF provider MUST NOT require audits of Service Provider’s business.

Requirement: R-44569
updated: dublin
target: VNF or PNF
keyword: MUST NOT

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
target: VNF
keyword: MUST

The VNF MUST provide clear measurements for licensing purposes to allow automated scale up/down by the management system.

Requirement: R-27511
target: VNF
keyword: MUST

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
updated: dublin
target: VNF or PNF
keyword: MUST

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. Licensing issues should be resolved without interrupting in-service VNFs or PNFs.

Requirement: R-47849
updated: dublin
target: VNF or PNF
keyword: MUST

The VNF or PNF provider MUST support the metadata about licenses (and their applicable entitlements) as defined in this specification for VNF or PNF software, 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. The details of this license model are described in Tables C1 to C8 in the Appendix.

Note: License metadata support in ONAP is not currently available and planned for 1Q 2018.