summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorweinstock, alan <aw2574@att.com>2019-04-11 17:35:32 +0000
committerstark, steven <steven.stark@att.com>2019-04-11 11:18:43 -0700
commita0c6ca75f1ce52556a89ae21d8491c64107af636 (patch)
treee5094cbf31998bf4750ad916a92b58ba73f1d002
parentc0ff2f4edd2c2c0af660df6cfed83b20059ce452 (diff)
[VNFRQTS] updated 4 requirements & fixed typo
Issue-ID: VNFRQTS-623 Change-Id: Ia29a35f206f194a1e66350e598c66fa6e51a2689 Signed-off-by: weinstock, alan <aw2574@att.com> Signed-off-by: stark, steven <steven.stark@att.com>
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst2
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Networking.rst61
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst6
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst10
4 files changed, 49 insertions, 30 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst b/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst
index 36a4deb..cf02974 100644
--- a/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst
@@ -10,7 +10,7 @@ ONAP Heat Cinder Volumes
Cinder Volumes are created with the heat resource OS::Cinder::Volume.
As stated in :need:`R-46119`, :need:`R-90748`, :need:`R-03251`, a
-VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``
+VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``
**MAY** be defined in a Base Module, Incremental Module, or Cinder
Volume Module.
diff --git a/docs/Chapter5/Heat/ONAP Heat Networking.rst b/docs/Chapter5/Heat/ONAP Heat Networking.rst
index d838049..09a2244 100644
--- a/docs/Chapter5/Heat/ONAP Heat Networking.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Networking.rst
@@ -96,22 +96,15 @@ or an external gateway or router
:target: VNF
:keyword: MUST
:validation_mode: static
- :updated: casablanca
+ :updated: dublin
If a VNF has an internal network, the VNF Heat Orchestration Template
**MUST** include the heat resources to create the internal network.
-.. req::
- :id: R-86972
- :target: VNF
- :keyword: SHOULD
- :updated: casablanca
-
- A VNF **SHOULD** create the internal network in the VNF's Heat
- Orchestration Template Base Module.
-
-An Internal Network may be created using Neutron Heat Resources and/or
-Contrail Heat Resources.
+ A VNF's Internal Network is created using Neutron Heat Resources
+ (i.e., ``OS::Neutron::Net``, ``OS::Neutron::Subnet``) and/or
+ Contrail Heat Resources (i.e., ``OS::ContrailV2::VirtualNetwork``,
+ ``ContrailV2::NetworkIpam``).
.. req::
@@ -147,18 +140,46 @@ Contrail Heat Resources.
A VNF's internal network **MAY** have more than one subnet.
.. req::
+ :id: R-86972
+ :target: VNF
+ :keyword: SHOULD
+ :updated: casablanca
+
+ A VNF **SHOULD** create the internal network in the VNF's Heat
+ Orchestration Template Base Module.
+
+
+.. req::
:id: R-22688
:target: VNF
:keyword: MUST
:validation_mode: static
- :updated: casablanca
-
- If a VNF's port is connected to an internal network and the port is
- created in an Incremental Module and the internal network is created
- in the Base Module then the UUID of the internal network **MUST** be
- exposed as a parameter in the ``outputs:`` section of the Base Module
- and the port resource **MUST** use a ``get_param`` to obtain the network
- UUID.
+ :updated: dublin
+
+ When a VNF's Heat Orchestration Template creates an internal network
+ (per the ONAP definition, see Requirements R-52425 and R-46461
+ and R-35666) and the internal network needs to be shared between modules
+ within a VNF, the internal network **MUST** be created either in the
+
+ * the base module
+ * a nested YAML file invoked by the base module
+
+ and the base module **MUST** contain an output parameter that provides
+ either the network UUID or network name.
+
+ * If the network UUID value is used to reference the network, the output
+ parameter name in the base module **MUST** follow the naming convention
+ ``int_{network-role}_net_id``
+ * If the network name in is used to reference the network, the output
+ parameter name in the base template **MUST** follow the naming convention
+ ``int_{network-role}_net_name``
+
+ ``{network-role}`` **MUST** be the network-role of the internal network
+ created in the Base Module.
+
+ ``The Base Module Output Parameter MUST be declared in the ``parameters:``
+ section of the Incremental Module(s) where the ``OS::Neutron::Port``
+ resource(s) is attaching to the internal network.
ONAP does not programmatically enforce a naming convention for
parameters for internal network. However, a naming convention is
diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
index 2b17d46..3511d06 100644
--- a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
@@ -99,7 +99,7 @@ after initial VNF deployment to add capacity.
:target: VNF
:keyword: MAY
- A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``
+ A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``
**MAY** be defined in a Base Module.
.. req::
@@ -107,7 +107,7 @@ after initial VNF deployment to add capacity.
:target: VNF
:keyword: MAY
- A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``
+ A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``
**MAY** be defined in an Incremental Module.
.. req::
@@ -115,7 +115,7 @@ after initial VNF deployment to add capacity.
:target: VNF
:keyword: MAY
- A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``
+ A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``
**MAY** be defined in a Cinder Volume Module.
ONAP also supports the concept of an optional, independently deployed Cinder
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 55527c8..d2a7240 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
@@ -204,20 +204,17 @@ the port is attached to.
:validation_mode: static
:updated: dublin
-
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port``
is in an incremental module and
is attaching to an internal network (per the
ONAP definition, see Requirements R-52425 and R-46461),
- and the internal network is created in
- the base module,
the ``network`` parameter name **MUST**
- * follow the naming convention ``int_{network-role}_net_id`` if the Neutron
+ * follow the naming convention ``int_{network-role}_net_id`` if the
network UUID value is used to reference the network
* follow the naming convention ``int_{network-role}_net_name`` if the
- OpenStack network name in is used to reference the network.
+ network name in is used to reference the network.
where ``{network-role}`` is the network-role of the internal network and
a ``get_param`` **MUST** be used as the intrinsic function.
@@ -227,7 +224,8 @@ In Requirement R-86182, the internal network is created in the VNF's
Base Module (Heat Orchestration Template) and the parameter name is
declared in the Base Module's ``outputs`` section.
The output parameter name will be declared as a parameter in the
-``parameters`` section of the incremental module.
+``parameters`` section of the incremental module (See Requirement R-22688).
+
When the VNF's Heat Orchestration Template's resource
``OS::Neutron::Port`` is in the base module and