[VNFRQTS] updated heat section of document 24/74924/1
authorweinstock, alan <aw2574@att.com>
Wed, 19 Dec 2018 14:45:15 +0000 (14:45 +0000)
committerweinstock, alan <aw2574@att.com>
Wed, 19 Dec 2018 14:45:15 +0000 (14:45 +0000)
Change-Id: I48fbb9da5d3672609d81e971648e9eefd46f482b
Issue-ID: VNFRQTS-516
Signed-off-by: weinstock, alan <aw2574@att.com>
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
docs/data/needs.json

index b8ad7bc..c68cc56 100644 (file)
@@ -324,7 +324,7 @@ 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
-    ECOMP definition, see Requirement R-57424),
+    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,
@@ -431,7 +431,7 @@ Parameter Definition*
 
     When the VNF's Heat Orchestration Template's Resource
     ``OS::Neutron::Port`` is attaching to an external network (per the
-    ECOMP definition, see Requirement R-57424),
+    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,
@@ -539,7 +539,7 @@ Definition*
 
     When the VNF's Heat Orchestration Template's Resource
     ``OS::Neutron::Port`` is attaching to an internal network (per the
-    ECOMP definition, see Requirements R-52425 and R-46461),
+    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
@@ -647,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
-    ECOMP definition, see Requirements R-52425 and R-46461),
+    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
index 134c383..e38c135 100644 (file)
@@ -141,7 +141,7 @@ there is no requirement for ``{network-role}`` / ``{network-role-tag}``
 uniqueness across Heat Orchestration Templates for
 different VNFs.
 
-When an external network is created by ECOMP, the network is also assigned a
+When an external network is created by ONAP, the network is also assigned a
 ``{network-role}``.  The ``{network-role}`` of the network is not required to
 match the ``{network-role}`` of the VNF Heat Orchestration Template.
 
@@ -150,9 +150,9 @@ For example, the VNF Heat Orchestration Template can assign a
 of ``oam`` to a network which attaches to an external network with a
 ``{network-role}`` of ``oam_protected`` .
 
-When the Heat Orchestration Template is on-boarded into ECOMP
+When the Heat Orchestration Template is on-boarded into ONAP
   * each ``{network-role}`` value in the Heat Orchestration Template
-    is mapped to the ``{network-role-tag}`` in the ECOMP
+    is mapped to the ``{network-role-tag}`` in the ONAP
     data structure.
   * each ``OS::Neutron::Port`` is associated with the external network it is
     connecting to, thus creating the VNF Heat Orchestration Template
index 77a1aff..5252c4c 100644 (file)
@@ -1,5 +1,5 @@
 {
-    "created": "2018-12-18T15:29:21.631864",
+    "created": "2018-12-19T14:43:29.335600",
     "current_version": "dublin",
     "project": "",
     "versions": {
             "needs_amount": 789
         },
         "dublin": {
-            "created": "2018-12-18T15:29:21.631843",
+            "created": "2018-12-19T14:43:29.335582",
             "needs": {
                 "R-00011": {
                     "description": "A VNF's Heat Orchestration Template's parameter defined\nin a nested YAML file\n**SHOULD NOT** have a parameter constraint defined.",
                     "validation_mode": ""
                 },
                 "R-27818": {
-                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
+                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
                     "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters",
                     "full_title": "",
                     "hide_links": "",
                     "validation_mode": ""
                 },
                 "R-304011": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property port referenced OS::Neutron::Port Resource ID\n  (defined in R-20453)\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751.  And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property port referenced OS::Neutron::Port Resource ID\n  (defined in R-20453)\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-\n, and R-29751.  And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).",
                     "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters",
                     "full_title": "",
                     "hide_links": "",
                     "validation_mode": "none"
                 },
                 "R-40971": {
-                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nECOMP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
+                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
                     "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters",
                     "full_title": "",
                     "hide_links": "",
                     "validation_mode": "static"
                 },
                 "R-54171": {
-                    "description": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_name_{index}``, where ``{index}`` is a numeric\nvalue that **MUST** start at\nzero  in a VNF's Heat Orchestration Template and **MUST** increment by one.",
+                    "description": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_name_{index}``, where ``{index}`` is a numeric\nvalue that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.",
                     "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters",
                     "full_title": "",
                     "hide_links": "",
                     "validation_mode": "static"
                 },
                 "R-71577": {
-                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nECOMP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n  ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
+                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n  ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
                     "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters",
                     "full_title": "",
                     "hide_links": "",
                     "validation_mode": ""
                 },
                 "R-78380": {
-                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n  ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
+                    "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n  ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n  VNF's Heat Orchestration Template and **MUST** increment by one",
                     "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters",
                     "full_title": "",
                     "hide_links": "",