5.2.5.3. Resource IDs

Requirement R-75141 states a VNF’s Heat Orchestration Template’s resource name (i.e., <resource ID>) MUST only contain alphanumeric characters and underscores (‘_’).*

Requirement R-16447 states 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.

As stated previously, OpenStack requires the <resource ID> to be unique to the Heat Orchestration Template and not unique across all Heat Orchestration Templates the compose the VNF.

Heat Orchestration Template resources are described in resources.

Requirement: R-54517 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: none

When a VNF’s Heat Orchestration Template’s resource is associated with a single {vm-type}, the Resource ID MUST contain the {vm-type}.

Requirement: R-96482 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: none

When a VNF’s Heat Orchestration Template’s resource is associated with a single ONAP external network, the Resource ID MUST contain the text {network-role}.

Requirement: R-98138 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: none

When a VNF’s Heat Orchestration Template’s resource is associated with a single ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666), the Resource ID MUST contain the text int_{network-role}.

Requirement: R-82115 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: none

When a VNF’s Heat Orchestration Template’s resource is associated with a single {vm-type} and a single ONAP 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}).

Requirement: R-82551 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: none

When a VNF’s Heat Orchestration Template’s resource is associated with a single {vm-type} and a single ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666), 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}).

Requirement: R-67793 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST NOT
updated: frankfurt
validation_mode: none

When a VNF’s Heat Orchestration Template’s resource is associated with more than one {vm-type} and/or more than one ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) and/or ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968), the Resource ID MUST NOT contain the {vm-type} and/or {network-role}/int_{network-role}.

Requirement: R-27970 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: frankfurt

When a VNF’s Heat Orchestration Template’s resource is associated with more than one {vm-type} and/or more than one ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) and/or ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968), the Resource ID MAY contain the term shared and/or MAY contain text that identifies the VNF.

Requirement: R-11690 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: dublin
validation_mode: static

When a VNF’s Heat Orchestration Template’s Resource ID contains an {index}, the {index} is a numeric value that MUST start at zero and MUST increment by one.

As stated in R-16447, a VNF’s <resource ID> MUST be unique across all Heat Orchestration Templates and all HEAT Orchestration Template Nested YAML files that are used to create the VNF. While the {index} will start at zero in the VNF, the {index} may not start at zero in a given Heat Orchestration Template or HEAT Orchestration Template Nested YAML file.

5.2.5.3.1. OpenStack Heat Resources Resource ID Naming Convention

Some OpenStack Heat Resources Resource IDs have mandatory or suggested naming conventions. They are provided in the following sections.

5.2.5.3.1.1. OS::Cinder::Volume

Requirement: R-87004 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: dublin

A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume Resource ID SHOULD use the naming convention

  • {vm-type}_volume_{index}

where

  • {vm-type} is the vm-type

  • {index} starts at zero and increments by one (as described in R-11690)

5.2.5.3.1.2. OS::Cinder::VolumeAttachment

Requirement: R-86497 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: dublin

A VNF’s Heat Orchestration Template’s Resource OS::Cinder::VolumeAttachment Resource ID SHOULD use the naming convention

  • {vm-type}_volume_attachment_{index}

where

  • {vm-type} is the vm-type

  • {index} starts at zero and increments by one (as described in R-11690)

5.2.5.3.1.3. OS::Heat::CloudConfig

Requirement: R-04747 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::Heat::CloudConfig Resource ID MUST contain the {vm-type}.

Requirement: R-20319 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.1.4. OS::Heat::MultipartMime

Requirement: R-30804 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::Heat::MultipartMime Resource ID MUST contain the {vm-type}.

Requirement: R-18202 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.1.5. OS::Heat::ResourceGroup

There is no mandatory naming convention for the resource ‘OS::Heat::ResourceGroup’.

5.2.5.3.1.6. OS::Heat::SoftwareConfig

Requirement: R-08975 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::Heat::SoftwareConfig Resource ID MUST contain the {vm-type}.

Requirement: R-03656 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.1.7. OS::Neutron::Net

Requirement: R-25720 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

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 ONAP internal networks (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666). There is no {index} after {network-role} because {network-role} MUST be unique in the scope of the VNF’s Heat Orchestration Template.

5.2.5.3.1.8. OS::Neutron::Port

