298 Requirements containing "HEAT" in the requirements text
| ID | Content | Target | Keyword | Section Name |
| 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-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-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-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-304011 | A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's * Resource ID * property ``image`` parameter name * property ``flavor`` parameter name * property ``name`` parameter name **MUST** contain the identical ``{vm-type}`` and **MUST** follow the naming conventions defined in R-58670, R-45188, R-54171, R-87817, and R-29751. | VNF | MUST | Resource: OS::Nova::Server - Parameters |
| R-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-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-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-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-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-99110 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming convention 1) ``int_{network-role}_network`` or 2) ``int_{network-role}_RVN`` where RVN represents Resource Virtual Network VNF Heat Orchestration Templates can only create internal networks. There is no ``{index}`` after ``{network-role}`` because ``{network-role}`` **MUST** be unique in the scope of the VNF's Heat Orchestration Template. Note that option 1 is preferred. | VNF | MUST | OS::ContrailV2::VirtualNetwork |
| R-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-98748 | The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter **MUST** be declared as type ``string``. | VNF | MUST | VIP Assignment, External Networks, Supported by Automation |
| R-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-98450 | The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``availability_zone`` parameter name **MUST** follow the naming convention ``availability_zone_{index}`` where the ``{index}`` **MUST** start at zero and increment by one. | VNF | MUST | Property: availability_zone |
| R-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-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-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-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-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-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-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-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-96253 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` is the instance of the the vmi on the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::ContrailV2::VirtualMachineInterface |
| R-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-95430 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` value is obtained via ``get_param``, the parameter **MUST** be declared as ``vm_role`` and the parameter **MUST** be defined as type: ``string``. | VNF | MUST | vm_role |
| R-95303 | A VNF's Heat Orchestration Template **MUST** be defined using valid YAML. | VNF | MUST | YAML Format |
| 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-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-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-93177 | When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and the internal network is created in the same Heat Orchestration Template as the ``OS::Neutron::Port``, the ``network`` property value **MUST** obtain the UUID of the internal network by using the intrinsic function ``get_resource`` and referencing the Resource ID of the internal network. | VNF | MUST | Property: network |
| R-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-92635 | A VNF's Heat Orchestration Template **MUST** be compliant with the OpenStack Template Guide. | MUST | ONAP Heat Orchestration Template Format | |
| 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-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-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-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-90748 | A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume **MAY** be defined in an Incremental Module. | VNF | MAY | ONAP VNF Modularity Overview |
| R-90526 | A VNF Heat Orchestration Template parameter declaration **MUST NOT** contain the ``default`` attribute. | VNF | MUST | default |
| 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-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-90152 | A VNF's Heat Orchestration Template's ``resources:`` section **MUST** contain the declaration of at least one resource. | VNF | MUST | resources |
| R-90022 | A VNF's Nested YAML file **MAY** be invoked more than once by a VNF's Heat Orchestration Template. | VNF | MAY | Nested Heat Template Requirements |
| R-89913 | A VNF's Heat Orchestration Template's Cinder Volume Module Output Parameter(s) **MUST** include the UUID(s) of the Cinder Volumes created in template, while others **MAY** be included. | VNF | MUST | ONAP Volume Module Output Parameters |
| R-88863 | A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type ``number`` **MUST** have a parameter constraint of ``range`` or ``allowed_values`` defined. | VNF | MUST | constraints |
| R-88540 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv6 Address on a sub-interface port attached to a sub-interface network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}_v6_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` is the index of the IPv6 address | VNF | MUST | OS::ContrailV2::InstanceIp |
| R-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-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-87848 | When using the intrinsic function get_file, ONAP does not support a directory hierarchy for included files. All files must be in a single, flat directory per VNF. A VNF's Heat Orchestration Template's ``get_file`` target files **MUST** be in the same directory hierarchy as the VNF's Heat Orchestration Templates. | VNF | MUST | Heat Files Support (get_file) |
| R-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-87563 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv6 Address on a port attached to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` is the index of the IPv6 address | VNF | MUST | OS::ContrailV2::InstanceIp |
| R-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-87247 | VNF Heat Orchestration Template's Incremental Module file name **MUST** contain only alphanumeric characters and underscores '_' and **MUST NOT** contain the case insensitive word ``base``. | VNF | MUST | Incremental Modules |
| R-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-87004 | A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` Resource ID **SHOULD** use the naming convention * ``{vm-type}_volume_{index}`` where * ``{vm-type}`` is the vm-type * ``{index}`` starts at zero and increments by one | VNF | SHOULD | OS::Cinder::Volume |
| R-86972 | A VNF **SHOULD** create the internal network in the VNF's Heat Orchestration Template Base Module. | VNF | SHOULD | Internal Networks |
| 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-86497 | A VNF's Heat Orchestration Template's Resource ``OS::Cinder::VolumeAttachment`` Resource ID **SHOULD** use the naming convention * ``{vm-type}_volume_attachment_{index}`` where * ``{vm-type}`` is the vm-type * ``{index}`` starts at zero and increments by one | VNF | SHOULD | OS::Cinder::VolumeAttachment |
| R-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-86285 | A VNF's Heat Orchestration template **MUST** have a corresponding environment file. | VNF | MUST | Environment File Format |
| R-86237 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` is passed into a Nested YAML file, the key/value pair name ``vf_module_id`` **MUST NOT** change. | VNF | MUST NOT | vf_module_id |
| R-86182 | When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and the internal network is created in a different Heat Orchestration Template than the ``OS::Neutron::Port``, the ``network`` parameter name **MUST** * follow the naming convention ``int_{network-role}_net_id`` if the Neutron network UUID value is used to reference the network * follow the naming convention ``int_{network-role}_net_name`` if the OpenStack network name in is used to reference the network. where ``{network-role}`` is the network-role of the internal network and a ``get_param`` **MUST** be used as the intrinsic function. | VNF | MUST | Property: network |
| R-85800 | When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``comma_delimited_list``, a parameter **MUST** be delcared once for all ``OS::Nova::Server`` resources associated with the ``{vm-type}``. | VNF | MUST | Property: Name |
| R-85734 | If a VNF's Heat Orchestration Template contains the property ``name`` for a non ``OS::Nova::Server`` resource, the intrinsic function ``str_replace`` **MUST** be used in conjunction with the ONAP supplied metadata parameter ``vnf_name`` to generate a unique value. | VNF | MUST | Resource Property “name” |
| R-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-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-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-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-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-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-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-83418 | The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_floating_v6_ip`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. | VNF | MUST NOT | VIP Assignment, External Networks, Supported by Automation |
| R-83412 | The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter ``{vm-type}_{network-role}_floating_ip`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. | VNF | MUST NOT | VIP Assignment, External Networks, Supported by Automation |
| R-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-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-82481 | A VNF's Heat Orchestration Template's Resource property parameter that is associated with a unique Virtual Machine type **MUST** include ``{vm-type}`` as part of the parameter name with two exceptions: 1.) The Resource ``OS::Nova::Server`` property ``availability_zone`` parameter **MUST NOT** be prefixed with a common ``{vm-type}`` identifier, 2.) The Resource ``OS::Nova::Server`` eight mandatory and optional ``metadata`` parameters (i.e., ``vnf_name``, ``vnf_id``, ``vf_module_id``, ``vf_module_name``, ``vm_role``, ``vf_module_index``, ``environment_context``, ``workload_context``) **MUST NOT** be prefixed with a common ``{vm-type}`` identifier. | VNF | MUST | {vm-type} |
| R-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-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-82018 | The xNF **MUST** load the Ansible Server SSH public key onto xNF VM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative, is for Ansible Server SSH public key to be loaded onto xNF VM(s) under /home/<Mechanized user ID>/.ssh/authorized_keys as part of instantiation, when a Mechanized user ID is created during instantiation, and Configure and all playbooks are designed to use a mechanized user ID only for authentication (never using root authentication during Configure playbook run). This will allow the Ansible Server to authenticate to perform post-instantiation configuration without manual intervention and without requiring specific xNF login IDs and passwords. *CAUTION*: For xNFs configured using Ansible, to eliminate the need for manual steps, post-instantiation and pre-configuration, to upload of SSH public keys, SSH public keys loaded during (heat) instantiation shall be preserved and not removed by (heat) embedded (userdata) scripts. | XNF | MUST | Ansible Client Requirements |
| R-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-81339 | A VNF Heat Orchestration Template's Base Module file name **MUST** include case insensitive 'base' in the filename and **MUST** match one of the following four formats: 1.) ``base_<text>.y[a]ml`` 2.) ``<text>_base.y[a]ml`` 3.) ``base.y[a]ml`` 4.) ``<text>_base_<text>``.y[a]ml where ``<text>`` **MUST** contain only alphanumeric characters and underscores '_' and **MUST NOT** contain the case insensitive word ``base``. | VNF | MUST | Base Modules |
| R-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-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-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-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-78569 | VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``external_id:``. | VNF | MAY | external_id |
| R-78380 | When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see Requirements R-52425 and R-46461), and an IPv4 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``string``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the internal network * the value for ``{index`` must start at zero (0) and increment by one | VNF | MUST | Property: fixed_ips, Map Property: ip_address |
| R-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-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-76449 | A VNF's Heat Orchestration Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIPAssociation``. | VNF | MUST NOT | VIP Assignment, External Networks, Supported by Automation |
| R-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-76057 | VNF Heat Orchestration Template's Nested YAML file name **MUST** contain only alphanumeric characters and underscores '_' and **MUST NOT** contain the case insensitive word ``base``. | VNF | MUST | Nested Heat file |
| R-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-75202 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``workload_context`` is passed into a Nested YAML file, the key/value pair name ``workload_context`` **MUST NOT** change. | VNF | MUST NOT | workload_context |
| R-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-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-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-73468 | The xNF **MUST** allow the NETCONF server connection parameters to be configurable during virtual machine instantiation through Heat templates where SSH keys, usernames, passwords, SSH service and SSH port numbers are Heat template parameters. | XNF | MUST | NETCONF Server Requirements |
| R-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-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-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-71699 | A VNF's Heat Orchestration Template's Resource **MUST NOT** reference a HTTP-based Nested YAML file. | VNF | MUST NOT | type |
| R-71577 | When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a string, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_v6_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the external network * the value for ``{index}`` must start at zero (0) and increment by one | VNF | MUST | Property: fixed_ips, Map Property: ip_address |
| R-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-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-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-70757 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` is passed into a Nested YAML file, the key/value pair name ``vm_role`` **MUST NOT** change. | VNF | MUST NOT | vm_role |
| R-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-70112 | A VNF's Heat Orchestration Template **MUST** reference a Nested YAML file by name. The use of ``resource_registry`` in the VNF's Heat Orchestration Templates Environment File **MUST NOT** be used. | VNF | MUST | Nested Heat Template Requirements |
| 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-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-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-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-69014 | When a VNF connects to an external network, a network role, referred to as the ``{network-role}`` **MUST** be assigned to the external network for use in the VNF's Heat Orchestration Template. | VNF | MUST | External Networks |
| R-68936 | When a VNF creates an internal network, a network role, referred to as the ``{network-role}`` **MUST** be assigned to the internal network for use in the VNF's Heat Orchestration Template. | VNF | MUST | Internal Networks |
| R-68520 | A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is creating a *Reserve Port* with an IPv6 address Resource ID **MUST** use the naming convention * ``reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}`` where * ``{vm-type}`` is the vm-type * ``{network-role}`` is the network-role of the network that the port is attached to * ``{index}`` is the instance of the IPv6 *Reserve Port* for the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::Neutron::Port |
| R-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-68023 | A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **SHOULD** contain the key/value pair ``vf_module_name`` and the value **MUST** be obtained via a ``get_param``. | VNF | SHOULD | vf_module_name |
| R-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-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-67386 | A VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``metadata``. | VNF | MUST | metadata |
| 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-66729 | A VNF's Heat Orchestration Template's Resource that is associated with a unique Virtual Machine type **MUST** include ``{vm-type}`` as part of the resource ID. | VNF | MUST | {vm-type} |
| R-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-65516 | A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to all Virtual Machines in the the VNF, the Resource ID **SHOULD** use the naming convention * ``{vnf-type}_keypair`` where * ``{vnf-type}`` describes the VNF | VNF | SHOULD | OS::Nova::Keypair |
| R-64197 | A VNF's Heat Orchestration Template's Resource ``OS::Heat::ResourceGroup`` Resource ID that creates sub-interfaces **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_port_{port-index}_subinterfaces`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the networks that the sub-interfaces attach to * ``{port-index}`` is the instance of the the port on the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::Heat::ResourceGroup |
| R-63137 | VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``update_policy:``. | VNF | MAY | update_policy |
| 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-62954 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server Resource`` ``metadata`` map value parameter ``environment_context`` is passed into a Nested YAML file, the parameter name ``environment_context`` **MUST NOT** change. | VNF | MUST NOT | environment_context |
| R-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-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-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-62300 | If a VNF has two or more ports that require a Virtual IP Address (VIP), a VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``allowed_address_pairs`` map property ``ip_address`` parameter **MUST** be used. | VNF | MUST | Property: allowed_address_pairs, Map Property: ip_address |
| R-62187 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv4 Address on a port attached to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` is the index of the IPv4 address | VNF | MUST | OS::ContrailV2::InstanceIp |
| R-61001 | A shared Heat Orchestration Template resource is a resource that **MUST** be defined in the base module and will be referenced by one or more resources in one or more incremental modules. The UUID of the shared resource (created in the base module) **MUST** be exposed by declaring a parameter in the ``outputs`` section of the base module. For ECOMP to provided the UUID value of the shared resource to the incremental module, the parameter name defined in the ``outputs`` section of the base module **MUST** be defined as a parameter in the ``parameters`` section of the incremental module. ECOMP will capture the output parameter name and value in the base module and provide the value to the corresponding parameter(s) in the incremental module(s). | VNF | MUST | ONAP Heat VNF Modularity |
| R-60011 | A VNF's Heat Orchestration Template **MUST** have no more than two levels of nesting. | VNF | MUST | Nested Heat Template 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-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-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-59434 | A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Subnet`` Resource ID **SHOULD** use the naming convention * ``int_{network-role}_subnet_{index}`` where * ``{network-role}`` is the network-role * ``{index}`` is the ``{index}`` of the subnet of the network | VNF | SHOULD | OS::Neutron::Subnet |
| R-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-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-58301 | The xNF **SHOULD NOT** use playbooks that make requests to Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.); therefore, there is no use for Cloud specific variables like Openstack UUIDs in Ansible Playbook related artifacts. **Rationale**: Flows that require interactions with Cloud services e.g. Openstack shall rely on workflows run by an Orchestrator (Change Management) or other capability (such as a control loop or Operations GUI) outside Ansible Server which can be executed by a APPC/SDN-C. There are policies, as part of Control Loop models, that send remediation action requests to an APPC/SDN-C; these are triggered as a response to an event or correlated events published to Event Bus. | XNF | SHOULD NOT | Ansible Playbook Requirements |
| R-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-56721 | A VNF's Incremental Module **MAY** utilize nested heat. | VNF | MAY | Nested Heat Orchestration Templates Overview |
| 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-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-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-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-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-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-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-54458 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` that is attaching to a sub-interface network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` is the instance of the the vmi on the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::ContrailV2::VirtualMachineInterface |
| R-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-54171 | When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``string``, the parameter name **MUST** follow the naming convention ``{vm-type}_name_{index}``, where ``{index}`` is a numeric value that starts at zero and increments by one. | VNF | MUST | Property: Name |
| R-53952 | A VNF's Heat Orchestration Template's Resource **MUST NOT** reference a HTTP-based resource definitions. | VNF | MUST NOT | type |
| R-53310 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv4 Address on a port attached to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the {vm-type} * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of {network-role} * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` is the index of the IPv4 address | VNF | MUST | OS::ContrailV2::InstanceIp |
| R-52753 | VNF's Heat Orchestration Template's Base Module's output parameter's name and type **MUST** match the VNF's Heat Orchestration Template's incremental Module's name and type unless the output parameter is of type ``comma_delimited_list``, then the corresponding input parameter **MUST** be declared as type ``json``. | VNF | MUST | ONAP Base Module Output Parameters |
| R-52530 | A VNF's Heat Orchestration Template's Nested YAML file **MUST** be in the same directory hierarchy as the VNF's Heat Orchestration Templates. | VNF | MUST | Nested Heat Template Requirements |
| R-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-50816 | A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MAY** contain the key/value pair ``vf_module_index`` and the value **MUST** be obtained via a ``get_param``. | VNF | MAY | vf_module_index |
| R-50468 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port (i.e. virtual machine interface) is attached to * ``{vmi_index}`` is the instance of the the vmi on the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::ContrailV2::VirtualMachineInterface |
| R-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-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-49177 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` is passed into a Nested YAML file, the key/value pair name ``vf_module_name`` **MUST NOT** change. | VNF | MUST | vf_module_name |
| R-48067 | A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a substring of ``{network-role}``. | VNF | MUST NOT | {vm-type} |
| 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-46968 | VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``depends_on:``. | VNF | MAY | depends_on |
| 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-46128 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv6 Address on a port attached to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of {network-role} * ``v6_IP`` signifies that an IPv6 address is being configured * ``{index}`` is the index of the IPv6 address | VNF | MUST | OS::ContrailV2::InstanceIp |
| R-46119 | A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume **MAY** be defined in a Base Module. | VNF | MAY | ONAP VNF Modularity Overview |
| R-46096 | A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``encrypted_parameters:`` section. | VNF | MAY | Environment File Format |
| 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-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-44491 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_id`` is passed into a Nested YAML file, the key/value pair name ``vnf_id`` **MUST NOT** change. | VNF | MUST NOT | vnf_id |
| R-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-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-44001 | A VNF's Heat Orchestration Template parameter declaration **MUST** contain the attribute ``description``. | VNF | MUST | description |
| R-43740 | VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``deletion_policy:``. | VNF | MAY | deletion_policy |
| 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-42685 | A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``parameter_merge_strategies:`` section. | VNF | MAY | Environment File Format |
| 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-41492 | When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 Virtual IP (VIP) address is assigned via ONAP automation using the property ``allowed_address_pairs`` map property ``ip_address`` and the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_floating_ip`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the external network And the parameter **MUST** be declared as type ``string``. | VNF | MUST | VIP Assignment, External Networks, Supported by Automation |
| R-40971 | When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv4 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a string, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` * ``{network-role}`` is the {network-role} of the external network * the value for ``{index}`` must start at zero (0) and increment by one | VNF | MUST | Property: fixed_ips, Map Property: ip_address |
| R-40899 | When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``string``, a parameter **MUST** be delcared for each ``OS::Nova::Server`` resource associated with the ``{vm-type}``. | VNF | MUST | Property: Name |
| R-40551 | A VNF's Heat Orchestration Template's Nested YAML files **MAY** (or **MAY NOT**) contain the section ``resources:``. | VNF | MAY | resources |
| 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-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-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-39402 | A VNF's Heat Orchestration Template **MUST** contain the section ``description:``. | MUST | description | |
| 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-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-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-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-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-36982 | A VNF's Heat Orchestration template **MAY** contain the ``outputs:`` section. | VNF | MAY | outputs |
| R-36772 | A VNF's Heat Orchestration Template's parameter **MUST** include the attribute ``type:``. | VNF | MUST | type |
| 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-36582 | A VNF's Base Module **MAY** utilize nested heat. | VNF | MAY | Nested Heat Orchestration Templates Overview |
| 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-35735 | When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the ONAP definition, see Requirement R-57424), and an IPv6 Virtual IP (VIP) address is assigned via ONAP automation using the property ``allowed_address_pairs`` map property ``ip_address``, the parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_floating_v6_ip`` where * ``{vm-type}`` is the {vm-type} associated with the OS::Nova::Server * ``{network-role}`` is the {network-role} of the external network And the parameter **MUST** be declared as type ``string``. | VNF | MUST | VIP Assignment, External Networks, Supported by Automation |
| R-35666 | If a VNF has an internal network, the VNF Heat Orchestration Template **MUST** include the heat resources to create the internal network. | VNF | MUST | Internal Networks |
| R-35414 | A VNF Heat Orchestration's template **MUST** contain the section ``parameters:``. | VNF | MUST | parameters |
| 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-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-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-32557 | A VNF's Heat Orchestration Template parameter declaration **MAY** contain the attribute ``hidden:``. | VNF | MAY | hidden |
| R-32408 | If a VNF's Heat Orchestration Template property ``name`` for a non ``OS::Nova::Server`` resource uses the intrinsic function ``str_replace`` in conjunction with the ONAP supplied metadata parameter ``vnf_name`` and does not create a unique value, additional data **MUST** be used in the ``str_replace`` to create a unique value, such as ``OS::stack_name`` and/or the ``OS::Heat::ResourceGroup`` ``index``. | VNF | MUST | Resource Property “name” |
| R-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-32094 | A VNF's Heat Orchestration Template parameter declaration **MAY** contain the attribute ``label:``. | VNF | MAY | label |
| R-32025 | When a VNF creates two or more internal networks, each internal network **MUST** be assigned a unique ``{network-role}`` in the context of the VNF for use in the VNF's Heat Orchestration Template. | VNF | MUST | Internal Networks |
| R-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-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-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-30395 | A VNF's Cinder Volume Module **MAY** utilize nested heat. | VNF | MAY | Nested Heat Orchestration Templates 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-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-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-29751 | A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` Resource ID **MUST** use the naming convention * ``{vm-type}_server_{index}`` where * ``{vm-type}`` is the vm-type * ``{index}`` is the index | VNF | MUST | OS::Nova::Server |
| R-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-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-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-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-27818 | When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the ONAP definition, see RRequirements R-52425 and R-46461), and an IPv6 address is assigned using the property ``fixed_ips`` map property ``ip_address`` and the parameter type is defined as a ``string``, the parameter name **MUST** follow the naming convention * ``{vm-type}_int_{network-role}_v6_ip_{index}`` where * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` * ``{network-role}`` is the {network-role} of the internal network * the value for ``{index}`` must start at zero (0) and increment by one | VNF | MUST | Property: fixed_ips, Map Property: ip_address |
| R-27469 | A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is creating a *Reserve Port* with an IPv4 address Resource ID **MUST** use the naming convention * ``reserve_port_{vm-type}_{network-role}_floating_ip_{index}`` where * ``{vm-type}`` is the vm-type * ``{network-role}`` is the network-role of the network that the port is attached to * ``{index}`` is the instance of the IPv4 *Reserve Port* for the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::Neutron::Port |
| R-27078 | A VNF's Heat Orchestration template **MUST** contain the section ``heat_template_version:``. | VNF | MUST | heat_template_version |
| R-26506 | A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain only alphanumeric characters and/or underscores '_' and **MUST NOT** contain any of the following strings: ``_int`` or ``int_`` or ``_int_``. | VNF | MUST | {network-role} |
| R-26351 | A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is attaching to an internal network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{port-index}`` is the instance of the the port on the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::Neutron::Port |
| R-26124 | If a VNF Heat Orchestration Template parameter has a default value, it **MUST** be enumerated in the environment file. | VNF | MUST | default |
| 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-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-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-24997 | A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to one ``{vm-type}`` Resource ID **SHOULD** use the naming convention * ``{vm-type}_keypair_{index}`` where * ``{network-role}`` is the network-role * ``{index}`` is the ``{index}`` of the keypair | VNF | SHOULD | OS::Nova::Keypair |
| R-24893 | A VNF's Heat Orchestration template's Environment File's **MAY** contain the ``event_sinks:`` section. | VNF | MAY | Environment File Format |
| R-23664 | A VNF's Heat Orchestration template **MUST** contain the section ``resources:``. | VNF | MUST | resources |
| 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-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-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-22608 | When a VNF's Heat Orchestration Template's Base Module's output parameter is declared as an input parameter in an Incremental Module, the parameter attribute ``constraints:`` **MUST NOT** be declared. | VNF | MUST NOT | ONAP Base Module Output Parameters |
| R-22589 | A VNF's Heat Orchestration Template parameter declaration **MAY** contain the attribute ``immutable:``. | VNF | MAY | immutable |
| R-22441 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` is passed into a Nested YAML file, the key/value pair ``vf_module_index`` **MUST NOT** change. | VNF | MUST NOT | vf_module_index |
| R-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-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-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-20947 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` that is configuring an IPv4 Address on a sub-interface port attached to a sub-interface network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}_IP_{index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{vmi_index}`` is the instance of the the virtual machine interface (e.g., port) on the vm-type attached to the network of ``{network-role}`` * ``IP`` signifies that an IPv4 address is being configured * ``{index}`` is the index of the IPv4 address | VNF | MUST | OS::ContrailV2::InstanceIp |
| R-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-20547 | When an ONAP Volume Module Output Parameter is declared as an input parameter in a base or an incremental module Heat Orchestration Template, parameter constraints **MUST NOT** be declared. | VNF | MUST NOT | ONAP Volume Module Output Parameters |
| R-20453 | A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is attaching to an external network Resource ID **MUST** use the naming convention * ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}`` where * ``{vm-type}`` is the vm-type * ``{vm-type_index}`` is the instance of the ``{vm-type}`` * ``{network-role}`` is the network-role of the network that the port is attached to * ``{port-index}`` is the instance of the the port on the vm-type attached to the network of ``{network-role}`` | VNF | MUST | OS::Neutron::Port |
| R-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-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-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-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-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-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-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-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-17528 | A VNF's Heat Orchestration Template's first level Nested YAML file **MUST NOT** contain more than one ``OS::Nova::Server`` resource. A VNF's Heat Orchestration Template's second level Nested YAML file **MUST NOT** contain an ``OS::Nova::Server`` resource. | VNF | MUST | Nested Heat Template Requirements |
| R-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-16968 | A VNF's Heat Orchestration Templates **MUST NOT** include heat resources to create external networks. | VNF | MUST NOT | External Networks |
| R-16576 | If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` is passed into a Nested YAML file, the key/value pair name ``vnf_name`` **MUST NOT** change. | VNF | MUST NOT | vnf_name |
| R-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-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-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-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-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-14447 | A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate`` Resource ID **MAY** use the naming convention * ``{vm-type}_RST_{index}`` where * ``{vm-type}`` is the vm-type * ``RST`` signifies that it is the Resource Service Template * ``{index}`` is is the index | VNF | MAY | OS::ContrailV2::ServiceTemplate |
| R-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-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-11690 | When a VNF's Heat Orchestration Template's Resource ID contains an ``{index}`` value (e.g. multiple VMs of same ``{vm-type}``), the ``{index}`` **MUST** start at zero and increment by one. | VNF | MUST | Resource IDs |
| R-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-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-10834 | If a VNF's Heat Orchestration Template resource attribute ``property:`` uses a nested ``get_param``, the nested ``get_param`` **MUST** reference an index. | VNF | MUST | properties |
| R-10754 | If a VNF has two or more ports that attach to an external network that require a Virtual IP Address (VIP), and the VNF requires ONAP automation to assign the IP address, all the Virtual Machines using the VIP address **MUST** be instantiated in the same Base Module Heat Orchestration Template or in the same Incremental Module Heat Orchestration Template. | VNF | MUST | VIP Assignment, External Networks, Supported by Automation |
| R-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-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-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-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-07443 | A VNF's Heat Orchestration Templates' Cinder Volume Module Output Parameter's name and type **MUST** match the input parameter name and type in the corresponding Base Module or Incremental Module unless the Output Parameter is of the type ``comma_delimited_list``, then the corresponding input parameter **MUST** be declared as type ``json``. | VNF | MUST | ONAP Volume Module Output Parameters |
| R-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-05257 | A VNF's Heat Orchestration Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIP``. | VNF | MUST NOT | VIP Assignment, External Networks, Supported by Automation |
| R-05201 | When a VNF connects to two or more external networks, each external network **MUST** be assigned a unique ``{network-role}`` in the context of the VNF for use in the VNF's Heat Orchestration Template. | VNF | MUST | External Networks |
| R-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-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-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-04344 | A VNF's Nested YAML file **MAY** be invoked by more than one of a VNF's Heat Orchestration Templates (when the VNF is composed of two or more Heat Orchestration Templates). | VNF | MAY | Nested Heat Template Requirements |
| R-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-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-03324 | A VNF's Heat Orchestration template's Environment File **MUST** contain the ``parameters:`` section. | VNF | MUST | Environment File Format |
| R-03251 | A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume **MAY** be defined in a Cinder Volume Module. | VNF | MAY | ONAP VNF Modularity Overview |
| R-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-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-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-01455 | When a VNF's Heat Orchestration Template creates a Virtual Machine (i.e., ``OS::Nova::Server``), each "class" of VMs **MUST** be assigned a VNF unique ``{vm-type}``; where "class" defines VMs that **MUST** have the following identical characteristics: 1.) ``OS::Nova::Server`` resource property ``flavor`` value 2.) ``OS::Nova::Server`` resource property ``image`` value 3.) Cinder Volume attachments - Each VM in the "class" **MUST** have the identical Cinder Volume configuration 4.) Network attachments and IP address requirements - Each VM in the "class" **MUST** have the the identical number of ports connecting to the identical networks and requiring the identical IP address configuration. | VNF | MUST | {vm-type} |
| R-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-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-00977 | A VNF's Heat Orchestration Template's ``{network-role}`` **MUST NOT** be a substring of ``{vm-type}``. | VNF | MUST NOT | {network-role} |
| R-00228 | A VNF's Heat Orchestration Template **MAY** reference the nested heat statically by repeated definition. | VNF | MAY | Nested Heat Template Requirements |
| R-00011 | A VNF's Heat Orchestration Template's parameter defined in a nested YAML file **MUST NOT** have a parameter constraint defined. | VNF | MUST NOT | constraints |