diff options
Diffstat (limited to 'docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention')
4 files changed, 54 insertions, 49 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst index 7fe73e5..b8ad7bc 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst @@ -324,22 +324,21 @@ IPv4 and/or IPv6 addresses. When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the - ONAP definition, see Requirement R-57424), + ECOMP 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}`` + * ``{vm-type}_{network-role}_ip_{index}`` - where + where - * ``{vm-type}`` is the {vm-type} associated with the - ``OS::Nova::Server`` - * ``{network-role}`` is the {network-role} of the external - network - * the value for ``{index}`` must start at zero (0) and increment by one + * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` + * ``{network-role}`` is the {network-role} of the external network + * ``{index}`` is a numeric value that **MUST** start at zero in a + VNF's Heat Orchestration Template and **MUST** increment by one .. req:: :id: R-39841 @@ -432,22 +431,22 @@ Parameter Definition* When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the - ONAP definition, see Requirement R-57424), + ECOMP 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}`` + * ``{vm-type}_{network-role}_v6_ip_{index}`` - where + where - * ``{vm-type}`` is the {vm-type} associated with the - OS::Nova::Server - * ``{network-role}`` is the {network-role} of the external - network - * the value for ``{index}`` must start at zero (0) and increment by one + * ``{vm-type}`` is the {vm-type} associated with the + ``OS::Nova::Server`` + * ``{network-role}`` is the {network-role} of the external network + * ``{index}`` is a numeric value that **MUST** start at zero in a + VNF's Heat Orchestration Template and **MUST** increment by one .. req:: :id: R-87123 @@ -540,7 +539,7 @@ Definition* When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the - ONAP definition, see Requirements R-52425 and R-46461), + ECOMP 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 @@ -548,15 +547,15 @@ Definition* the parameter name **MUST** follow the naming convention - * ``{vm-type}_int_{network-role}_ip_{index}`` + * ``{vm-type}_int_{network-role}_ip_{index}`` where - * ``{vm-type}`` is the {vm-type} associated with the - OS::Nova::Server - * ``{network-role}`` is the {network-role} of the internal - network - * the value for ``{index`` must start at zero (0) and increment by one + * ``{vm-type}`` is the {vm-type} associated with the + ``OS::Nova::Server`` + * ``{network-role}`` is the {network-role} of the internal network + * ``{index}`` is a numeric value that **MUST** start at zero in a + VNF's Heat Orchestration Template and **MUST** increment by one .. req:: :id: R-28795 @@ -648,7 +647,7 @@ Heat Orchestration Template's Environment File. When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the - ONAP definition, see RRequirements R-52425 and R-46461), + ECOMP 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 @@ -656,15 +655,14 @@ Heat Orchestration Template's Environment File. the parameter name **MUST** follow the naming convention - * ``{vm-type}_int_{network-role}_v6_ip_{index}`` + * ``{vm-type}_int_{network-role}_v6_ip_{index}`` where - * ``{vm-type}`` is the {vm-type} associated with the - ``OS::Nova::Server`` - * ``{network-role}`` is the {network-role} of the internal - network - * the value for ``{index}`` must start at zero (0) and increment by one + * ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server`` + * ``{network-role}`` is the {network-role} of the internal network + * ``{index}`` is a numeric value that **MUST** start at zero in a + VNF's Heat Orchestration Template and **MUST** increment by one .. req:: diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst index f861615..c84e32b 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst @@ -243,8 +243,8 @@ Property: Name 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. + value that **MUST** start at + zero in a VNF Orchestration Template and increments by one. .. req:: :id: R-87817 @@ -376,10 +376,13 @@ Property: availability_zone :updated: casablanca The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` - property - ``availability_zone`` parameter name **MUST** follow the naming convention - ``availability_zone_{index}`` where the ``{index}`` - **MUST** start at zero and + property ``availability_zone`` parameter name + **MUST** follow the naming convention + + * ``availability_zone_{index}`` + + where ``{index}`` is a numeric value that **MUST** start at zero + in a VNF's Heat Orchestration Templates and **MUST** increment by one. .. req:: diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst index d0f00dd..45f6ecf 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst @@ -130,8 +130,16 @@ Heat Orchestration Template resources are described in :ref:`resources`. :updated: casablanca When a VNF's Heat Orchestration Template's Resource ID contains an - ``{index}`` value (e.g. multiple VMs of same ``{vm-type}``), the ``{index}`` - **MUST** start at zero and increment by one. + ``{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. OpenStack Heat Resources Resource ID Naming Convention ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst index 6357b8e..4683a5e 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst @@ -35,6 +35,13 @@ ports connecting to the identical networks and requiring the identical IP address configuration. +The ``{vm-type}`` will be used in a VNF's Heat Orchestration Template's + +* Resource IDs +* Resource property parameter names + +Requirements in this document will explain it in further detail. + .. req:: :id: R-82481 :target: VNF @@ -57,17 +64,6 @@ **MUST NOT** be prefixed with a common ``{vm-type}`` identifier. .. req:: - :id: R-66729 - :target: VNF - :keyword: MUST - :validation_mode: static - :updated: casablanca - - A VNF's Heat Orchestration Template's Resource that is associated with a - unique Virtual Machine type **MUST** include ``{vm-type}`` as part of the - resource ID. - -.. req:: :id: R-98407 :target: VNF :keyword: MUST NOT |