VNF HEAT Requirements

Owned by Steven wright
Last updated: Nov 15, 2018
42 min read

298 Requirements containing "HEAT" in the requirements text


IDContentTargetKeywordSection Name
R-901331The VNF's Heat Orchestration   Template's Resource ``OS::Nova::Server`` property ``image`` value **MUST** be   be obtained via a ``get_param``.VNFMUSTProperty: image
R-842258The 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).VNFMUSTVNF General Security Requirements
R-663631The VNF's Heat Orchestration   Template's Resource ``OS::Nova::Server`` property ``name`` value **MUST** be   be obtained via a ``get_param``.VNFMUSTProperty: Name
R-481670The VNF's Heat Orchestration   Template's Resource ``OS::Nova::Server`` property ``flavor`` value **MUST**   be be obtained via a ``get_param``.VNFMUSTProperty: flavor
R-304011A 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.VNFMUSTResource: OS::Nova::Server - Parameters
R-270358A 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`` resourceVNFMUSTONAP Heat Cinder Volumes
R-99812A 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.VNFMUST NOTResource Property “name”
R-99798A 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.VNFMAYBoot Options
R-99771The 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.VNFMUSTVNF General Security Requirements
R-99646A VNF's YAML files (i.e, Heat   Orchestration Template files and Nested files) **MUST** have a unique name in   the scope of the VNF.VNFMUSTONAP Heat Orchestration Template Filenames
R-99110A 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.VNFMUSTOS::ContrailV2::VirtualNetwork
R-98905The 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.VNFMUST NOTProperty: fixed_ips, Map Property: ip_address
R-98748The 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``.VNFMUSTVIP Assignment, External Networks, Supported by Automation
R-98569The 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.VNFMUSTProperty: fixed_ips, Map Property: ip_address
R-98450The 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.VNFMUSTProperty: availability_zone
R-98407A 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_``.VNFMUST NOT{vm-type}
R-98374A 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.VNFMUST NOTvf_module_id
R-98138When 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}``.VNFMUSTResource IDs
R-97726A VNF's Heat Orchestration   Template's Base Module Output Parameter names **MUST** contain ``{vm-type}``   and/or ``{network-role}`` when appropriate.VNFMUSTONAP Base Module Output Parameters:
R-97201The 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.VNFMUSTProperty: fixed_ips, Map Property: ip_address
R-97102The 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.VNFMUSTCompute, Network, and Storage Requirements
R-96983A 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.VNFMUST{network-role}
R-96482When a VNF's Heat Orchestration   Template's resource is associated with a single external network, the   Resource ID **MUST** contain the text ``{network-role}``.VNFMUSTResource IDs
R-96253A 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}``VNFMUSTOS::ContrailV2::VirtualMachineInterface
R-96227A VNF's Heat Orchestration   Template's parameter defined in a non-nested YAML file as type ``json``   **MAY** have a parameter constraint defined.VNFMAYconstraints
R-95430If 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``.VNFMUSTvm_role
R-95303A VNF's Heat Orchestration   Template **MUST** be defined using valid YAML.VNFMUSTYAML Format
R-94669If 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``.VNFMUSTOAM Management IP Addresses
R-94509A 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``.VNFMUSTIncremental Modules
R-93496The 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.VNFMUSTProperty: fixed_ips, Map Property: ip_address
R-93177When 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.VNFMUSTProperty: network
R-93030The 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.VNFMUST NOTProperty: fixed_ips, Map Property: ip_address
R-92635A VNF's Heat Orchestration   Template **MUST** be compliant with the OpenStack Template Guide.
MUSTONAP Heat Orchestration Template Format
R-92193A 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.VNFMUST NOTExternal Networks
R-91342A 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``.VNFMUSTBase Modules
R-91273A 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``.VNFMAY NOTparameters
R-91125The 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.VNFMUSTProperty: image
R-90748A VNF's Heat Orchestration   Template's Resource OS::Heat::CinderVolume **MAY** be defined in an   Incremental Module.VNFMAYONAP VNF Modularity Overview
R-90526A VNF Heat Orchestration   Template parameter declaration **MUST NOT** contain the ``default``   attribute.VNFMUSTdefault
R-90279A 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``.VNFMUSTparameters
R-90206The 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.VNFMUSTProperty: fixed_ips, Map Property: ip_address
R-90152A VNF's Heat Orchestration   Template's ``resources:`` section **MUST** contain the declaration of at   least one resource.VNFMUSTresources
R-90022A VNF's Nested YAML file **MAY**   be invoked more than once by a VNF's Heat Orchestration Template.VNFMAYNested Heat Template Requirements
R-89913A 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.VNFMUSTONAP Volume Module Output Parameters
R-88863A 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.VNFMUSTconstraints
R-88540A 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 addressVNFMUSTOS::ContrailV2::InstanceIp
R-88536A VNF's Heat Orchestration   Template's OS::Nova::Server Resource **SHOULD** contain the metadata map   value parameter 'environment_context'.VNFSHOULDenvironment_context
R-88524A VNF's Heat Orchestration   Template's Volume Template Output Parameter names **MUST** contain   ``{vm-type}`` when appropriate.VNFMUSTONAP Volume Template Output Parameters:
R-87848When 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.VNFMUSTHeat Files Support (get_file)
R-87817When 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``.VNFMUSTProperty: Name
R-87563A 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 addressVNFMUSTOS::ContrailV2::InstanceIp
R-87485A VNF's Heat Orchestration   Template's file extension **MUST** be in the lower case format ``.yaml`` or   ``.yml``.VNFMUSTONAP Heat Orchestration Template Filenames
R-87247VNF Heat Orchestration   Template's Incremental Module file name **MUST** contain only alphanumeric   characters and underscores '_' and **MUST NOT** contain the case insensitive   word ``base``.VNFMUSTIncremental Modules
R-87123The 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.VNFMUST NOTProperty: fixed_ips, Map Property: ip_address
R-87004A 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 oneVNFSHOULDOS::Cinder::Volume
R-86972A VNF **SHOULD** create the   internal network in the VNF's Heat Orchestration Template Base Module.VNFSHOULDInternal Networks
R-86588A 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.VNFSHOULD{network-role}
R-86497A 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 oneVNFSHOULDOS::Cinder::VolumeAttachment
R-86476A 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., '_').VNFMUSTvm_role
R-86285A VNF's Heat Orchestration   template **MUST** have a corresponding environment file.VNFMUSTEnvironment File Format
R-86237If 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.VNFMUST NOTvf_module_id
R-86182When 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.VNFMUSTProperty: network
R-85800When 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}``.VNFMUSTProperty: Name
R-85734If 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.VNFMUSTResource Property “name”
R-85328A 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``.VNFMAYvm_role
R-85235When 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     networkVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-84457A 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 TupleVNFMAYOS::ContrailV2::PortTuple
R-84322A 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.VNFMUST{network-role}
R-84123When    * 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.VNFMUSTProperty: fixed_ips, Map Property: subnet
R-83706When 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.VNFMUSTBoot Options
R-83677The 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.VNFMUST NOTProperty: fixed_ips, Map Property: subnet
R-83418The 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.VNFMUST NOTVIP Assignment, External Networks, Supported by Automation
R-83412The 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.VNFMUST NOTVIP Assignment, External Networks, Supported by Automation
R-82732A VNF Heat Orchestration   Template's Cinder Volume Module **MUST** be named identical to the base or   incremental module it is supporting with ``_volume`` appended.VNFMUSTCinder Volume Modules
R-82551When 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}``).VNFMUSTResource IDs
R-82481A 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.VNFMUST{vm-type}
R-82134A 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``.VNFMUSTvf_module_id
R-82115When 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}``).VNFMUSTResource IDs
R-82018The 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.XNFMUSTAnsible Client Requirements
R-81979A 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 IPAMVNFMAYOS::ContrailV2::NetworkIpam
R-81339A 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``.VNFMUSTBase Modules
R-81214A VNF's Heat Orchestration   Template's Resource ``OS::ContrailV2::InterfaceRouteTable`` Resource ID   **MUST** contain the ``{network-role}``.VNFMUSTOS::ContrailV2::InterfaceRouteTable
R-80829The 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.VNFMUST NOTProperty: fixed_ips, Map Property: subnet
R-80374A 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.VNFMUST NOTvf_module_name
R-79817A 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.VNFMAYconstraints
R-78569VNF's Heat Orchestration   Template's Resource **MAY** declare the attribute ``external_id:``.VNFMAYexternal_id
R-78380When 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 oneVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-76718If 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.VNFMUSTHeat Files Support (get_file)
R-76682If 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.VNFMUST NOTInterface Route Table Prefixes for Contrail InterfaceRoute Table
R-76449A VNF's Heat Orchestration   Template's **MUST NOT** contain the Resource   ``OS::Neutron::FloatingIPAssociation``.VNFMUST NOTVIP Assignment, External Networks, Supported by Automation
R-76160When    * 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.VNFMUSTProperty: fixed_ips, Map Property: subnet
R-76057VNF Heat Orchestration   Template's Nested YAML file name **MUST** contain only alphanumeric   characters and underscores '_' and **MUST NOT** contain the case insensitive   word ``base``.VNFMUSTNested Heat file
R-76014A VNF's Heat Orchestration   Template's Resource ``OS::ContrailV2::ServiceHealthCheck`` Resource ID   **MUST** contain the ``{vm-type}``.VNFMUSTOS::ContrailV2::ServiceHealthCheck
R-75202If 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.VNFMUST NOTworkload_context
R-75141A VNF's Heat Orchestration   Template's resource name (i.e., <resource ID>) **MUST** only contain   alphanumeric characters and underscores ('_').VNFMUSTresource ID
R-74978A 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``.VNFMUSTworkload_context
R-74304A VNF's Heat Orchestration   Template's Environment file extension **MUST** be in the lower case format   ``.env``.VNFMUSTONAP Heat Orchestration Template Filenames
R-73468The 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.XNFMUSTNETCONF Server Requirements
R-73213A 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-roleVNFSHOULDOS::Neutron::SecurityGroup
R-72871A 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.VNFMUST NOTvf_module_id
R-72483A 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``.VNFMUSTvnf_name
R-71699A VNF's Heat Orchestration   Template's Resource **MUST NOT** reference a HTTP-based Nested YAML file.VNFMUST NOTtype
R-71577When 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 oneVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-71493A 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``.VNFMUSTvf_module_id
R-71152The VNF's Heat Orchestration   Template's Resource ``OS::Nova::Server`` property ``image`` parameter   **MUST** be declared as type: ``string``.VNFMUSTProperty: image
R-70964If 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   usedVNFMUST NOTItems to Note
R-70757If 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.VNFMUST NOTvm_role
R-70276A 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.VNFMUST NOTNested Heat file
R-70112A 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.VNFMUSTNested Heat Template Requirements
R-69663A VNF **MAY** be composed from   one or more Heat Orchestration Templates, each of which represents a subset   of the overall VNF.VNFMAYONAP VNF Modularity Overview
R-69634The 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.VNFMUST NOTProperty: fixed_ips, Map Property: subnet
R-69588When 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.VNFMUSTBoot Options
R-69431The 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.VNFMUSTProperty: flavor
R-69014When 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.VNFMUSTExternal Networks
R-68936When 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.VNFMUSTInternal Networks
R-68520A 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}``VNFMUSTOS::Neutron::Port
R-68198A VNF's Heat Orchestration   template's Environment File's ``parameters:`` section **MAY** (or **MAY   NOT**) enumerate parameters.VNFMAYEnvironment File Format
R-68023A 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``.VNFSHOULDvf_module_name
R-67793When 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.VNFMUST NOTResource IDs
R-67597A 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.VNFMUST NOTvm_role
R-67386A VNF's Heat Orchestration   Template's Resource **MAY** declare the attribute ``metadata``.VNFMUSTmetadata
R-67231A VNF's Heat Orchestration   template's Environment File's **MUST NOT** contain the ``resource_registry:``   section.VNFMUST NOTEnvironment File Format
R-66729A 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.VNFMUST{vm-type}
R-65618A 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 interfaceVNFMAYOS::ContrailV2::ServiceHealthCheck
R-65516A 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 VNFVNFSHOULDOS::Nova::Keypair
R-64197A 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}``VNFMUSTOS::Heat::ResourceGroup
R-63137VNF's Heat Orchestration   Template's Resource **MAY** declare the attribute ``update_policy:``.VNFMAYupdate_policy
R-62983When 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.VNFMUSTProperty: network
R-62954If 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.VNFMUST NOTenvironment_context
R-62802When 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.VNFMUSTProperty: fixed_ips, Map Property: subnet
R-62590The 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.VNFMUST NOTProperty: fixed_ips, Map Property: ip_address
R-62428A 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``.VNFMUSTvnf_name
R-62300If 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.VNFMUSTProperty: allowed_address_pairs, Map Property: ip_address
R-62187A 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 addressVNFMUSTOS::ContrailV2::InstanceIp
R-61001A 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).VNFMUSTONAP Heat VNF Modularity
R-60011A VNF's Heat Orchestration   Template **MUST** have no more than two levels of nesting.VNFMUSTNested Heat Template Requirements
R-59930A VNF's Heat Orchestration   template's Environment File's **MAY** contain the ``parameter_defaults:``   section.VNFMAYEnvironment File Format
R-59568The 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.VNFMUST NOTProperty: availability_zone
R-59482A VNF's Heat Orchestration   Template **MUST NOT** be VNF instance specific or cloud site specific.VNFMUST NOTScope of a Heat Orchestration Template
R-59434A 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   networkVNFSHOULDOS::Neutron::Subnet
R-58670The VNF's Heat Orchestration   Template's Resource ``OS::Nova::Server`` property ``image`` parameter name   **MUST** follow the naming convention ``{vm-type}_image_name``.VNFMUSTProperty: image
R-58424A VNF's Heat Orchestration   Template's use of ``{network-role}`` in all Resource property parameter names   **MUST** be the same case.VNFMUST{network-role}
R-58301The 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.XNFSHOULD NOTAnsible Playbook Requirements
R-57282Each 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.VNFMUSTProperty: image
R-56721A VNF's Incremental Module   **MAY** utilize nested heat.VNFMAYNested Heat Orchestration Templates Overview
R-56438A VNF's Heat Orchestration   Template's Nested YAML file extension **MUST** be in the lower case format   ``.yaml`` or ``.yml``.VNFMUSTONAP Heat Orchestration Template Filenames
R-56287If 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} }VNFMUSTOAM Management IP Addresses
R-56183A 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.VNFMUST NOTenvironment_context
R-55802The 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*.VNFMUSTCompute, Network, and Storage Requirements
R-55306A 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.VNFMUST NOTvf_module_index
R-55218A 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.VNFMUST NOTvnf_id
R-54517When a VNF's Heat Orchestration   Template's resource is associated with a single ``{vm-type}``, the Resource   ID **MUST** contain the ``{vm-type}``.VNFMUSTResource IDs
R-54458A 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}``VNFMUSTOS::ContrailV2::VirtualMachineInterface
R-54340A 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``.VNFMUSTvf_module_index
R-54171When 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.VNFMUSTProperty: Name
R-53952A VNF's Heat Orchestration   Template's Resource **MUST NOT** reference a HTTP-based resource definitions.VNFMUST NOTtype
R-53310A 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 addressVNFMUSTOS::ContrailV2::InstanceIp
R-52753VNF'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``.VNFMUSTONAP Base Module Output Parameters
R-52530A VNF's Heat Orchestration   Template's Nested YAML file **MUST** be in the same directory hierarchy as   the VNF's Heat Orchestration Templates.VNFMUSTNested Heat Template Requirements
R-51430The 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``.VNFMUSTProperty: Name
R-50816A 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``.VNFMAYvf_module_index
R-50468A 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}``VNFMUSTOS::ContrailV2::VirtualMachineInterface
R-50436The VNF's Heat Orchestration   Template's Resource ``OS::Nova::Server`` property ``flavor`` parameter   **MUST** be declared as type: ``string``.VNFMUSTProperty: flavor
R-50011A 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.VNFMUSTOS::Heat::ResourceGroup Property count
R-49177If 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.VNFMUSTvf_module_name
R-48067A VNF's Heat Orchestration   Template's ``{vm-type}`` **MUST NOT** be a substring of ``{network-role}``.VNFMUST NOT{vm-type}
R-47061A VNF's Heat Orchestration   Template's OS::Nova::Server Resource **SHOULD** contain the metadata map   value parameter 'workload_context'.VNFSHOULDworkload_context
R-46968VNF's Heat Orchestration   Template's Resource **MAY** declare the attribute ``depends_on:``.VNFMAYdepends_on
R-46839A VNF's Heat Orchestration   Template's use of ``{vm-type}`` in all Resource IDs **MUST** be the same   case.VNFMUST{vm-type}
R-46128A 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 addressVNFMUSTOS::ContrailV2::InstanceIp
R-46119A VNF's Heat Orchestration   Template's Resource OS::Heat::CinderVolume **MAY** be defined in a Base   Module.VNFMAYONAP VNF Modularity Overview
R-46096A VNF's Heat Orchestration   template's Environment File's **MAY** contain the ``encrypted_parameters:``   section.VNFMAYEnvironment File Format
R-45188The VNF's Heat Orchestration   Template's Resource 'OS::Nova::Server' property ``flavor`` parameter name   **MUST** follow the naming convention ``{vm-type}_flavor_name``.VNFMUSTProperty: flavor
R-44896The VNF Package **MUST** include   VM requirements via a Heat template that provides the necessary data for high   availability redundancy model.VNFMUSTCompute, Network, and Storage Requirements
R-44491If 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.VNFMUST NOTvnf_id
R-44318A 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.VNFMUST NOTvnf_name
R-44271The 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: --- \" ! $ ' (\ \ ) = ~ ^ | @ ` { } [ ] > ,   . _VNFSHOULD NOTContrail Issue with Values for OS::Nova::Server Property Name
R-44001A VNF's Heat Orchestration   Template parameter declaration **MUST** contain the attribute   ``description``.VNFMUSTdescription
R-43740VNF's Heat Orchestration   Template's Resource **MAY** declare the attribute ``deletion_policy:``.VNFMAYdeletion_policy
R-43413A VNF **MUST** utilize a modular   Heat Orchestration Template design to support scaling (growth/de-growth).VNFMUSTSupport of heat stack update
R-42685A VNF's Heat Orchestration   template's Environment File's **MAY** contain the   ``parameter_merge_strategies:`` section.VNFMAYEnvironment File Format
R-41888A VNF's Heat Orchestration   Template intrinsic function ``get_file`` **MUST NOT** utilize URL-based file   retrieval.VNFMUST NOTHeat Files Support (get_file)
R-41492When 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``.VNFMUSTVIP Assignment, External Networks, Supported by Automation
R-40971When 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 oneVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-40899When 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}``.VNFMUSTProperty: Name
R-40551A VNF's Heat Orchestration   Template's Nested YAML files **MAY** (or **MAY NOT**) contain the section   ``resources:``.VNFMAYresources
R-40518A VNF's Heat Orchestration   Template's parameter defined in a non-nested YAML file as type ``string``   **MAY** have a parameter constraint defined.VNFMAYconstraints
R-40499Each 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.VNFMUSTProperty: flavor
R-39841The 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.VNFMUST NOTProperty: fixed_ips, Map Property: ip_address
R-39402A VNF's Heat Orchestration   Template **MUST** contain the section ``description:``.
MUSTdescription
R-39349A VNF Heat Orchestration   Template **MUST NOT** be designed to utilize the OpenStack ``heat   stack-update`` command for scaling (growth/de-growth).VNFMUST NOTSupport of heat stack update
R-39067A 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``.VNFMUSTvf_module_name
R-38236The VNF's Heat Orchestration   Template's resource ``OS::Neutron::Port`` property ``fixed_ips`` map property   ``subnet`` parameter **MUST** be declared type ``string``.VNFMUSTProperty: fixed_ips, Map Property: subnet
R-37437A 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``.VNFMUSTvnf_id
R-37039A 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.VNFMUST NOTvf_module_index
R-36982A VNF's Heat Orchestration   template **MAY** contain the ``outputs:`` section.VNFMAYoutputs
R-36772A VNF's Heat Orchestration   Template's parameter **MUST** include the attribute ``type:``.VNFMUSTtype
R-36687A 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.VNFSHOULD{vm-type}
R-36582A VNF's Base Module **MAY**   utilize nested heat.VNFMAYNested Heat Orchestration Templates Overview
R-36542A 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.VNFMUST NOTvnf_name
R-35735When 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``.VNFMUSTVIP Assignment, External Networks, Supported by Automation
R-35666If a VNF has an internal   network, the VNF Heat Orchestration Template **MUST** include the heat   resources to create the internal network.VNFMUSTInternal Networks
R-35414A VNF Heat Orchestration's   template **MUST** contain the section ``parameters:``.VNFMUSTparameters
R-34055A 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.VNFMUST NOTworkload_context
R-34037The 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``.VNFMUSTProperty: fixed_ips, Map Property: ip_address
R-33132A 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).VNFMAYONAP VNF Modularity Overview
R-32557A VNF's Heat Orchestration   Template parameter declaration **MAY** contain the attribute ``hidden:``.VNFMAYhidden
R-32408If 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``.VNFMUSTResource Property “name”
R-32394A VNF's Heat Orchestration   Template's use of ``{vm-type}`` in all Resource property parameter names   **MUST** be the same case.VNFMUST{vm-type}
R-32094A VNF's Heat Orchestration   Template parameter declaration **MAY** contain the attribute ``label:``.VNFMAYlabel
R-32025When 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.VNFMUSTInternal Networks
R-31141VNF 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``.VNFMUSTCinder Volume Modules
R-30804A VNF's Heat Orchestration   Template's Resource ``OS::Heat::MultipartMime`` Resource ID **MUST** contain   the ``{vm-type}``.VNFMUSTOS::Heat::MultipartMime
R-30753A VNF's Heat Orchestration   Template's Resource ``OS::ContrailV2::NetworkIpam`` Resource ID **MUST**   contain the ``{network-role}``.VNFMUSTOS::ContrailV2::NetworkIpam
R-30395A VNF's Cinder Volume Module   **MAY** utilize nested heat.VNFMAYNested Heat Orchestration Templates Overview
R-30005A 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 VNFVNFMAYOS::Neutron::SecurityGroup
R-29872The 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.VNFMUST NOTProperty: network
R-29765When 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     networkVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-29751A 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 indexVNFMUSTOS::Nova::Server
R-28795The 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.VNFMUSTProperty: fixed_ips, Map Property: ip_address
R-28222If 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``VNFMUSTInterface Route Table Prefixes for Contrail InterfaceRoute Table
R-28189A 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 TableVNFMAYOS::ContrailV2::InterfaceRouteTable
R-27970When 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.VNFMAYResource IDs
R-27818When 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 oneVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-27469A 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}``VNFMUSTOS::Neutron::Port
R-27078A VNF's Heat Orchestration   template **MUST** contain the section ``heat_template_version:``.VNFMUSTheat_template_version
R-26506A 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_``.VNFMUST{network-role}
R-26351A 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}``VNFMUSTOS::Neutron::Port
R-26124If a VNF Heat Orchestration   Template parameter has a default value, it **MUST** be enumerated in the   environment file.VNFMUSTdefault
R-25877A VNF's Heat Orchestration   Template's parameter name (i.e., <param name>) **MUST** contain only   alphanumeric characters and underscores ('_').VNFMUST<param name>
R-25720A 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.VNFMUSTOS::Neutron::Net
R-25190A VNF's Heat Orchestration   Template's Resource ``OS::Cinder::Volume`` **SHOULD NOT** declare the   property ``availability_zone``.VNFSHOULD NOTOptional Property availability_zone
R-24997A 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 keypairVNFSHOULDOS::Nova::Keypair
R-24893A VNF's Heat Orchestration   template's Environment File's **MAY** contain the ``event_sinks:`` section.VNFMAYEnvironment File Format
R-23664A VNF's Heat Orchestration   template **MUST** contain the section ``resources:``.VNFMUSTresources
R-23503When 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     networkVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-23311The VNF's Heat Orchestration   Template's Resource ``OS::Nova::Server`` property ``availability_zone``   parameter **MUST** be declared as type: ``string``.VNFMUSTProperty: availability_zone
R-22838The 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.VNFMUST NOTProperty: Name
R-22608When 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.VNFMUST NOTONAP Base Module Output Parameters
R-22589A VNF's Heat Orchestration   Template parameter declaration **MAY** contain the attribute ``immutable:``.VNFMAYimmutable
R-22441If 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.VNFMUST NOTvf_module_index
R-22288The 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.VNFMUST NOTProperty: fixed_ips, Map Property: subnet
R-21511A VNF's Heat Orchestration   Template's use of ``{network-role}`` in all Resource IDs **MUST** be the same   case.VNFMUST{network-role}
R-21330A 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.VNFMUST{network-role}
R-20947A 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 addressVNFMUSTOS::ContrailV2::InstanceIp
R-20856A 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.VNFMUST NOTvnf_id
R-20547When 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.VNFMUST NOTONAP Volume Module Output Parameters
R-20453A 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}``VNFMUSTOS::Neutron::Port
R-20319A 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 ConfigVNFMAYOS::Heat::CloudConfig
R-20308A 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``.VNFMUSTenvironment_context
R-20204The 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.VNFMUSTCompute, Network, and Storage Requirements
R-20065A VNF's Heat Orchestration   Template's Resource ``OS::ContrailV2::PortTuple`` Resource ID **MUST**   contain the ``{vm-type}``.VNFMUSTOS::ContrailV2::PortTuple
R-19756If 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``.VNFMUSTInterface Route Table Prefixes for Contrail InterfaceRoute Table
R-18683If 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``.VNFMUSTOAM Management IP Addresses
R-18202A 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 MimeVNFMAYOS::Heat::MultipartMime
R-18008The VNF's Heat Orchestration   Template's Resource ``OS::Neutron::Port`` property ``network`` parameter   **MUST** be declared as type: ``string``.VNFMUSTProperty: network
R-17528A 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.VNFMUSTNested Heat Template Requirements
R-17334A 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-roleVNFSHOULDOS::Neutron::SecurityGroup
R-16968A VNF's Heat Orchestration   Templates **MUST NOT** include heat resources to create external networks.VNFMUST NOTExternal Networks
R-16576If 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.VNFMUST NOTvnf_name
R-16447A 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.VNFMUSTresource ID
R-16437A VNF's Heat Orchestration   Template's Resource ``OS::ContrailV2::ServiceTemplate`` Resource ID **MUST**   contain the ``{vm-type}``.VNFMUSTOS::ContrailV2::ServiceTemplate
R-15480A 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.VNFMUST NOTvf_module_name
R-15287When 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.VNFMUSTProperty: fixed_ips, Map Property: subnet
R-15189A 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``VNFMAYOS::Nova::ServerGroup
R-14447A 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   indexVNFMAYOS::ContrailV2::ServiceTemplate
R-14198A 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-roleVNFSHOULDOS::Neutron::SecurityGroup
R-13194A 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.VNFMUST NOTenvironment_context
R-11690When 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.VNFMUSTResource IDs
R-11441A VNF's Heat Orchestration   Template's parameter type **MUST** be one of the following values:  * ``string`` * ``number`` * ``json`` *   ``comma_delimited_list`` * ``boolean``VNFMUSTtype
R-11168A 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.VNFMUST{network-role}
R-10834If a VNF's Heat Orchestration   Template resource attribute ``property:`` uses a nested ``get_param``, the   nested ``get_param`` **MUST** reference an index.VNFMUSTproperties
R-10754If 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.VNFMUSTVIP Assignment, External Networks, Supported by Automation
R-09811A VNF's Heat Orchestration   Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair   ``vf_module_index`` **MUST NOT** have parameter constraints defined.VNFMUST NOTvf_module_index
R-08975A VNF's Heat Orchestration   Template's Resource ``OS::Heat::SoftwareConfig`` Resource ID **MUST** contain   the ``{vm-type}``.VNFMUSTOS::Heat::SoftwareConfig
R-08775A 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-typeVNFSHOULDOS::Neutron::SecurityGroup
R-07507A 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``.VNFMUSTvnf_id
R-07443A 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``.VNFMUSTONAP Volume Module Output Parameters
R-06613A VNF's Heat Orchestration   Template's parameter defined in a non-nested YAML file as type ``boolean``   **MAY** have a parameter constraint defined.VNFMAYconstraints
R-05257A VNF's Heat Orchestration   Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIP``.VNFMUST NOTVIP Assignment, External Networks, Supported by Automation
R-05201When 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.VNFMUSTExternal Networks
R-05050A 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 fileVNFMAYHeat Files Support (get_file)
R-04747A VNF's Heat Orchestration   Template's Resource ``OS::Heat::CloudConfig`` Resource ID **MUST** contain   the ``{vm-type}``.VNFMUSTOS::Heat::CloudConfig
R-04697When 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     networkVNFMUSTProperty: fixed_ips, Map Property: ip_address
R-04344A 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).VNFMAYNested Heat Template Requirements
R-03656A 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 ConfigVNFMAYOS::Heat::SoftwareConfig
R-03595A 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-roleVNFSHOULDOS::Neutron::SecurityGroup
R-03324A VNF's Heat Orchestration   template's Environment File **MUST** contain the ``parameters:`` section.VNFMUSTEnvironment File Format
R-03251A VNF's Heat Orchestration   Template's Resource OS::Heat::CinderVolume **MAY** be defined in a Cinder   Volume Module.VNFMAYONAP VNF Modularity Overview
R-02691A 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.VNFMUST NOTworkload_context
R-02164When 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 FileVNFMUSTExternal Networks
R-01896A VNF's Heat Orchestration   Template's parameter values that are constant across all deployments **MUST**   be declared in a Heat Orchestration Template Environment File.VNFMUSTScope of a Heat Orchestration Template
R-01455When 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.VNFMUST{vm-type}
R-01359A 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.VNFMAYProperty: availability_zone
R-01101A VNF's Heat Orchestration   Template **MAY** reference the nested heat dynamically using the resource   ``OS::Heat::ResourceGroup``.VNFMAYNested Heat Template Requirements
R-00977A VNF's Heat Orchestration   Template's ``{network-role}`` **MUST NOT** be a substring of ``{vm-type}``.VNFMUST NOT{network-role}
R-00228A VNF's Heat Orchestration   Template **MAY** reference the nested heat statically by repeated definition.VNFMAYNested Heat Template Requirements
R-00011A VNF's Heat Orchestration   Template's parameter defined in a nested YAML file **MUST NOT** have a   parameter constraint defined.VNFMUST NOTconstraints