summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention
diff options
context:
space:
mode:
authorweinstock, alan <aw2574@att.com>2018-11-27 18:48:38 +0000
committerHagop Bozawglanian <hagop.bozawglanian@att.com>2018-11-27 19:43:09 +0000
commita7c65c3c94a997cc215a33f81e274329c9850bec (patch)
tree621ff488ffc7645b07e854e3cafc03d89b424e6c /docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention
parentdff948f1f98c37587e78bdb7ae0b0f0f0e54d7cb (diff)
[VNFRQTS] updates to the Heat Section
Change-Id: Id81d515314776f82e34460aef0da3b6698e0403c Issue-ID: VNFRQTS-500 Signed-off-by: weinstock, alan <aw2574@att.com>
Diffstat (limited to 'docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst2
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst30
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst42
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst54
4 files changed, 74 insertions, 54 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst
index 1fbdec7..8a31cad 100644
--- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst
@@ -234,7 +234,7 @@ instance_ip_address*
The property instance_ip_address uses the same parameter naming
convention as the property fixed_ips and Map Property ip_address in
-OS::Neutron::Port. The resource is assigning an ECOMP SDN-C Assigned IP
+OS::Neutron::Port. The resource is assigning an ONAP SDN-C Assigned IP
Address. The {network-role} has been defined as oam_protected to
represent an oam protected network and the {vm-type} has been defined as
fw for firewall.
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 996e370..4342bb0 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
@@ -62,27 +62,15 @@ This will be described in the forth coming sections.
Items to Note
~~~~~~~~~~~~~~
-.. req::
- :id: R-93272
- :target: VNF
- :keyword: MAY
- :updated: casablanca
-
- A VNF **MAY** have one or more ports connected to a unique
- external network. All VNF ports connected to the unique external
- network **MUST** have cloud assigned IP Addresses
- or **MUST** have ONAP SDN-C assigned IP addresses.
-
-.. req::
- :id: R-13841
- :target: VNF
- :keyword: MAY
- :updated: casablanca
-
- A VNF **MAY** have one or more ports connected to a unique
- internal network. All VNF ports connected to the unique internal
- network **MUST** have cloud assigned IP Addresses
- or **MUST** have statically assigned IP addresses.
+A VNF **MAY** have one or more ports connected to a unique
+external network. All VNF ports connected to the unique external
+network **MUST** have cloud assigned IP Addresses
+or **MUST** have ONAP SDN-C assigned IP addresses.
+
+A VNF **MAY** have one or more ports connected to a unique
+internal network. All VNF ports connected to the unique internal
+network **MUST** have cloud assigned IP Addresses
+or **MUST** have statically assigned IP addresses.
.. req::
:id: R-45602
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 b5501fd..f861615 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
@@ -35,15 +35,21 @@ Requirement R-82481 defines how the ``{vm-type}`` is used.
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's
- * Resource ID
- * property ``image`` parameter name
- * property ``flavor`` parameter name
- * property ``name`` parameter name
-
+ * Resource ID (defined in R-29751)
+ * property ``image`` parameter name (defined in R-58670)
+ * property ``flavor`` parameter name (defined in R-45188)
+ * property ``name`` parameter name (defined in R-54171 & R-87817)
+ * property port referenced OS::Neutron::Port Resource ID
+ (defined in R-58670)
**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.
+ in R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in
+ the ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match
+ the ``{vm-type_index}`` defined in
+ the ``OS::Nova::Server`` property ``port``
+ referenced ``OS::Neutron::Port`` Resource ID.
+
The table below provides a summary. The sections that follow provides
the detailed requirements.
@@ -241,18 +247,6 @@ Property: Name
zero and increments by one.
.. req::
- :id: R-40899
- :target: VNF
- :keyword: MUST
- :validation_mode: static
- :updated: casablanca
-
- When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
- property ``name`` parameter is defined as a ``string``, a parameter
- **MUST** be delcared for
- each ``OS::Nova::Server`` resource associated with the ``{vm-type}``.
-
-.. req::
:id: R-87817
:target: VNF
:keyword: MUST
@@ -265,18 +259,6 @@ Property: Name
``{vm-type}_names``.
.. req::
- :id: R-85800
- :target: VNF
- :keyword: MUST
- :validation_mode: static
- :updated: casablanca
-
- When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
- property ``name`` parameter is defined as a ``comma_delimited_list``,
- a parameter **MUST** be delcared once for all ``OS::Nova::Server`` resources
- associated with the ``{vm-type}``.
-
-.. req::
:id: R-22838
:target: VNF
:keyword: MUST NOT
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
index 48ca384..134c383 100644
--- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
@@ -5,8 +5,31 @@
{network-role}
-----------------------------
-The assignment of a {network-role} is discussed in
-:ref:`ONAP Heat Networking`.
+.. req::
+ :id: R-69014
+ :target: VNF
+ :keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
+
+ When a VNF's port connects to an internal network or external network,
+ a network role, referred to
+ as the ``{network-role}`` **MUST** be assigned to the network for
+ use in the VNF's Heat Orchestration Template. The ``{network-role}``
+ is used in the VNF's Heat Orchestration Template resource IDs
+ and resource property parameter names.
+
+.. req::
+ :id: R-05201
+ :target: VNF
+ :keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
+
+ When a VNF connects to two or more unique networks, each
+ network **MUST** be assigned a unique ``{network-role}``
+ in the context of the VNF for use in the VNF's Heat Orchestration
+ Template.
.. req::
:id: R-21330
@@ -108,3 +131,30 @@ For example, if a VNF has a '{vm-type}' of 'oam' and a
A VNF's Heat Orchestration Template's ``{network-role}`` case in Resource
property parameter names **SHOULD** match the case of ``{network-role}``
in Resource IDs and vice versa.
+
+
+Note that this document refers to ``{network-role}`` which in reality
+is the ``{network-role-tag}``. The value of the
+``{network-role}`` / ``{network-role-tag}``
+is determined by the designer of the VNF's Heat Orchestration Template and
+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
+``{network-role}``. The ``{network-role}`` of the network is not required to
+match the ``{network-role}`` of the VNF Heat Orchestration Template.
+
+For example, the VNF Heat Orchestration Template can assign a
+``{network-role}``
+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
+ * each ``{network-role}`` value in the Heat Orchestration Template
+ is mapped to the ``{network-role-tag}`` in the ECOMP
+ data structure.
+ * each ``OS::Neutron::Port`` is associated with the external network it is
+ connecting to, thus creating the VNF Heat Orchestration Template
+ ``{network-role}`` / ``{network-role-tag}``
+ to external network ``{network-role}`` mapping.