VNF Package Requirements

43 VNF requirements referring to "package"

Note there is some overlap with those referring "document" as well.

ID	Content	Target	Keyword	Section Name
R-842258	The VNF MUST include a configuration, e.g., a heat template or CSAR package, that specifies the targetted parameters, e.g. a limited set of ports, over which the VNF will communicate (including internal, external and management communication).	VNF	MUST	VNF General Security Requirements
R-384337	The VNF documentation MUST contain a list of the files within the VNF package that are static during the VNF's runtime.	VNF	MUST	Resource Description
R-98191	The xNF MUST vary the frequency that asynchronous data is delivered based on the content and how data may be aggregated or grouped together. Note: - For example, alarms and alerts are expected to be delivered as soon as they appear. In contrast, other content, such as performance measurements, KPIs or reported network signaling may have various ways of packaging and delivering content. Some content should be streamed immediately; or content may be monitored over a time interval, then packaged as collection of records and delivered as block; or data may be collected until a package of a certain size has been collected; or content may be summarized statistically over a time interval, or computed as a KPI, with the summary or KPI being delivered. - We expect the reporting frequency to be configurable depending on the virtual network functions needs for management. For example, Service Provider may choose to vary the frequency of collection between normal and trouble-shooting scenarios. - Decisions about the frequency of data reporting will affect the size of delivered data sets, recommended delivery method, and how the data will be interpreted by ONAP. These considerations should not affect deserialization and decoding of the data, which will be guided by the accompanying JSON schema or GPB definition files.	XNF	MUST	Reporting Frequency
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.	VNF	MUST	Compute, Network, and Storage Requirements
R-90632	The xNF Package MUST include documentation about KPIs and metrics that need to be collected at each VM for capacity planning and performance management purposes.	XNF	MUST	Resource Control Loop
R-87234	The VNF package provided by a VNF vendor MAY be either with TOSCA-Metadata directory (CSAR Option 1) or without TOSCA-Metadata directory (CSAR Option 2) as specified in ETSI GS NFV-SOL004. On-boarding entity (ONAP SDC) must support both options. Note: SDC supports only the CSAR Option 1 in Casablanca. The Option 2 will be considered in future ONAP releases,	VNF	MAY	VNF Package Structure and Format
R-86235	The xNF 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 xNF and those that must be exercised by the xNF in order to perform its function.	XNF	MUST	Resource Control Loop
R-84366	The xNF Package MUST include documentation describing xNF Functional APIs that are utilized to build network and application services. This document describes the externally exposed functional inputs and outputs for the xNF, including interface format and protocols supported.	XNF	MUST	Resource Description
R-77707	The xNF provider MUST include a Manifest File that contains a list of all the components in the xNF package.	XNF	MUST	Resource Description
R-73560	The xNF Package MUST include documentation about monitoring parameters/counters exposed for virtual resource management and xNF application management.	XNF	MUST	Resource Control Loop
R-69877	The xNF Package MUST include documentation for each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded.	XNF	MUST	Resource Control Loop
R-69565	The xNF Package MUST include documentation describing xNF Management APIs, which must include information and tools for ONAP to deploy and configure (initially and ongoing) the xNF application(s) (e.g., NETCONF APIs) which includes a description of configurable parameters for the xNF and whether the parameters can be configured after xNF instantiation.	XNF	MUST	Resource Description
R-67709	The VNF MUST be designed, built and packaged to enable deployment across multiple fault zones (e.g., VNFCs deployed in different servers, racks, OpenStack regions, geographies) so that in the event of a planned/unplanned downtime of a fault zone, the overall operation/throughput of the VNF is maintained.	VNF	MUST	All Layer Redundancy
R-66070	The xNF Package MUST include xNF Identification Data to uniquely identify the resource for a given xNF provider. The identification data must include: an identifier for the xNF, the name of the xNF as was given by the xNF provider, xNF description, xNF provider, and version.	XNF	MUST	Resource Description
R-58775	The xNF provider MUST provide software components that can be packaged with/near the xNF, if needed, to simulate any functions or systems that connect to the xNF system under test. This component is necessary only if the existing testing environment does not have the necessary simulators.	XNF	MUST	Testing
R-56815	The xNF Package MUST include documentation describing supported xNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls).	XNF	MUST	Resource Control Loop
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.	VNF	MUST	Compute, Network, and Storage Requirements
R-53598	The xNF Package MUST include documentation to, when relevant, provide a threshold crossing alert point for each KPI and describe the significance of the threshold crossing.	XNF	MUST	Resource Control Loop
R-51347	The VNF package MUST be arranged as a CSAR archive as specified in TOSCA Simple Profile in YAML 1.2.	VNF	MUST	VNF Package Structure and Format
R-48596	The xNF Package MUST include documentation describing the characteristics for the xNF reliability and high availability.	XNF	MUST	Resource Control Loop
R-46567	The xNF Package MUST include configuration scripts for boot sequence and configuration.	XNF	MUST	Configuration Management via Ansible
R-44896	The VNF Package MUST include VM requirements via a Heat template that provides the necessary data for high availability redundancy model.	VNF	MUST	Compute, Network, and Storage Requirements
R-43958	The xNF Package MUST include documentation describing the tests that were conducted by the xNF provider and the test results.	XNF	MUST	Testing
R-42018	The xNF Package MUST include documentation which must include all events (fault, measurement for xNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html>`__ ) and for the overall xNF.	XNF	MUST	Resource Control Loop
R-35960	The xNF 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.	XNF	MUST	Resource Control Loop
R-35851	The xNF Package MUST include xNF topology that describes basic network and application connectivity internal and external to the xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable) for each interface.	XNF	MUST	Compute, Network, and Storage Requirements
R-33904	The xNF Package MUST include documentation for each KPI, provide lower and upper limits.	XNF	MUST	Resource Control Loop
R-33694	The xNF Package MUST include documentation to when applicable, provide calculators needed to convert raw data into appropriate reporting artifacts.	XNF	MUST	Resource Control Loop
R-30654	The xNF Package MUST have appropriate cookbooks that are designed to automatically 'rollback' to the original state in case of any errors for actions that change state of the xNF (e.g., configure).	XNF	MUST	Chef Roles/Requirements
R-27310	The xNF Package MUST include all relevant Chef artifacts (roles/cookbooks/recipes) required to execute xNF actions requested by ONAP for loading on appropriate Chef Server.	XNF	MUST	Chef Roles/Requirements
R-26567	The xNF Package MUST include a run list of roles/cookbooks/recipes, for each supported xNF action, that will perform the desired xNF action in its entirety as specified by ONAP (see Section 7.c, APPC/SDN-C APIs and Behavior, for list of xNF actions and requirements), when triggered by a chef-client run list in JSON file.	XNF	MUST	Chef Roles/Requirements
R-25238	The xNF PACKAGE MUST validated YANG code using the open source pyang [#7.3.1]_ program using the following commands: .. code-block:: text $ pyang --verbose --strict <YANG-file-name(s)> $ echo $!	VNF	MUST	NETCONF Server Requirements
R-22680	The xNF Package MUST include documentation that describes any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the xNF.	XNF	MUST	Resource Control Loop
R-22346	The VNF package MUST provide :doc:`VES Event Registration <../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>` for all VES events provided by that xNF.	VNF PACKAGE	MUST	Resource Description
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.	VNF	MUST	Compute, Network, and Storage Requirements
R-16875	The xNF Package MUST include documentation which must include a unique identification string for the specific xNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue.	XNF	MUST	Resource Control Loop
R-12678	The xNF Package MUST include documentation which includes a description of runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the xNF.	XNF	MUST	Resource Description
R-10087	The VNF package MUST contain all standard artifacts as specified in ETSI GS NFV-SOL004 including Manifest file, VNFD (or Main TOSCA/YAML based Service Template) and other optional artifacts. CSAR Manifest file as per SOL004 - for example ROOT\\ MainServiceTemplate.mf	VNF	MUST	VNF Package Contents
R-01556	The xNF Package MUST include documentation describing the fault, performance, capacity events/alarms and other event records that are made available by the xNF.	XNF	MUST	Resource Control Loop
R-01478	The xNF Package MUST include documentation describing all parameters that are available to monitor the xNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected for reporting purposes.	XNF	MUST	Resource Control Loop
R-01123	The VNF package Manifest file MUST contain: VNF package meta-data, a list of all artifacts (both internal and external) entry's including their respected URI's, an algorithm to calculate a digest and a digest result calculated on the content of each artifacts, as specified in ETSI GS NFV-SOL004. 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.	VNF	MUST	VNF Package Contents
R-00156	The xNF Package MUST include documentation describing xNF Management APIs, which must include information and tools for ONAP to monitor the health of the xNF (conditions that require healing and/or scaling responses).	XNF	MUST	Resource Description
R-00068	The xNF Package MUST include documentation which includes a description of parameters that can be monitored for the xNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the xNF after instantiation.	XNF	MUST	Resource Description