-.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
+.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
(the "License"); you may not use this documentation except in compliance
.. req::
:id: R-66070
- :target: XNF
+ :target: VNF Package
:keyword: MUST
+ :updated: dublin
- 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.
+ 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.
.. req::
:id: R-69565
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation describing xNF
+ 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 xNF application(s)
+ 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 xNF and whether the parameters can be configured
- after xNF instantiation.
+ parameters for the VNF or PNF and whether the parameters can be configured
+ after VNF or PNF instantiation.
.. req::
:id: R-00156
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation describing xNF
+ 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 xNF (conditions that require
+ ONAP to monitor the health of the VNF or PNF (conditions that require
healing and/or scaling responses).
.. req::
:id: R-00068
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation which includes
- a description of parameters that can be monitored for the xNF
+ 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 xNF after instantiation.
+ plane, etc.) generated by the VNF or PNF after instantiation.
.. req::
:id: R-12678
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation which includes a
+ 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 xNF.
+ control responses, tests) which can be performed for the VNF or PNF.
.. req::
:id: R-84366
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation describing
- xNF Functional APIs that are utilized to build network and
+ 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 xNF, including interface
+ functional inputs and outputs for the VNF or PNF, including interface
format and protocols supported.
.. req::
:id: R-36280
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide documentation describing
- xNF Functional Capabilities that are utilized to operationalize the
- xNF and compose complex services.
+ 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.
.. req::
:id: R-98617
- :target: XNF
+ :target: VNF PROVIDER
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide information regarding any
- dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
+ The VNF Provider **MUST** provide documentation regarding any dependency
+ (e.g. affinity, anti-affinity) the VNF has on other VNFs and resources.
.. req::
:id: R-22346
- :target: XNF PACKAGE
+ :target: VNF or PNF PACKAGE
:keyword: MUST
:introduced: casablanca
+ :updated: dublin
:validation_mode: static
- The xNF package MUST provide :doc:`VES Event Registration <../../../../vnfsdk/model.git/docs/files/VESEventRegistration_3_0>`
- for all VES events provided by that xNF.
+ The VNF or PNF package **MUST** provide :ref:`VES Event Registration <ves_event_registration_3_2>`
+ for all VES events provided by that VNF or PNF.
.. req::
:id: R-384337
- :target: VNF
+ :target: VNF DOCUMENTATION PACKAGE
:keyword: MUST
:introduced: casablanca
+ :updated: dublin
- The VNF documentation **MUST** contain a list of the files within the VNF
+ The VNF Documentation Package **MUST** contain a list of the files within the VNF
package that are static during the VNF's runtime.
+.. req::
+ :id: R-025941
+ :target: VNF PROVIDER
+ :keyword: MUST
+ :introduced: dublin
+ :impacts: DCAE,Documentation,Integration,SDC
+ :validation_mode: static
+
+ 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.
+
+.. req::
+ :id: R-816745
+ :target: VNF or PNF PROVIDER
+ :keyword: MUST
+ :introduced: dublin
+ :impacts: DCAE,Documentation,Integration,SDC
+ :validation_mode: static
+
+ 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.
Resource Configuration
^^^^^^^^^^^^^^^^^^^^^^^
.. req::
:id: R-89571
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF **MUST** support and provide artifacts for configuration
+ 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 xNF providor.
+ protocol option is provided by the VNF or PNF providor.
Configuration Management via NETCONF/YANG
.. req::
:id: R-30278
- :target: XNF
- :keyword: MUST
+ :target: VNF or PNF
+ :keyword: SHOULD
+ :updated: dublin
- The xNF provider **MUST** provide a Resource/Device YANG model
- as a foundation for creating the YANG model for configuration. This will
- include xNF attributes/parameters and valid values/attributes configurable
- by policy.
+ The VNF or PNF provider **SHOULD** provide a Resource/Device YANG model
+ as a foundation for creating the YANG model for configuration.
Configuration Management via Chef
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. req::
:id: R-13390
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide cookbooks to be loaded
+ The VNF or PNF provider **MUST** provide cookbooks to be loaded
on the appropriate Chef Server.
.. req::
:id: R-18525
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide a JSON file for each
- supported action for the xNF. The JSON file must contain key value
+ 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.
.. req::
:id: R-75608
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide playbooks to be loaded
+ The VNF or PNF provider **MUST** provide playbooks to be loaded
on the appropriate Ansible Server.
.. req::
:id: R-16777
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide a JSON file for each
- supported action for the xNF. The JSON file must contain key value
+ 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.
.. req::
:id: R-46567
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include configuration scripts
+ The VNF or PNF Package **MUST** include configuration scripts
for boot sequence and configuration.
.. req::
:id: R-16065
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide configurable parameters
- (if unable to conform to YANG model) including xNF attributes/parameters
+ 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).
.. req::
:id: R-22888
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide documentation for the xNF
- Policy Description to manage the xNF runtime lifecycle. The document
+ 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 xNF.
+ are implemented in the VNF or PNF.
.. req::
:id: R-01556
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation describing the
+ The VNF or PNF Documentation Package **MUST** describe the
fault, performance, capacity events/alarms and other event records
- that are made available by the xNF.
+ that are made available by the VNF or PNF.
.. req::
:id: R-16875
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- 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
+ 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.
.. req::
:id: R-35960
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation which must include
+ 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.
.. req::
:id: R-42018
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- 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.
+ 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 <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines.html>`__ ) and for the overall VNF or PNF.
-.. req::
- :id: R-27711
- :target: XNF
- :keyword: MUST
-
- The xNF provider **MUST** provide an XML file that contains a
- list of xNF error codes, descriptions of the error, and possible
- causes/corrective action.
.. req::
:id: R-01478
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation describing all
- parameters that are available to monitor the xNF after instantiation
+ 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.
.. req::
:id: R-73560
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation about monitoring
- parameters/counters exposed for virtual resource management and xNF
+ The VNF or PNF Package **MUST** include documentation about monitoring
+ parameters/counters exposed for virtual resource management and VNF or PNF
application management.
.. req::
:id: R-90632
- :target: XNF
+ :target: VNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation about KPIs and
+ 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.
.. req::
:id: R-86235
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation about the monitoring
+ 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 xNF and those that must be exercised by the xNF in order to perform
+ the VNF or PNF and those that must be exercised by the VNF or PNF in order to perform
its function.
.. req::
:id: R-33904
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation for each KPI, provide
+ The VNF or PNF Package **MUST** include documentation for each KPI, provide
lower and upper limits.
.. req::
:id: R-53598
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation to, when relevant,
+ 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.
.. req::
:id: R-69877
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation for each KPI,
+ 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.
.. req::
:id: R-22680
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation that describes
+ 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 xNF.
+ of the VNF or PNF.
.. req::
:id: R-33694
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation to when applicable,
+ The VNF or PNF Package **MUST** include documentation to when applicable,
provide calculators needed to convert raw data into appropriate reporting
artifacts.
.. req::
:id: R-56815
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation describing
- supported xNF scaling capabilities and capacity limits (e.g., number
+ 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).
.. req::
:id: R-48596
- :target: XNF
+ :target: VNF or PNF DOCUMENTATION PACKAGE
:keyword: MUST
+ :updated: dublin
- The xNF Package **MUST** include documentation describing
- the characteristics for the xNF reliability and high availability.
+ The VNF or PNF Documentation Package **MUST** describe
+ the characteristics for the VNF or PNF reliability and high availability.
-.. req::
- :id: R-74763
- :target: XNF
- :keyword: MUST
- The xNF provider **MUST** provide an artifact per xNF that contains
- all of the xNF Event Records supported. The artifact should include
- reference to the specific release of the xNF Event Stream Common Event
- Data Model document it is based on. (e.g.,
- `VES Event Listener <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>`__)
Compute, Network, and Storage Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. req::
:id: R-35851
- :target: XNF
+ :target: VNF HEAT PACKAGE
:keyword: MUST
+ :updated: dublin
- 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.
+ 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.
.. req::
:id: R-97102
.. req::
:id: R-26881
- :target: XNF
+ :target: VNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide the binaries and images
- needed to instantiate the xNF (xNF and VNFC images).
+ The VNF provider **MUST** provide the binaries and images
+ needed to instantiate the VNF (VNF and VNFC images).
.. req::
:id: R-96634
- :target: XNF
+ :target: VNF or PNF PROVIDER
:keyword: MUST
+ :updated: dublin
+
+ 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.
- The xNF provider **MUST** describe scaling capabilities
- to manage scaling characteristics of the xNF.
Testing
^^^^^^^^^^
-
.. req::
:id: R-43958
- :target: XNF
+ :target: VNF DOCUMENTATION PACKAGE
:keyword: MUST
- :updated: casablanca
+ :updated: dublin
- The xNF Package **MUST** include documentation describing
- the tests that were conducted by the xNF provider and the test results.
+ The VNF Documentation Package **MUST** describe
+ the tests that were conducted by the VNF provider and the test results.
.. req::
:id: R-04298
- :target: XNF
+ :target: VNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide their testing scripts to
+ The VNF provider **MUST** provide their testing scripts to
support testing.
.. req::
:id: R-58775
- :target: XNF
+ :target: VNF
:keyword: MUST
+ :updated: dublin
- 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
+ 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.
.. req::
:id: R-85653
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF **MUST** provide metrics (e.g., number of sessions,
+ 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.
.. req::
:id: R-44125
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** agree to the process that can
+ 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.
.. req::
:id: R-40827
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** enumerate all of the open
- source licenses their xNF(s) incorporate.
+ The VNF or PNF provider **MUST** enumerate all of the open
+ source licenses their VNF or PNF(s) incorporate.
.. req::
:id: R-97293
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST NOT
+ :updated: dublin
- The xNF provider **MUST NOT** require audits
+ The VNF or PNF provider **MUST NOT** require audits
of Service Provider's business.
.. req::
:id: R-44569
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST NOT
+ :updated: dublin
- The xNF provider **MUST NOT** require additional
- infrastructure such as a xNF provider license server for xNF provider
+ 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.
.. req::
.. req::
:id: R-85991
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** provide a universal license key
- per xNF to be used as needed by services (i.e., not tied to a VM
- instance) as the recommended solution. The xNF provider may provide
- pools of Unique xNF License Keys, where there is a unique key for
- each xNF instance as an alternate solution. Licensing issues should
- be resolved without interrupting in-service xNFs.
+ 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.
.. req::
:id: R-47849
- :target: XNF
+ :target: VNF or PNF
:keyword: MUST
+ :updated: dublin
- The xNF provider **MUST** support the metadata about
+ The VNF or PNF provider **MUST** support the metadata about
licenses (and their applicable entitlements) as defined in this
- document for xNF software, and any license keys required to authorize
- use of the xNF software. This metadata will be used to facilitate
- onboarding the xNF into the ONAP environment and automating processes
+ 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.
Code Review / vnfrqts / requirements.git / blobdiff