summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Chapter5')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Networking.rst2
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Orchestration Templates: Overview.rst2
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst10
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst4
-rw-r--r--docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst24
5 files changed, 26 insertions, 16 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Networking.rst b/docs/Chapter5/Heat/ONAP Heat Networking.rst
index 1d10a5a..7591a97 100644
--- a/docs/Chapter5/Heat/ONAP Heat Networking.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Networking.rst
@@ -147,7 +147,7 @@ or an external gateway or router
:keyword: MAY
:updated: casablanca
- A VNF **MAY** contain zero, one or more than one internal networks.
+ A VNF **MAY** contain zero, one or more than one internal network.
.. req::
:id: R-35666
diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates: Overview.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates: Overview.rst
index f8f0425..cfd6e36 100644
--- a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates: Overview.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates: Overview.rst
@@ -145,7 +145,7 @@ Module.
:keyword: MUST
:validation_mode: static
- The VNF **MUST** have a corresponding environment file for a Base Module.
+ A VNF's Base Module **MUST** have a corresponding Environment File.
.. req::
:id: R-81725
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 e9049c0..f0d2212 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
@@ -70,7 +70,7 @@ Items to Note
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
+ network **MUST** have cloud assigned IP Addresses
or **MUST** have ONAP SDN-C assigned IP addresses.
.. req::
@@ -254,7 +254,7 @@ The output parameter name will be declared as a parameter in the
:validation_mode: static
:updated: casablanca
- The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
+ The 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.
@@ -710,7 +710,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 Requirement 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
@@ -778,7 +778,7 @@ Heat Orchestration Template's Environment File.
parameter associated with an external network, i.e.,
* ``{vm-type}_{network-role}_ip_{index}``
- * ``{vm-type}_{network-role}_ip_v6_{index}``
+ * ``{vm-type}_{network-role}_v6_ip_{index}``
* ``{vm-type}_{network-role}_ips``
* ``{vm-type}_{network-role}_v6_ips``
@@ -800,7 +800,7 @@ Heat Orchestration Template's Environment File.
parameter associated with an internal network, i.e.,
* ``{vm-type}_int_{network-role}_ip_{index}``
- * ``{vm-type}_int_{network-role}_ip_v6_{index}``
+ * ``{vm-type}_int_{network-role}_v6_ip_{index}``
* ``{vm-type}_int_{network-role}_ips``
* ``{vm-type}_int_{network-role}_v6_ips``
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 9c6e3ab..d0f00dd 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
@@ -39,7 +39,7 @@ Heat Orchestration Template resources are described in :ref:`resources`.
When a VNF's Heat Orchestration Template's resource is associated
with a single external network, the Resource ID **MUST** contain the text
- '{network-role}'.
+ ``{network-role}``.
.. req::
:id: R-98138
@@ -1034,4 +1034,4 @@ OS::ContrailV2::VirtualNetwork
**MUST** be unique in the scope of the VNF's
Heat Orchestration Template.
-Note that option 1 is preferred.
+ Note that option 1 is preferred.
diff --git a/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst b/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst
index 7e1ebe3..3a19ea9 100644
--- a/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst
+++ b/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst
@@ -64,13 +64,23 @@ Incremental Module.
:validation_mode: static
:updated: casablanca
- A shared Heat Orchestration Template resource must be defined
- in the base module. A shared resource is a resource that that will
- be referenced by another resource that is defined in the Base Module
- and/or one or more incremental modules. When the shared resource needs
- to be referenced by a resource in an incremental module, the UUID of
- the shared resource **MUST** be exposed by declaring an ONAP Base
- Module Output Parameter.
+
+ A 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 more 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).
When the shared resource needs to be referenced by a resource in an
incremental module, the UUID of the shared resource must be exposed by