Requirement: R-20453 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::Port that is attaching to an ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968), the OS::Neutron::Port Resource ID MUST use the naming convention

  • {vm-type}_{vm-type_index}_{network-role}_port_{port-index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP external network that the port is attached to

  • {port_index} references the instance of the port on the {vm-type} attached to {network-role} network. The {port_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new port is defined on the instance of the {vm-type} attached to {network-role} network.

Requirement: R-26351 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::Port that is attaching to an ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666), the OS::Neutron::Port Resource ID MUST use the naming convention

  • {vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP internal network that the port is attached to

  • {port_index} references the instance of the port on the {vm-type} attached to {network-role} network. The {port_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new port is defined on the instance of the {vm-type} attached to {network-role} network.

Requirement: R-27469 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt
validation_mode: none

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::Port that is creating a Reserve Port with an IPv4 address, the OS::Neutron::Port Resource ID SHOULD use the naming convention

  • reserve_port_{vm-type}_{network-role}_floating_ip_{index}

where

  • {vm-type} is the vm-type

  • {network-role} is the network-role of the ONAP external network that the port is attached to

  • {index} is the instance of the IPv4 Reserve Port for the vm-type attached to the network of {network-role}. The {index} starts at zero and increments by one (as described in R-11690).

Requirement: R-68520 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt
validation_mode: none

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::Port that is creating a Reserve Port with an IPv6 address, the OS::Neutron::Port Resource ID SHOULD use the naming convention

  • reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}

where

  • {vm-type} is the vm-type

  • {network-role} is the network-role of the ONAP external network that the port is attached to

  • {index} is the instance of the IPv6 Reserve Port for the vm-type attached to the network of {network-role}. The {index} starts at zero and increments by one (as described in R-11690).

5.2.5.3.1.9. OS::Neutron::SecurityGroup

Requirement: R-08775 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::SecurityGroup that is applicable to one {vm-type} and more than one network (ONAP internal network and/or ONAP external network), the OS::Neutron::SecurityGroup Resource ID SHOULD use the naming convention

  • {vm-type}_security_group

where

  • {vm-type} is the vm-type

Requirement: R-03595 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::SecurityGroup that is applicable to more than one {vm-type} and one ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968), the OS::Neutron::SecurityGroup Resource ID SHOULD use the naming convention

  • {network-role}_security_group

where

  • {network-role} is the network-role of the ONAP external network

Requirement: R-73213 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::SecurityGroup that is applicable to more than one {vm-type} and one ONAP internal network, (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666), the OS::Neutron::SecurityGroup Resource ID SHOULD use the naming convention

  • int_{network-role}_security_group

where

  • {network-role} is the network-role of the ONAP internal network

Requirement: R-17334 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::SecurityGroup that is applicable to one {vm-type} and one ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968), the OS::Neutron::SecurityGroup 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 of the ONAP external network

Requirement: R-14198 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

A VNF’s Heat Orchestration Template’s Resource OS::Neutron::SecurityGroup that is applicable to one {vm-type} and one ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666), the OS::Neutron::SecurityGroup 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 of the ONAP internal network

Requirement: R-30005 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: frankfurt

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), the OS::Neutron::SecurityGroup Resource ID MAY use the naming convention

  • shared_security_group

or

  • {vnf-type}_security_group

where

  • {vnf-type} describes the VNF

5.2.5.3.1.10. OS::Neutron::Subnet

Requirement: R-59434 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

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 of the ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666).

  • {index} is the {index} of the subnet of the ONAP internal network. The {index} starts at zero and increments by one (as described in R-11690).

5.2.5.3.1.11. OS::Nova::Keypair

Requirement: R-24997 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

A VNF’s Heat Orchestration Template’s Resource OS::Nova::Keypair that applies to one {vm-type}, the OS::Nova::Keypair Resource ID SHOULD use the naming convention

  • {vm-type}_keypair_{index}

where

  • {vm-type} is the vm-type of the OS::Nova::Server

  • {index} is the {index} of the keypair. The {index} starts at zero and increments by one (as described in R-11690).

Requirement: R-65516 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: SHOULD
updated: frankfurt

A VNF’s Heat Orchestration Template’s Resource OS::Nova::Keypair that applies to all Virtual Machines in the VNF, the OS::Nova::Keypair Resource ID SHOULD use the naming convention

  • {vnf-type}_keypair

where

  • {vnf-type} describes the VNF

5.2.5.3.1.12. OS::Nova::Server

Requirement: R-29751 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: dublin
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::Nova::Server Resource ID MUST use the naming convention

  • {vm-type}_server_{index}

where

  • {vm-type} is the vm-type

  • {index} is the index. The {index} MUST starts at zero and increment by one as described in R-11690.

5.2.5.3.1.13. OS::Nova::ServerGroup

Requirement: R-15189 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.2. Contrail Heat Resources Resource ID Naming Convention

Some Contrail Heat Resources Resource IDs have mandatory or suggested naming conventions. They are provided in the following sections.

5.2.5.3.2.1. OS::ContrailV2::InstanceIp

