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-717227 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 Virtual IP (VIP) address is assigned using the property ``allowed_address_pairs`` map property ``ip_address``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{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`` and **MUST** be enumerated in the environment file. OR the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_floating_ips`` 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: comma_delimited_list`` and **MUST** be enumerated in the environment file. VNF MUST VIP Assignment, Internal Networks
R-86235 The VNF or PNF Package **MUST** include documentation about the monitoring parameters that must include latencies, success rates, retry rates, load and quality (e.g., DPM) for the key transactions/functions supported by the VNF or PNF and those that must be exercised by the VNF or PNF in order to perform its function. VNF or PNF MUST Resource Control Loop
R-100330 When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 Virtual IP (VIP) is required to be supported by the ONAP data model, the map property ``virtual_machine_interface_allowed_address_pairs``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` 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``. The ONAP data model can only support one IPv6 VIP address. VNF MUST External Networks
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 VNF or PNF **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 VNF or PNF VM authentication. VNF or PNF 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-100000 The VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` parameter **MUST** be declared as either type ``string`` or type ``comma_delimited_list``. VNF MUST Resource OS::ContrailV2::InstanceIp Property instance_ip_address
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-65641 The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command. VNF or PNF MUST Lifecycle Management Related Commands
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 VNF or PNF **SHOULD** conform its YANG model to RFC 7223, "A YANG Data Model for Interface Management". VNF or PNF SHOULD NETCONF Server Requirements
R-03251 A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` **MAY** be defined in a Cinder Volume Module. VNF MAY ONAP VNF Modularity Overview
R-83873 The VNF or PNF **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. VNF or PNF MUST NETCONF Server Requirements
R-46851 The VNF **MUST** support ONAP Controller's Evacuate command. VNF MUST Virtual Function - Container Recovery Requirements
R-34957 The VNF **MUST** provide a method of metrics gathering for each layer's performance to identify 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-64064 The PNFD provided by a PNF vendor **MUST** comply with the following Relationship Types as specified in ETSI NFV-SOL001 standard: - tosca.datatypes.nfv.VirtualLinksTo PNF MUST Relationship Types
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-100200 When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address 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 ``subnet_uuid``, the parameter **MUST** follow the naming convention * ``{network-role}_subnet_id`` where * ``{network-role}`` is the network role of the network. VNF MUST Resource OS::ContrailV2::InstanceIp Property subnet_uuid
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 VNF or PNF **SHOULD** deliver event records that fall into the event domains supported by VES. VNF or PNF 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. The ``{index}`` **MUST** starts at zero and increment by one as described in R-11690. VNF MUST OS::Nova::Server
R-02651 The VNF or PNF **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. VNF or PNF 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 or PNF package provided by a VNF or PNF vendor **MUST** be with TOSCA-Metadata directory (CSAR Option 1) as specified in ETSI GS NFV-SOL004. **Note:** SDC supports only the CSAR Option 1 in Dublin. The Option 2 will be considered in future ONAP releases. VNF or PNF MUST 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-41252 The VNF **MUST** support the capability of online storage of security audit logs. VNF MUST VNF Security Analytics Requirements
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 ONAP 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. ONAP 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 VNF or PNF **SHOULD** support callback URLs to return information to ONAP upon completion of the chef-client run for any chef-client run associated with a VNF or PNF 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. VNF or PNF SHOULD Chef Roles/Requirements
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-100050 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 address is assigned using the property ``instance_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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** increment by one VNF MUST Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-100110 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv4 address is assigned using the property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
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-43253 The VNF or PNF **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). VNF or PNF MUST Ansible Playbook 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 VNF or PNF **MUST** make available playbooks that conform to the ONAP requirement. VNF or PNF MUST Ansible Playbook Requirements
R-599443 A parameter enumerated in a VNF's Heat Orchestration Template's environment file **MUST** be declared in the corresponding VNF's Heat Orchestration Template's YAML file's ``parameters:`` section. VNF MUST ONAP Heat Support of Environment Files
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 identical number of ports connecting to the identical networks and requiring the identical IP address configuration. VNF MUST {vm-type}
R-72184 The VNF or PNF **MUST** have routable FQDNs for all the endpoints (VMs) of a VNF or PNF that contain chef-clients which are used to register with the Chef Server. As part of invoking VNF or PNF actions, ONAP will trigger push jobs against FQDNs of endpoints for a VNF or PNF, if required. VNF or PNF MUST Chef Client Requirements
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-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 VNF or PNF Documentation Package **MUST**, when relevant, provide a threshold crossing alert point for each KPI and describe the significance of the threshold crossing. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Control Loop
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-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 unique networks, each 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 {network-role}
R-28756 The VNF or PNF **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. VNF or PNF MUST NETCONF Server Requirements
R-86182 When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is in an incremental module and is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), the ``network`` parameter name **MUST** * follow the naming convention ``int_{network-role}_net_id`` if the network UUID value is used to reference the network * follow the naming convention ``int_{network-role}_net_name`` if the 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 VNF or PNF **MUST** support APPC/SDN-C ``HealthCheck`` command. VNF or PNF 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-60656 The VNF or PNF **MUST** support sub tree filtering. VNF or PNF MUST NETCONF Server Requirements
R-708564 If a VNF's Heat Orchestration Template's resource invokes a nested YAML file, either statically or dynamically (via ``OS::Heat::ResourceGroup``), the names of the parameters associated with the following resource properties **MUST NOT** change. * ``OS::Nova::Server`` property ``flavor`` * ``OS::Nova::Server`` property ``image`` * ``OS::Nova::Server`` property ``name`` * ``OS::Nova::Server`` property metadata key value ``vnf_id`` * ``OS::Nova::Server`` property metadata key value ``vf_module_id`` * ``OS::Nova::Server`` property metadata key value ``vnf_name`` * ``OS::Nova::Server`` property metadata key value ``vf_module_name`` * ``OS::Nova::Server`` property metadata key value ``vm_role`` * ``OS::Nova::Server`` property metadata key value ``vf_module_index`` * ``OS::Nova::Server`` property metadata key value ``workload_context`` * ``OS::Nova::Server`` property metadata key value ``environment_context`` * ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address`` * ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet`` * ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property ``ip_address`` * ``OS::Neutron::Port`` property ``network`` * ``OS::ContrailV2::VirtualMachineInterface`` property ``virtual_network_refs`` * ``OS::ContrailV2::VirtualMachineInterface`` property ``virtual_machine_interface_allowed_address_pairs``, map property ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip`` , ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` * ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address`` * ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid`` MUST NOT 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 (as described in R-11690) 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 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 ``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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** increment by one VNF MUST Property: fixed_ips, Map Property: ip_address
R-70496 The VNF or PNF **MUST** implement the protocol operation: ``commit(confirmed, confirm-timeout)`` - Commit candidate configuration data store to the running configuration. VNF or PNF 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 VNF or PNF Package **MUST** include documentation which must include all events, severity level (e.g., informational, warning, error) and descriptions including causes/fixes if applicable for the event. VNF or PNF MUST Resource Control Loop
R-88899 The VNF or PNF **MUST** support simultaneous <commit> operations within the context of this locking requirements framework. VNF or PNF 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 VNF or PNF **MUST** conform to the NETCONF RFC 5717, "Partial Lock Remote Procedure Call". VNF or PNF 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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the port is attached to * ``{port_index}`` references the instance of the port on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{port_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new port is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. VNF MUST OS::Neutron::Port
R-49466 The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command. VNF or PNF MUST Lifecycle Management Related Commands
R-49396 The VNF or PNF **MUST** support each APPC/SDN-C VNF or PNF 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. VNF or PNF MUST Ansible Playbook Requirements
R-100260 When * the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` 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 ``subnet_uuid``, 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 Resource OS::ContrailV2::InstanceIp Property subnet_uuid
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-511776 When a VNF's Heat Orchestration Template is ready to be on-boarded to ONAP, all files composing the VNF Heat Orchestration Template **MUST** be placed in a flat (i.e., non-hierarchical) directory and archived using ZIP. The resulting ZIP file is uploaded into ONAP. MUST ONAP VNF On-Boarding
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 VNF or PNF Package **MUST** include a run list of roles/cookbooks/recipes, for each supported VNF or PNF action, that will perform the desired VNF or PNF action in its entirety as specified by ONAP (see Section 7.c, APPC/SDN-C APIs and Behavior, for list of VNF or PNF actions and requirements), when triggered by a chef-client run list in JSON file. VNF or PNF MUST Chef Roles/Requirements
R-18733 The VNF or PNF **MUST** implement the protocol operation: ``discard-changes()`` - Revert the candidate configuration data store to the running configuration. VNF or PNF 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-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-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-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-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 VNF or PNF **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. VNF or PNF 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 or PNF CSAR package **MUST** be arranged as a CSAR archive as specified in TOSCA Simple Profile in YAML 1.2. VNF or PNF 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-795126 The VNF TOSCA CSAR package Manifest file **MUST** start with the VNF package metadata in the form of a name-value pairs. Each pair shall appear on a different line. The name is specified as following: - vnf_provider_id - vnf_product_name - vnf_release_date_time - vnf_package_version VNF CSAR PACKAGE MUST VNF Package Contents
R-02616 The VNF or PNF **MUST** permit locking at the finest granularity if a VNF or PNF 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). VNF or PNF 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-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-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-68990 The VNF or PNF **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. VNF or PNF MUST NETCONF Server Requirements
R-56385 The VNF or PNF **MUST** support APPC ``Audit`` command. VNF or PNF 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 VNF or PNF **MUST** implement the protocol operation: ``get-config(source, filter`` - Retrieve a (filtered subset of a) configuration from the configuration data store source. VNF or PNF 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 VNF or PNF **MUST** conform to the NETCONF RFC 5277, "NETCONF Event Notification". VNF or PNF 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-100370 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv6 Virtual IP (VIP) address is assigned using the map property, ``virtual_machine_interface_allowed_address_pairs, virtual_machine_interface_allowed_address_pairs_allowed_address_pair, virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip, virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` , the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{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`` and **MUST** be enumerated in the environment file OR the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_floating_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 And the parameter **MUST** be declared as ``type: comma_delimited_list`` and **MUST** be enumerated in the environment file. VNF MUST Internal Networks
R-26881 The VNF provider **MUST** provide the binaries and images needed to instantiate the VNF (VNF and VNFC images). VNF MUST Compute, Network, and Storage Requirements
R-95950 The VNF or PNF **MUST** provide a NETCONF interface fully defined by supplied YANG models for the embedded NETCONF server. VNF or PNF MUST Configuration Management
R-92866 The VNF or PNF **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). VNF or PNF MUST Ansible Client Requirements
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-100090 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv4 address is assigned using the property ``instance_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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** increment by one VNF MUST Resource OS::ContrailV2::InstanceIp Property instance_ip_address
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-100150 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv6 address is assigned using the property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
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 ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Templates and **MUST** 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-100250 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` parameter ``int_{network-role}_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Resource OS::ContrailV2::InstanceIp Property subnet_uuid
R-16065 The VNF or PNF provider **MUST** provide configurable parameters (if unable to conform to YANG model) including VNF or PNF attributes/parameters and valid values, dynamic attributes and cross parameter dependencies (e.g., customer provisioning data). VNF or PNF MUST Configuration Management via Ansible
R-506221 The VNF or PNF TOSCA CSAR file **MUST** be a zip file with .csar extension. VNF or PNF CSAR PACKAGE MUST VNF Package Structure and Format
R-35851 The VNF HEAT Package **MUST** include VNF topology that describes basic network and application connectivity internal and external to the VNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable) for each interface. VNF HEAT PACKAGE 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 VNF or PNF **MUST**, if serving as a distribution point or anchor point for steering point from source to destination, support the ONAP Controller's ``DistributeTraffic`` command. VNF or PNF MUST Lifecycle Management Related Commands
R-841740 The VNF or PNF **SHOULD** support FileReady VES event for event-driven bulk transfer of monitoring data. VNF or PNF SHOULD Bulk Performance Measurement
R-65486 The VNFD **MUST** comply with ETSI GS NFV-SOL001 specification 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 VNF or PNF **MUST** use the YANG configuration models and RESTCONF [RFC8040] (https://tools.ietf.org/html/rfc8040). VNF or PNF 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 VNF or PNF **MUST** control access to ONAP and to VNFs or PNFs, and creation of connections, through secure credentials, log-on and exchange mechanisms. VNF or PNF 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 VNF or PNF **MUST NOT** use any instance specific parameters for the VNF or PNF in roles/cookbooks/recipes invoked for a VNF or PNF action. VNF or PNF MUST NOT Chef Roles/Requirements
R-11499 The VNF or PNF **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. VNF or PNF 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 **SHOULD** 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}``. The ``{index}`` starts at zero and increments by one (as described in R-11690). VNF SHOULD OS::Neutron::Port
R-25238 The VNF or PNF 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 VNF or PNF **SHOULD** conform its YANG model to RFC 6991, "Common YANG Data Types". VNF or PNF SHOULD NETCONF Server Requirements
R-97451 The VNF or PNF **MUST** provide the ability to remove root access once post-instantiation configuration (Configure) is completed. VNF or PNF 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. 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-46567 The VNF or PNF Package **MUST** include configuration scripts for boot sequence and configuration. VNF or PNF MUST Configuration Management via Ansible
R-93443 The VNF or PNF **MUST** define all data models in YANG 1.0 [RFC6020] or YANG 1.1 [RFC7950]. A combination of YANG 1.0 and YANG 1.1 modules is allowed subject to the rules in [RFC7950] section 12. The mapping to NETCONF shall follow the rules defined in this RFC. VNF or PNF 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-100020 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-91745 The VNF or PNF **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 VNFs or PNFs. VNF or PNF MUST Ansible Client Requirements
R-46119 A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` **MAY** be defined in a Base Module. VNF MAY ONAP VNF Modularity Overview
R-43958 The VNF Documentation Package **MUST** describe the tests that were conducted by the VNF provider and the test results. VNF DOCUMENTATION PACKAGE MUST Testing
R-68165 The VNF or PNF **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. VNF or PNF 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. 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 A VNF's Heat Orchestration Template resource attribute ``property:`` **MUST NOT** use more than two levels of nested ``get_param`` intrinsic functions when deriving a property value. SDC does not support nested ``get_param`` with recursive lists (i.e., a list inside list). The second ``get_param`` in a nested lookup must directly derive its value without further calls to ``get_param`` functions. * Example of valid nesting: * ``name: {get_param: [ {vm-type}_names, {get_param : index } ] }`` * Examples of invalid nesting. SDC will not support these examples since there is an array inside array. * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist, 0 ] } ] }`` * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist1, { get_param: indexlist2 } ] } ] }`` VNF MUST NOT 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 VNF or PNF **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 VNF or PNF using PUTs to a RESTful API, in the same manner that other controls over data reporting will be controlled by policy. VNF or PNF 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 VNF or PNF providers **MUST** provide the Service Provider the following artifacts to support the delivery of high-volume VNF or PNF 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 VNF or PNF 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 VNF or PNF **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-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 VNF or PNF 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. VNF or PNF 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 VNF or PNF **MUST** implement the protocol operation: ``kill-session(session``- Force the termination of **session**. VNF or PNF 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 VNF or PNF **MUST** implement the ``:with-defaults`` capability [RFC6243]. VNF or PNF MUST NETCONF Server Requirements
R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs. VNF MUST VNF Identity and Access Management Requirements
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 or PNF TOSCA PACKAGE **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 or PNF TOSCA PACKAGE MUST VNF Package Contents
R-29324 The VNF or PNF **SHOULD** implement the protocol operation: ``copy-config(target, source)`` - Copy the content of the configuration data store source to the configuration data store target. VNF or PNF 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-146092 If one or more non-MANO artifact(s) is included in the VNF or PNF TOSCA CSAR package, the Manifest file in this CSAR package **MUST** contain: non-MANO artifact set which MAY contain following ONAP public tag. - onap_ves_events: contains VES registration files - onap_pm_dictionary: contains the PM dictionary files - onap_yang_modules: contains Yang module files for configurations - onap_ansible_playbooks: contains any ansible_playbooks - onap_others: contains any other non_MANO artifacts, e.g. informational documents VNF or PNF TOSCA PACKAGE MUST VNF Package Contents
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-130206 If the VNF or PNF CSAR Package utilizes Option 2 for package security, then the complete CSAR file **MUST** contain a Digest (a.k.a. hash) for each of the components of the VNF or PNF package. The table of hashes is included in the package manifest file, which is signed with the VNF or PNF provider private key. In addition, the VNF or PNF provider MUST include a signing certificate that includes the VNF or PNF provider public key, following a TOSCA pre-defined naming convention and located either at the root of the archive or in a predefined location specified by the TOSCA.meta file with the corresponding entry named "ETSI-Entry-Certificate". VNF or PNF CSAR PACKAGE MUST VNF or PNF Package Authenticity and Integrity
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 VNF or PNF **MUST** support APPC ``ConfigModify`` command. VNF or PNF MUST Configuration Commands
R-348813 The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include a binary image file. MUST ONAP VNF On-Boarding
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`` Resource ID that is configuring an IPv6 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an internal network **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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` references the instance of the virtual machine interface on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{vmi_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new virtual machine interface is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` references the instance of the IPv6 address configured on the virtual machine interface. The ``{index}`` is a numeric value that **MUST** start at zero on an instance of a virtual machine interface and **MUST** increment by one each time a new IPv6 address is configured on the virtual machine interface. VNF MUST OS::ContrailV2::InstanceIp
R-87564 The VNF or PNF **SHOULD** conform its YANG model to RFC 7317, "A YANG Data Model for System Management". VNF or PNF SHOULD NETCONF Server Requirements
R-75943 The VNF or PNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when supporting the event-driven bulk transfer of monitoring data. VNF or PNF SHOULD Bulk Performance Measurement
R-42366 The VNF or PNF **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>`_. VNF or PNF 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-100190 The VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` parameter **MUST** be declared type ``string``. VNF MUST Resource OS::ContrailV2::InstanceIp Property subnet_uuid
R-63229 The VNF or PNF **MAY** use another option which is expected to include REST for synchronous data, using RESTCONF (e.g., for VNF or PNF state polling). VNF or PNF MAY Addressing and Delivery Protocol
R-100210 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` parameter ``{network-role}_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Resource OS::ContrailV2::InstanceIp Property subnet_uuid
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}``, the ``{index}`` is a numeric value that **MUST** start at zero and **MUST** increment by one. As stated in 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*. While the ``{index}`` will start at zero in the VNF, the ``{index}`` may not start at zero in a given Heat Orchestration Template or HEAT Orchestration Template Nested YAML file. 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 VNF or PNF **MUST** support APPC ``StopApplication`` command. VNF or PNF 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. Additional data **MAY** be used in the ``str_replace`` construct 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 string ``base`` or ``volume``. 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 VNF or PNF **MUST** respond to data requests from ONAP as soon as those requests are received, as a synchronous response. VNF or PNF 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 VNF or PNF **MUST** have the echo command return a zero value otherwise the validation has failed. VNF or PNF MUST NETCONF Server Requirements
R-27310 The VNF or PNF Package **MUST** include all relevant Chef artifacts (roles/cookbooks/recipes) required to execute VNF or PNF actions requested by ONAP for loading on appropriate Chef Server. VNF or PNF MUST Chef Roles/Requirements
R-146931 The VNF or PNF **MUST** report exactly one Measurement event per period per source name. VNF or PNF MUST Reporting Frequency
R-304011 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's * Resource ID (defined in R-29751) * property ``image`` parameter name (defined in R-58670) * property ``flavor`` parameter name (defined in R-45188) * property ``name`` parameter name (defined in R-54171 & R-87817) * property ``networks`` map property ``port`` value which is a ``OS::Neutron::Port`` Resource ID (defined in R-20453) referenced using the intrinsic function ``get_attr`` **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. And the ``{index}`` in the ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match the ``{vm-type_index}`` defined in the ``OS::Nova::Server`` property ``networks`` map property ``port`` referenced ``OS::Neutron::Port`` Resource ID (defined in R-20453). 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-100280 If a VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), the map property ``virtual_machine_interface_allowed_address_pairs``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` parameter **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT External Networks
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-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-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 VNF or PNF provider **MUST** provide cookbooks to be loaded on the appropriate Chef Server. VNF or PNF MUST Configuration Management via Chef
R-697654 The VNF or PNF **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. VNF or PNF MAY VNF or PNF Telemetry using Google Protocol Buffers
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-12709 The VNFC **SHOULD** be independently deployed, configured, upgraded, scaled, monitored, and administered by ONAP. VNF SHOULD VNF Design
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-100060 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-30395 A VNF's Cinder Volume Module **MAY** utilize nested heat. VNF MAY Nested Heat Orchestration Templates Overview
R-70266 The VNF or PNF **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 VNF or PNF scaling fields, and syslog fields. Other record types will be added in the future as they become standardized and are made available.) VNF or PNF MUST Asynchronous and Synchronous Data Delivery
R-53015 The VNF or PNF **MUST** apply locking based on the sequence of NETCONF operations, with the first configuration operation locking out all others until completed. VNF or PNF MUST NETCONF Server Requirements
R-100100 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-60011 A VNF's Heat Orchestration Template **MUST** have no more than two levels of nesting. MUST Nested Heat Template Requirements
R-33694 The VNF or PNF Package **MUST** include documentation to when applicable, provide calculators needed to convert raw data into appropriate reporting artifacts. VNF or PNF MUST Resource Control Loop
R-01033 The VNF or PNF **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 VNFs or PNFs. (Preferred is to reorganize the data into more frequent or more focused data sets, and deliver these by REST or TCP as appropriate.) VNF or PNF 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-27078 A VNF's Heat Orchestration template **MUST** contain the section ``heat_template_version:``. VNF MUST heat_template_version
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-681859 A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's * Resource ID (defined in R-20453) * property ``network`` parameter name (defined in R-62983 and R-86182) * property ``fixed_ips``, map property ``ip_address`` parameter name (defined in R-40971, R-04697, R-71577, R-23503, R-78380, R-85235, R-27818, and R-29765) * property ``fixed_ips``, map property ``subnet`` parameter name (defined in R-62802, R-15287, R-84123, R-76160) * property ``allowed_address_pairs`` parameter name (defined in R-41492 and R-83418) **MUST** contain the identical ``{network-role}``. VNF MUST Items to Note
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 VNF or 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. VNF or PNF MUST Security
R-11240 The VNF or PNF **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. VNF or PNF 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-807129 The VNF or PNF **SHOULD** report the files in FileReady for as long as they are available at VNF or PNF. Note: Recommended period is at least 24 hours. VNF or PNF SHOULD Bulk Performance Measurement
R-45197 The VNF or PNF **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. VNF or PNF MUST Ansible Client Requirements
R-932071 The VNF or PNF 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 VNF or PNF into ONAP SDC Design Studio. VNF or PNF MUST Transports and Protocols Supporting Resource Interfaces
R-82811 The VNF or PNF **MUST** support APPC ``StartApplication`` command. VNF or PNF MUST Lifecycle Management Related Commands
R-46128 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` Resource ID that is configuring an IPv6 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an external network **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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` references the instance of the virtual machine interface on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{vmi_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new virtual machine interface is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` references the instance of the IPv6 address configured on the virtual machine interface. The ``{index}`` is a numeric value that **MUST** start at zero on an instance of a virtual machine interface and **MUST** increment by one each time a new IPv6 address is configured on the virtual machine interface. VNF MUST OS::ContrailV2::InstanceIp
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-535009 The PNFD provided by a PNF vendor **MUST** comply with the following Node Types as specified in ETSI NFV-SOL001 standard: - tosca.nodes.nfv.PNF - tosca.nodes.nfv.PnfExtCp - tosca.nodes.nfv.Cp PNF MUST Node Types
R-56815 The VNF or PNF Documentation Package **MUST** describe supported VNF or PNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls). VNF or PNF DOCUMENTATION PACKAGE 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-589037 A VNF Heat Orchestration Template's Cinder Volume Module ``resources:`` section **MUST** only be defined using one of the following: * one of more ``OS::Cinder::Volume`` resources * one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML file that contains only ``OS::Cinder::Volume`` resources * a resource that calls a nested YAML file (static nesting) that contains only ``OS::Cinder::Volume`` resources MUST Cinder Volume Modules
R-10716 The VNF or PNF **MUST** support parallel and simultaneous configuration of separate objects within itself. VNF or PNF 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-35666 If a VNF has an internal network, the VNF Heat Orchestration Template **MUST** include the heat resources to create the internal network. A VNF's Internal Network is created using Neutron Heat Resources (i.e., ``OS::Neutron::Net``, ``OS::Neutron::Subnet``) and/or Contrail Heat Resources (i.e., ``OS::ContrailV2::VirtualNetwork``, ``ContrailV2::NetworkIpam``). 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-22346 The VNF or PNF package **MUST** provide :ref:`VES Event Registration <ves_event_registration_3_2>` for all VES events provided by that VNF or PNF. VNF or PNF PACKAGE MUST Resource Description
R-787965 If the VNF or PNF CSAR Package utilizes Option 2 for package security, then the complete CSAR file **MUST** be digitally signed with the VNF or PNF provider private key. The VNF or PNF provider delivers one zip file consisting of the CSAR file, a signature file and a certificate file that includes the VNF or PNF provider public key. The certificate may also be included in the signature container, if the signature format allows that. The VNF or PNF provider creates a zip file consisting of the CSAR file with .csar extension, signature and certificate files. The signature and certificate files must be siblings of the CSAR file with extensions .cms and .cert respectively. VNF or PNF CSAR PACKAGE MUST VNF or PNF Package Authenticity and Integrity
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-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-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-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-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-41829 The VNF or PNF **MUST** be able to specify the granularity of the lock via a restricted or full XPath expression. VNF or PNF MUST NETCONF Server Requirements
R-177937 The PNFD provided by a PNF vendor **MUST** comply with the following Capabilities Types as specified in ETSI NFV-SOL001 standard: - tosca.datatypes.nfv.VirtualLinkable PNF MUST Capability Types
R-12271 The VNF or PNF **SHOULD** conform its YANG model to RFC 7223, "IANA Interface Type YANG Module". VNF or PNF 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-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-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 VNF or PNF **MUST** carry data in motion only over secure connections. VNF or PNF 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-256347 The PNF **MUST** support one of the protocols for a Service Configuration message exchange between the PNF and PNF Controller (in ONAP): a) Netconf/YANG, b) Chef, or c) Ansible. Note: The PNF Controller may be VF-C, APP-C or SDN-C based on the PNF and PNF domain. 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 **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** increment 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 VNF provider **MUST** provide their testing scripts to support testing. VNF 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 the IPv4 VIP is required to be supported by the ONAP data model, the property ``allowed_address_pairs`` map property ``ip_address`` 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``. As noted in the introduction to this section, the ONAP data model can only support one IPv4 VIP address. VNF MUST VIP Assignment, External Networks
R-41493 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 the IPv4 VIP address and/or IPv6 VIP address is **not** supported by the ONAP data model, the property ``allowed_address_pairs`` map property ``ip_address`` * Parameter name **MAY** use any naming convention. That is, there is no ONAP mandatory parameter naming convention. * Parameter **MAY** be declared as type ``string`` or type ``comma_delimited_list``. And the ``OS::Neutron::Port`` resource **MUST** contain resource-level ``metadata`` (not property-level). And the ``metadata`` format **MUST** must contain the key value ``aap_exempt`` with a list of all ``allowed_address_pairs`` map property ``ip_address`` parameters **not** supported by the ONAP data model. VNF MUST VIP Assignment, External Networks
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-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 VNF or PNF * ``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-100310 When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 Virtual IP (VIP) is required to be supported by the ONAP data model, the map property ``virtual_machine_interface_allowed_address_pairs``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` 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``. The ONAP data model can only support one IPv4 VIP address. VNF MUST External Networks
R-821473 The VNF or PNF MUST produce heartbeat indicators consisting of events containing the common event header only per the VES Listener Specification. VNF or PNF 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 VNF or PNF Documentation Package **MUST** describe the fault, performance, capacity events/alarms and other event records that are made available by the VNF or PNF. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Control Loop
R-44013 The VNF or PNF **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 VNF or PNF action requires the output of a chef-client run be made available (e.g., get running configuration). VNF or PNF MUST Chef Roles/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 string ``base``. VNF MUST Incremental Modules
R-22946 The VNF or PNF **SHOULD** conform its YANG model to RFC 6536, "NETCONF Access Control Model". VNF or PNF 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-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-26508 The VNF or PNF **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. VNF or PNF 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_`` * **MUST NOT** end in the string: ``_v6`` * **MUST NOT** contain the strings ``_#_``, where ``#`` is a number * **MUST NOT** end in the string: ``_#``, where ``#`` is a number VNF MUST NOT {network-role}
R-29495 The VNF or PNF **MUST** support locking if a common object is being manipulated by two simultaneous NETCONF configuration operations on the same VNF or PNF 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). VNF or PNF 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-100360 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv4 Virtual IP (VIP) address is assigned using the map property, ``virtual_machine_interface_allowed_address_pairs, virtual_machine_interface_allowed_address_pairs_allowed_address_pair, virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip, virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` , the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{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`` and **MUST** be enumerated in the environment file. OR the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_floating_ips`` 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: comma_delimited_list`` and **MUST** be enumerated in the environment file. VNF MUST Internal Networks
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 VNF or PNF **MAY** use another option which is expected to include REST delivery of binary encoded data sets. VNF or PNF MAY Addressing and Delivery Protocol
R-89571 The VNF or PNF **MUST** support and provide artifacts for configuration management using at least one of the following technologies; a) Netconf/YANG, b) Chef, or c) Ansible. Note: The requirements for Netconf/YANG, Chef, and Ansible protocols are provided separately and must be supported only if the corresponding protocol option is provided by the VNF or PNF providor. VNF or PNF 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 * ``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::ContrailV2::VirtualNetwork
R-78116 The VNF or PNF **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 VNF or PNF action. VNF or PNF 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-32217 The VNF or PNF **MUST** have routable management IP addresses or FQDNs that are reachable via the Ansible Server for the endpoints (VMs) of a VNF or PNF that playbooks will target. ONAP will initiate requests to the Ansible Server for invocation of playbooks against these end points [#7.3.3]_. VNF or PNF MUST Ansible Client Requirements
R-08134 The VNF or PNF **MUST** conform to the NETCONF RFC 6241, "NETCONF Configuration Protocol". VNF or PNF MUST NETCONF Server Requirements
R-100140 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
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-100380 If a VNF requires the use of an SSH key created by OpenStack, the VNF Heat Orchestration Template **SHOULD** create the ``OS::Nova::Keypair`` in the base module, and expose the public key as an output value. This allows re-use of the key by ONAP when triggering scale out, recovery, or other day 1 operations. VNF SHOULD Key Pairs
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-46986 The VNF **SHOULD** have source code scanned using scanning tools (e.g., Fortify) and provide reports. VNF SHOULD VNF General Security Requirements
R-68023 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` value **MUST** be obtained via a ``get_param``. VNF MUST 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. 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-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-22700 The VNF or PNF **MUST** conform its YANG model to RFC 6470, "NETCONF Base Notifications". VNF or PNF 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 VNF or PNF **MUST** support Ansible playbooks that are compatible with Ansible version 2.6 or later. VNF or PNF 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-100160 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` 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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-97445 The VNF **MUST** log the field "date/time" in the security audit logs. VNF MUST VNF Security Analytics Requirements
R-100030 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 address is assigned using the property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-221914 The VNF or PNF package **MUST** contain a a human-readable change log text file. The Change Log file keeps a history describing any changes in the VNF or PNF package. The Change Log file is kept up to date continuously from the creation of the CSAR package. VNF or PNF MUST VNF Package Contents
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-37692 The VNFC **MUST** provide API versioning to allow for independent upgrades of VNFC. VNF MUST VNF Design
R-100130 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv6 address is assigned using the property ``instance_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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** increment by one VNF MUST Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-05257 A VNF's Heat Orchestration Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIP``. VNF MUST NOT VIP Assignment, External Networks
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 VNF or PNF Documentation Package **MUST** describe all parameters that are available to monitor the VNF or PNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected for reporting purposes. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Control Loop
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-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-100240 When * the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is assigning an IP address 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 ``subnet_uuid``, 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 Resource OS::ContrailV2::InstanceIp Property subnet_uuid
R-86926 A VNF's incremental module **MAY** be used for scale out only. VNF MAY ONAP VNF Modularity Overview
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-894004 When the VNF or PNF sets up a HTTP or HTTPS connection to the collector, 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. VNF or PNF MUST Security
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 VNF or PNF **MUST** allow all configuration data to be edited through a NETCONF <edit-config> operation. Proprietary NETCONF RPCs that make configuration changes are not sufficient. VNF or PNF 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 VNF or PNF **MUST** conform to the NETCONF RFC 4742, "Using the NETCONF Configuration Protocol over Secure Shell (SSH)". VNF or PNF 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 VNF or PNF Documentation Package **MUST** describe the characteristics for the VNF or PNF reliability and high availability. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Control Loop
R-96554 The VNF or PNF **MUST** implement the protocol operation: ``unlock(target)`` - Unlock the configuration data store target. VNF or PNF 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-79224 The VNF or PNF **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. VNF or PNF MUST Chef Client 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-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-97529 The VNF or PNF **SHOULD** implement the protocol operation: ``get-schema(identifier, version, format)`` - Retrieve the YANG schema. VNF or PNF SHOULD NETCONF Server Requirements
R-997907 The VNF or PNF **SHOULD** support TLS as secure transport for the NETCONF protocol according to [RFC7589]. VNF or PNF 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-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-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-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 VNF or PNF **MUST** release locks to prevent permanent lock-outs when/if a session applying the lock is terminated (e.g., SSH session is terminated). VNF or PNF MUST NETCONF Server Requirements
R-96253 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` Resource ID that is attaching to an external network **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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` references the instance of the virtual machine interface on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{vmi_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new virtual machine interface is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. VNF MUST OS::ContrailV2::VirtualMachineInterface
R-44125 The VNF or PNF provider **MUST** agree to the process that can be met by Service Provider reporting infrastructure. The Contract shall define the reporting process and the available reporting tools. VNF or PNF 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. MUST Nested Heat Template Requirements
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-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 VNF or PNF **SHOULD** conform its YANG model to RFC 7277, "A YANG Data Model for IP Management". VNF or PNF 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-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 VNF or PNF **MUST** support heartbeat via a <get> with null filter. VNF or PNF MUST NETCONF Server Requirements
R-35401 The VNF or PNF **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. VNF or PNF MUST Ansible Client Requirements
R-258686 The VNF application processes **MUST NOT** run as root. VNF MUST NOT VNF General Security Requirements
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 VNF or PNF **MUST** conform its YANG model to RFC 6087, "Guidelines for Authors and Reviewers of YANG Data Model specification". VNF or PNF 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`` Resource ID that is configuring an IPv4 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an external network **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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the virtual machine interface is attached to * ``{vmi_index}`` references the instance of the virtual machine interface on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{vmi_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new virtual machine interface is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` references the instance of the IPv4 address configured on the virtual machine interface. The ``{index}`` is a numeric value that **MUST** start at zero on an instance of a virtual machine interface and **MUST** increment by one each time a new IPv4 address is configured on the virtual machine interface. 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 VNF or PNF 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 VNF or PNF (e.g., configure). VNF or PNF 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. 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 **SHOULD NOT** be declared. VNF SHOULD 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-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 VNF or PNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command. VNF or PNF MUST Lifecycle Management Related Commands
R-66793 The VNF or PNF **MUST** guarantee the VNF or PNF 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 VNF or PNF without locking either configuration method out). VNF or PNF MUST NETCONF Server Requirements
R-42018 The VNF or PNF Package **MUST** include documentation which must include all events (fault, measurement for VNF or PNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines.html>`__ ) and for the overall VNF or PNF. VNF or PNF 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 VNF or PNF **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 VNF or PNF action, it should reflect this status on the Chef Server regardless of whether the Callback succeeded or not. VNF or PNF 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 VNF or PNF **MUST** support all operations, administration and management (OAM) functions available from the supplier for VNFs or PNFs using the supplied YANG code and associated NETCONF servers. VNF or PNF MUST NETCONF Server Requirements
R-100350 When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and the IPv4 VIP address and/or IPv6 VIP address is **not** supported by the ONAP data model, the map property ``virtual_machine_interface_allowed_address_pairs``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` * Parameter name **MAY** use any naming convention. That is, there is no ONAP mandatory parameter naming convention. * Parameter **MAY** be declared as type ``string`` or type ``comma_delimited_list``. And the ``OS::ContrailV2::VirtualMachineInterface`` resource **MUST** contain resource-level ``metadata`` (not property-level). And the ``metadata`` format **MUST** must contain the key value ``aap_exempt`` with a list of all map property ``virtual_machine_interface_allowed_address_pairs``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` parameters **not** supported by the ONAP data model. VNF MUST NOT External Networks
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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the port is attached to * ``{port_index}`` references the instance of the port on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{port_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new port is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. 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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** 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-100070 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 address is assigned using the property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-859208 The VNF **MUST** log automated remote activities performed with elevated privileges. VNF MUST VNF Security Analytics Requirements
R-100170 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-293901 The VNF or PNF CSAR PACKAGE with TOSCA-Metadata **MUST** include following additional keywords pointing to TOSCA files: - ETSI-Entry-Manifest - ETSI-Entry-Change-Log Note: For a CSAR containing a TOSCA-Metadata directory, which includes the TOSCA.meta metadata file. The TOSCA.meta metadata file includes block_0 with the Entry-Definitions keyword pointing to a TOSCA definitions YAML file used as entry for parsing the contents of the overall CSAR archive. VNF or PNF CSAR PACKAGE MUST VNF Package Contents
R-88482 The VNF or PNF **SHOULD** use REST using HTTPS delivery of plain text JSON for moderate sized asynchronous data sets, and for high volume data sets when feasible. VNF or PNF 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-100270 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` parameter ``int_{network-role}_v6_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Resource OS::ContrailV2::InstanceIp Property subnet_uuid
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-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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** increment by one VNF MUST Property: fixed_ips, Map Property: ip_address
R-12706 The VNF or PNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command. VNF or PNF MUST Lifecycle Management Related Commands
R-26115 The VNF or PNF **MUST** follow the data model update rules defined in [RFC6020] section 10 for YANG 1.0 modules, and [RFC7950] section 11 for YANG 1.1 modules. All deviations from the aforementioned update rules shall be handled by a built-in automatic upgrade mechanism. VNF or PNF MUST NETCONF Server Requirements
R-50816 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` value **MUST** be obtained via a ``get_param``. VNF MUST 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:`` **SHOULD NOT** be declared. VNF SHOULD NOT ONAP Base Module Output Parameters
R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [#4.5.1]_ VNF MUST VNF Devops
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 the index. The ``{index}`` starts at zero and increments by one (as described in R-11690). VNF MAY OS::ContrailV2::ServiceTemplate
R-85991 The VNF or PNF provider **MUST** provide a universal license key per VNF or PNF to be used as needed by services (i.e., not tied to a VM instance) as the recommended solution. The VNF or PNF provider may provide pools of Unique VNF or PNF License Keys, where there is a unique key for each VNF or PNF instance as an alternate solution. Licensing issues should be resolved without interrupting in-service VNFs or PNFs. VNF or PNF 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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** 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 VNF or PNF **MUST** support APPC ``ConfigRestore`` command. VNF or PNF 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-98617 The VNF Provider **MUST** provide documentation regarding any dependency (e.g. affinity, anti-affinity) the VNF has on other VNFs and resources. VNF PROVIDER MUST Resource Description
R-30278 The VNF or PNF provider **SHOULD** provide a Resource/Device YANG model as a foundation for creating the YANG model for configuration. VNF or PNF SHOULD 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 VNF or PNF provider **MUST** support the metadata about licenses (and their applicable entitlements) as defined in this specification for VNF or PNF software, and any license keys required to authorize use of the VNF or PNF software. This metadata will be used to facilitate onboarding the VNF or PNF into the ONAP environment and automating processes for putting the licenses into use and managing the full lifecycle of the licenses. The details of this license model are described in Tables C1 to C8 in the Appendix. Note: License metadata support in ONAP is not currently available and planned for 1Q 2018. VNF or PNF MUST Licensing Requirements
R-06924 The VNF or PNF **MUST** deliver asynchronous data as data becomes available, or according to the configured frequency. VNF or PNF MUST Asynchronous and Synchronous Data Delivery
R-32981 The VNF or PNF **MUST** support APPC ``ConfigBackup`` command. VNF or PNF MUST Configuration Commands
R-03465 The VNF or PNF **MUST** release locks to prevent permanent lock-outs when the corresponding <partial-unlock> operation succeeds. VNF or PNF MUST NETCONF Server Requirements
R-58301 The VNF or PNF **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. VNF or PNF SHOULD NOT Ansible Playbook Requirements
R-84879 The VNF or PNF **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 VNF or PNF. In this case, the network will promptly resolve connectivity problems caused by a collector or network failure transparently to the VNF or PNF. VNF or PNF MUST Addressing and Delivery Protocol
R-123044 The VNF or PNF 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. VNF or PNF 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 VNF or PNF **MUST**, by ONAP Policy, provide the ONAP addresses as data destinations for each VNF or PNF, and may be changed by Policy while the VNF or PNF is in operation. We expect the VNF or PNF 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. VNF or PNF MUST Addressing and Delivery Protocol
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-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 VNF or PNF **MUST** implement the protocol operation: ``lock(target)`` - Lock the configuration data store target. VNF or PNF MUST NETCONF Server Requirements
R-24269 The VNF or PNF **SHOULD** conform its YANG model to RFC 7407, "A YANG Data Model for SNMP Configuration", if Netconf used to configure SNMP engine. VNF or PNF SHOULD NETCONF Server Requirements
R-816745 The VNF or PNF PROVIDER *MUST* provide the Service Provider with PM Meta Data (PM Dictionary) to support the analysis of PM events delivered to DCAE. The PM Dictionary is to be provided as a separate YAML artifact at onboarding and must follow the VES Event Listener Specification and VES Event Registration Specification which contain the format and content required. VNF or PNF PROVIDER MUST Resource Description
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 VNF or PNF **SHOULD** support File transferring protocol, such as FTPES or SFTP, when supporting the event-driven bulk transfer of monitoring data. VNF or PNF SHOULD Bulk Performance Measurement
R-50468 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` Resource ID that is attaching to an internal network **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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` references the instance of the virtual machine interface on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{vmi_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new virtual machine interface is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. VNF MUST OS::ContrailV2::VirtualMachineInterface
R-805572 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 Virtual IP (VIP) address is assigned using the property ``allowed_address_pairs`` map property ``ip_address``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{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`` and **MUST** be enumerated in the environment file OR the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_floating_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 And the parameter **MUST** be declared as ``type: comma_delimited_list`` and **MUST** be enumerated in the environment file. VNF MUST VIP Assignment, Internal Networks
R-46290 The VNF or PNF **MUST** respond to an ONAP request to deliver granular data on device or subsystem status or performance, referencing the YANG configuration model for the VNF or PNF by returning the requested data elements. VNF or PNF MUST Asynchronous and Synchronous Data Delivery
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. The ``{index}`` starts at zero and increments by one (as described in R-11690). VNF SHOULD OS::Neutron::Subnet
R-24482 The VNF or PNF **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 VNF or PNF VM(s) as needed. VNF or PNF MUST Ansible Client Requirements
R-686466 The PNF **MUST** support sending a pnfRegistration VES event. PNF MUST PNF Plug and Play
R-36280 The VNF or PNF Documentation Package **MUST** describe the VNF or PNF Functional Capabilities that are utilized to operationalize the VNF or PNF and compose complex services. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Description
R-44001 A VNF's Heat Orchestration Template parameter declaration **MUST** contain the attribute ``description``. VNF MUST description
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-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-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-51442 The VNF or PNF **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 VNF or PNF (e.g., configure). **Note**: In case rollback at the playbook level is not supported or possible, the VNF or PNF provider shall provide alternative rollback mechanism (e.g., for a small VNF or PNF 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. VNF or PNF 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. The ``{index}`` starts at zero and increments by one (as described in R-11690). VNF SHOULD OS::Nova::Keypair
R-83412 If a 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 property ``allowed_address_pairs`` map property ``ip_address`` parameter(s) **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT VIP Assignment, External Networks
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 string ``base``. VNF MUST Nested Heat file
R-49145 The VNF or PNF **MUST** implement ``:confirmed-commit`` If ``:candidate`` is supported. VNF or PNF 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 VNF or PNF **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/VNF or PNF names. VNF or PNF MUST Ansible Client Requirements
R-73560 The VNF or PNF Package **MUST** include documentation about monitoring parameters/counters exposed for virtual resource management and VNF or PNF application management. VNF or PNF MUST Resource Control Loop
R-24632 The PNF Descriptor (PNFD) provided by PNF vendor **MUST** comply with TOSCA/YAML based Service template for PNF descriptor specified in ETSI NFV-SOL001. PNF MUST General
R-96634 The VNF or PNF Provider **MUST** provide human readable documentation (not in the on-boarding package) to describe scaling capabilities to manage scaling characteristics of the VNF or PNF. VNF or PNF PROVIDER 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 VNF or PNF **MUST** allow the entire configuration of the VNF or PNF to be retrieved via NETCONF's <get-config> and <edit-config>, independently of whether it was configured via NETCONF or other mechanisms. VNF or PNF 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`` **MAY** have a parameter constraint defined. VNF MAY constraints
R-88026 The VNF or PNF **MUST** include a NETCONF server enabling runtime configuration and lifecycle management capabilities. VNF or PNF MUST Configuration Management
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-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-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 VNF or PNF **MAY** expose a single endpoint that is responsible for all functionality. VNF or PNF 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 VNF or PNF Documentation Package **MUST** describe the VNF or PNF Management APIs, which must include information and tools for ONAP to deploy and configure (initially and ongoing) the VNF or PNF application(s) (e.g., NETCONF APIs) which includes a description of configurable parameters for the VNF or PNF and whether the parameters can be configured after VNF or PNF instantiation. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Description
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-49911 The VNF or PNF 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. VNF or PNF SHOULD Ansible Playbook Requirements
R-384337 The VNF Documentation Package **MUST** contain a list of the files within the VNF package that are static during the VNF's runtime. VNF DOCUMENTATION PACKAGE MUST Resource Description
R-63473 The VNF **MUST** automatically advertise newly scaled components so there is no manual intervention required. VNF MUST System Resource Optimization
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-100410 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MAY** contain the key/value pair ``vf_module_index``. VNF MAY vf_module_index
R-40827 The VNF or PNF provider **MUST** enumerate all of the open source licenses their VNF or PNF(s) incorporate. VNF or PNF MUST Licensing 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-27469 A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is creating a *Reserve Port* with an IPv4 address Resource ID **SHOULD** 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}``. The ``{index}`` starts at zero and increments by one (as described in R-11690). VNF SHOULD OS::Neutron::Port
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 (as described in R-11690) VNF SHOULD OS::Cinder::Volume
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-90748 A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` **MAY** be defined in an Incremental Module. VNF MAY ONAP VNF Modularity Overview
R-100230 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` parameter ``{network-role}_v6_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. VNF MUST NOT Resource OS::ContrailV2::InstanceIp Property subnet_uuid
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 For HEAT package, the VNF Package **MUST** include VNF Identification Data to uniquely identify the resource for a given VNF provider. The identification data must include: an identifier for the VNF, the name of the VNF as was given by the VNF provider, VNF description, VNF provider, and version. VNF Package MUST Resource Description
R-63935 The VNF or PNF **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). VNF or PNF MUST NETCONF Server Requirements
R-86285 A VNF's Heat Orchestration template **MUST** have a corresponding environment file. VNF MUST Environment File Format
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-100400 A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property metadata **SHOULD** contain the key/value pair ``vf_module_name``. VNF SHOULD vf_module_name
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-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-22888 The VNF or PNF Documentation Package **MUST** provide the VNF or PNF Policy Description to manage the VNF or PNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the VNF or PNF. VNF or PNF DOCUMENTATION PACKAGE 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-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-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-10353 The VNF or PNF **MUST** conform its YANG model to RFC 6244, "An Architecture for Network Management Using NETCONF and YANG". VNF or PNF 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 VNF or PNF **MUST** implement the data model discovery and download as defined in [RFC6022]. VNF or PNF MUST NETCONF Server Requirements
R-62187 A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` Resource ID that is configuring an IPv4 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an internal network **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}`` references the instance of the ``{vm-type}`` in the VNF. The ``{vm-type_index}`` is a numeric value that **MUST** start at zero in the VNF and **MUST** increment by one each time a new instance of a ``{vm-type}`` is referenced. * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` references the instance of the virtual machine interface on the ``{vm-type}`` attached to ``{network-role}`` network. The ``{vmi_index}`` is a numeric value that **MUST** start at zero on an instance of a ``{vm-type}`` and **MUST** increment by one each time a new virtual machine interface is defined on the instance of the ``{vm-type}`` attached to ``{network-role}`` network. * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` references the instance of the IPv4 address configured on the virtual machine interface. The ``{index}`` is a numeric value that **MUST** start at zero on an instance of a virtual machine interface and **MUST** increment by one each time a new IPv4 address is configured on the virtual machine interface. VNF MUST OS::ContrailV2::InstanceIp
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-821839 The VNF or PNF **MUST** deliver event records to ONAP using the common transport mechanisms and protocols defined in this specification. VNF or PNF 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-100040 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
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-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-100120 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
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-20353 The VNF or PNF **MUST** implement both ``:candidate`` and ``:writable-running`` capabilities. When both ``:candidate`` and ``:writable-running`` are provided then two locks should be supported. VNF or PNF MUST NETCONF Server Requirements
R-62170 The VNF or PNF **MUST** over-ride any default values for configurable parameters that can be set by ONAP in the roles, cookbooks and recipes. VNF or PNF 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-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 VNF or PNF provider **MUST** provide playbooks to be loaded on the appropriate Ansible Server. VNF or PNF MUST Configuration Management via Ansible
R-44569 The VNF or PNF provider **MUST NOT** require additional infrastructure such as a VNF or PNF provider license server for VNF or PNF provider functions and metrics. VNF or PNF 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-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 VNF or PNF **MAY** leverage bulk VNF or PNF telemetry transmission mechanism, as depicted in Figure 4, in instances where other transmission methods are not practical or advisable. VNF or PNF 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 VNF or PNF **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. VNF or PNF 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-57019 The PNF TOSCA CSAR PACKAGE Manifest file **MUST** start with the PNF package metadata in the form of a name-value pairs. Each pair shall appear on a different line. The name is specified as following: - pnfd_provider - pnfd_name - pnfd_release_date_time - pnfd_archive_version PNF CSAR PACKAGE MUST VNF Package Contents
R-48698 The VNF or PNF **MUST** utilize information from key value pairs that will be provided by the Ansible Server as "extra-vars" during invocation to execute the desired VNF or PNF 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., VNF or PNF instantiation. Recommendation is to avoid these instance specific, manually created in advance of instantiation, files. VNF or PNF MUST Ansible Playbook Requirements
R-85653 The VNF or PNF **MUST** provide metrics (e.g., number of sessions, number of subscribers, number of seats, etc.) to ONAP for tracking every license. VNF or PNF MUST Licensing 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 or PNF CSAR package **MUST** include all artifacts required by ETSI GS NFV-SOL004 including Manifest file, VNFD or PNFD (or Main TOSCA/YAML based Service Template) and other optional artifacts. VNF or PNF CSAR PACKAGE 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-596064 The PNFD provided by a PNF vendor **MUST** comply with the following Policy Types as specified in ETSI NFV-SOL001 standard: - tosca.datatypes.nfv.SecurityGroupRule PNF MUST Policy Types
R-68200 The VNF or PNF **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. VNF or PNF 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-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU architectures and families, virtual machines, etc. VNF MAY VNF Devops
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 VNF or PNF **SHOULD** implement the protocol operation: ``delete-config(target)`` - Delete the named configuration data store target. VNF or PNF 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 VNF or PNF 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 :ref:`VES Event Registration specification <ves_event_registration_3_2>`. VNF or PNF PROVIDER MUST Data Structure Specification of the Event Record
R-106240 The following VES Events **SHOULD** 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 SHOULD PNF Plug and Play
R-73468 The VNF or PNF **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. VNF or PNF 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-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-24893 A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``event_sinks:`` section. VNF MAY Environment File Format
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-10173 The VNF or PNF **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. VNF or PNF 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
R-19624 The VNF or PNF, 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 data format are described using JSON. VNF or PNF MUST JSON
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 VNF or PNF **MUST** must be compliant with the common event format defined in the :ref:`VES Event Listener<ves_event_listener_7_1>` specification. VNF or PNF 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 or PNF package Manifest file **MUST** contain: VNF or PNF 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. VNF or PNF MUST VNF Package Contents
R-31809 The VNF or PNF **MUST** support the HealthCheck RPC. The HealthCheck RPC executes a VNF or PNF Provider-defined VNF or PNF HealthCheck over the scope of the entire VNF or PNF (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 VNF or PNF is unable to run the HealthCheck, return a standard http error code and message. VNF or PNF 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 VNF or PNF, 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 VNF or PNF 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 VNF or PNF resource. * The required Google Protocol Buffers (GPB) metadata is provided in the form of .proto files. VNF or PNF MUST Google Protocol Buffers (GPB)
R-22680 The VNF or PNF Documentation Package **MUST** describe any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the VNF or PNF. VNF or PNF DOCUMENTATION PACKAGE 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's port connects to an internal network or external network, a network role, referred to as the ``{network-role}`` **MUST** be assigned to the network for use in the VNF's Heat Orchestration Template. The ``{network-role}`` is used in the VNF's Heat Orchestration Template resource IDs and resource property parameter names. VNF MUST {network-role}
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 When a VNF's Heat Orchestration Template creates an internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) and the internal network needs to be shared between modules within a VNF, the internal network **MUST** be created either in the * the base module * a nested YAML file invoked by the base module and the base module **MUST** contain an output parameter that provides either the network UUID or network name. * If the network UUID value is used to reference the network, the output parameter name in the base module **MUST** follow the naming convention ``int_{network-role}_net_id`` * If the network name in is used to reference the network, the output parameter name in the base template **MUST** follow the naming convention ``int_{network-role}_net_name`` ``{network-role}`` **MUST** be the network-role of the internal network created in the Base Module. The Base Module Output Parameter MUST be declared in the ``parameters:`` section of the Incremental Module(s) where the ``OS::Neutron::Port`` resource(s) is attaching to the internal network. VNF MUST Internal Networks
R-00068 The VNF or PNF Documentation Package **MUST** include a description of parameters that can be monitored for the VNF or PNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the VNF or PNF after instantiation. VNF or PNF DOCUMENTATION PACKAGE 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 VNF or PNF **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. VNF or PNF 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-484843 The PNFD provided by a PNF vendor **MUST** comply with the following Data Types as specified in ETSI NFV-SOL001 standard: - tosca.datatypes.nfv.CpProtocolData - tosca.datatypes.nfv.AddressData - tosca.datatypes.nfv.L2AddressData - tosca.datatypes.nfv.L3AddressData - tosca.datatypes.nfv.LocationInfo - tosca.datatypes.nfv.CivicAddressElement PNF MUST Data Types
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 VNF or PNF **MUST** have Python >= 2.6 on the endpoint VM(s) of a VNF or PNF on which an Ansible playbook will be executed. VNF or PNF MUST Ansible Client Requirements
R-520802 The VNF or PNF provider **MUST** provide a YAML file formatted in adherence with the :ref:`VES Event Registration specification <ves_event_registration_3_2>` 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 VNF or PNF PROVIDER MUST Data Structure Specification of the Event Record
R-33280 The VNF or PNF **MUST NOT** use any instance specific parameters in a playbook. VNF or PNF 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). 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-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-45856 The VNF or PNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command. VNF or PNF 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 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-100080 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-50252 The VNF or PNF **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 VNF or PNF action (e.g., audit), a playbook is required to return any VNF or PNF 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 VNF or PNF with the name '<VNF or PNF name>_results.txt'. All playbook output results, for all VNF or PNF VMs, to be provided as a response to the request, must be written to this response file. VNF or PNF 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-100180 The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_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 Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-19922 The VNF or PNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command. VNF or PNF MUST Lifecycle Management Related Commands
R-12678 The VNF or PNF Documentation Package **MUST** include a description of runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the VNF or PNF. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Description
R-659655 The VNF or PNF **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. VNF or PNF SHOULD VNF or PNF Telemetry using VES/JSON Model
R-90632 The VNF Package **MUST** include documentation about KPIs and metrics that need to be collected at each VM for capacity planning and performance management purposes. VNF 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 VNF or PNF **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. VNF or PNF SHOULD Asynchronous and Synchronous Data Delivery
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-91497 A VNF's incremental module **MAY** be used for both deployment and scale out. VNF MAY ONAP VNF Modularity Overview
R-90007 The VNF or PNF **MUST** implement the protocol operation: ``close-session()`` - Gracefully close the current session. VNF or PNF 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-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-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 VNF or PNF **MUST** accept all necessary instance specific data from the environment or node object attributes for the VNF or PNF in roles/cookbooks/recipes invoked for a VNF or PNF action. VNF or PNF MUST Chef Roles/Requirements
R-18525 The VNF or PNF provider **MUST** provide a JSON file for each supported action for the VNF or PNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Tables A1 and A2 in the Appendix. Note: Chef support in ONAP is not currently available and planned for 4Q 2017. VNF or PNF MUST Configuration Management via Chef
R-33904 The VNF or PNF Package **MUST** include documentation for each KPI, provide lower and upper limits. VNF or PNF 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 VNF or PNF **MUST** conform to the NETCONF RFC 6242, "Using the Network Configuration Protocol over Secure Shell". VNF or PNF 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 VNF or PNF **MUST** conform to the NETCONF RFC 4741, "NETCONF Configuration Protocol". VNF or PNF MUST NETCONF Server Requirements
R-67386 A VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``metadata``. VNF MAY metadata
R-98191 The VNF or PNF **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. VNF or PNF MUST Reporting Frequency
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. 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-332680 The VNF or PNF **SHOULD** deliver all syslog messages to the VES Collector per the specifications in Monitoring and Management chapter. VNF or PNF SHOULD Asynchronous and Synchronous Data Delivery
R-97293 The VNF or PNF provider **MUST NOT** require audits of Service Provider's business. VNF or PNF MUST NOT Licensing Requirements
R-69877 The VNF or PNF Package **MUST** include documentation for each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded. VNF or PNF MUST Resource Control Loop
R-100010 When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 address is assigned using the property ``instance_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 * ``{index}`` is a numeric value that **MUST** start at zero in a VNF's Heat Orchestration Template and **MUST** increment by one VNF MUST Resource OS::ContrailV2::InstanceIp Property instance_ip_address
R-32094 A VNF's Heat Orchestration Template parameter declaration **MAY** contain the attribute ``label:``. VNF MAY label
R-025941 The VNF or PNF PROVIDER **MUST** provide FM Meta Data to support the analysis of fault events delivered to DCAE. The Meta Data must be included in the VES Registration YAML file with each fault event supported by that NF at onboarding time and the Meta Data must follow the VES Event Listener and VES Event Registration Specifications. VNF PROVIDER MUST Resource Description
R-73285 The VNF or PNF **MUST** must encode, address and deliver the data as described in the previous paragraphs. VNF or PNF MUST Asynchronous and Synchronous Data Delivery
R-83790 The VNF or PNF **MUST** implement the ``:validate`` capability. VNF or PNF 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 VNF or PNF **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 VNF or PNF supported schemas. VNF or PNF MUST NETCONF Server Requirements
R-34660 The VNF or PNF **MUST** use the RESTCONF/NETCONF framework used by the ONAP configuration subsystem for synchronous communication. VNF or PNF 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 VNF or PNF **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. VNF or PNF 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 VNF or PNF **MUST** permit authentication, using root account, only right after instantiation and until post-instantiation configuration is completed. VNF or PNF 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 VNF or PNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command. VNF or PNF MUST Lifecycle Management Related Commands
R-94084 The VNF or PNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command. VNF or PNF MUST Configuration Commands
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 VNF or PNF **MUST** support APPC/SDN-C ``Configure`` command. VNF or PNF MUST Configuration Commands
R-16777 The VNF or PNF provider **MUST** provide a JSON file for each supported action for the VNF or PNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Table B1 in the Appendix. VNF or PNF 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-53433 A VNF's Cinder Volume Module **MUST** have a corresponding environment file VNF MUST ONAP VNF Modularity Overview
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 the IPv6 VIP is required to be supported by the ONAP data model, the property ``allowed_address_pairs`` map property ``ip_address`` 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``. As noted in the introduction to this section, the ONAP data model can only support one IPv6 VIP address. VNF MUST VIP Assignment, External Networks
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-58775 The VNF provider **MUST** provide software components that can be packaged with/near the VNF, if needed, to simulate any functions or systems that connect to the VNF system under test. This component is necessary only if the existing testing environment does not have the necessary simulators. VNF 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 VNF or PNF **MUST** load the Ansible Server SSH public key onto VNF or PNF VM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative, is for Ansible Server SSH public key to be loaded onto VNF or PNF 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 VNF or PNF login IDs and passwords. *CAUTION*: For VNFs or PNFs 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. VNF or PNF MUST Ansible Client Requirements
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-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 **SHOULD NOT** have a parameter constraint defined. VNF SHOULD NOT constraints
R-84366 The VNF or PNF Documentation Package **MUST** describe the VNF or PNF Functional APIs that are utilized to build network and application services. This document describes the externally exposed functional inputs and outputs for the VNF or PNF, including interface format and protocols supported. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Description
R-00156 The VNF or PNF Documentation Package **MUST** describe the VNF or PNF Management APIs, which must include information and tools for ONAP to monitor the health of the VNF or PNF (conditions that require healing and/or scaling responses). VNF or PNF DOCUMENTATION PACKAGE MUST Resource Description
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 **MAY** be declared as * ``vm_role`` and the parameter defined as ``type: string``. * ``vm_roles`` and the parameter defined as ``type: comma_delimited_list``. * ``{vm-type}_vm_role`` and the parameter defined as ``type: string``. VNF MAY vm_role
R-16875 The VNF or PNF Documentation Package **MUST** include documentation which must include a unique identification string for the specific VNF or PNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue. VNF or PNF DOCUMENTATION PACKAGE MUST Resource Control Loop
R-100220 When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address 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 ``subnet_uuid``, the parameter **MUST** follow the naming convention * ``{network-role}_v6_subnet_id`` where * ``{network-role}`` is the network role of the network. VNF MUST Resource OS::ContrailV2::InstanceIp Property subnet_uuid