9. Requirement List

This appendix provides a consolidated list of requirements that can be searched and exported in a variety of formats.

Additionally, a JSON version of the requirements can be downloaded here

ID Content Target Keyword Section Name
R-71842 The VNF **MUST** include the field "service or program used for access" in the Security alarms (where applicable and technically feasible). VNF MUST VNF Security Analytics Requirements
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-19624 The xNF, when leveraging JSON for events, **MUST** encode and serialize content delivered to ONAP using JSON (RFC 7159) plain text format. High-volume data is to be encoded and serialized using `Avro <http://avro.apache.org/>`_, where the Avro [#7.4.1]_ data format are described using JSON. XNF MUST JSON
R-06613 A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type ``boolean`` **MAY** have a parameter constraint defined. VNF MAY constraints
R-31614 The VNF **MUST** log the field "event type" in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-73459 The xNF **MUST** provide the ability to include a "from=" clause in SSH public keys associated with mechanized user IDs created for an Ansible Server cluster to use for xNF VM authentication. XNF MUST Ansible Client Requirements
R-99766 The VNF **MUST** allow configurations and configuration parameters to be managed under version control to ensure the ability to rollback to a known valid configuration. VNF MUST Application Configuration Management
R-36772 A VNF's Heat Orchestration Template's parameter **MUST** include the attribute ``type:``. VNF MUST type
R-85959 The VNF **SHOULD** automatically enable/disable added/removed sub-components or component so there is no manual intervention required. VNF SHOULD System Resource Optimization
R-29872 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``network`` parameter **MUST NOT** be enumerated in the Heat Orchestration Template's Environment File. VNF MUST NOT Property: network
R-50011 A VNF's Heat Orchestration Template's ``OS::Heat::ResourceGroup`` property ``count`` **MUST** be enumerated in the VNF's Heat Orchestration Template's Environment File and **MUST** be assigned a value. VNF MUST OS::Heat::ResourceGroup Property count
R-54430 The VNF **MUST** use the NCSP's supported library and compute flavor that supports DPDK to optimize network efficiency if using DPDK. [#4.1.1]_ VNF MUST VNF Design
R-25720 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net`` Resource ID **MUST** use the naming convention * ``int_{network-role}_network`` VNF Heat Orchestration Templates can only create internal networks. There is no ``{index}`` after ``{network-role}`` because ``{network-role}`` **MUST** be unique in the scope of the VNF's Heat Orchestration Template. VNF MUST OS::Neutron::Net
R-10129 The xNF **SHOULD** conform its YANG model to RFC 7223, "A YANG Data Model for Interface Management". XNF SHOULD NETCONF Server Requirements
R-03251 A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume **MAY** be defined in a Cinder Volume Module. VNF MAY ONAP VNF Modularity Overview
R-83873 The xNF **MUST** support ``:rollback-on-error`` value for the <error-option> parameter to the <edit-config> operation. If any error occurs during the requested edit operation, then the target database (usually the running configuration) will be left unaffected. This provides an 'all-or-nothing' edit mode for a single <edit-config> request. XNF MUST NETCONF Server Requirements
R-15671 The VNF **MUST** provide access controls that allow the Operator to restrict access to VNF functions and data to authorized entities. VNF MUST VNF Identity and Access Management Requirements
R-34957 The VNF **MUST** provide a method of metrics gathering for each layer's performance to identify/document variances in the allocations so they can be addressed. VNF MUST Monitoring & Dashboard
R-73583 The VNF **MUST** allow changes of configuration parameters to be consumed by the VNF without requiring the VNF or its sub-components to be bounced so that the VNF availability is not effected. VNF MUST Application Configuration Management
R-21511 A VNF's Heat Orchestration Template's use of ``{network-role}`` in all Resource IDs **MUST** be the same case. VNF MUST {network-role}
R-20856 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT** be enumerated in the Heat Orchestration Template's environment file. VNF MUST NOT vnf_id
R-34552 The VNF **MUST** be implemented so that it is not vulnerable to OWASP Top 10 web application security risks. VNF MUST VNF Security Analytics Requirements
R-98569 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_int_{network-role}_v6_ips`` **MUST** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST Property: fixed_ips, Map Property: ip_address
R-59391 The VNF **MUST NOT** allow the assumption of the permissions of another account to mask individual accountability. For example, use SUDO when a user requires elevated permissions such as root or admin. VNF MUST NOT VNF Identity and Access Management Requirements
R-99771 The VNF **MUST** have all code (e.g., QCOW2) and configuration files (e.g., HEAT template, Ansible playbook, script) hardened, or with documented recommended configurations for hardening and interfaces that allow the Operator to harden the VNF. Actions taken to harden a system include disabling all unnecessary services, and changing default values such as default credentials and community strings. VNF MUST VNF General Security Requirements
R-40551 A VNF's Heat Orchestration Template's Nested YAML files **MAY** (or **MAY NOT**) contain the section ``resources:``. VNF MAY resources
R-73213 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that is applicable to more than one ``{vm-type}`` and one internal network Resource ID **SHOULD** use the naming convention * ``int_{network-role}_security_group`` where * ``{network-role}`` is the network-role VNF SHOULD OS::Neutron::SecurityGroup
R-798933 The xNF **SHOULD** deliver event records that fall into the event domains supported by VES. XNF SHOULD Transports and Protocols Supporting Resource Interfaces
R-49224 The VNF **MUST** provide unique traceability of a transaction through its life cycle to ensure quick and efficient troubleshooting. VNF MUST Monitoring & Dashboard
R-29751 A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` Resource ID **MUST** use the naming convention * ``{vm-type}_server_{index}`` where * ``{vm-type}`` is the vm-type * ``{index}`` is the index VNF MUST OS::Nova::Server
R-02651 The xNF **SHOULD** use available backup capabilities to save a copy of configuration files before implementing changes to support operations such as backing out of software upgrades, configuration changes or other work as this will help backing out of configuration changes when needed. XNF SHOULD Ansible Playbook Requirements
R-86476 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` value **MUST** only contain alphanumeric characters and underscores (i.e., '_'). VNF MUST vm_role
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-42685 A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``parameter_merge_strategies:`` section. VNF MAY Environment File Format
R-23311 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``availability_zone`` parameter **MUST** be declared as type: ``string``. VNF MUST Property: availability_zone
R-75041 The VNF **MUST**, if not integrated with the Operator's Identity and Access Management system, support configurable password expiration. VNF MUST VNF Identity and Access Management Requirements
R-15480 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name`` **MUST NOT** have parameter constraints defined. VNF MUST NOT vf_module_name
R-22441 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` is passed into a Nested YAML file, the key/value pair ``vf_module_index`` **MUST NOT** change. VNF MUST NOT vf_module_index
R-96482 When a VNF's Heat Orchestration Template's resource is associated with a single external network, the Resource ID **MUST** contain the text ``{network-role}``. VNF MUST Resource IDs
R-87096 A VNF **MAY** contain zero, one or more than one internal network. VNF MAY Internal Networks
R-71787 Each architectural layer of the VNF (eg. operating system, network, application) **MUST** support access restriction independently of all other layers so that Segregation of Duties can be implemented. VNF MUST VNF Identity and Access Management Requirements
R-81979 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::NetworkIpam`` Resource ID **MAY** use the naming convention * ``{network-role}_RNI`` where * ``{network-role}`` is the network-role * ``RNI`` signifies that it is the Resource Network IPAM VNF MAY OS::ContrailV2::NetworkIpam
R-61001 A shared Heat Orchestration Template resource is a resource that **MUST** be defined in the base module and will be referenced by one or more resources in one or more incremental modules. The UUID of the shared resource (created in the base module) **MUST** be exposed by declaring a parameter in the ``outputs`` section of the base module. For ECOMP to provided the UUID value of the shared resource to the incremental module, the parameter name defined in the ``outputs`` section of the base module **MUST** be defined as a parameter in the ``parameters`` section of the incremental module. ECOMP will capture the output parameter name and value in the base module and provide the value to the corresponding parameter(s) in the incremental module(s). VNF MUST ONAP Heat VNF Modularity
R-56183 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata``key/value pair ``environment_context`` parameter ``environment_context`` **MUST NOT** have parameter constraints defined. VNF MUST NOT environment_context
R-33132 A VNF's Heat Orchestration Template **MAY** be 1.) Base Module Heat Orchestration Template (also referred to as a Base Module), 2.) Incremental Module Heat Orchestration Template (referred to as an Incremental Module), or 3.) a Cinder Volume Module Heat Orchestration Template (referred to as Cinder Volume Module). VNF MAY ONAP VNF Modularity Overview
R-30005 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that is applicable to more than one ``{vm-type}`` and more than one network (internal and/or external) Resource ID **MAY** use the naming convention * ``shared_security_group`` or * ``{vnf-type}_security_group`` where * ``{vnf-type}`` describes the VNF VNF MAY OS::Neutron::SecurityGroup
R-65755 The xNF **SHOULD** support callback URLs to return information to ONAP upon completion of the chef-client run for any chef-client run associated with a xNF action. - As part of the push job, ONAP will provide two parameters in the environment of the push job JSON object: - "RequestId" a unique Id to be used to identify the request, - "CallbackUrl", the URL to post response back. - If the CallbackUrl field is empty or missing in the push job, then the chef-client run need not post the results back via callback. XNF SHOULD Chef Roles/Requirements
R-90279 A VNF Heat Orchestration's template's parameter **MUST** be used in a resource with the exception of the parameters for the ``OS::Nova::Server`` resource property ``availability_zone``. VNF MUST parameters
R-65618 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceHealthCheck`` Resource ID **MAY** use the naming convention * ``{vm-type}_RSHC_{LEFT|RIGHT}`` where * ``{vm-type}`` is the vm-type * ``RSHC`` signifies that it is the Resource Service Health Check * ``LEFT`` is used if the Service Health Check is on the left interface * ``RIGHT`` is used if the Service Health Check is on the right interface VNF MAY OS::ContrailV2::ServiceHealthCheck
R-32695 The VNF **MUST** provide the ability to modify the number of retries, the time between retries and the behavior/action taken after the retries have been exhausted for exception handling to allow the NCSP to control that behavior, where the interface and/or functional specification allows for altering behaviour. VNF MUST Application Resilient Error Handling
R-663631 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` value **MUST** be be obtained via a ``get_param``. VNF MUST Property: Name
R-11441 A VNF's Heat Orchestration Template's parameter type **MUST** be one of the following values: * ``string`` * ``number`` * ``json`` * ``comma_delimited_list`` * ``boolean`` VNF MUST type
R-39604 The VNF **MUST** provide the capability of testing the validity of a digital certificate by checking the Certificate Revocation List (CRL) for the certificates of that type to ensure that the certificate has not been revoked. VNF MUST VNF Cryptography Requirements
R-32217 The xNF **MUST** have routable management IP addresses or FQDNs that are reachable via the Ansible Server for the endpoints (VMs) of a xNF that playbooks will target. ONAP will initiate requests to the Ansible Server for invocation of playbooks against these end points [#7.3.3]_. XNF MUST Ansible Client Requirements
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-25401 The VNF **MUST** use asymmetric keys of at least 2048 bits in length. VNF MUST VNF Cryptography Requirements
R-40293 The xNF **MUST** make available playbooks that conform to the ONAP requirement. XNF MUST Ansible Playbook Requirements
R-01455 When a VNF's Heat Orchestration Template creates a Virtual Machine (i.e., ``OS::Nova::Server``), each "class" of VMs **MUST** be assigned a VNF unique ``{vm-type}``; where "class" defines VMs that **MUST** have the following identical characteristics: 1.) ``OS::Nova::Server`` resource property ``flavor`` value 2.) ``OS::Nova::Server`` resource property ``image`` value 3.) Cinder Volume attachments - Each VM in the "class" **MUST** have the identical Cinder Volume configuration 4.) Network attachments and IP address requirements - Each VM in the "class" **MUST** have the the identical number of ports connecting to the identical networks and requiring the identical IP address configuration. VNF MUST {vm-type}
R-72184 The xNF **MUST** have routable FQDNs for all the endpoints (VMs) of a xNF that contain chef-clients which are used to register with the Chef Server. As part of invoking xNF actions, ONAP will trigger push jobs against FQDNs of endpoints for a xNF, if required. XNF MUST Chef Client Requirements
R-07577 If the VNF's ports connected to a unique network (internal or external) and the port's IP addresses are cloud assigned IP Addresses, all the IPv4 Addresses **MUST** be from the same subnet and all the IPv6 Addresses **MUST** be from the same subnet. VNF MUST Items to Note
R-99812 A value for VNF's Heat Orchestration Template's property ``name`` for a non ``OS::Nova::Server`` resource **MUST NOT** be declared in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Resource Property “name”
R-756950 The VNF **MUST** be operable without the use of Network File System (NFS). VNF MUST VNF General Security 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-68936 When a VNF creates an internal network, a network role, referred to as the ``{network-role}`` **MUST** be assigned to the internal network for use in the VNF's Heat Orchestration Template. VNF MUST Internal Networks
R-18001 If the VNF's ports connected to a unique internal network and the port's IP addresses are statically assigned IP Addresses, the IPv4 Addresses **MAY** be from different subnets and the IPv6 Addresses **MAY** be from different subnets. VNF MAY Items to Note
R-20319 A VNF's Heat Orchestration Template's Resource ``OS::Heat::CloudConfig`` Resource ID **MAY** use the naming convention * ``{vm-type}_RCC`` where * ``{vm-type}`` is the vm-type * ``RCC`` signifies that it is the Resource Cloud Config VNF MAY OS::Heat::CloudConfig
R-638216 (Error Case) - The PNF **MUST** support a configurable timer to stop the periodicity sending of the pnfRegistration VES event. If this timer expires during a Service Configuration exchange between the PNF and ONAP, it MAY log a time-out error and notify an operator. Note: It is expected that each vendor will enforce and define a PNF service configuration timeout period. This is because the PNF cannot wait indefinitely as there may also be a technician on-site trying to complete installation & commissioning. The management of the VES event exchange is also a requirement on the PNF to be developed by the PNF vendor. PNF MUST PNF Plug and Play
R-03324 A VNF's Heat Orchestration template's Environment File **MUST** contain the ``parameters:`` section. VNF MUST Environment File Format
R-63473 The VNF **MUST** automatically advertise newly scaled components so there is no manual intervention required. VNF MUST System Resource Optimization
R-04982 The VNF **MUST NOT** include an authentication credential, e.g., password, in the security audit logs, even if encrypted. VNF MUST NOT VNF Security Analytics Requirements
R-83500 The VNF **MUST** provide the capability of allowing certificate renewal and revocation. VNF MUST VNF Cryptography Requirements
R-05201 When a VNF connects to two or more external networks, each external network **MUST** be assigned a unique ``{network-role}`` in the context of the VNF for use in the VNF's Heat Orchestration Template. VNF MUST External Networks
R-28756 The xNF **MUST** support ``:partial-lock`` and ``:partial-unlock`` capabilities, defined in RFC 5717. This allows multiple independent clients to each write to a different part of the <running> configuration at the same time. XNF MUST NETCONF Server Requirements
R-86182 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and the internal network is created in a different Heat Orchestration Template than the ``OS::Neutron::Port``, the ``network`` parameter name **MUST** * follow the naming convention ``int_{network-role}_net_id`` if the Neutron network UUID value is used to reference the network * follow the naming convention ``int_{network-role}_net_name`` if the OpenStack network name in is used to reference the network. where ``{network-role}`` is the network-role of the internal network and a ``get_param`` **MUST** be used as the intrinsic function. VNF MUST Property: network
R-41430 The xNF **MUST** support APPC/SDN-C ``HealthCheck`` command. XNF MUST HealthCheck and Failure Related Commands
R-08975 A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig`` Resource ID **MUST** contain the ``{vm-type}``. VNF MUST OS::Heat::SoftwareConfig
R-481670 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``flavor`` value **MUST** be be obtained via a ``get_param``. VNF MUST Property: flavor
R-68122 A VNF's incremental module **MAY** be deployed more than once, either during initial VNF deployment and/or scale out. VNF MAY ONAP VNF Modularity Overview
R-55345 The VNF **SHOULD** use techniques such as "lazy loading" when initialization includes loading catalogues and/or lists which can grow over time, so that the VNF startup time does not grow at a rate proportional to that of the list. VNF SHOULD System Resource Optimization
R-20065 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::PortTuple`` Resource ID **MUST** contain the ``{vm-type}``. VNF MUST OS::ContrailV2::PortTuple
R-240760 The VNF **MUST NOT** contain any backdoors. VNF MUST NOT VNF General Security Requirements
R-60011 A VNF's Heat Orchestration Template **MUST** have no more than two levels of nesting. VNF MUST Nested Heat Template Requirements
R-11200 A VNF's Cinder Volume Module, when it exists, **MUST** be 1:1 with a Base module or Incremental module. VNF MUST ONAP VNF Modularity Overview
R-11168 A VNF's Heat Orchestration Template's Resource ID that is associated with an external network **MUST** include the ``{network-role}`` as part of the resource ID. VNF MUST {network-role}
R-86497 A VNF's Heat Orchestration Template's Resource ``OS::Cinder::VolumeAttachment`` Resource ID **SHOULD** use the naming convention * ``{vm-type}_volume_attachment_{index}`` where * ``{vm-type}`` is the vm-type * ``{index}`` starts at zero and increments by one VNF SHOULD OS::Cinder::VolumeAttachment
R-69649 The VNF Provider **MUST** have patches available for vulnerabilities in the VNF as soon as possible. Patching shall be controlled via change control process with vulnerabilities disclosed along with mitigation recommendations. VNF MUST VNF General Security Requirements
R-27818 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see RRequirements R-52425 and R-46461), and an IPv6 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``string``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_v6_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` * ``{network-role}`` is the {network-role} of the internal network * the value for ``{index}`` must start at zero (0) and increment by one VNF MUST Property: fixed_ips, Map Property: ip_address
R-70496 The xNF **MUST** implement the protocol operation: ``commit(confirmed, confirm-timeout)`` - Commit candidate configuration data store to the running configuration. XNF MUST NETCONF Server Requirements
R-45602 If a VNF's Port is attached to a network (internal or external) and the port's IP addresses are cloud assigned by OpenStack's DHCP Service, the ``OS::Neutron::Port`` Resource's * property ``fixed_ips`` map property ``ip_address`` **MUST NOT** be used * property ``fixed_ips`` map property ``subnet`` **MAY** be used VNF MUST NOT Items to Note
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-88899 The xNF **MUST** support simultaneous <commit> operations within the context of this locking requirements framework. XNF MUST NETCONF Server Requirements
R-41994 The VNF **MUST** support the use of X.509 certificates issued from any Certificate Authority (CA) that is compliant with RFC5280, e.g., a public CA such as DigiCert or Let's Encrypt, or an RFC5280 compliant Operator CA. Note: The VNF provider cannot require the use of self-signed certificates in an Operator's run time environment. VNF MUST VNF Cryptography Requirements
R-00228 A VNF's Heat Orchestration Template **MAY** reference the nested heat statically by repeated definition. VNF MAY Nested Heat Template Requirements
R-01334 The xNF **MUST** conform to the NETCONF RFC 5717, "Partial Lock Remote Procedure Call". XNF MUST NETCONF Server Requirements
R-01896 A VNF's Heat Orchestration Template's parameter values that are constant across all deployments **MUST** be declared in a Heat Orchestration Template Environment File. VNF MUST Scope of a Heat Orchestration Template
R-44271 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter value **SHOULD NOT** contain special characters since the Contrail GUI has a limitation displaying special characters. However, if special characters must be used, the only special characters supported are: --- \" ! $ ' (\ \ ) = ~ ^ | @ ` { } [ ] > , . _ VNF SHOULD NOT Contrail Issue with Values for OS::Nova::Server Property Name
R-26351 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is attaching to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{port-index}`` is the instance of the the port on the vm-type attached to the network of ``{network-role}`` VNF MUST OS::Neutron::Port
R-49466 The xNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command. XNF MUST Lifecycle Management Related Commands
R-49396 The xNF **MUST** support each APPC/SDN-C xNF action by invocation of **one** playbook [#7.3.4]_. The playbook will be responsible for executing all necessary tasks (as well as calling other playbooks) to complete the request. XNF MUST Ansible Playbook Requirements
R-82134 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` parameter **MUST** be declared as ``vf_module_id`` and the parameter **MUST** be defined as type: ``string``. VNF MUST vf_module_id
R-20947 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv4 Address on a sub-interface port attached to a sub-interface network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` is the index of the IPv4 address VNF MUST OS::ContrailV2::InstanceIp
R-58964 The VNF **MUST** provide the capability to restrict read and write access to data handled by the VNF. VNF MUST VNF Data Protection 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-18733 The xNF **MUST** implement the protocol operation: ``discard-changes()`` - Revert the candidate configuration data store to the running configuration. XNF MUST NETCONF Server Requirements
R-98138 When a VNF's Heat Orchestration Template's resource is associated with a single internal network, the Resource ID **MUST** contain the text ``int_{network-role}``. VNF MUST Resource IDs
R-56218 The VNF **MUST** support ONAP Controller's Migrate command that moves container (VM) from a live Physical Server / Compute Node to another live Physical Server / Compute Node. Note: Container migrations MUST be transparent to the VNF and no more intrusive than a stop, followed by some down time for the migration to be performed from one Compute Node / Physical Server to another, followed by a start of the same VM with same configuration on the new Compute Node / Physical Server. VNF MUST Virtual Function - Container Recovery Requirements
R-98989 The VNF **SHOULD** utilize resource pooling (threads, connections, etc.) within the VNF application so that resources are not being created and destroyed resulting in resource management overhead. VNF SHOULD System Resource Optimization
R-46851 The VNF **MUST** support ONAP Controller's Evacuate command. VNF MUST Virtual Function - Container Recovery Requirements
R-29977 The VNF **MUST** provide the capability of testing the validity of a digital certificate by validating the CA signature on the certificate. VNF MUST VNF Cryptography Requirements
R-67124 The xNF **MUST** provide Ansible playbooks that are designed to run using an inventory hosts file in a supported format; with group names matching VNFC 3-character string adding "vip" for groups with virtual IP addresses shared by multiple VMs as seen in examples provided in Appendix. XNF MUST Ansible Client Requirements
R-94509 A VNF Heat Orchestration Template's Incremental Module's Environment File **MUST** be named identical to the VNF Heat Orchestration Template's Incremental Module with ``.y[a]ml`` replaced with ``.env``. VNF MUST Incremental Modules
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-470963 The VNF, when publishing events, **MUST** leverage camel case to separate words and acronyms used as keys that will be sent through extensible fields. When an acronym is used as the key, then only the first letter shall be capitalized. VNF MUST Miscellaneous
R-63137 VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``update_policy:``. VNF MAY update_policy
R-02616 The xNF **MUST** permit locking at the finest granularity if a xNF needs to lock an object for configuration to avoid blocking simultaneous configuration operations on unrelated objects (e.g., BGP configuration should not be locked out if an interface is being configured or entire Interface configuration should not be locked out if a non-overlapping parameter on the interface is being configured). XNF MUST NETCONF Server Requirements
R-04697 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``comma_delimited_list``, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_ips`` where * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` * ``{network-role}`` is the {network-role} of the external network VNF MUST Property: fixed_ips, Map Property: ip_address
R-86237 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` is passed into a Nested YAML file, the key/value pair name ``vf_module_id`` **MUST NOT** change. VNF MUST NOT vf_module_id
R-49308 The VNF **SHOULD** test for adherence to the defined resiliency rating recommendation at each layer, during each delivery cycle with delivered results, so that the resiliency rating is measured and the code is adjusted to meet software resiliency requirements. VNF SHOULD Deployment Optimization
R-03954 The VNF **MUST** survive any single points of failure within the Network Cloud (e.g., virtual NIC, VM, disk failure). VNF MUST All Layer Redundancy
R-48880 If a VNF's Port is attached to an external network and the port's IP addresses are assigned by ONAP's SDN-Controller, the ``OS::Neutron::Port`` Resource's * property ``fixed_ips`` map property ``ip_address`` **MUST** be used * property ``fixed_ips`` map property ``subnet`` **MUST NOT** be used VNF MUST Items to Note
R-75202 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``workload_context`` is passed into a Nested YAML file, the key/value pair name ``workload_context`` **MUST NOT** change. VNF MUST NOT workload_context
R-68990 The xNF **MUST** support the ``:startup`` capability. It will allow the running configuration to be copied to this special database. It can also be locked and unlocked. XNF MUST NETCONF Server Requirements
R-56385 The xNF **MUST** support APPC ``Audit`` command. XNF MUST Configuration Commands
R-16496 The VNF **MUST** enable instantiating only the functionality that is needed for the decomposed VNF (e.g., if transcoding is not needed it should not be instantiated). VNF MUST VNF Design
R-41159 The VNF **MUST** deliver any and all functionality from any VNFC in the pool (where pooling is the most suitable solution). The VNFC pool member should be transparent to the client. Upstream and downstream clients should only recognize the function being performed, not the member performing it. VNF MUST System Resource Optimization
R-29488 The xNF **MUST** implement the protocol operation: ``get-config(source, filter`` - Retrieve a (filtered subset of a) configuration from the configuration data store source. XNF MUST NETCONF Server Requirements
R-22838 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter **MUST NOT** be enumerated in the Heat Orchestration Template's Environment File. VNF MUST NOT Property: Name
R-13800 The xNF **MUST** conform to the NETCONF RFC 5277, "NETCONF Event Notification". XNF MUST NETCONF Server Requirements
R-82223 The VNF **MUST** be decomposed if the functions have significantly different scaling characteristics (e.g., signaling versus media functions, control versus data plane functions). VNF MUST VNF Design
R-99646 A VNF's YAML files (i.e, Heat Orchestration Template files and Nested files) **MUST** have a unique name in the scope of the VNF. VNF MUST ONAP Heat Orchestration Template Filenames
R-21330 A VNF's Heat Orchestration Template's Resource property parameter that is associated with external network **MUST** include the ``{network-role}`` as part of the parameter name. VNF MUST {network-role}
R-26881 The xNF provider **MUST** provide the binaries and images needed to instantiate the xNF (xNF and VNFC images). XNF MUST Compute, Network, and Storage Requirements
R-26885 The VNF provider **MUST** provide the binaries and images needed to instantiate the VNF (VNF and VNFC images) either as: - Local artifact in CSAR: ROOT\\Artifacts\\ **VNF_Image.bin** - externally referred (by URI) artifact in Manifest file (also may be referred by VNF Descriptor) Note: Currently, ONAP doesn't have the capability of Image management, we upload the image into VIM/VNFM manually. VNF MUST VNF Package Contents
R-95950 The xNF **MUST** provide a NETCONF interface fully defined by supplied YANG models for the embedded NETCONF server. XNF MUST Configuration Management
R-64197 A VNF's Heat Orchestration Template's Resource ``OS::Heat::ResourceGroup`` Resource ID that creates sub-interfaces **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_port_{port-index}_subinterfaces`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the networks that the sub-interfaces attach to * ``{port-index}`` is the instance of the the port on the vm-type attached to the network of ``{network-role}`` VNF MUST OS::Heat::ResourceGroup
R-35291 The VNF **MUST** support the ability to failover a VNFC automatically to other geographically redundant sites if not deployed active-active to increase the overall resiliency of the VNF. VNF MUST All Layer Redundancy
R-85419 The VNF **SHOULD** support OAuth 2.0 authorization using an external Authorization Server. VNF SHOULD VNF Identity and Access Management Requirements
R-48080 The VNF **SHOULD** support an automated certificate management protocol such as CMPv2, Simple Certificate Enrollment Protocol (SCEP) or Automated Certificate Management Environment (ACME). VNF SHOULD VNF Cryptography Requirements
R-43884 The VNF **SHOULD** integrate with the Operator's authentication and authorization services (e.g., IDAM). VNF SHOULD VNF API Security Requirements
R-980039 The PNF **MUST** send the pnfRegistration VES event periodically. PNF MUST PNF Plug and Play
R-98450 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``availability_zone`` parameter name **MUST** follow the naming convention ``availability_zone_{index}`` where the ``{index}`` **MUST** start at zero and increment by one. VNF MUST Property: availability_zone
R-13344 The VNF **MUST** log starting and stopping of security logging. VNF MUST VNF Security Analytics Requirements
R-68198 A VNF's Heat Orchestration template's Environment File's ``parameters:`` section **MAY** (or **MAY NOT**) enumerate parameters. VNF MAY Environment File Format
R-35854 The VNF Descriptor (VNFD) provided by VNF vendor **MUST** comply with TOSCA/YAML based Service template for VNF descriptor specified in ETSI NFV-SOL001. **Note**: As the ETSI NFV-SOL001 is work in progress the below tables summarizes the TOSCA definitions agreed to be part of current version of NFV profile and that VNFD MUST comply with in ONAP Release 2+ Requirements. VNF MUST General
R-16065 The xNF provider **MUST** provide configurable parameters (if unable to conform to YANG model) including xNF attributes/parameters and valid values, dynamic attributes and cross parameter dependencies (e.g., customer provisioning data). XNF MUST Configuration Management via Ansible
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-86588 A VNF's Heat Orchestration Template's ``{network-role}`` case in Resource property parameter names **SHOULD** match the case of ``{network-role}`` in Resource IDs and vice versa. VNF SHOULD {network-role}
R-86585 The VNFC **SHOULD** minimize the use of state within a VNFC to facilitate the movement of traffic from one instance to another. VNF SHOULD VNF Design
R-328086 The xNF **MUST**, if serving as a distribution point or anchor point for steering point from source to destination, support the ONAP Controller's ``DistributeTraffic`` command. XNF MUST Lifecycle Management Related Commands
R-841740 The xNF **SHOULD** support FileReady VES event for event-driven bulk transfer of monitoring data. XNF SHOULD Bulk Performance Measurement
R-65486 The VNFD **MUST** comply with ETSI GS NFV-SOL001 document endorsing the above mentioned NFV Profile and maintaining the gaps with the requirements specified in ETSI GS NFV-IFA011 standard. VNF MUST General
R-86586 The xNF **MUST** use the YANG configuration models and RESTCONF [RFC8040] (https://tools.ietf.org/html/rfc8040). XNF MUST Asynchronous and Synchronous Data Delivery
R-11790 The VNF **MUST** support ONAP Controller's **Restart (stop/start or reboot)** command. VNF MUST Virtual Function - Container Recovery Requirements
R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation of connections, through secure credentials, log-on and exchange mechanisms. XNF MUST Security
R-52060 The VNF **MUST** provide the capability to configure encryption algorithms or devices so that they comply with the laws of the jurisdiction in which there are plans to use data encryption. VNF MUST VNF Cryptography Requirements
R-55306 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` **MUST NOT** be used in a ``OS::Cinder::Volume`` resource and **MUST NOT** be used in VNF's Volume template; it is not supported. VNF MUST NOT vf_module_index
R-86972 A VNF **SHOULD** create the internal network in the VNF's Heat Orchestration Template Base Module. VNF SHOULD Internal Networks
R-25547 The VNF **MUST** log the field "protocol" in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-98911 The xNF **MUST NOT** use any instance specific parameters for the xNF in roles/cookbooks/recipes invoked for a xNF action. XNF MUST NOT Chef Roles/Requirements
R-11499 The xNF **MUST** fully support the XPath 1.0 specification for filtered retrieval of configuration and other database contents. The 'type' attribute within the <filter> parameter for <get> and <get-config> operations may be set to 'xpath'. The 'select' attribute (which contains the XPath expression) will also be supported by the server. A server may support partial XPath retrieval filtering, but it cannot advertise the ``:xpath`` capability unless the entire XPath 1.0 specification is supported. XNF MUST NETCONF Server Requirements
R-68520 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is creating a *Reserve Port* with an IPv6 address Resource ID **MUST** use the naming convention * ``reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}`` where * ``{vm-type}`` is the vm-type * ``{network-role}`` is the network-role of the network that the port is attached to * ``{index}`` is the instance of the IPv6 *Reserve Port* for the vm-type attached to the network of ``{network-role}`` VNF MUST OS::Neutron::Port
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-57282 Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** have a unique parameter name for the ``OS::Nova::Server`` property ``image`` even if more than one ``{vm-type}`` shares the same image. VNF MUST Property: image
R-33955 The xNF **SHOULD** conform its YANG model to RFC 6991, "Common YANG Data Types". XNF SHOULD NETCONF Server Requirements
R-97451 The xNF **MUST** provide the ability to remove root access once post-instantiation configuration (Configure) is completed. XNF MUST Ansible Client Requirements
R-52753 VNF's Heat Orchestration Template's Base Module's output parameter's name and type **MUST** match the VNF's Heat Orchestration Template's incremental Module's name and type unless the output parameter is of type ``comma_delimited_list``, then the corresponding input parameter **MUST** be declared as type ``json``. VNF MUST ONAP Base Module Output Parameters
R-37028 A VNF **MUST** be composed of one Base Module VNF MUST ONAP VNF Modularity Overview
R-54816 The VNF **MUST** support the storage of security audit logs for a configurable period of time. VNF MUST VNF Security Analytics Requirements
R-27711 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. XNF MUST Resource Control Loop
R-93443 The xNF **MUST** define all data models in YANG [RFC6020], and the mapping to NETCONF shall follow the rules defined in this RFC. XNF MUST NETCONF Server Requirements
R-21558 The VNF **SHOULD** use intelligent routing by having knowledge of multiple downstream/upstream endpoints that are exposed to it, to ensure there is no dependency on external services (such as load balancers) to switch to alternate endpoints. VNF SHOULD Intelligent Transaction Distribution & Management
R-52425 A VNF's port connected to an internal network **MUST** use the port for the purpose of reaching VMs in the same VNF. VNF MUST Internal Networks
R-44491 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_id`` is passed into a Nested YAML file, the key/value pair name ``vnf_id`` **MUST NOT** change. VNF MUST NOT vnf_id
R-91745 The xNF **MUST** update the Ansible Server and other entities storing and using the SSH keys for authentication when the SSH keys used by Ansible are regenerated/updated. **Note**: Ansible Server itself may be used to upload new SSH public keys onto supported xNFs. XNF MUST Ansible Client Requirements
R-46119 A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume **MAY** be defined in a Base Module. VNF MAY ONAP VNF Modularity Overview
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-46461 A VNF's port connected to an internal network **MUST NOT** use the port for the purpose of reaching VMs in another VNF and/or an external gateway and/or external router. VNF MUST NOT Internal Networks
R-68165 The xNF **MUST** encrypt any content containing Sensitive Personal Information (SPI) or certain proprietary data, in addition to applying the regular procedures for securing access and delivery. XNF MUST Security
R-07443 A VNF's Heat Orchestration Templates' Cinder Volume Module Output Parameter's name and type **MUST** match the input parameter name and type in the corresponding Base Module or Incremental Module unless the Output Parameter is of the type ``comma_delimited_list``, then the corresponding input parameter **MUST** be declared as type ``json``. VNF MUST ONAP Volume Module Output Parameters
R-793716 The PNF **MUST** have "ONAP Aware" software which is capable of performing PNF PnP registration with ONAP. The "ONAP Aware" software is capable of performing the PNF PnP Registration with ONAP MUST either be loaded separately or integrated into the PNF software upon physical delivery and installation of the PNF. Note: It is up to the specific vendor to design the software management functions. PNF MUST PNF Plug and Play
R-10834 If a VNF's Heat Orchestration Template resource attribute ``property:`` uses a nested ``get_param``, the nested ``get_param`` **MUST** reference an index. VNF MUST properties
R-75141 A VNF's Heat Orchestration Template's resource name (i.e., <resource ID>) **MUST** only contain alphanumeric characters and underscores ('_'). VNF MUST resource ID
R-81725 A VNF's Incremental Module **MUST** have a corresponding Environment File VNF MUST ONAP VNF Modularity Overview
R-81777 The xNF **MUST** be configured with initial address(es) to use at deployment time. Subsequently, address(es) may be changed through ONAP-defined policies delivered from ONAP to the xNF using PUTs to a RESTful API, in the same manner that other controls over data reporting will be controlled by policy. XNF MUST Addressing and Delivery Protocol
R-32557 A VNF's Heat Orchestration Template parameter declaration **MAY** contain the attribute ``hidden:``. VNF MAY hidden
R-978752 The xNF providers **MUST** provide the Service Provider the following artifacts to support the delivery of high-volume xNF telemetry to DCAE via GPB over TLS/TCP: * A valid VES Event .proto definition file, to be used validate and decode an event * A valid high volume measurement .proto definition file, to be used for processing high volume events * A supporting PM content metadata file to be used by analytics applications to process high volume measurement events XNF PROVIDER MUST Google Protocol Buffers (GPB)
R-00977 A VNF's Heat Orchestration Template's ``{network-role}`` **MUST NOT** be a substring of ``{vm-type}``. VNF MUST NOT {network-role}
R-84473 The VNF **MUST** enable DPDK in the guest OS for VNF's requiring high packets/sec performance. High packet throughput is defined as greater than 500K packets/sec. VNF MUST VNF Design
R-18864 The VNF **MUST NOT** use technologies that bypass virtualization layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary to meet functional or performance requirements). VNF MUST NOT VNF Design
R-39349 A VNF Heat Orchestration Template **MUST NOT** be designed to utilize the OpenStack ``heat stack-update`` command for scaling (growth/de-growth). VNF MUST NOT Support of heat stack update
R-64445 The VNF **MUST** support the ability of a requestor of the service to determine the version (and therefore capabilities) of the service so that Network Cloud Service Provider can understand the capabilities of the service. VNF MUST Deployment Optimization
R-67114 The xNF **MUST** be installed with Chef-Client >= 12.0 and Chef push jobs client >= 2.0. VNF MUST Chef Client Requirements
R-36582 A VNF's Base Module **MAY** utilize nested heat. VNF MAY Nested Heat Orchestration Templates Overview
R-10754 If a VNF has two or more ports that attach to an external network that require a Virtual IP Address (VIP), and the VNF requires ONAP automation to assign the IP address, all the Virtual Machines using the VIP address **MUST** be instantiated in the same Base Module Heat Orchestration Template or in the same Incremental Module Heat Orchestration Template. VNF MUST VIP Assignment, External Networks, Supported by Automation
R-91125 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``image`` parameter **MUST** be enumerated in the Heat Orchestration Template's Environment File and a value **MUST** be assigned. VNF MUST Property: image
R-931076 The VNF **MUST** support account names that contain at least A-Z, a-z, 0-9 character sets and be at least 6 characters in length. VNF MUST VNF Identity and Access Management Requirements
R-24189 The xNF provider **MUST** deliver a new set of playbooks that includes all updated and unchanged playbooks for any new revision to an existing set of playbooks. XNF SHOULD Ansible Playbook Requirements
R-88524 A VNF's Heat Orchestration Template's Volume Template Output Parameter names **MUST** contain ``{vm-type}`` when appropriate. VNF MUST ONAP Volume Template Output Parameters:
R-11235 The xNF **MUST** implement the protocol operation: ``kill-session(session``- Force the termination of **session**. XNF MUST NETCONF Server Requirements
R-981585 The pnfRegistration VES event periodicity **MUST** be configurable. Note: The PNF uses the service configuration request as a semaphore to stop sending the pnfRegistration sent. See the requirement PNP-5360 requirement. PNF MUST PNF Plug and Play
R-41888 A VNF's Heat Orchestration Template intrinsic function ``get_file`` **MUST NOT** utilize URL-based file retrieval. VNF MUST NOT Heat Files Support (get_file)
R-44723 The VNF **MUST** use symmetric keys of at least 112 bits in length. VNF MUST VNF Cryptography Requirements
R-58358 The xNF **MUST** implement the ``:with-defaults`` capability [RFC6243]. XNF MUST NETCONF Server Requirements
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-94978 The VNF **MUST** provide a mechanism and tool to perform a graceful shutdown of all the containers (VMs) in the VNF without impacting service or service quality assuming another VNF in same or other geographical location can take over traffic and process service requests. VNF MUST Application Resilient Error Handling
R-06885 The VNF **SHOULD** support the ability to scale down a VNFC pool without jeopardizing active sessions. Ideally, an active session should not be tied to any particular VNFC instance. VNF SHOULD System Resource Optimization
R-40820 The VNF provider MUST enumerate all of the open source licenses their VNF(s) incorporate. CSAR License directory as per ETSI SOL004. for example ROOT\\Licenses\\ **License_term.txt** VNF MUST VNF Package Contents
R-29324 The xNF **SHOULD** implement the protocol operation: ``copy-config(target, source)`` - Copy the content of the configuration data store source to the configuration data store target. XNF SHOULD NETCONF Server Requirements
R-258352 The PNF **MUST** support & accept the provisioning of an ONAP contact IP address (in IPv4 or IPv6 format). Note: For example, it a possibility is that an external EMS would configure & provision the ONAP contact IP address to the PNF (in either IPv4 or IPv6 format). For the PNF Plug and Play Use Case, this IP address is the service provider's "point of entry" to the DCAE VES Listener. Note: different service provider's network architecture may also require special setup to allow an external PNF to contact the ONAP installation. For example, in the AT&T network, a maintenance tunnel is used to access ONAP. PNF MUST PNF Plug and Play
R-04492 The VNF **MUST** generate security audit logs that can be sent to Security Analytics Tools for analysis. VNF MUST VNF Security Analytics Requirements
R-67597 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` parameter ``vm_role`` **MUST NOT** have parameter constraints defined. VNF MUST NOT vm_role
R-12538 The VNF **SHOULD** support load balancing and discovery mechanisms in resource pools containing VNFC instances. VNF SHOULD System Resource Optimization
R-13841 A VNF **MAY** have one or more ports connected to a unique internal network. All VNF ports connected to the unique internal network **MUST** have cloud assigned IP Addresses or **MUST** have statically assigned IP addresses. VNF MAY Items to Note
R-80829 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``subnet`` parameter ``{network-role}_v6_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: subnet
R-90206 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_int_{network-role}_int_ips`` **MUST** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST Property: fixed_ips, Map Property: ip_address
R-95321 The VNFD provided by VNF vendor may use the below described TOSCA relationships. An on-boarding entity (ONAP SDC) **MUST** support them. **tosca.relationships.nfv.VirtualBindsTo** This relationship type represents an association relationship between VDU and CP node types. **tosca.relationships.nfv.VirtualLinksTo** This relationship type represents an association relationship between the VduCpd's and VirtualLinkDesc node types. VNF MUST Relationship Types
R-74978 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``workload_context`` parameter **MUST** be declared as ``workload_context`` and the parameter **MUST** be defined as type: ``string``. VNF MUST workload_context
R-87848 When using the intrinsic function get_file, ONAP does not support a directory hierarchy for included files. All files must be in a single, flat directory per VNF. A VNF's Heat Orchestration Template's ``get_file`` target files **MUST** be in the same directory hierarchy as the VNF's Heat Orchestration Templates. VNF MUST Heat Files Support (get_file)
R-256267 If SNMP is utilized, the VNF **MUST** support at least SNMPv3 with message authentication. VNF MUST VNF General Security Requirements
R-118669 Login access (e.g., shell access) to the operating system layer, whether interactive or as part of an automated process, **MUST** be through an encrypted protocol such as SSH or TLS. VNF MUST VNF General Security Requirements
R-87485 A VNF's Heat Orchestration Template's file extension **MUST** be in the lower case format ``.yaml`` or ``.yml``. VNF MUST ONAP Heat Orchestration Template Filenames
R-19366 The xNF **MUST** support APPC ``ConfigModify`` command. XNF MUST Configuration Commands
R-378131 (Error Case) - If an error is encountered by the PNF during a Service Configuration exchange with ONAP, the PNF **MAY** log the error and notify an operator. PNF MAY PNF Plug and Play
R-35414 A VNF Heat Orchestration's template **MUST** contain the section ``parameters:``. VNF MUST parameters
R-64713 The VNF **SHOULD** support a software promotion methodology from dev/test -> pre-prod -> production in software, development & testing and operations. VNF SHOULD VNF Devops
R-25190 A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` **SHOULD NOT** declare the property ``availability_zone``. VNF SHOULD NOT Optional Property availability_zone
R-54520 The VNF **MUST** log successful and unsuccessful authentication attempts, e.g., authentication associated with a transaction, authentication to create a session, authentication to assume elevated privilege. VNF MUST VNF Security Analytics Requirements
R-85328 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MAY** contain the key/value pair ``vm_role`` and the value **MUST** be obtained either via - ``get_param`` - hard coded in the key/value pair ``vm_role``. VNF MAY vm_role
R-87563 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv6 Address on a port attached to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` is the index of the IPv6 address VNF MUST OS::ContrailV2::InstanceIp
R-87564 The xNF **SHOULD** conform its YANG model to RFC 7317, "A YANG Data Model for System Management". XNF SHOULD NETCONF Server Requirements
R-75943 The xNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when supporting the event-driven bulk transfer of monitoring data. XNF SHOULD Bulk Performance Measurement
R-42366 The xNF **MUST** support secure connections and transports such as Transport Layer Security (TLS) protocol [`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to the best current practices outlined in `RFC7525 <https://tools.ietf.org/html/rfc7525>`_. XNF MUST Security
R-73364 The VNF **MUST** support at least two major versions of the VNF software and/or sub-components to co-exist within production environments at any time so that upgrades can be applied across multiple systems in a staggered manner. VNF MUST Deployment Optimization
R-22589 A VNF's Heat Orchestration Template parameter declaration **MAY** contain the attribute ``immutable:``. VNF MAY immutable
R-16437 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate`` Resource ID **MUST** contain the ``{vm-type}``. VNF MUST OS::ContrailV2::ServiceTemplate
R-63229 The xNF **MAY** use another option which is expected to include REST for synchronous data, using RESTCONF (e.g., for xNF state polling). XNF MAY Addressing and Delivery Protocol
R-89010 The VNF **MUST** survive any single points of software failure internal to the VNF (e.g., in memory structures, JMS message queues). VNF MUST All Layer Redundancy
R-83227 The VNF **MUST** Provide the capability to encrypt data in transit on a physical or virtual network. VNF MUST VNF Data Protection Requirements
R-11690 When a VNF's Heat Orchestration Template's Resource ID contains an ``{index}`` value (e.g. multiple VMs of same ``{vm-type}``), the ``{index}`` **MUST** start at zero and increment by one. VNF MUST Resource IDs
R-01101 A VNF's Heat Orchestration Template **MAY** reference the nested heat dynamically using the resource ``OS::Heat::ResourceGroup``. VNF MAY Nested Heat Template Requirements
R-83146 The xNF **MUST** support APPC ``StopApplication`` command. XNF MUST Lifecycle Management Related Commands
R-85734 If a VNF's Heat Orchestration Template contains the property ``name`` for a non ``OS::Nova::Server`` resource, the intrinsic function ``str_replace`` **MUST** be used in conjunction with the ONAP supplied metadata parameter ``vnf_name`` to generate a unique value. VNF MUST Resource Property “name”
R-81339 A VNF Heat Orchestration Template's Base Module file name **MUST** include case insensitive 'base' in the filename and **MUST** match one of the following four formats: 1.) ``base_<text>.y[a]ml`` 2.) ``<text>_base.y[a]ml`` 3.) ``base.y[a]ml`` 4.) ``<text>_base_<text>``.y[a]ml where ``<text>`` **MUST** contain only alphanumeric characters and underscores '_' and **MUST NOT** contain the case insensitive word ``base``. VNF MUST Base Modules
R-57617 The VNF **MUST** include the field "success/failure" in the Security alarms (where applicable and technically feasible). VNF MUST VNF Security Analytics Requirements
R-57424 A VNF's port connected to an external network **MUST** use the port for the purpose of reaching VMs in another VNF and/or an external gateway and/or external router. A VNF's port connected to an external network **MAY** use the port for the purpose of reaching VMs in the same VNF. VNF MUST External Networks
R-42140 The xNF **MUST** respond to data requests from ONAP as soon as those requests are received, as a synchronous response. XNF MUST Asynchronous and Synchronous Data Delivery
R-28222 If a VNF's Heat Orchestration Template ``OS::ContrailV2::InterfaceRouteTable`` resource ``interface_route_table_routes`` property ``interface_route_table_routes_route`` map property parameter name **MUST** follow the format * ``{vm-type}_{network-role}_route_prefixes`` VNF MUST Interface Route Table Prefixes for Contrail InterfaceRoute Table
R-63953 The xNF **MUST** have the echo command return a zero value otherwise the validation has failed. XNF MUST NETCONF Server Requirements
R-95430 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` value is obtained via ``get_param``, the parameter **MUST** be declared as ``vm_role`` and the parameter **MUST** be defined as type: ``string``. VNF MUST vm_role
R-146931 The xNF **MUST** report exactly one Measurement event per period per source name. XNF MUST Reporting Frequency
R-304011 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's * Resource ID * property ``image`` parameter name * property ``flavor`` parameter name * property ``name`` parameter name **MUST** contain the identical ``{vm-type}`` and **MUST** follow the naming conventions defined in R-58670, R-45188, R-54171, R-87817, and R-29751. VNF MUST Resource: OS::Nova::Server - Parameters
R-63956 If the VNF's ports connected to a unique external network and the port's IP addresses are ONAP SDN-C assigned IP Addresses, the IPv4 Addresses **MAY** be from different subnets and the IPv6 Addresses **MAY** be from different subnets. VNF MAY Items to Note
R-40813 The VNF **SHOULD** support the use of virtual trusted platform module. VNF SHOULD VNF General Security Requirements
R-15325 The VNF **MUST** log the field "success/failure" in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-13627 The VNF **MUST** monitor API invocation patterns to detect anomalous access patterns that may represent fraudulent access or other types of attacks, or integrate with tools that implement anomaly and abuse detection. VNF MUST VNF Security Analytics Requirements
R-08315 The VNF **SHOULD** use redundant connection pooling to connect to any backend data source that can be switched between pools in an automated/scripted fashion to ensure high availability of the connection to the data source. VNF SHOULD Intelligent Transaction Distribution & Management
R-86835 The VNF **MUST** set the default settings for user access to deny authorization, except for a super user type of account. When a VNF is added to the network, nothing should be able to use it until the super user configures the VNF to allow other users (human and application) have access. VNF MUST VNF Identity and Access Management Requirements
R-69663 A VNF **MAY** be composed from one or more Heat Orchestration Templates, each of which represents a subset of the overall VNF. VNF MAY ONAP VNF Modularity Overview
R-54458 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` that is attaching to a sub-interface network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` is the instance of the the vmi on the vm-type attached to the network of ``{network-role}`` VNF MUST OS::ContrailV2::VirtualMachineInterface
R-54356 The below table includes the data types used by NFV node and is based on TOSCA/YAML constructs specified in draft GS NFV-SOL 001. The node data definitions/attributes used in VNFD **MUST** comply with the below table. VNF MUST Data Types
R-13390 The xNF provider **MUST** provide cookbooks to be loaded on the appropriate Chef Server. XNF MUST Configuration Management via Chef
R-06413 The VNF **MUST** log the field "service or program used for access" in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-78010 The VNF **MUST** integrate with standard identity and access management protocols such as LDAP, TACACS+, Windows Integrated Authentication (Kerberos), SAML federation, or OAuth 2.0. VNF MUST VNF Identity and Access Management Requirements
R-30395 A VNF's Cinder Volume Module **MAY** utilize nested heat. VNF MAY Nested Heat Orchestration Templates Overview
R-70266 The xNF **MUST** respond to an ONAP request to deliver the current data for any of the record types defined in `Event Records - Data Structure Description`_ by returning the requested record, populated with the current field values. (Currently the defined record types include fault fields, mobile flow fields, measurements for xNF scaling fields, and syslog fields. Other record types will be added in the future as they become standardized and are made available.) XNF MUST Asynchronous and Synchronous Data Delivery
R-53015 The xNF **MUST** apply locking based on the sequence of NETCONF operations, with the first configuration operation locking out all others until completed. XNF MUST NETCONF Server Requirements
R-79224 The xNF **MUST** have the chef-client be preloaded with validator keys and configuration to register with the designated Chef Server as part of the installation process. XNF MUST Chef Client Requirements
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-01033 The xNF **MAY** use another option which is expected to include SFTP for asynchronous bulk files, such as bulk files that contain large volumes of data collected over a long time interval or data collected across many xNFs. (Preferred is to reorganize the data into more frequent or more focused data sets, and deliver these by REST or TCP as appropriate.) XNF MAY Addressing and Delivery Protocol
R-21652 The VNF **MUST** implement the following input validation control: Check the size (length) of all input. Do not permit an amount of input so great that it would cause the VNF to fail. Where the input may be a file, the VNF API must enforce a size limit. VNF MUST VNF API Security Requirements
R-93177 When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and the internal network is created in the same Heat Orchestration Template as the ``OS::Neutron::Port``, the ``network`` property value **MUST** obtain the UUID of the internal network by using the intrinsic function ``get_resource`` and referencing the Resource ID of the internal network. VNF MUST Property: network
R-95303 A VNF's Heat Orchestration Template **MUST** be defined using valid YAML. VNF MUST YAML Format
R-00606 A VNF **MAY** be connected to zero, one or more than one external network. VNF MAY External Networks
R-01427 The PNF **MUST** support the provisioning of security and authentication parameters (HTTP username and password) in order to be able to authenticate with DCAE (in ONAP). Note: In R3, a username and password are used with the DCAE VES Event Listener which are used for HTTP Basic Authentication. Note: The configuration management and provisioning software are specific to a vendor architecture. PNF MUST PNF Plug and Play
R-11240 The xNF **MUST** respond with content encoded in JSON, as described in the RESTCONF specification. This way the encoding of a synchronous communication will be consistent with Avro. XNF MUST Asynchronous and Synchronous Data Delivery
R-74712 The VNF **MUST** utilize FQDNs (and not IP address) for both Service Chaining and scaling. VNF MUST System Resource Optimization
R-46567 The xNF Package **MUST** include configuration scripts for boot sequence and configuration. XNF MUST Configuration Management via Ansible
R-45197 The xNF **MUST** define the "from=" clause to provide the list of IP addresses of the Ansible Servers in the Cluster, separated by coma, to restrict use of the SSH key pair to elements that are part of the Ansible Cluster owner of the issued and assigned mechanized user ID. XNF MUST Ansible Client Requirements
R-932071 The xNF provider **MUST** reach agreement with the Service Provider on the selected methods for encoding, serialization and data delivery prior to the on-boarding of the xNF into ONAP SDC Design Studio. XNF MUST Transports and Protocols Supporting Resource Interfaces
R-82811 The xNF **MUST** support APPC ``StartApplication`` command. XNF MUST Lifecycle Management Related Commands
R-60656 The xNF **MUST** support sub tree filtering. XNF MUST NETCONF Server Requirements
R-36542 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` parameter ``vnf_name`` **MUST NOT** be enumerated in the Heat Orchestration Template's environment file. VNF MUST NOT vnf_name
R-26371 The VNF **MUST** detect communication failure for inter VNFC instance and intra/inter VNF and re-establish communication automatically to maintain the VNF without manual intervention to provide service continuity. VNF MUST Application Resilient Error Handling
R-53433 A VNF's Cinder Volume Module **MUST** have a corresponding environment file VNF MUST ONAP VNF Modularity Overview
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-62802 When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 address is being cloud assigned by OpenStack's DHCP Service and the external network IPv4 subnet is to be specified using the property ``fixed_ips`` map property ``subnet``, the parameter **MUST** follow the naming convention * ``{network-role}_subnet_id`` where * ``{network-role}`` is the network role of the network. VNF MUST Property: fixed_ips, Map Property: subnet
R-33846 The VNF **MUST** install the NCSP required software on Guest OS images when not using the NCSP provided Guest OS images. [#4.5.1]_ VNF MUST VNF Devops
R-02454 The VNF **MUST** support the existence of multiple major/minor versions of the VNF software and/or sub-components and interfaces that support both forward and backward compatibility to be transparent to the Service Provider usage. VNF MUST Deployment Optimization
R-10716 The xNF **MUST** support parallel and simultaneous configuration of separate objects within itself. XNF MUST NETCONF Server Requirements
R-581188 A failed authentication attempt **MUST NOT** identify the reason for the failure to the user, only that the authentication failed. VNF MUST NOT VNF Identity and Access Management Requirements
R-93272 A VNF **MAY** have one or more ports connected to a unique external network. All VNF ports connected to the unique external network **MUST** have cloud assigned IP Addresses or **MUST** have ONAP SDN-C assigned IP addresses. VNF MAY Items to Note
R-35666 If a VNF has an internal network, the VNF Heat Orchestration Template **MUST** include the heat resources to create the internal network. VNF MUST Internal Networks
R-75850 The VNF **SHOULD** decouple persistent data from the VNFC and keep it in its own datastore that can be reached by all instances of the VNFC requiring the data. VNF SHOULD VNF Design
R-270358 A VNF's Heat Orchestration Template's Cinder Volume Template **MUST** contain either * An ``OS::Cinder::Volume`` resource * An ``OS::Heat::ResourceGroup`` resource that references a Nested YAML file that contains an ``OS::Cinder::Volume`` resource * A resource that defines the property ``type`` as a Nested YAML file (i.e., static nesting) and the Nested YAML contains an ``OS::Cinder::Volume`` resource VNF MUST ONAP Heat Cinder Volumes
R-13151 The VNF **SHOULD** disable the paging of the data requiring encryption, if possible, where the encryption of non-transient data is required on a device for which the operating system performs paging to virtual memory. If not possible to disable the paging of the data requiring encryption, the virtual memory should be encrypted. VNF SHOULD VNF Data Protection Requirements
R-41215 The VNF **MAY** have zero to many "incremental" modules. VNF MAY ONAP VNF Modularity Overview
R-46128 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv6 Address on a port attached to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of {network-role} * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` is the index of the IPv6 address VNF MUST OS::ContrailV2::InstanceIp
R-55218 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT** have parameter constraints defined. VNF MUST NOT vnf_id
R-56920 The VNF **MUST** protect all security audit logs (including API, OS and application-generated logs), security audit software, data, and associated documentation from modification, or unauthorized viewing, by standard OS access control mechanisms, by sending to a remote system, or by encryption. VNF MUST VNF Security Analytics Requirements
R-96227 A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type ``json`` **MAY** have a parameter constraint defined. VNF MAY constraints
R-20308 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``environment_context`` parameter **MUST** be declared as ``environment_context`` and the parameter type **MUST** be defined as type: ``string``. VNF MUST environment_context
R-67231 A VNF's Heat Orchestration template's Environment File's **MUST NOT** contain the ``resource_registry:`` section. VNF MUST NOT Environment File Format
R-22059 The VNF **MUST NOT** execute long running tasks (e.g., IO, database, network operations, service calls) in a critical section of code, so as to minimize blocking of other operations and increase concurrent throughput. VNF MUST NOT System Resource Optimization
R-28545 The xNF **MUST** conform its YANG model to RFC 6060, "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)". XNF MUST NETCONF Server Requirements
R-64768 The VNF **MUST** limit the size of application data packets to no larger than 9000 bytes for SDN network-based tunneling when guest data packets are transported between tunnel endpoints that support guest logical networks. VNF MUST VNF Design
R-44013 The xNF **MUST** populate an attribute, defined as node ['PushJobOutput'] with the desired output on all nodes in the push job that execute chef-client run if the xNF action requires the output of a chef-client run be made available (e.g., get running configuration). XNF MUST Chef Roles/Requirements
R-12271 The xNF **SHOULD** conform its YANG model to RFC 7223, "IANA Interface Type YANG Module". XNF SHOULD NETCONF Server Requirements
R-58421 The VNF **SHOULD** be decomposed into granular re-usable VNFCs. VNF SHOULD VNF Design
R-67793 When a VNF's Heat Orchestration Template's resource is associated with more than one ``{vm-type}`` and/or more than one internal and/or external network, the Resource ID **MUST** not contain the ``{vm-type}`` and/or ``{network-role}``/``int_{network-role}``. It also should contain the term ``shared`` and/or contain text that identifies the VNF. VNF MUST NOT Resource IDs
R-62428 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` parameter **MUST** be declared as ``vnf_name`` and the parameter **MUST** be defined as type: ``string``. VNF MUST vnf_name
R-58424 A VNF's Heat Orchestration Template's use of ``{network-role}`` in all Resource property parameter names **MUST** be the same case. VNF MUST {network-role}
R-41825 The VNF **MUST** activate security alarms automatically when a configurable number of consecutive unsuccessful login attempts is reached. VNF MUST VNF Security Analytics Requirements
R-91273 A VNF Heat Orchestration's template's parameter for the ``OS::Nova::Server`` resource property ``availability_zone`` **MAY NOT** be used in any ``OS::Nova::Server``. VNF MAY NOT parameters
R-65515 The VNF **MUST** provide a mechanism and tool to start VNF containers (VMs) without impacting service or service quality assuming another VNF in same or other geographical location is processing service requests. VNF MUST Application Resilient Error Handling
R-69431 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``flavor`` parameter **MUST** be enumerated in the Heat Orchestration Template's Environment File and a value **MUST** be assigned. VNF MUST Property: flavor
R-23475 VNFCs **SHOULD** be agnostic to the details of the Network Cloud (such as hardware, host OS, Hypervisor or container technology) and must run on the Network Cloud with acknowledgement to the paradigm that the Network Cloud will continue to rapidly evolve and the underlying components of the platform will change regularly. VNF SHOULD VNF Devops
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-47597 The xNF **MUST** carry data in motion only over secure connections. XNF MUST Security
R-81147 The VNF **MUST** support strong authentication, also known as multifactor authentication, on all protected interfaces exposed by the VNF for use by human users. Strong authentication uses at least two of the three different types of authentication factors in order to prove the claimed identity of a user. VNF MUST VNF Identity and Access Management Requirements
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-256347 The PNF **MUST** support the Ansible protocol for a Service Configuration message exchange between the PNF and PNF Controller (in ONAP). Note: this exchange may be either Ansible, Chef, or NetConf depending on the PNF. Note: The PNF Controller may be VF-C, APP-C or SDN-C based on the PNF and PNF domain. Note: for R3 (Casablanca) only Ansible is supported. PNF MUST PNF Plug and Play
R-18725 The VNF **MUST** handle the restart of a single VNFC instance without requiring all VNFC instances to be restarted. VNF MUST Application Resilient Error Handling
R-54171 When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``string``, the parameter name **MUST** follow the naming convention ``{vm-type}_name_{index}``, where ``{index}`` is a numeric value that starts at zero and increments by one. VNF MUST Property: Name
R-67895 The VNFD provided by VNF vendor may use the below described TOSCA capabilities. An on-boarding entity (ONAP SDC) **MUST** support them. **tosca.capabilities.nfv.VirtualBindable** A node type that includes the VirtualBindable capability indicates that it can be pointed by **tosca.relationships.nfv.VirtualBindsTo** relationship type. **tosca.capabilities.nfv.VirtualLinkable** A node type that includes the VirtualLinkable capability indicates that it can be pointed by **tosca.relationships.nfv.VirtualLinksTo** relationship. **tosca.capabilities.nfv.ExtVirtualLinkable** A node type that includes the ExtVirtualLinkable capability indicates that it can be pointed by **tosca.relationships.nfv.VirtualLinksTo** relationship. **Note**: This capability type is used in Casablanca how it does not exist in the last SOL001 draft **tosca.capabilities.nfv.VirtualCompute** and **tosca.capabilities.nfv.VirtualStorage** includes flavours of VDU VNF MUST Capability Types
R-92193 A VNF's Heat Orchestration Template's parameter ``{network-role}_net_fqdn`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT External Networks
R-47204 The VNF **MUST** be capable of protecting the confidentiality and integrity of data at rest and in transit from unauthorized access and modification. VNF MUST VNF Data Protection Requirements
R-04298 The xNF provider **MUST** provide their testing scripts to support testing. XNF MUST Testing
R-41492 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 Virtual IP (VIP) address is assigned via ONAP automation using the property ``allowed_address_pairs`` map property ``ip_address`` and the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_floating_ip`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the external network And the parameter **MUST** be declared as type ``string``. VNF MUST VIP Assignment, External Networks, Supported by Automation
R-62300 If a VNF has two or more ports that require a Virtual IP Address (VIP), a VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter **MUST** be used. VNF MUST Property: allowed_address_pairs, Map Property: ip_address
R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [#4.5.1]_ VNF MUST VNF Devops
R-528866 The VNF **MUST** produce VES events that include the following mandatory fields in the common event header. * ``domain`` - the event domain enumeration * ``eventId`` - the event key unique to the event source * ``eventName`` - the unique event name * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated with the event * ``priority`` - the processing priority enumeration * ``reportingEntityName`` - name of the entity reporting the event or detecting a problem in another xNF * ``sequence`` - the ordering of events communicated by an event source * ``sourceName`` - name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity * ``startEpochMicrosec`` - the earliest unix time (aka epoch time) associated with the event * ``version`` - the version of the event header * ``vesEventListenerVersion`` - Version of the VES event listener API spec that this event is compliant with VNF MUST Common Event Header
R-73067 The VNF **MUST** use NIST and industry standard cryptographic algorithms and standard modes of operations when implementing cryptography. VNF MUST VNF Data Protection Requirements
R-821473 The xNF MUST produce heartbeat indicators consisting of events containing the common event header only per the VES Listener Specification. XNF MUST VNF telemetry via standardized interface
R-38474 A VNF's Base Module **MUST** have a corresponding Environment File. VNF MUST ONAP VNF Modularity Overview
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-16576 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` is passed into a Nested YAML file, the key/value pair name ``vnf_name`` **MUST NOT** change. VNF MUST NOT vnf_name
R-41829 The xNF **MUST** be able to specify the granularity of the lock via a restricted or full XPath expression. XNF MUST NETCONF Server Requirements
R-84160 The VNF **MUST** have security logging for VNFs and their OSs be active from initialization. Audit logging includes automatic routines to maintain activity records and cleanup programs to ensure the integrity of the audit/logging systems. VNF MUST VNF Security Analytics Requirements
R-87247 VNF Heat Orchestration Template's Incremental Module file name **MUST** contain only alphanumeric characters and underscores '_' and **MUST NOT** contain the case insensitive word ``base``. VNF MUST Incremental Modules
R-82115 When a VNF's Heat Orchestration Template's resource is associated with a single ``{vm-type}`` and a single external network, the Resource ID text **MUST** contain both the ``{vm-type}`` and the ``{network-role}`` - the ``{vm-type}`` **MUST** appear before the ``{network-role}`` and **MUST** be separated by an underscore '_' - e.g., ``{vm-type}_{network-role}``, ``{vm-type}_{index}_{network-role}`` - note that an ``{index}`` value **MAY** separate the ``{vm-type}`` and the ``{network-role}`` and when this occurs underscores **MUST** separate the three values. (e.g., ``{vm-type}_{index}_{network-role}``). VNF MUST Resource IDs
R-22946 The xNF **SHOULD** conform its YANG model to RFC 6536, "NETCONF Access Control Model". XNF SHOULD NETCONF Server Requirements
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-57855 The VNF **MUST** support hitless staggered/rolling deployments between its redundant instances to allow "soak-time/burn in/slow roll" which can enable the support of low traffic loads to validate the deployment prior to supporting full traffic loads. VNF MUST Deployment Optimization
R-284934 If the PNF encounters an error authenticating, reaching the ONAP DCAE VES Event listener or recieves an error response from sending the pnfRegistration VES Event, it **MAY** log the error, and notify the operator. Note: the design of how errors are logged, retrieved and reported will be a vendor-specific architecture. Reporting faults and errors is also a vendor specific design. It is expected that the PNF shall have a means to log an error and notify a user when a fault condition occurs in trying to contact ONAP, authenticate or send a pnfRegistration event. PNF MUST PNF Plug and Play
R-12110 The VNF **MUST NOT** use keys generated or derived from predictable functions or values, e.g., values considered predictable include user identity information, time of day, stored/transmitted data. VNF MUST NOT VNF Data Protection Requirements
R-29705 The VNF **MUST** restrict changing the criticality level of a system security alarm to users with administrative privileges. VNF MUST VNF Security Analytics Requirements
R-90152 A VNF's Heat Orchestration Template's ``resources:`` section **MUST** contain the declaration of at least one resource. VNF MUST resources
R-35532 The VNF **SHOULD** release and clear all shared assets (memory, database operations, connections, locks, etc.) as soon as possible, especially before long running sync and asynchronous operations, so as to not prevent use of these assets by other entities. VNF SHOULD System Resource Optimization
R-98407 A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only alphanumeric characters and/or underscores '_' and **MUST NOT** contain any of the following strings: ``_int`` or ``int_`` or ``_int_``. VNF MUST NOT {vm-type}
R-26508 The xNF **MUST** support a NETCONF server that can be mounted on OpenDaylight (client) and perform the operations of: modify, update, change, rollback configurations using each configuration data element, query each state (non-configuration) data element, execute each YANG RPC, and receive data through each notification statement. XNF MUST NETCONF Server Requirements
R-26506 A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain only alphanumeric characters and/or underscores '_' and **MUST NOT** contain any of the following strings: ``_int`` or ``int_`` or ``_int_``. VNF MUST {network-role}
R-29495 The xNF **MUST** support locking if a common object is being manipulated by two simultaneous NETCONF configuration operations on the same xNF within the context of the same writable running data store (e.g., if an interface parameter is being configured then it should be locked out for configuration by a simultaneous configuration operation on that same interface parameter). XNF MUST NETCONF Server Requirements
R-18202 A VNF's Heat Orchestration Template's Resource ``OS::Heat::MultipartMime`` Resource ID **MAY** use the naming convention * ``{vm-type}_RMM`` where * ``{vm-type}`` is the vm-type * ``RMM`` signifies that it is the Resource Multipart Mime VNF MAY OS::Heat::MultipartMime
R-71699 A VNF's Heat Orchestration Template's Resource **MUST NOT** reference a HTTP-based Nested YAML file. VNF MUST NOT type
R-76160 When * the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` in an Incremental Module is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461) that is created in the Base Module, AND * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND * the internal network IPv6 subnet is to be specified using the property ``fixed_ips`` map property ``subnet``, the parameter **MUST** follow the naming convention ``int_{network-role}_v6_subnet_id``, where ``{network-role}`` is the network role of the internal network. Note that the parameter **MUST** be defined as an ``output`` parameter in the base module. VNF MUST Property: fixed_ips, Map Property: subnet
R-71493 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MUST** contain the key/value pair ``vf_module_id`` and the value MUST be obtained via a ``get_param``. VNF MUST vf_module_id
R-99730 The VNF **MUST** include the field "Login ID" in the Security alarms (where applicable and technically feasible). VNF MUST VNF Security Analytics Requirements
R-08312 The xNF **MAY** use another option which is expected to include REST delivery of binary encoded data sets. XNF MAY Addressing and Delivery Protocol
R-89571 The xNF **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. XNF MUST Resource Configuration
R-579051 The PNF **MAY** support a HTTP connection to the DCAE VES Event Listener. Note: HTTP is allowed but not recommended. PNF MAY PNF Plug and Play
R-465236 The VNF **SHOULD** provide the capability of maintaining the integrity of its static files using a cryptographic method. VNF SHOULD VNF Security Analytics Requirements
R-99110 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming convention 1) ``int_{network-role}_network`` or 2) ``int_{network-role}_RVN`` where RVN represents Resource Virtual Network VNF Heat Orchestration Templates can only create internal networks. There is no ``{index}`` after ``{network-role}`` because ``{network-role}`` **MUST** be unique in the scope of the VNF's Heat Orchestration Template. Note that option 1 is preferred. VNF MUST OS::ContrailV2::VirtualNetwork
R-78116 The xNF **MUST** update status on the Chef Server appropriately (e.g., via a fail or raise an exception) if the chef-client run encounters any critical errors/failures when executing a xNF action. XNF MUST Chef Roles/Requirements
R-83706 When a VNF's Heat Orchestration Template's Virtual Machine (i.e., ``OS::Nova::Server`` resource) boots from an image, the ``OS::Nova::Server`` resource property ``image`` **MUST** be used. VNF MUST Boot Options
R-43253 The xNF **MUST** use playbooks designed to allow Ansible Server to infer failure or success based on the "PLAY_RECAP" capability. **Note**: There are cases where playbooks need to interpret results of a task and then determine success or failure and return result accordingly (failure for failed tasks). XNF MUST Ansible Playbook Requirements
R-08134 The xNF **MUST** conform to the NETCONF RFC 6241, "NETCONF Configuration Protocol". XNF MUST NETCONF Server Requirements
R-814377 The VNF **MUST** have the capability of allowing the Operator to create, manage, and automatically provision user accounts using an Operator approved identity lifecycle management tool using a standard protocol, e.g., NETCONF API. VNF MUST VNF Identity and Access Management Requirements
R-48987 If the VNF's OAM Management IP Address is cloud assigned and and the OAM IP Address is required to be inventoried in ONAP A&AI, then the parameter **MUST** be obtained by the resource ``OS::Neutron::Port`` attribute ``ip_address``. VNF MUST OAM Management IP Addresses
R-36687 A VNF's Heat Orchestration Template's ``{vm-type}`` case in Resource property parameter names **SHOULD** match the case of ``{vm-type}`` in Resource IDs and vice versa. VNF SHOULD {vm-type}
R-40827 The xNF provider **MUST** enumerate all of the open source licenses their xNF(s) incorporate. XNF MUST Licensing Requirements
R-59568 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``availability_zone`` parameter **MUST NOT** be enumerated in the Heat Orchestration Template's Environment File. VNF MUST NOT Property: availability_zone
R-872986 The VNF **MUST** store Authentication Credentials used to authenticate to other systems encrypted except where there is a technical need to store the password unencrypted in which case it must be protected using other security techniques that include the use of file and directory permissions. Ideally, credentials SHOULD rely on a HW Root of Trust, such as a TPM or HSM. VNF MUST VNF General Security Requirements
R-13613 The VNF **MUST** provide clear measurements for licensing purposes to allow automated scale up/down by the management system. VNF MUST Licensing Requirements
R-86261 The VNF **MUST** support the ability to prohibit remote access to the VNF via a host based security mechanism. VNF MUST VNF General Security Requirements
R-37039 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` parameter ``vf_module_index`` **MUST NOT** be enumerated in the Heat Orchestration Template's environment file. VNF MUST NOT vf_module_index
R-98905 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_ips`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: ip_address
R-85800 When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``comma_delimited_list``, a parameter **MUST** be delcared once for all ``OS::Nova::Server`` resources associated with the ``{vm-type}``. VNF MUST Property: Name
R-68023 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **SHOULD** contain the key/value pair ``vf_module_name`` and the value **MUST** be obtained via a ``get_param``. VNF SHOULD vf_module_name
R-25877 A VNF's Heat Orchestration Template's parameter name (i.e., <param name>) **MUST** contain only alphanumeric characters and underscores ('_'). VNF MUST <param name>
R-90022 A VNF's Nested YAML file **MAY** be invoked more than once by a VNF's Heat Orchestration Template. VNF MAY Nested Heat Template Requirements
R-80374 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name`` **MUST NOT** be enumerated in the Heat Orchestration Template's environment file. VNF MUST NOT vf_module_name
R-19756 If a VNF's Heat Orchestration Template ``OS::ContrailV2::InterfaceRouteTable`` resource ``interface_route_table_routes`` property ``interface_route_table_routes_route`` map property parameter ``{vm-type}_{network-role}_route_prefixes`` **MUST** be defined as type ``json``. VNF MUST Interface Route Table Prefixes for Contrail InterfaceRoute Table
R-30804 A VNF's Heat Orchestration Template's Resource ``OS::Heat::MultipartMime`` Resource ID **MUST** contain the ``{vm-type}``. VNF MUST OS::Heat::MultipartMime
R-80070 The VNF **MUST** handle errors and exceptions so that they do not interrupt processing of incoming VNF requests to maintain service continuity (where the error is not directly impacting the software handling the incoming request). VNF MUST Application Resilient Error Handling
R-53952 A VNF's Heat Orchestration Template's Resource **MUST NOT** reference a HTTP-based resource definitions. VNF MUST NOT type
R-76718 If a VNF's Heat Orchestration Template uses the intrinsic function ``get_file``, the ``get_file`` target **MUST** be referenced in the Heat Orchestration Template by file name. VNF MUST Heat Files Support (get_file)
R-22367 The VNF **MUST** support detection of malformed packets due to software misconfiguration or software vulnerability, and generate an error to the syslog console facility. VNF MUST VNF Security Analytics Requirements
R-22700 The xNF **MUST** conform its YANG model to RFC 6470, "NETCONF Base Notifications". XNF MUST NETCONF Server Requirements
R-97726 A VNF's Heat Orchestration Template's Base Module Output Parameter names **MUST** contain ``{vm-type}`` and/or ``{network-role}`` when appropriate. VNF MUST ONAP Base Module Output Parameters:
R-47874 A VNF **MAY** have * Only an IPv4 OAM Management IP Address * Only an IPv6 OAM Management IP Address * Both a IPv4 and IPv6 OAM Management IP Addresses VNF MAY OAM Management IP Addresses
R-49751 The xNF **MUST** support Ansible playbooks that are compatible with Ansible version 2.6 or later. XNF MUST Ansible Playbook Requirements
R-283988 The VNF, when publishing events, **MUST NOT** send information through extensible structures if the event specification has explicitly defined fields for that information. VNF MUST NOT Miscellaneous
R-97445 The VNF **MUST** log the field "date/time" in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-41252 The VNF **MUST** support the capability of online storage of security audit logs. VNF MUST VNF Security Analytics Requirements
R-37692 The VNFC **MUST** provide API versioning to allow for independent upgrades of VNFC. VNF MUST VNF Design
R-05257 A VNF's Heat Orchestration Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIP``. VNF MUST NOT VIP Assignment, External Networks, Supported by Automation
R-69610 The VNF **MUST** provide the capability of using X.509 certificates issued by an external Certificate Authority. VNF MUST VNF Data Protection Requirements
R-77667 The VNF **MUST** test for adherence to the defined performance budget at each layer, during each delivery cycle so that the performance budget is measured and feedback is provided where the performance budget is not met. VNF MUST Deployment Optimization
R-21210 The VNF **MUST** implement the following input validation control on APIs: Validate that any input file has a correct and valid Multipurpose Internet Mail Extensions (MIME) type. Input files should be tested for spoofed MIME types. VNF MUST VNF API Security Requirements
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-45719 The VNF **MUST**, if not integrated with the Operator's Identity and Access Management system, or enforce a configurable "terminate idle sessions" policy by terminating the session after a configurable period of inactivity. VNF MUST VNF Identity and Access Management Requirements
R-97201 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_int_{network-role}_v6_ip_{index}`` **MUST** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST Property: fixed_ips, Map Property: ip_address
R-30932 The VNF **MUST** log successful and unsuccessful access to VNF resources, including data. VNF MUST VNF Security Analytics Requirements
R-33488 The VNF **MUST** protect against all denial of service attacks, both volumetric and non-volumetric, or integrate with external denial of service protection tools. VNF MUST VNF Security Analytics Requirements
R-34484 The VNF **SHOULD** create a single component VNF for VNFCs that can be used by other VNFs. VNF SHOULD VNF Design
R-697654 The xNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model depicted in Figure 3 to support real-time performance management (PM) data. In this model the VES events are streamed as binary-encoded GBPs over via TCP sockets. XNF MAY xNF Telemetry using Google Protocol Buffers
R-894004 When the PNF sets up a HTTP or HTTPS connection, it **MUST** provide a username and password to the DCAE VES Collector for HTTP Basic Authentication. Note: HTTP Basic Authentication has 4 steps: Request, Authenticate, Authorization with Username/Password Credentials, and Authentication Status as per RFC7617 and RFC 2617. PNF MUST PNF Plug and Play
R-48917 The VNF **MUST** monitor for and alert on (both sender and receiver) errant, running longer than expected and missing file transfers, so as to minimize the impact due to file transfer errors. VNF MUST Monitoring & Dashboard
R-62468 The xNF **MUST** allow all configuration data to be edited through a NETCONF <edit-config> operation. Proprietary NETCONF RPCs that make configuration changes are not sufficient. XNF MUST NETCONF Server Requirements
R-48067 A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a substring of ``{network-role}``. VNF MUST NOT {vm-type}
R-04158 The xNF **MUST** conform to the NETCONF RFC 4742, "Using the NETCONF Configuration Protocol over Secure Shell (SSH)". XNF MUST NETCONF Server Requirements
R-49109 The VNF **MUST** support HTTP/S using TLS v1.2 or higher with strong cryptographic ciphers. VNF MUST VNF Cryptography Requirements
R-763774 The PNF **MUST** support a HTTPS connection to the DCAE VES Event Listener. PNF MUST PNF Plug and Play
R-48596 The xNF Package **MUST** include documentation describing the characteristics for the xNF reliability and high availability. XNF MUST Resource Control Loop
R-96554 The xNF **MUST** implement the protocol operation: ``unlock(target)`` - Unlock the configuration data store target. XNF MUST NETCONF Server Requirements
R-70013 The VNF **MUST NOT** require any manual steps to get it ready for service after a container rebuild. VNF MUST NOT Application Resilient Error Handling
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-65134 The VNF **SHOULD** maintain state in a geographically redundant datastore that may, in fact, be its own VNFC. VNF SHOULD VNF Design
R-39402 A VNF's Heat Orchestration Template **MUST** contain the section ``description:``. MUST description
R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs. VNF MUST VNF Identity and Access Management Requirements
R-97529 The xNF **SHOULD** implement the protocol operation: ``get-schema(identifier, version, format)`` - Retrieve the YANG schema. XNF SHOULD NETCONF Server Requirements
R-88536 A VNF's Heat Orchestration Template's OS::Nova::Server Resource **SHOULD** contain the metadata map value parameter 'environment_context'. VNF SHOULD environment_context
R-41956 If a VNF requires ONAP to assign a Virtual IP (VIP) Address to ports connected an external network, the port **MUST NOT** have more than one IPv6 VIP address. VNF MUST NOT VIP Assignment, External Networks, Supported by Automation
R-74481 The VNF **MUST NOT** require the use of a dynamic routing protocol unless necessary to meet functional requirements. VNF MUST NOT VNF Design
R-89800 The VNF **MUST NOT** require Hypervisor-level customization from the cloud provider. VNF MUST NOT VNF Devops
R-42207 The VNF **MUST** design resiliency into a VNF such that the resiliency deployment model (e.g., active-active) can be chosen at run-time. VNF MUST All Layer Redundancy
R-17852 The VNFD **MAY** include TOSCA/YAML definitions that are not part of NFV Profile. If provided, these definitions MUST comply with TOSCA Simple Profile in YAML v.1.2. VNF MAY General
R-48356 The VNF **MUST** fully exploit exception handling to the extent that resources (e.g., threads and memory) are released when no longer needed regardless of programming language. VNF MUST Application Resilient Error Handling
R-18008 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``network`` parameter **MUST** be declared as type: ``string``. VNF MUST Property: network
R-54190 The xNF **MUST** release locks to prevent permanent lock-outs when/if a session applying the lock is terminated (e.g., SSH session is terminated). XNF MUST NETCONF Server Requirements
R-96253 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` is the instance of the the vmi on the vm-type attached to the network of ``{network-role}`` VNF MUST OS::ContrailV2::VirtualMachineInterface
R-44125 The xNF 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. XNF MUST Licensing Requirements
R-84123 When * the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` in an Incremental Module is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461) that is created in the Base Module, AND * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND * the internal network IPv4 subnet is to be specified using the property ``fixed_ips`` map property ``subnet``, the parameter **MUST** follow the naming convention * ``int_{network-role}_subnet_id`` where * ``{network-role}`` is the network role of the internal network Note that the parameter **MUST** be defined as an ``output`` parameter in the base module. VNF MUST Property: fixed_ips, Map Property: subnet
R-11041 All parameters defined in a VNFs Nested YAML file **MUST** be passed in as properties of the resource calling the nested yaml file. VNF MUST Nested Heat Template Requirements
R-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU architectures and families, virtual machines, etc. VNF MAY VNF Devops
R-15837 The following table defines the major TOSCA Types specified in ETSI NFV-SOL001 standard draft. The VNFD provided by a VNF vendor **MUST** comply with the below definitions: VNF MUST General
R-01359 A VNF's Heat Orchestration Template that contains an ``OS::Nova:Server`` Resource **MAY** define a parameter for the property ``availability_zone`` that is not utilized in any ``OS::Nova::Server`` resources in the Heat Orchestration Template. VNF MAY Property: availability_zone
R-91342 A VNF Heat Orchestration Template's Base Module's Environment File **MUST** be named identical to the VNF Heat Orchestration Template's Base Module with ``.y[a]ml`` replaced with ``.env``. VNF MUST Base Modules
R-85235 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv4 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``comma_delimited_list``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_ips`` where * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` * ``{network-role}`` is the {network-role} of the internal network VNF MUST Property: fixed_ips, Map Property: ip_address
R-84517 The Contrail GUI has a limitation displaying special characters. The issue is documented in https://bugs.launchpad.net/juniperopenstack/+bug/1590710. It is recommended that special **SHOULD** characters be avoided. However, if special characters must be used, note that for the following resources: * Virtual Machine * Virtual Network * Port * Security Group * Policies * IPAM Creation the only special characters supported are - \" ! $\ \ ' ( ) = ~ ^ | @ ` { } [ ] > , . _" VNF SHOULD Contrail Issue with Values for the Property Name
R-629534 The VNF **MUST** be capable of automatically synchronizing the system clock daily with the Operator's trusted time source, to assure accurate time reporting in log files. It is recommended that Coordinated Universal Time (UTC) be used where possible, so as to eliminate ambiguity owing to daylight savings time. VNF MUST VNF Security Analytics Requirements
R-49036 The xNF **SHOULD** conform its YANG model to RFC 7277, "A YANG Data Model for IP Management". XNF SHOULD NETCONF Server Requirements
R-92935 The VNF **SHOULD** minimize the propagation of state information across multiple data centers to avoid cross data center traffic. VNF SHOULD Minimize Cross Data-Center Traffic
R-54517 When a VNF's Heat Orchestration Template's resource is associated with a single ``{vm-type}``, the Resource ID **MUST** contain the ``{vm-type}``. VNF MUST Resource IDs
R-46096 A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``encrypted_parameters:`` section. VNF MAY Environment File Format
R-40899 When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``string``, a parameter **MUST** be delcared for each ``OS::Nova::Server`` resource associated with the ``{vm-type}``. VNF MUST Property: Name
R-72871 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id`` **MUST NOT** be enumerated in the Heat Orchestration Template's environment file. VNF MUST NOT vf_module_id
R-18683 If a VNF has one IPv4 OAM Management IP Address and the IP Address needs to be inventoried in ONAP's A&AI database, an output parameter **MUST** be declared in only one of the VNF's Heat Orchestration Templates and the parameter **MUST** be named ``oam_management_v4_address``. VNF MUST OAM Management IP Addresses
R-94525 The VNF **MUST** log connections to the network listeners of the resource. VNF MUST VNF Security Analytics Requirements
R-80898 TThe xNF **MUST** support heartbeat via a <get> with null filter. XNF MUST NETCONF Server Requirements
R-35401 The xNF **MUST** support SSH and allow SSH access by the Ansible server to the endpoint VM(s) and comply with the Network Cloud Service Provider guidelines for authentication and access. XNF MUST Ansible Client Requirements
R-258686 The VNF application processes **MUST NOT** run as root. VNF MUST NOT VNF General Security Requirements
R-88540 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv6 Address on a sub-interface port attached to a sub-interface network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}_v6_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` is the index of the IPv6 address VNF MUST OS::ContrailV2::InstanceIp
R-56287 If the VNF's OAM Management IP Address is assigned by ONAP SDN-C and assigned in the VNF's Heat Orchestration Template's via a heat resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_adress`` parameter (e.g., ``{vm-type}_{network-role}_ip_{index}``, ``{vm-type}_{network-role}_v6_ip_{index}``) and the OAM IP Address is required to be inventoried in ONAP A&AI, then the parameter **MUST** be echoed in an output statement. .. code-block:: yaml outputs: oam_management_v4_address: value: {get_param: {vm-type}_{network-role}_ip_{index} } oam_management_v6_address: value: {get_param: {vm-type}_{network-role}_v6_ip_{index} } VNF MUST OAM Management IP Addresses
R-53317 The xNF **MUST** conform its YANG model to RFC 6087, "Guidelines for Authors and Reviewers of YANG Data Model Documents". XNF MUST NETCONF Server Requirements
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. VNF MUST Licensing Requirements
R-952314 If the PNF set up a TLS connection and mutual (two-way) authentication is being used, then the PNF **MUST** provide its own X.509v3 Certificate to the DCAE VES Collector for authentication. Note: This allows TLS authentication by DCAE VES Collector. Note: The PNF got its X.509 certificate through Enrollment with an operator certificate authority or a X.509 vendor certificate from the vendor factory CA. Note: In R3 three authentication options are supported: (1) HTTP with Username & Password and no TLS. (2) HTTP with Username & Password & TLS with two-way certificate authentication. (3) HTTP with Username & Password & TLS with server-side certificate authentication. PNF MUST PNF Plug and Play
R-53310 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv4 Address on a port attached to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the {vm-type} * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of {network-role} * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` is the index of the IPv4 address VNF MUST OS::ContrailV2::InstanceIp
R-63330 The VNF **MUST** detect when its security audit log storage medium is approaching capacity (configurable) and issue an alarm. VNF MUST VNF Security Analytics Requirements
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-30650 The VNF **MUST** utilize cloud provided infrastructure and VNFs (e.g., virtualized Local Load Balancer) as part of the VNF so that the cloud can manage and provide a consistent service resiliency and methods across all VNF's. VNF MUST VNF Design
R-09811 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` **MUST NOT** have parameter constraints defined. VNF MUST NOT vf_module_index
R-99798 A VNF's Heat Orchestration Template's Virtual Machine (i.e., ``OS::Nova::Server`` resource) **MAY** boot from an image or **MAY** boot from a Cinder Volume. VNF MAY Boot Options
R-16039 The VNF **SHOULD** test for adherence to the defined resiliency rating recommendation at each layer, during each delivery cycle so that the resiliency rating is measured and feedback is provided where software resiliency requirements are not met. VNF SHOULD Deployment Optimization
R-39067 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` parameter **MUST** be declared as ``vf_module_name`` and the parameter **MUST** be defined as type: ``string``. VNF MUST vf_module_name
R-92571 The VNF **MUST** provide operational instrumentation such as logging, so as to facilitate quick resolution of issues with the VNF to provide service continuity. VNF MUST Monitoring & Dashboard
R-72483 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the value **MUST** be obtained via a ``get_param``. VNF MUST vnf_name
R-17528 A VNF's Heat Orchestration Template's first level Nested YAML file **MUST NOT** contain more than one ``OS::Nova::Server`` resource. A VNF's Heat Orchestration Template's second level Nested YAML file **MUST NOT** contain an ``OS::Nova::Server`` resource. VNF MUST Nested Heat Template Requirements
R-20547 When an ONAP Volume Module Output Parameter is declared as an input parameter in a base or an incremental module Heat Orchestration Template, parameter constraints **MUST NOT** be declared. VNF MUST NOT ONAP Volume Module Output Parameters
R-99794 An external network **MUST** have one subnet. An external network **MAY** have more than one subnet. VNF MUST External Networks
R-46839 A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource IDs **MUST** be the same case. VNF MUST {vm-type}
R-71152 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``image`` parameter **MUST** be declared as type: ``string``. VNF MUST Property: image
R-87352 The VNF **SHOULD** utilize Cloud health checks, when available from the Network Cloud, from inside the application through APIs to check the network connectivity, dropped packets rate, injection, and auto failover to alternate sites if needed. VNF SHOULD Monitoring & Dashboard
R-56438 A VNF's Heat Orchestration Template's Nested YAML file extension **MUST** be in the lower case format ``.yaml`` or ``.yml``. VNF MUST ONAP Heat Orchestration Template Filenames
R-23664 A VNF's Heat Orchestration template **MUST** contain the section ``resources:``. VNF MUST resources
R-07251 The xNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command. XNF MUST Lifecycle Management Related Commands
R-66793 The xNF **MUST** guarantee the xNF configuration integrity for all simultaneous configuration operations (e.g., if a change is attempted to the BUM filter rate from multiple interfaces on the same EVC, then they need to be sequenced in the xNF without locking either configuration method out). XNF MUST NETCONF Server Requirements
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/casablanca/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines.html>`__ ) and for the overall xNF. XNF MUST Resource Control Loop
R-15884 The VNF **MUST** include the field "date" in the Security alarms (where applicable and technically feasible). VNF MUST VNF Security Analytics Requirements
R-15885 The xNF **MUST** Upon completion of the chef-client run, POST back on the callback URL, a JSON object as described in Table A2 if the chef-client run list includes a cookbook/recipe that is callback capable. Failure to POST on the Callback Url should not be considered a critical error. That is, if the chef-client successfully completes the xNF action, it should reflect this status on the Chef Server regardless of whether the Callback succeeded or not. XNF MUST Chef Roles/Requirements
R-54340 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` parameter **MUST** be declared as ``vf_module_index`` and the parameter **MUST** be defined as type: ``number``. VNF MUST vf_module_index
R-07545 The xNF **MUST** support all operations, administration and management (OAM) functions available from the supplier for xNFs using the supplied YANG code and associated NETCONF servers. XNF MUST NETCONF Server Requirements
R-80335 For all GUI and command-line interfaces, the VNF **MUST** provide the ability to present a warning notice that is set by the Operator. A warning notice is a formal statement of resource intent presented to everyone who accesses the system. VNF MUST VNF General Security Requirements
R-56793 The VNF **MUST** test for adherence to the defined performance budgets at each layer, during each delivery cycle with delivered results, so that the performance budget is measured and the code is adjusted to meet performance budget. VNF MUST Deployment Optimization
R-83677 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``subnet`` parameter ``{network-role}_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: subnet
R-20453 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is attaching to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{port-index}`` is the instance of the the port on the vm-type attached to the network of ``{network-role}`` VNF MUST OS::Neutron::Port
R-78380 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv4 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``string``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the internal network * the value for ``{index`` must start at zero (0) and increment by one VNF MUST Property: fixed_ips, Map Property: ip_address
R-22288 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``subnet`` parameter ``int_{network-role}_v6_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: subnet
R-859208 The VNF **MUST** log automated remote activities performed with elevated privileges. VNF MUST VNF Security Analytics Requirements
R-85653 The xNF **MUST** provide metrics (e.g., number of sessions, number of subscribers, number of seats, etc.) to ONAP for tracking every license. XNF MUST Licensing Requirements
R-88482 The xNF **SHOULD** use REST using HTTPS delivery of plain text JSON for moderate sized asynchronous data sets, and for high volume data sets when feasible. XNF SHOULD Addressing and Delivery Protocol
R-16241 A VNF's internal network **MUST** have one subnet. A VNF's internal network **MAY** have more than one subnet. VNF MUST Internal Networks
R-21819 The VNF **MUST** provide functionality that enables the Operator to comply with requests for information from law enforcement and government agencies. VNF MUST VNF General Security Requirements
R-05050 A VNF's Heat Orchestration Templates intrinsic function ``get_file`` <content key> **MAY** be used: * more than once in a VNF's Heat Orchestration Template * in two or more of a VNF's Heat Orchestration Templates * in a VNF's Heat Orchestration Templates nested YAML file VNF MAY Heat Files Support (get_file)
R-12467 The VNF **MUST NOT** use compromised encryption algorithms. For example, SHA, DSS, MD5, SHA-1 and Skipjack algorithms. Acceptable algorithms can be found in the NIST FIPS publications (https://csrc.nist.gov/publications/fips) and in the NIST Special Publications (https://csrc.nist.gov/publications/sp). VNF MUST NOT VNF Data Protection Requirements
R-12709 The VNFC **SHOULD** be independently deployed, configured, upgraded, scaled, monitored, and administered by ONAP. VNF SHOULD VNF Design
R-12706 The xNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command. XNF MUST Lifecycle Management Related Commands
R-26115 The xNF **MUST** follow the data model upgrade rules defined in [RFC6020] section 10. All deviations from section 10 rules shall be handled by a built-in automatic upgrade mechanism. XNF MUST NETCONF Server Requirements
R-50816 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MAY** contain the key/value pair ``vf_module_index`` and the value **MUST** be obtained via a ``get_param``. VNF MAY vf_module_index
R-22608 When a VNF's Heat Orchestration Template's Base Module's output parameter is declared as an input parameter in an Incremental Module, the parameter attribute ``constraints:`` **MUST NOT** be declared. VNF MUST NOT ONAP Base Module Output Parameters
R-901331 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``image`` value **MUST** be be obtained via a ``get_param``. VNF MUST Property: image
R-14447 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate`` Resource ID **MAY** use the naming convention * ``{vm-type}_RST_{index}`` where * ``{vm-type}`` is the vm-type * ``RST`` signifies that it is the Resource Service Template * ``{index}`` is is the index VNF MAY OS::ContrailV2::ServiceTemplate
R-85991 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. XNF MUST Licensing Requirements
R-71577 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a string, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_v6_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the external network * the value for ``{index}`` must start at zero (0) and increment by one VNF MUST Property: fixed_ips, Map Property: ip_address
R-56721 A VNF's Incremental Module **MAY** utilize nested heat. VNF MAY Nested Heat Orchestration Templates Overview
R-37437 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MUST** contain the key/value pair ``vnf_id`` and the value **MUST** be obtained via a ``get_param``. VNF MUST vnf_id
R-48247 The xNF **MUST** support APPC ``ConfigRestore`` command. XNF MUST Configuration Commands
R-32155 The VNFD provided by VNF vendor may use the below described TOSCA interface types. An on-boarding entity (ONAP SDC) **MUST** support them. **tosca.interfaces.nfv.vnf.lifecycle.Nfv** supports LCM operations VNF MUST Interface Types
R-32408 If a VNF's Heat Orchestration Template property ``name`` for a non ``OS::Nova::Server`` resource uses the intrinsic function ``str_replace`` in conjunction with the ONAP supplied metadata parameter ``vnf_name`` and does not create a unique value, additional data **MUST** be used in the ``str_replace`` to create a unique value, such as ``OS::stack_name`` and/or the ``OS::Heat::ResourceGroup`` ``index``. VNF MUST Resource Property “name”
R-98617 The xNF provider **MUST** provide information regarding any dependency (e.g., affinity, anti-affinity) with other xNFs and resources. XNF MUST Resource Description
R-30278 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. XNF MUST Configuration Management via NETCONF/YANG
R-46908 The VNF **MUST**, if not integrated with the Operator's Identity and Access Management system, comply with "password complexity" policy. When passwords are used, they shall be complex and shall at least meet the following password construction requirements: (1) be a minimum configurable number of characters in length, (2) include 3 of the 4 following types of characters: upper-case alphabetic, lower-case alphabetic, numeric, and special, (3) not be the same as the UserID with which they are associated or other common strings as specified by the environment, (4) not contain repeating or sequential characters or numbers, (5) not to use special characters that may have command functions, and (6) new passwords must not contain sequences of three or more characters from the previous password. VNF MUST VNF Identity and Access Management Requirements
R-47849 The xNF 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 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. XNF MUST Licensing Requirements
R-06924 The xNF **MUST** deliver asynchronous data as data becomes available, or according to the configured frequency. XNF MUST Asynchronous and Synchronous Data Delivery
R-19768 The VNF **SHOULD** support network segregation, i.e., separation of OA&M traffic from signaling and payload traffic, using technologies such as VPN and VLAN. VNF SHOULD VNF General Security Requirements
R-32981 The xNF **MUST** support APPC ``ConfigBackup`` command. XNF MUST Configuration Commands
R-03465 The xNF **MUST** release locks to prevent permanent lock-outs when the corresponding <partial-unlock> operation succeeds. XNF MUST NETCONF Server Requirements
R-58301 The xNF **SHOULD NOT** use playbooks that make requests to Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.); therefore, there is no use for Cloud specific variables like Openstack UUIDs in Ansible Playbook related artifacts. **Rationale**: Flows that require interactions with Cloud services e.g. Openstack shall rely on workflows run by an Orchestrator (Change Management) or other capability (such as a control loop or Operations GUI) outside Ansible Server which can be executed by a APPC/SDN-C. There are policies, as part of Control Loop models, that send remediation action requests to an APPC/SDN-C; these are triggered as a response to an event or correlated events published to Event Bus. XNF SHOULD NOT Ansible Playbook Requirements
R-84879 The xNF **MUST** have the capability of maintaining a primary and backup DNS name (URL) for connecting to ONAP collectors, with the ability to switch between addresses based on conditions defined by policy such as time-outs, and buffering to store messages until they can be delivered. At its discretion, the service provider may choose to populate only one collector address for a xNF. In this case, the network will promptly resolve connectivity problems caused by a collector or network failure transparently to the xNF. XNF MUST Addressing and Delivery Protocol
R-123044 The xNF Provider **MAY** require that specific events, identified by their ``eventName``, require that certain fields, which are optional in the common event format, must be present when they are published. XNF PROVIDER MUST Data Structure Specification of the Event Record
R-52870 The VNF **MUST** provide a method of metrics gathering and analysis to evaluate the resiliency of the software from both a granular as well as a holistic standpoint. This includes, but is not limited to thread utilization, errors, timeouts, and retries. VNF MUST Monitoring & Dashboard
R-03070 The xNF **MUST**, by ONAP Policy, provide the ONAP addresses as data destinations for each xNF, and may be changed by Policy while the xNF is in operation. We expect the xNF to be capable of redirecting traffic to changed destinations with no loss of data, for example from one REST URL to another, or from one TCP host and port to another. XNF MUST Addressing and Delivery Protocol
R-70276 A VNF HEAT's Orchestration Nested Template's YAML file name **MUST NOT** be in the format ``{vm-type}.y[a]ml`` where ``{vm-type}`` is defined in the Heat Orchestration Template. VNF MUST NOT Nested Heat file
R-02597 The xNF **MUST** implement the protocol operation: ``lock(target)`` - Lock the configuration data store target. XNF MUST NETCONF Server Requirements
R-24269 The xNF **SHOULD** conform its YANG model to RFC 7407, "A YANG Data Model for SNMP Configuration", if Netconf used to configure SNMP engine. XNF SHOULD NETCONF Server Requirements
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-20860 The VNF **MUST** be agnostic to the underlying infrastructure (such as hardware, host OS, Hypervisor), any requirements should be provided as specification to be fulfilled by any hardware. VNF MUST VNF Devops
R-440220 The xNF **SHOULD** support File transferring protocol, such as FTPES or SFTP, when supporting the event-driven bulk transfer of monitoring data. XNF SHOULD Bulk Performance Measurement
R-50468 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` is the instance of the the vmi on the vm-type attached to the network of ``{network-role}`` VNF MUST OS::ContrailV2::VirtualMachineInterface
R-46290 The xNF **MUST** respond to an ONAP request to deliver granular data on device or subsystem status or performance, referencing the YANG configuration model for the xNF by returning the requested data elements. XNF MUST Asynchronous and Synchronous Data Delivery
R-70757 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` is passed into a Nested YAML file, the key/value pair name ``vm_role`` **MUST NOT** change. VNF MUST NOT vm_role
R-59434 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Subnet`` Resource ID **SHOULD** use the naming convention * ``int_{network-role}_subnet_{index}`` where * ``{network-role}`` is the network-role * ``{index}`` is the ``{index}`` of the subnet of the network VNF SHOULD OS::Neutron::Subnet
R-24482 The xNF **MUST** provide Ansible playbooks that are designed to run using an inventory hosts file in a supported format; with site group that shall be used to add site specific configurations to the target xNF VM(s) as needed. XNF MUST Ansible Client Requirements
R-686466 The PNF **MUST** support sending a pnfRegistration VES event. PNF MUST PNF Plug and Play
R-36280 The xNF provider **MUST** provide documentation describing xNF Functional Capabilities that are utilized to operationalize the xNF and compose complex services. XNF MUST Resource Description
R-44001 A VNF's Heat Orchestration Template parameter declaration **MUST** contain the attribute ``description``. VNF MUST description
R-02360 The VNFC **MUST** be designed as a standalone, executable process. VNF MUST VNF Design
R-48761 The VNF **MUST** support ONAP Controller's Snapshot command. VNF MUST Virtual Function - Container Recovery Requirements
R-00098 The VNF **MUST NOT** impact the ability of the VNF to provide service/function due to a single container restart. VNF MUST NOT All Layer Redundancy
R-78569 VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``external_id:``. VNF MAY external_id
R-38001 The VNF **MUST** support ONAP Controller's **Rebuild** command. VNF MUST Virtual Function - Container Recovery Requirements
R-42874 The VNF **MUST** allow the Operator to restrict access based on the assigned permissions associated with an ID in order to support Least Privilege (no more privilege than required to perform job functions). VNF MUST VNF Identity and Access Management Requirements
R-87817 When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``comma_delimited_list``, the parameter name **MUST** follow the naming convention ``{vm-type}_names``. VNF MUST Property: Name
R-83418 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_floating_v6_ip`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT VIP Assignment, External Networks, Supported by Automation
R-51442 The xNF **SHOULD** use playbooks 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). **Note**: In case rollback at the playbook level is not supported or possible, the xNF provider shall provide alternative rollback mechanism (e.g., for a small xNF the rollback mechanism may rely on workflow to terminate and re-instantiate VNF VMs and then re-run playbook(s)). Backing up updated files is also recommended to support rollback when soft rollback is feasible. XNF SHOULD Ansible Playbook Requirements
R-02164 When a VNF's Heat Orchestration Template's Contrail resource has a property that references an external network that requires the network's Fully Qualified Domain Name (FQDN), the property parameter * **MUST** follow the format ``{network-role}_net_fqdn`` * **MUST** be declared as type ``string`` * **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File VNF MUST External Networks
R-39841 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_ip_{index}`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: ip_address
R-24997 A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to one ``{vm-type}`` Resource ID **SHOULD** use the naming convention * ``{vm-type}_keypair_{index}`` where * ``{network-role}`` is the network-role * ``{index}`` is the ``{index}`` of the keypair VNF SHOULD OS::Nova::Keypair
R-83412 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_floating_ip`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT VIP Assignment, External Networks, Supported by Automation
R-61354 The VNF **MUST** provide a mechanism (e.g., access control list) to permit and/or restrict access to services on the VNF by source, destination, protocol, and/or port. VNF MUST VNF General Security Requirements
R-15287 When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 address is being cloud assigned by OpenStack's DHCP Service and the external network IPv6 subnet is to be specified using the property ``fixed_ips`` map property ``subnet``, the parameter **MUST** follow the naming convention * ``{network-role}_v6_subnet_id`` where * ``{network-role}`` is the network role of the network. VNF MUST Property: fixed_ips, Map Property: subnet
R-36843 The VNF **MUST** support the ability of the VNFC to be deployable in multi-zoned cloud sites to allow for site support in the event of cloud zone failure or upgrades. VNF MUST All Layer Redundancy
R-17624 The PNF **MAY** support the optional parameters for Service Configuration Parameters. Note: These are detailed in the Stage 5 PnP Note: These parameters are optional, and not all PNFs will support any or all of these parameters, it is up to the vendor and service provider to ascertain which ones are supported up to an including all of the ones that have been defined. Note: It is expected that there will be a growing list of supported configuration parameters in future releases of ONAP. PNF MAY PNF Plug and Play
R-76057 VNF Heat Orchestration Template's Nested YAML file name **MUST** contain only alphanumeric characters and underscores '_' and **MUST NOT** contain the case insensitive word ``base``. VNF MUST Nested Heat file
R-49145 The xNF **MUST** implement ``:confirmed-commit`` If ``:candidate`` is supported. XNF MUST NETCONF Server Requirements
R-44318 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` parameter ``vnf_name`` **MUST NOT** have parameter constraints defined. VNF MUST NOT vnf_name
R-76901 The VNF **MUST** support a container rebuild mechanism based on existing image (e.g. Glance image in Openstack environment) or a snapshot. VNF MUST Virtual Function - Container Recovery Requirements
R-59482 A VNF's Heat Orchestration Template **MUST NOT** be VNF instance specific or cloud site specific. VNF MUST NOT Scope of a Heat Orchestration Template
R-94567 The xNF **MUST** provide Ansible playbooks that are designed to run using an inventory hosts file in a supported format with only IP addresses or IP addresses and VM/xNF names. XNF MUST Ansible Client Requirements
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-96634 The xNF provider **MUST** describe scaling capabilities to manage scaling characteristics of the xNF. XNF MUST Compute, Network, and Storage Requirements
R-343842 The VNF **MUST**, after a successful login at command line or a GUI, display the last valid login date and time and the number of unsuccessful attempts since then made with that user's ID. This requirement is only applicable when the user account is defined locally in the VNF. VNF MUST VNF General Security Requirements
R-30753 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::NetworkIpam`` Resource ID **MUST** contain the ``{network-role}``. VNF MUST OS::ContrailV2::NetworkIpam
R-82551 When a VNF's Heat Orchestration Template's resource is associated with a single ``{vm-type}`` and a single internal network, the Resource ID **MUST** contain both the ``{vm-type}`` and the ``int_{network-role}`` and - the ``{vm-type}`` **MUST** appear before the ``int_{network-role}`` and **MUST** be separated by an underscore '_' - (e.g., ``{vm-type}_int_{network-role}``, ``{vm-type}_{index}_int_{network-role}``) - note that an ``{index}`` value **MAY** separate the ``{vm-type}`` and the ``int_{network-role}`` and when this occurs underscores **MUST** separate the three values. (e.g., ``{vm-type}_{index}_int_{network-role}``). VNF MUST Resource IDs
R-16560 The VNF **SHOULD** conduct a resiliency impact assessment for all inter/intra-connectivity points in the VNF to provide an overall resiliency rating for the VNF to be incorporated into the software design and development of the VNF. VNF SHOULD Monitoring & Dashboard
R-01382 The xNF **MUST** allow the entire configuration of the xNF to be retrieved via NETCONF's <get-config> and <edit-config>, independently of whether it was configured via NETCONF or other mechanisms. XNF MUST NETCONF Server Requirements
R-59930 A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``parameter_defaults:`` section. VNF MAY Environment File Format
R-88863 A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type ``number`` **MUST** have a parameter constraint of ``range`` or ``allowed_values`` defined. VNF MUST constraints
R-88026 The xNF **MUST** include a NETCONF server enabling runtime configuration and lifecycle management capabilities. XNF MUST Configuration Management
R-70933 The VNF **MUST** provide the ability to migrate to newer versions of cryptographic algorithms and protocols with minimal impact. VNF MUST VNF Data Protection Requirements
R-99174 The VNF **MUST**, if not integrated with the Operator's Identity and Access Management system, support the creation of multiple IDs so that individual accountability can be supported. VNF MUST VNF Identity and Access Management Requirements
R-74958 The VNF **MUST** activate security alarms automatically when it detects an unsuccessful attempt to gain permissions or assume the identity of another user. VNF MUST VNF Security Analytics Requirements
R-47068 The xNF **MAY** expose a single endpoint that is responsible for all functionality. XNF MAY Chef Client Requirements
R-408813 The VNF, when publishing events, **MUST** pass all information it is able to collect even if the information field is identified as optional. However, if the data cannot be collected, then optional fields can be omitted. VNF MUST Miscellaneous
R-23035 The VNF **MUST** be designed to scale horizontally (more instances of a VNF or VNFC) and not vertically (moving the existing instances to larger VMs or increasing the resources within a VM) to achieve effective utilization of cloud resources. VNF MUST VNF Design
R-16968 A VNF's Heat Orchestration Templates **MUST NOT** include heat resources to create external networks. VNF MUST NOT External Networks
R-47061 A VNF's Heat Orchestration Template's OS::Nova::Server Resource **SHOULD** contain the metadata map value parameter 'workload_context'. VNF SHOULD workload_context
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-79107 The VNF **MUST**, if not integrated with the Operator's Identity and Access Management system, support the ability to disable the userID after a configurable number of consecutive unsuccessful authentication attempts using the same userID. VNF MUST VNF Identity and Access Management Requirements
R-49911 The xNF provider **MUST** assign a new point release to the updated playbook set. The functionality of a new playbook set must be tested before it is deployed to the production. XNF SHOULD Ansible Playbook 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-46986 The VNF **SHOULD** have source code scanned using scanning tools (e.g., Fortify) and provide reports. VNF SHOULD VNF General Security Requirements
R-76014 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceHealthCheck`` Resource ID **MUST** contain the ``{vm-type}``. VNF MUST OS::ContrailV2::ServiceHealthCheck
R-86926 A VNF's incremental module **MAY** be used for scale out only. VNF MAY ONAP VNF Modularity Overview
R-27469 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is creating a *Reserve Port* with an IPv4 address Resource ID **MUST** use the naming convention * ``reserve_port_{vm-type}_{network-role}_floating_ip_{index}`` where * ``{vm-type}`` is the vm-type * ``{network-role}`` is the network-role of the network that the port is attached to * ``{index}`` is the instance of the IPv4 *Reserve Port* for the vm-type attached to the network of ``{network-role}`` VNF MUST OS::Neutron::Port
R-54930 The VNF **MUST** implement the following input validation controls: Do not permit input that contains content or characters inappropriate to the input expected by the design. Inappropriate input, such as SQL expressions, may cause the system to execute undesirable and unauthorized transactions against the database or allow other inappropriate access to the internal network (injection attacks). VNF MUST VNF API Security Requirements
R-52530 A VNF's Heat Orchestration Template's Nested YAML file **MUST** be in the same directory hierarchy as the VNF's Heat Orchestration Templates. VNF MUST Nested Heat Template Requirements
R-90748 A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume **MAY** be defined in an Incremental Module. VNF MAY ONAP VNF Modularity Overview
R-73223 The VNF **MUST** support proactive monitoring to detect and report the attacks on resources so that the VNFs and associated VMs can be isolated, such as detection techniques for resource exhaustion, namely OS resource attacks, CPU attacks, consumption of kernel memory, local storage attacks. VNF MUST VNF Security Analytics Requirements
R-67918 The VNF **MUST** handle replication race conditions both locally and geo-located in the event of a data base instance failure to maintain service continuity. VNF MUST Application Resilient Error Handling
R-46968 VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``depends_on:``. VNF MAY depends_on
R-43740 VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``deletion_policy:``. VNF MAY deletion_policy
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-63935 The xNF **MUST** release locks to prevent permanent lock-outs when a user configured timer has expired forcing the NETCONF SSH Session termination (i.e., product must expose a configuration knob for a user setting of a lock expiration timer). XNF MUST NETCONF Server Requirements
R-86285 A VNF's Heat Orchestration template **MUST** have a corresponding environment file. VNF MUST Environment File Format
R-82481 A VNF's Heat Orchestration Template's Resource property parameter that is associated with a unique Virtual Machine type **MUST** include ``{vm-type}`` as part of the parameter name with two exceptions: 1.) The Resource ``OS::Nova::Server`` property ``availability_zone`` parameter **MUST NOT** be prefixed with a common ``{vm-type}`` identifier, 2.) The Resource ``OS::Nova::Server`` eight mandatory and optional ``metadata`` parameters (i.e., ``vnf_name``, ``vnf_id``, ``vf_module_id``, ``vf_module_name``, ``vm_role``, ``vf_module_index``, ``environment_context``, ``workload_context``) **MUST NOT** be prefixed with a common ``{vm-type}`` identifier. VNF MUST {vm-type}
R-34055 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``workload_context`` parameter ``workload_context`` **MUST NOT** have parameter constraints defined. VNF MUST NOT workload_context
R-81214 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InterfaceRouteTable`` Resource ID **MUST** contain the ``{network-role}``. VNF MUST OS::ContrailV2::InterfaceRouteTable
R-94084 The xNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command. XNF MUST Configuration Commands
R-16447 A VNF's <resource ID> **MUST** be unique across all Heat Orchestration Templates and all HEAT Orchestration Template Nested YAML files that are used to create the VNF. VNF MUST resource ID
R-69588 When a VNF's Heat Orchestration Template's Virtual Machine (i.e., ``OS::Nova::Server`` Resource) boots from Cinder Volume, the ``OS::Nova::Server`` resource property ``block_device_mapping`` or ``block_device_mapping_v2`` **MUST** be used. VNF MUST Boot Options
R-22888 The xNF provider **MUST** provide documentation for the xNF Policy Description to manage the xNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the xNF. XNF MUST Resource Control Loop
R-93030 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_v6_ips`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: ip_address
R-65641 The xNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command. XNF MUST Lifecycle Management Related Commands
R-07617 The VNF **MUST** log success and unsuccessful creation, removal, or change to the inherent privilege level of users. VNF MUST VNF Security Analytics Requirements
R-91810 If a VNF requires ONAP to assign a Virtual IP (VIP) Address to ports connected an external network, the port **MUST NOT** have more than one IPv4 VIP address. VNF MUST NOT VIP Assignment, External Networks, Supported by Automation
R-10353 The xNF **MUST** conform its YANG model to RFC 6244, "An Architecture for Network Management Using NETCONF and YANG". XNF MUST NETCONF Server Requirements
R-79952 The VNF **SHOULD** support container snapshots if not for rebuild and evacuate for rollback or back out mechanism. VNF SHOULD All Layer Redundancy
R-28980 A VNF's incremental module **MAY** be used for initial VNF deployment only. VNF MAY ONAP VNF Modularity Overview
R-50436 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``flavor`` parameter **MUST** be declared as type: ``string``. VNF MUST Property: flavor
R-59610 The xNF **MUST** implement the data model discovery and download as defined in [RFC6022]. XNF MUST NETCONF Server Requirements
R-62187 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv4 Address on a port attached to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` is the index of the IPv4 address VNF MUST OS::ContrailV2::InstanceIp
R-82732 A VNF Heat Orchestration Template's Cinder Volume Module **MUST** be named identical to the base or incremental module it is supporting with ``_volume`` appended. VNF MUST Cinder Volume Modules
R-821839 The xNF **MUST** deliver event records to ONAP using the common transport mechanisms and protocols defined in this document. XNF MUST Transports and Protocols Supporting Resource Interfaces
R-08775 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that is applicable to one ``{vm-type}`` and more than one network (internal and/or external) Resource ID **SHOULD** use the naming convention * ``{vm-type}_security_group`` where * ``{vm-type}`` is the vm-type VNF SHOULD OS::Neutron::SecurityGroup
R-87004 A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` Resource ID **SHOULD** use the naming convention * ``{vm-type}_volume_{index}`` where * ``{vm-type}`` is the vm-type * ``{index}`` starts at zero and increments by one VNF SHOULD OS::Cinder::Volume
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-79817 A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type ``comma_delimited_list`` **MAY** have a parameter constraint defined. VNF MAY constraints
R-92866 The xNF **MUST** include as part of post-instantiation configuration done by Ansible Playbooks the removal/update of the SSH public key from /root/.ssh/authorized_keys, and update of SSH keys loaded through instantiation to support Ansible. This may include creating Mechanized user ID(s) used by the Ansible Server(s) on VNF VM(s) and uploading and installing new SSH keys used by the mechanized use ID(s). XNF MUST Ansible Client Requirements
R-20353 The xNF **MUST** implement both ``:candidate`` and ``:writable-running`` capabilities. When both ``:candidate`` and ``:writable-running`` are provided then two locks should be supported. XNF MUST NETCONF Server Requirements
R-62170 The xNF **MUST** over-ride any default values for configurable parameters that can be set by ONAP in the roles, cookbooks and recipes. XNF MUST Chef Roles/Requirements
R-21322 The VNF provider **MUST** provide their testing scripts to support testing as specified in ETSI NFV-SOL004 - Testing directory in CSAR VNF MUST VNF Package Contents
R-22286 The VNF **MUST** support Integration functionality via API/Syslog/SNMP to other functional modules in the network (e.g., PCRF, PCEF) that enable dynamic security control by blocking the malicious traffic or malicious end users. VNF MUST VNF Security Analytics Requirements
R-07507 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_id`` parameter **MUST** be declared as ``vnf_id`` and the parameter **MUST** be defined as type: ``string``. VNF MUST vnf_id
R-75608 The xNF provider **MUST** provide playbooks to be loaded on the appropriate Ansible Server. XNF MUST Configuration Management via Ansible
R-44569 The xNF provider **MUST NOT** require additional infrastructure such as a xNF provider license server for xNF provider functions and metrics. XNF MUST NOT Licensing Requirements
R-32636 The VNF **MUST** support API-based monitoring to take care of the scenarios where the control interfaces are not exposed, or are optimized and proprietary in nature. VNF MUST VNF Security Analytics Requirements
R-83015 A VNF's ``{network-role}`` assigned to an external network **MUST** be different than the ``{network-role}`` assigned to the VNF's internal networks, if internal networks exist. VNF MUST External Networks
R-40499 Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** have a unique parameter name for the ``OS::Nova::Server`` property ``flavor`` even if more than one ``{vm-type}`` shares the same flavor. VNF MUST Property: flavor
R-908291 The XNF **MAY** leverage bulk xNF telemetry transmission mechanism, as depicted in Figure 4, in instances where other transmission methods are not practical or advisable. XNF MAY Bulk Telemetry Transmission
R-23882 The VNF **SHOULD** provide the capability for the Operator to run security vulnerability scans of the operating system and all application layers. VNF SHOULD VNF General Security Requirements
R-303569 The VNF **MUST** log the Source IP address in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-93860 The VNF **SHOULD** provide the capability to integrate with an external encryption service. VNF SHOULD VNF Cryptography Requirements
R-28189 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InterfaceRouteTable`` Resource ID **MAY** use the naming convention * ``{network-role}_RIRT`` where * ``{network-role}`` is the network-role * ``RIRT`` signifies that it is the Resource Interface Route Table VNF MAY OS::ContrailV2::InterfaceRouteTable
R-44281 The xNF **MUST** implement the protocol operation: ``edit-config(target, default-operation, test-option, error-option, config)`` - Edit the target configuration data store by merging, replacing, creating, or deleting new config elements. XNF MUST NETCONF Server Requirements
R-43413 A VNF **MUST** utilize a modular Heat Orchestration Template design to support scaling (growth/de-growth). VNF MUST Support of heat stack update
R-48698 The xNF **MUST** utilize information from key value pairs that will be provided by the Ansible Server as "extra-vars" during invocation to execute the desired xNF action. The "extra-vars" attribute-value pairs are passed to the Ansible Server by an APPC/SDN-C as part of the Rest API request. If the playbook requires files, they must also be supplied using the methodology detailed in the Ansible Server API, unless they are bundled with playbooks, example, generic templates. Any files containing instance specific info (attribute-value pairs), not obtainable from any ONAP inventory databases or other sources, referenced and used an input by playbooks, shall be provisioned (and distributed) in advance of use, e.g., xNF instantiation. Recommendation is to avoid these instance specific, manually created in advance of instantiation, files. XNF MUST Ansible Playbook Requirements
R-58670 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``image`` parameter name **MUST** follow the naming convention ``{vm-type}_image_name``. VNF MUST Property: image
R-84322 A VNF's Heat Orchestration Template's Resource property parameter that is associated with an internal network **MUST** include ``int_{network-role}`` as part of the parameter name, where ``int_`` is a hard coded string. VNF MUST {network-role}
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-92635 A VNF's Heat Orchestration Template **MUST** be compliant with the OpenStack Template Guide. MUST ONAP Heat Orchestration Template Format
R-703767 The VNF **MUST** have the capability to securely transmit the security logs and security events to a remote system before they are purged from the system. VNF MUST VNF Security Analytics Requirements
R-98391 The VNF **MUST**, if not integrated with the Operator's Identity and Access Management system, support Role-Based Access Control to enforce least privilege. VNF MUST VNF Identity and Access Management Requirements
R-332680 The xNF **SHOULD** deliver all syslog messages to the VES Collector per the specifications in Monitoring and Management chapter. XNF SHOULD Asynchronous and Synchronous Data Delivery
R-68200 The xNF **MUST** support the ``:url`` value to specify protocol operation source and target parameters. The capability URI for this feature will indicate which schemes (e.g., file, https, sftp) that the server supports within a particular URL value. The 'file' scheme allows for editable local configuration databases. The other schemes allow for remote storage of configuration databases. XNF MUST NETCONF Server Requirements
R-93496 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter associated with an internal network, i.e., * ``{vm-type}_int_{network-role}_ip_{index}`` * ``{vm-type}_int_{network-role}_v6_ip_{index}`` * ``{vm-type}_int_{network-role}_ips`` * ``{vm-type}_int_{network-role}_v6_ips`` **MUST** be enumerated in the Heat Orchestration Template's Environment File and IP addresses **MUST** be assigned. VNF MUST Property: fixed_ips, Map Property: ip_address
R-77334 The VNF **MUST** allow configurations and configuration parameters to be managed under version control to ensure consistent configuration deployment, traceability and rollback. VNF MUST Application Configuration Management
R-52499 The VNF **MUST** meet their own resiliency goals and not rely on the Network Cloud. VNF MUST All Layer Redundancy
R-24893 A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``event_sinks:`` section. VNF MAY Environment File Format
R-24359 The VNF **MUST** provide the capability of testing the validity of a digital certificate by validating the date the certificate is being used is within the validity period for the certificate. VNF MUST VNF Cryptography Requirements
R-23957 The VNF **MUST** include the field "time" in the Security alarms (where applicable and technically feasible). VNF MUST VNF Security Analytics Requirements
R-58370 The VNF **SHOULD** operate with anti-virus software which produces alarms every time a virus is detected. VNF SHOULD VNF Security Analytics Requirements
R-88031 The xNF **SHOULD** implement the protocol operation: ``delete-config(target)`` - Delete the named configuration data store target. XNF SHOULD NETCONF Server Requirements
R-17334 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that is applicable to one ``{vm-type}`` and one external network Resource ID **SHOULD** use the naming convention * ``{vm-type}_{network-role}_security_group`` where * ``{vm-type}`` is the vm-type * ``{network-role}`` is the network-role VNF SHOULD OS::Neutron::SecurityGroup
R-120182 The xNF provider **MUST** indicate specific conditions that may arise, and recommend actions that may be taken at specific thresholds, or if specific conditions repeat within a specified time interval, using the semantics and syntax described by the :doc:`VES Event Registration specification<../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>`. XNF PROVIDER MUST Data Structure Specification of the Event Record
R-106240 The following VES Events **MUST** be supported by the PNF: pnfRegistration VES Event, HVol VES Event, and Fault VES Event. These are onboarded via he SDC Design Studio. Note: these VES Events are emitted from the PNF to support PNF Plug and Play, High Volume Measurements, and Fault events respectively. PNF MUST PNF Plug and Play
R-73468 The xNF **MUST** allow the NETCONF server connection parameters to be configurable during virtual machine instantiation through Heat templates where SSH keys, usernames, passwords, SSH service and SSH port numbers are Heat template parameters. XNF MUST NETCONF Server Requirements
R-15189 A VNF's Heat Orchestration Template's Resource ``OS::Nova::ServerGroup`` Resource ID **MAY** use the naming convention * ``{vm-type}_RSG`` or * ``{vm-type}_Server_Grp`` or * ``{vm-type}_ServerGroup`` or * ``{vm-type}_servergroup`` VNF MAY OS::Nova::ServerGroup
R-74304 A VNF's Heat Orchestration Template's Environment file extension **MUST** be in the lower case format ``.env``. VNF MUST ONAP Heat Orchestration Template Filenames
R-31141 VNF Heat Orchestration Template's Cinder Volume Module's Environment File **MUST** be named identical to the VNF Heat Orchestration Template's Cinder Volume Module with ``.y[a]ml`` replaced with ``.env``. VNF MUST Cinder Volume Modules
R-99656 The VNF **MUST** NOT terminate stable sessions if a VNFC instance fails. VNF MUST VNF Design
R-20974 At orchestration time, the VNF's Base Module **MUST** be deployed first, prior to any incremental modules. VNF MUST ONAP VNF Modularity Overview
R-98374 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id`` **MUST NOT** have parameter constraints defined. VNF MUST NOT vf_module_id
R-638682 The VNF **MUST** log any security event required by the VNF Requirements to Syslog using LOG_AUTHPRIV for any event that would contain sensitive information and LOG_AUTH for all other relevant events. VNF MUST VNF General Security Requirements
R-62954 If a VNF's Heat Orchestration Template's ``OS::Nova::Server Resource`` ``metadata`` map value parameter ``environment_context`` is passed into a Nested YAML file, the parameter name ``environment_context`` **MUST NOT** change. VNF MUST NOT environment_context
R-10173 The xNF **MUST** allow another NETCONF session to be able to initiate the release of the lock by killing the session owning the lock, using the <kill-session> operation to guard against hung NETCONF sessions. XNF MUST NETCONF Server Requirements
R-76449 A VNF's Heat Orchestration Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIPAssociation``. VNF MUST NOT VIP Assignment, External Networks, Supported by Automation
R-40971 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a string, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` * ``{network-role}`` is the {network-role} of the external network * the value for ``{index}`` must start at zero (0) and increment by one VNF MUST Property: fixed_ips, Map Property: ip_address
R-36792 The VNF **MUST** automatically retry/resubmit failed requests made by the software to its downstream system to increase the success rate. VNF MUST Application Resilient Error Handling
R-570134 The events produced by the xNF **MUST** must be compliant with the common event format defined in the :doc:`VES Event Listener<../../../../vnfsdk/model.git/docs/files/VESEventListener_7_0_1>` specification. XNF MUST Data Structure Specification of the Event Record
R-76682 If a VNF's Heat Orchestration Template ``OS::ContrailV2::InterfaceRouteTable`` resource ``interface_route_table_routes`` property ``interface_route_table_routes_route`` map property parameter ``{vm-type}_{network-role}_route_prefixes`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Interface Route Table Prefixes for Contrail InterfaceRoute Table
R-51430 The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter **MUST** be declared as either type ``string`` or type ``comma_delimited_list``. VNF MUST Property: Name
R-231402 The VNF **MUST** provide a means for the user to explicitly logout, thus ending that session for that authenticated user. VNF MUST VNF Identity and Access Management Requirements
R-62590 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter associated with an external network, i.e., * ``{vm-type}_{network-role}_ip_{index}`` * ``{vm-type}_{network-role}_v6_ip_{index}`` * ``{vm-type}_{network-role}_ips`` * ``{vm-type}_{network-role}_v6_ips`` **MUST NOT** be enumerated in the Heat Orchestration Template's Environment File. ONAP provides the IP address assignments at orchestration time. VNF MUST NOT Property: fixed_ips, Map Property: ip_address
R-02170 The VNF **MUST** use, whenever possible, standard implementations of security applications, protocols, and formats, e.g., S/MIME, TLS, SSH, IPSec, X.509 digital certificates for cryptographic implementations. These implementations must be purchased from reputable vendors or obtained from reputable open source communities and must not be developed in-house. VNF MUST VNF Data Protection Requirements
R-03595 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that is applicable to more than one ``{vm-type}`` and one external network Resource ID **SHOULD** use the naming convention * ``{network-role}_security_group`` where * ``{network-role}`` is the network-role VNF SHOULD OS::Neutron::SecurityGroup
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-31809 The xNF **MUST** support the HealthCheck RPC. The HealthCheck RPC executes a xNF Provider-defined xNF HealthCheck over the scope of the entire xNF (e.g., if there are multiple VNFCs, then run a health check, as appropriate, for all VNFCs). It returns a 200 OK if the test completes. A JSON object is returned indicating state (healthy, unhealthy), scope identifier, time-stamp and one or more blocks containing info and fault information. If the xNF is unable to run the HealthCheck, return a standard http error code and message. XNF MUST REST APIs
R-02997 The VNF **MUST** preserve their persistent data. Running VMs will not be backed up in the Network Cloud infrastructure. VNF MUST VNF Devops
R-257367 The xNF, when leveraging Google Protocol Buffers for events, **MUST** serialize the events using native Google Protocol Buffers (GPB) according to the following guidelines: * The keys are represented as integers pointing to the system resources for the xNF being monitored * The values correspond to integers or strings that identify the operational state of the VNF resource, such a statistics counters and the state of an xNF resource. * The required Google Protocol Buffers (GPB) metadata is provided in the form of .proto files. XNF MUST Google Protocol Buffers (GPB)
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-70964 If a VNF's Port is attached to an internal network and the port's IP addresses are statically assigned by the VNF's Heat Orchestration\ Template (i.e., enumerated in the Heat Orchestration Template's environment file), the ``OS::Neutron::Port`` Resource's * property ``fixed_ips`` map property ``ip_address`` **MUST** be used * property ``fixed_ips`` map property ``subnet`` **MUST NOT** be used VNF MUST NOT Items to Note
R-69014 When a VNF connects to an external network, a network role, referred to as the ``{network-role}`` **MUST** be assigned to the external network for use in the VNF's Heat Orchestration Template. VNF MUST External Networks
R-04747 A VNF's Heat Orchestration Template's Resource ``OS::Heat::CloudConfig`` Resource ID **MUST** contain the ``{vm-type}``. VNF MUST OS::Heat::CloudConfig
R-22688 If a VNF's port is connected to an internal network and the port is created in an Incremental Module and the internal network is created in the Base Module then the UUID of the internal network **MUST** be exposed as a parameter in the ``outputs:`` section of the Base Module and the port resource **MUST** use a ``get_param`` to obtain the network UUID. VNF MUST Internal Networks
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
R-29765 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv6 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``comma_delimited_list``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_v6_ips`` where * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` * ``{network-role}`` is the {network-role} of the internal network VNF MUST Property: fixed_ips, Map Property: ip_address
R-29760 The VNFC **MUST** be installed on non-root file systems, unless software is specifically included with the operating system distribution of the guest image. VNF MUST VNF Devops
R-79412 The xNF **MAY** use another option which is expected to include TCP for high volume streaming asynchronous data sets and for other high volume data sets. TCP delivery can be used for either JSON or binary encoded data sets. XNF MAY Addressing and Delivery Protocol
R-46527 A VNFD is a deployment template which describes a VNF in terms of deployment and operational behavior requirements. It contains virtualized resources (nodes) requirements as well as connectivity and interfaces requirements and **MUST** comply with info elements specified in ETSI GS NFV-IFA 011. The main parts of the VNFD are the following: - VNF topology: it is modeled in a cloud agnostic way using virtualized containers and their connectivity. Virtual Deployment Units (VDU) describe the capabilities of the virtualized containers, such as virtual CPU, RAM, disks; their connectivity is modeled with VDU Connection Point Descriptors (VduCpd), Virtual Link Descriptors (VnfVld) and VNF External Connection Point Descriptors (VnfExternalCpd); - VNF deployment aspects: they are described in one or more deployment flavours, including configurable parameters, instantiation levels, placement constraints (affinity / antiaffinity), minimum and maximum VDU instance numbers. Horizontal scaling is modeled with scaling aspects and the respective scaling levels in the deployment flavours; **Note**: The deployment aspects (deployment flavour etc.) are postponed for future ONAP releases. - VNF lifecycle management (LCM) operations: describes the LCM operations supported per deployment flavour, and their input parameters; Note, thatthe actual LCM implementation resides in a different layer, namely referring to additional template artifacts. VNF MUST General
R-45188 The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property ``flavor`` parameter name **MUST** follow the naming convention ``{vm-type}_flavor_name``. VNF MUST Property: flavor
R-27078 A VNF's Heat Orchestration template **MUST** contain the section ``heat_template_version:``. VNF MUST heat_template_version
R-14198 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that is applicable to one {vm-type} and one internal network Resource ID **SHOULD** use the naming convention * ``{vm-type}_int_{network-role}_security_group`` where * ``{vm-type}`` is the vm-type * ``{network-role}`` is the network-role VNF SHOULD OS::Neutron::SecurityGroup
R-54373 The xNF **MUST** have Python >= 2.6 on the endpoint VM(s) of a xNF on which an Ansible playbook will be executed. XNF MUST Ansible Client Requirements
R-520802 The xNF provider **MUST** provide a YAML file formatted in adherence with the :doc:`VES Event Registration specification<../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>` that defines the following information for each event produced by the VNF: * ``eventName`` * Required fields * Optional fields * Any special handling to be performed for that event XNF PROVIDER MUST Data Structure Specification of the Event Record
R-33280 The xNF **MUST NOT** use any instance specific parameters in a playbook. XNF MUST NOT Ansible Playbook Requirements
R-92207 The VNF **SHOULD** provide a mechanism that enables the operators to perform automated system configuration auditing at configurable time intervals. VNF SHOULD VNF General Security Requirements
R-19082 The VNF **MUST** allow the Operator to disable or remove any security testing tools or programs included in the VNF, e.g., password cracker, port scanner. VNF MUST VNF General Security Requirements
R-28168 The VNF **SHOULD** use an appropriately configured logging level that can be changed dynamically, so as to not cause performance degradation of the VNF due to excessive logging. VNF SHOULD Monitoring & Dashboard
R-04344 A VNF's Nested YAML file **MAY** be invoked by more than one of a VNF's Heat Orchestration Templates (when the VNF is composed of two or more Heat Orchestration Templates). VNF MAY Nested Heat Template Requirements
R-95864 The VNF **MUST** support digital certificates that comply with X.509 standards. VNF MUST VNF Data Protection Requirements
R-06668 The VNF **MUST** handle the start or restart of VNFC instances in any order with each VNFC instance establishing or re-establishing required connections or relationships with other VNFC instances and/or VNFs required to perform the VNF function/role without requiring VNFC instance(s) to be started/restarted in a particular order. VNF MUST Application Resilient Error Handling
R-45856 The xNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command. XNF MUST Lifecycle Management Related Commands
R-65516 A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to all Virtual Machines in the the VNF, the Resource ID **SHOULD** use the naming convention * ``{vnf-type}_keypair`` where * ``{vnf-type}`` describes the VNF VNF SHOULD OS::Nova::Keypair
R-84457 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::PortTuple`` Resource ID **MAY** use the naming convention * ``{vm-type}_RPT`` where * ``{vm-type}`` is the vm-type * ``RPT`` signifies that it is the Resource Port Tuple VNF MAY OS::ContrailV2::PortTuple
R-50252 The xNF **MUST** write to a response file in JSON format that will be retrieved and made available by the Ansible Server if, as part of a xNF action (e.g., audit), a playbook is required to return any xNF information/response. The text files must be written in the main playbook home directory, in JSON format. The JSON file must be created for the xNF with the name '<xNF name>_results.txt'. All playbook output results, for all xNF VMs, to be provided as a response to the request, must be written to this response file. XNF MUST Ansible Playbook Requirements
R-54876 The below table describes the data types used for LCM configuration and is based on TOSCA constructs specified in draft GS NFV-SOL 001. The LCM configuration data elements used in VNFD **MUST** comply with the below table. VNF MUST Data Types
R-32641 The VNF **MUST** provide the capability to encrypt data on non-volatile memory.Non-volative memory is storage that is capable of retaining data without electrical power, e.g. Complementary metal-oxide-semiconductor (CMOS) or hard drives. VNF MUST VNF Data Protection Requirements
R-96983 A VNF's Heat Orchestration Template's Resource ID that is associated with an internal network **MUST** include ``int_{network-role}`` as part of the Resource ID, where ``int_`` is a hard coded string. VNF MUST {network-role}
R-32394 A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource property parameter names **MUST** be the same case. VNF MUST {vm-type}
R-89474 The VNF **MUST** log the field "Login ID" in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-26124 If a VNF Heat Orchestration Template parameter has a default value, it **MUST** be enumerated in the environment file. VNF MUST default
R-87123 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_v6_ip_{index}`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: ip_address
R-02691 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``workload_context`` parameter ``workload_context`` **MUST NOT** be enumerated in the Heat Orchestration Template's environment file. VNF MUST NOT workload_context
R-19922 The xNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command. XNF MUST Lifecycle Management Related Commands
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-659655 The xNF **SHOULD** leverage the JSON-driven model, as depicted in Figure 2, for data delivery unless there are specific performance or operational concerns agreed upon by the Service Provider that would warrant using an alternate model. XNF SHOULD xNF Telemetry using VES/JSON Model
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-14853 The VNF **MUST** respond to a "move traffic" [#4.5.2]_ command against a specific VNFC, moving all existing session elsewhere with minimal disruption if a VNF provides a load balancing function across multiple instances of its VNFCs. Note: Individual VNF performance aspects (e.g., move duration or disruption scope) may require further constraints. VNF MUST VNF Devops
R-55478 The VNF **MUST** log logoffs. VNF MUST VNF Security Analytics Requirements
R-23740 The VNF **MUST** implement and enforce the principle of least privilege on all protected interfaces. VNF MUST VNF General Security Requirements
R-40518 A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type ``string`` **MAY** have a parameter constraint defined. VNF MAY constraints
R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG <https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be translated to and from JSON{RFC7951]. YANG configuration and content can be represented via JSON, consistent with Avro, as described in "Encoding and Serialization" section. XNF SHOULD Asynchronous and Synchronous Data Delivery
R-91497 A VNF's incremental module **MAY** be used for both deployment and scale out. VNF MAY ONAP VNF Modularity Overview
R-90007 The xNF **MUST** implement the protocol operation: ``close-session()`` - Gracefully close the current session. XNF MUST NETCONF Server Requirements
R-39650 The VNF **SHOULD** provide the ability to test incremental growth of the VNF. VNF SHOULD VNF Devops
R-27970 When a VNF's Heat Orchestration Template's resource is associated with more than one ``{vm-type}`` and/or more than one internal and/or external network, the Resource ID **MAY** contain the term ``shared`` and/or **MAY** contain text that identifies the VNF. VNF MAY Resource IDs
R-56718 The PNF Vendor **MAY** provide software version(s) to be supported by PNF for SDC Design Studio PNF Model. This is set in the PNF Model property software_versions. PNF MAY PNF Plug and Play
R-06327 The VNF **MUST** respond to a "drain VNFC" [#4.5.2]_ command against a specific VNFC, preventing new session from reaching the targeted VNFC, with no disruption to active sessions on the impacted VNFC, if a VNF provides a load balancing function across multiple instances of its VNFCs. This is used to support scenarios such as proactive maintenance with no user impact. VNF MUST VNF Devops
R-94669 If a VNF has one IPv6 OAM Management IP Address and the IP Address needs to be inventoried in ONAP's A&AI database, an output parameter **MUST** be declared in only one of the VNF's Heat Orchestration Templates and the parameter **MUST** be named ``oam_management_v6_address``. VNF MUST OAM Management IP Addresses
R-479386 The VNF **MUST NOT** display "Welcome" notices or messages that could be misinterpreted as extending an invitation to unauthorized users. VNF MUST NOT VNF Identity and Access Management Requirements
R-844011 The VNF MUST not store authentication credentials to itself in clear text or any reversible form and must use salting. VNF MUST VNF Identity and Access Management Requirements
R-37929 The xNF **MUST** accept all necessary instance specific data from the environment or node object attributes for the xNF in roles/cookbooks/recipes invoked for a xNF action. XNF MUST Chef Roles/Requirements
R-18525 The xNF provider **MUST** provide a JSON file for each supported action for the xNF. 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. XNF MUST Configuration Management via Chef
R-33904 The xNF Package **MUST** include documentation for each KPI, provide lower and upper limits. XNF MUST Resource Control Loop
R-62983 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), the ``network`` parameter name **MUST** * follow the naming convention ``{network-role}_net_id`` if the Neutron network UUID value is used to reference the network * follow the naming convention ``{network-role}_net_name`` if the OpenStack network name is used to reference the network. where ``{network-role}`` is the network-role of the external network and a ``get_param`` **MUST** be used as the intrinsic function. VNF MUST Property: network
R-78282 The xNF **MUST** conform to the NETCONF RFC 6242, "Using the Network Configuration Protocol over Secure Shell". XNF MUST NETCONF Server Requirements
R-27995 The VNF **SHOULD** include control loop mechanisms to notify the consumer of the VNF of their exceeding SLA thresholds so the consumer is able to control its load against the VNF. VNF SHOULD Intelligent Transaction Distribution & Management
R-33946 The xNF **MUST** conform to the NETCONF RFC 4741, "NETCONF Configuration Protocol". XNF MUST NETCONF Server Requirements
R-67386 A VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``metadata``. VNF MUST metadata
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-98748 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter **MUST** be declared as type ``string``. VNF MUST VIP Assignment, External Networks, Supported by Automation
R-89913 A VNF's Heat Orchestration Template's Cinder Volume Module Output Parameter(s) **MUST** include the UUID(s) of the Cinder Volumes created in template, while others **MAY** be included. VNF MUST ONAP Volume Module Output Parameters
R-34037 The VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter **MUST** be declared as either type ``string`` or type ``comma_delimited_list``. VNF MUST Property: fixed_ips, Map Property: ip_address
R-97293 The xNF provider **MUST NOT** require audits of Service Provider's business. XNF MUST NOT Licensing Requirements
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-69874 A VNF's ``{network-role}`` assigned to an internal network **MUST** be different than the ``{network-role}`` assigned to the VNF's external networks. VNF MUST Internal Networks
R-86758 The VNF **SHOULD** provide an automated test suite to validate every new version of the software on the target environment(s). The tests should be of sufficient granularity to independently test various representative VNF use cases throughout its lifecycle. Operations might choose to invoke these tests either on a scheduled basis or on demand to support various operations functions including test, turn-up and troubleshooting. VNF SHOULD VNF Devops
R-32094 A VNF's Heat Orchestration Template parameter declaration **MAY** contain the attribute ``label:``. VNF MAY label
R-75343 The VNF **MUST** provide the capability of testing the validity of a digital certificate by recognizing the identity represented by the certificate - the "distinguished name". VNF MUST VNF Cryptography Requirements
R-73285 The xNF **MUST** must encode, address and deliver the data as described in the previous paragraphs. XNF MUST Asynchronous and Synchronous Data Delivery
R-83790 The xNF **MUST** implement the ``:validate`` capability. XNF MUST NETCONF Server Requirements
R-90526 A VNF Heat Orchestration Template parameter declaration **MUST NOT** contain the ``default`` attribute. VNF MUST default
R-60106 The xNF **MUST** implement the protocol operation: ``get(filter)`` - Retrieve (a filtered subset of) the running configuration and device state information. This should include the list of xNF supported schemas. XNF MUST NETCONF Server Requirements
R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by the ONAP configuration subsystem for synchronous communication. XNF MUST Asynchronous and Synchronous Data Delivery
R-809261 The PNF **MUST** use a IP address to contact ONAP. Note: it is expected that an ONAP operator can ascertain the ONAP IP address or the security gateway to reach ONAP on the VID or ONAP portal GUI. Note: The ONAP contact IP address has been previously configured and provisioned prior to this step. Note: The ONAP IP address could be provisioned or resolved through FQDN & DNS. PNF MUST PNF Plug and Play
R-43353 The xNF **MUST** return control from Ansible Playbooks only after all tasks performed by playbook are fully complete, signaling that the playbook completed all tasks. When starting services, return control only after all services are up. This is critical for workflows where the next steps are dependent on prior tasks being fully completed. XNF MUST Ansible Playbook Requirements
R-23503 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``comma_delimited_list``, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_v6_ips`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the external network VNF MUST Property: fixed_ips, Map Property: ip_address
R-97345 The xNF **MUST** permit authentication, using root account, only right after instantiation and until post-instantiation configuration is completed. XNF MUST Ansible Client Requirements
R-69634 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``subnet`` parameter ``int_{network-role}_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Property: fixed_ips, Map Property: subnet
R-97343 The xNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command. XNF MUST Lifecycle Management Related Commands
R-74763 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/casablanca/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>`__) XNF MUST Resource Control Loop
R-03656 A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig`` Resource ID **MAY** use the naming convention * ``{vm-type}_RSC`` where * ``{vm-type}`` is the vm-type * ``RSC`` signifies that it is the Resource Software Config VNF MAY OS::Heat::SoftwareConfig
R-20741 The xNF **MUST** support APPC/SDN-C ``Configure`` command. XNF MUST Configuration Commands
R-16777 The xNF provider **MUST** provide a JSON file for each supported action for the xNF. 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. XNF MUST Configuration Management via Ansible
R-88199 The VNF **MUST** utilize a persistent datastore service that can meet the data performance/latency requirements. (For example: Datastore service could be a VNFC in VNF or a DBaaS in the Cloud execution environment) VNF MUST VNF Design
R-13194 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``environment_context`` **MUST NOT** be enumerated in the Heat Orchestration Template's environment file. VNF MUST NOT environment_context
R-13196 A VNF **MAY** be composed of zero to many Incremental Modules. VNF MAY ONAP VNF Modularity Overview
R-35735 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 Virtual IP (VIP) address is assigned via ONAP automation using the property ``allowed_address_pairs`` map property ``ip_address``, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_floating_v6_ip`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the external network And the parameter **MUST** be declared as type ``string``. VNF MUST VIP Assignment, External Networks, Supported by Automation
R-23135 The VNF **MUST**, if not integrated with the Operator's identity and access management system, authenticate all access to protected GUIs, CLIs, and APIs. VNF MUST VNF Identity and Access Management Requirements
R-48470 The VNF **MUST** support Real-time detection and notification of security events. VNF MUST VNF Security Analytics Requirements
R-36982 A VNF's Heat Orchestration template **MAY** contain the ``outputs:`` section. VNF MAY outputs
R-56904 The VNF **MUST** interoperate with the ONAP (SDN) Controller so that it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual routing and forwarding rules. VNF MUST VNF General Security Requirements
R-38236 The VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``subnet`` parameter **MUST** be declared type ``string``. VNF MUST Property: fixed_ips, Map Property: subnet
R-707977 When the PNF receives a Service configuration from ONAP, the PNF **MUST** cease sending the pnfRegistration VES Event. PNF MUST PNF Plug and Play
R-66729 A VNF's Heat Orchestration Template's Resource that is associated with a unique Virtual Machine type **MUST** include ``{vm-type}`` as part of the resource ID. VNF MUST {vm-type}
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-43332 The VNF **MUST** activate security alarms automatically when it detects the successful modification of a critical system or application file. VNF MUST VNF Security Analytics Requirements
R-28795 The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` map property ``ip_address`` parameter ``{vm-type}_int_{network-role}_ip_{index}`` **MUST** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST Property: fixed_ips, Map Property: ip_address
R-82018 The xNF **MUST** load the Ansible Server SSH public key onto xNF VM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative, is for Ansible Server SSH public key to be loaded onto xNF VM(s) under /home/<Mechanized user ID>/.ssh/authorized_keys as part of instantiation, when a Mechanized user ID is created during instantiation, and Configure and all playbooks are designed to use a mechanized user ID only for authentication (never using root authentication during Configure playbook run). This will allow the Ansible Server to authenticate to perform post-instantiation configuration without manual intervention and without requiring specific xNF login IDs and passwords. *CAUTION*: For xNFs configured using Ansible, to eliminate the need for manual steps, post-instantiation and pre-configuration, to upload of SSH public keys, SSH public keys loaded during (heat) instantiation shall be preserved and not removed by (heat) embedded (userdata) scripts. XNF MUST Ansible Client Requirements
R-32025 When a VNF creates two or more internal networks, each internal network **MUST** be assigned a unique ``{network-role}`` in the context of the VNF for use in the VNF's Heat Orchestration Template. VNF MUST Internal Networks
R-62498 The VNF **MUST** support encrypted access protocols, e.g., TLS, SSH, SFTP. VNF MUST VNF General Security Requirements
R-00011 A VNF's Heat Orchestration Template's parameter defined in a nested YAML file **MUST NOT** have a parameter constraint defined. VNF MUST NOT constraints
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-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-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-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-49177 If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` is passed into a Nested YAML file, the key/value pair name ``vf_module_name`` **MUST NOT** change. VNF MUST vf_module_name
R-70112 A VNF's Heat Orchestration Template **MUST** reference a Nested YAML file by name. The use of ``resource_registry`` in the VNF's Heat Orchestration Templates Environment File **MUST NOT** be used. VNF MUST Nested Heat Template Requirements