Requirement: R-53310 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::InstanceIp Resource ID that is configuring an IPv4 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968) MUST use the naming convention

  • {vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP external network that the virtual machine interface is attached to

  • {vmi_index} references the instance of the virtual machine interface on the {vm-type} attached to {network-role} network. The {vmi_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new virtual machine interface is defined on the instance of the {vm-type} attached to {network-role} network.

  • IP signifies that an IPv4 address is being configured

  • {index} references the instance of the IPv4 address configured on the virtual machine interface. The {index} is a numeric value that MUST start at zero on an instance of a virtual machine interface and MUST increment by one each time a new IPv4 address is configured on the virtual machine interface.

Requirement: R-46128 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::InstanceIp Resource ID that is configuring an IPv6 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968) MUST use the naming convention

  • {vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP external network that the port is attached to

  • {vmi_index} references the instance of the virtual machine interface on the {vm-type} attached to {network-role} network. The {vmi_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new virtual machine interface is defined on the instance of the {vm-type} attached to {network-role} network.

  • v6_IP signifies that an IPv6 address is being configured

  • {index} references the instance of the IPv6 address configured on the virtual machine interface. The {index} is a numeric value that MUST start at zero on an instance of a virtual machine interface and MUST increment by one each time a new IPv6 address is configured on the virtual machine interface.

Requirement: R-62187 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::InstanceIp Resource ID that is configuring an IPv4 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) MUST use the naming convention

  • {vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP internal network that the port is attached to

  • {vmi_index} references the instance of the virtual machine interface on the {vm-type} attached to {network-role} network. The {vmi_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new virtual machine interface is defined on the instance of the {vm-type} attached to {network-role} network.

  • IP signifies that an IPv4 address is being configured

  • {index} references the instance of the IPv4 address configured on the virtual machine interface. The {index} is a numeric value that MUST start at zero on an instance of a virtual machine interface and MUST increment by one each time a new IPv4 address is configured on the virtual machine interface.

Requirement: R-87563 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::InstanceIp Resource ID that is configuring an IPv6 Address on a virtual machine interface (i.e., OS::ContrailV2::VirtualMachineInterface) attached to an ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) MUST use the naming convention

  • {vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP internal network that the port is attached to

  • {vmi_index} references the instance of the virtual machine interface on the {vm-type} attached to {network-role} network. The {vmi_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new virtual machine interface is defined on the instance of the {vm-type} attached to {network-role} network.

  • v6_IP signifies that an IPv6 address is being configured

  • {index} references the instance of the IPv6 address configured on the virtual machine interface. The {index} is a numeric value that MUST start at zero on an instance of a virtual machine interface and MUST increment by one each time a new IPv6 address is configured on the virtual machine interface.

5.2.5.3.2.2. OS::ContrailV2::InterfaceRouteTable

Requirement: R-81214 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::InterfaceRouteTable Resource ID MUST contain the {network-role}.

Requirement: R-28189 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.2.3. OS::ContrailV2::NetworkIpam

Requirement: R-30753 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::NetworkIpam Resource ID MUST contain the {network-role} of the ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) that the resource is associated with.

Requirement: R-81979 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.2.4. OS::ContrailV2::PortTuple

Requirement: R-20065 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::PortTuple Resource ID MUST contain the {vm-type}.

Requirement: R-84457 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.2.5. OS::ContrailV2::ServiceHealthCheck

Requirement: R-76014 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::ServiceHealthCheck Resource ID MUST contain the {vm-type}.

Requirement: R-65618 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: casablanca

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

5.2.5.3.2.6. OS::ContrailV2::ServiceTemplate

Requirement: R-16437 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: casablanca
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::ServiceTemplate Resource ID MUST contain the {vm-type}.

Requirement: R-14447 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MAY
updated: dublin

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::ServiceTemplate Resource ID MAY use the naming convention

  • {vm-type}_RST_{index}

where

  • {vm-type} is the vm-type

  • RST signifies that it is the Resource Service Template

  • {index} is the index. The {index} starts at zero and increments by one (as described in R-11690).

5.2.5.3.2.7. OS::ContrailV2::VirtualMachineInterface

Requirement: R-96253 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::VirtualMachineInterface Resource ID that is attaching to an ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968) MUST use the naming convention

  • {vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP external network that the port (i.e. virtual machine interface) is attached to

  • {vmi_index} references the instance of the virtual machine interface on the {vm-type} attached to {network-role} network. The {vmi_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new virtual machine interface is defined on the instance of the {vm-type} attached to {network-role} network.

Requirement: R-50468 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::VirtualMachineInterface Resource ID that is attaching to an ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) MUST use the naming convention

  • {vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}

where

  • {vm-type} is the vm-type

  • {vm-type_index} references the instance of the {vm-type} in the VNF. The {vm-type_index} is a numeric value that MUST start at zero in the VNF and MUST increment by one each time a new instance of a {vm-type} is referenced.

  • {network-role} is the network-role of the ONAP internal network that the port (i.e. virtual machine interface) is attached to

  • {vmi_index} references the instance of the virtual machine interface on the {vm-type} attached to {network-role} network. The {vmi_index} is a numeric value that MUST start at zero on an instance of a {vm-type} and MUST increment by one each time a new virtual machine interface is defined on the instance of the {vm-type} attached to {network-role} network.

5.2.5.3.2.8. OS::ContrailV2::VirtualNetwork

Requirement: R-99110 ../../../_images/arrow-right-circle.svg
target: VNF
keyword: MUST
updated: frankfurt
validation_mode: static

A VNF’s Heat Orchestration Template’s Resource OS::ContrailV2::VirtualNetwork Resource ID MUST use the naming convention

  • int_{network-role}_network

VNF Heat Orchestration Templates can only create ONAP internal networks (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666). There is no {index} after {network-role} because {network-role} MUST be unique in the scope of the VNF’s Heat Orchestration Template.