summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst
diff options
context:
space:
mode:
authorstark, steven <ss820f@att.com>2018-09-13 13:17:01 -0700
committerstark, steven <ss820f@att.com>2018-09-13 17:49:14 -0700
commit7188bd47e219f83405ba8296ebfcdf054e25a998 (patch)
tree05f6efb4ff52590213d0a80da86fea17a1319d5e /docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst
parentefb8f384941889d8d7fa469fecebe9b0e8169065 (diff)
[VNFRQTS] update heat reqs for casablanca
commit #3 section 5.4 and 5.5 Change-Id: Ied69ffb23d9678455a964ed55ed8c193048dcd5e Issue-ID: VNFRQTS-438 Signed-off-by: stark, steven <ss820f@att.com>
Diffstat (limited to 'docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst1005
1 files changed, 577 insertions, 428 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 049967e..c3cd308 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
@@ -12,14 +12,17 @@ The resource OS::Neutron::Port is for managing Neutron ports.
Introduction
^^^^^^^^^^^^^
-Four properties of the resource OS::Neutron::Port that must follow the
-ONAP parameter naming convention. The four properties are:
+Four properties of the resource ``OS::Neutron::Port`` must follow the ONAP
+naming convention. The four properties are:
1. network
2. fixed_ips, ip_address
3. fixed_ips, subnet_id or fixed_ips, subnet
- * Note that in many examples in this document fixed_ips, subnet_id is used.
+ * These two properties represent the same construct.
+ ONAP currently has a Sev-2 issues associated with fixed_ips, subnet_id
+ and it is recommended to use fixed_ips, subnet
+ * Note that in many examples in this document fixed_ips, subnet_id is used.
4. allowed_address_pairs, ip_address
@@ -46,13 +49,13 @@ The values associated with these properties may reference an external
network or internal network. External networks and internal
networks are defined in :ref:`ONAP Heat Networking`.
-When the OS::Neutron::Port is attaching to an external network, all
+When the ``OS::Neutron::Port`` is attaching to an external network, all
property values are parameters that are retrieved via the intrinsic
-function 'get_param'.
+function ``get_param``.
-When the OS::Neutron::Port is attaching to an internal network, a
+When the ``OS::Neutron::Port`` is attaching to an internal network, a
property value maybe retrieved via the intrinsic
-function 'get_param', 'get_resource', or 'get_attr'.
+function ``get_param``, ``get_resource``, or ``get_attr``.
This will be described in the forth coming sections.
@@ -63,9 +66,7 @@ Items to Note
:id: R-93272
:target: VNF
:keyword: MAY
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :updated: casablanca
A VNF **MAY** have one or more ports connected to a unique
external network. All VNF ports connected to the unique external
@@ -76,9 +77,7 @@ Items to Note
:id: R-13841
:target: VNF
:keyword: MAY
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :updated: casablanca
A VNF **MAY** have one or more ports connected to a unique
internal network. All VNF ports connected to the unique internal
@@ -89,9 +88,8 @@ Items to Note
:id: R-07577
:target: VNF
:keyword: MUST
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
If the VNF's ports connected to a unique network (internal or external)
and the port's IP addresses are Cloud Assigned IP Addresses,
@@ -103,24 +101,22 @@ Items to Note
:id: R-45602
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
If a VNF's Port is attached to a network (internal or external)
- and the port's IP addresses are Cloud Assigned by OpenStack's DHCP
- Service, the 'OS::Neutron::Port' Resource's
+ and the port's IP addresses are cloud assigned by OpenStack's DHCP
+ Service, the ``OS::Neutron::Port`` Resource's
- * property 'fixed_ips' map property 'ip_address' **MUST NOT** be used
- * property 'fixed_ips' map property 'subnet'/'subnet_id' **MAY** be used
+ * property ``fixed_ips`` map property ``ip_address`` **MUST NOT** be used
+ * property ``fixed_ips`` map property ``subnet``/``subnet_id``
+ **MAY** be used
.. req::
:id: R-63956
:target: VNF
:keyword: MAY
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :updated: casablanca
If the VNF's ports connected to a unique external network
and the port's IP addresses are ONAP SDN-C assigned IP Addresses,
@@ -131,24 +127,22 @@ Items to Note
:id: R-48880
:target: VNF
:keyword: MUST
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
If a VNF's Port is attached to an external network and the port's
IP addresses are assigned by ONAP's SDN-Controller,
- the 'OS::Neutron::Port' Resource's
+ the ``OS::Neutron::Port`` Resource's
- * property 'fixed_ips' map property 'ip_address' **MUST** be used
- * property 'fixed_ips' map property 'subnet'/'subnet_id' **MUST NOT** be used
+ * property ``fixed_ips`` map property ``ip_address`` **MUST** be used
+ * property ``fixed_ips`` map property ``subnet``/``subnet_id``
+ **MUST NOT** be used
.. req::
:id: R-18001
:target: VNF
:keyword: MAY
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :updated: casablanca
If the VNF's ports connected to a unique internal network
and the port's IP addresses are statically assigned IP Addresses,
@@ -159,95 +153,111 @@ Items to Note
:id: R-70964
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
If a VNF's Port is attached to an internal network and the port's
IP addresses are statically assigned by the VNF's Heat Orchestration\
Template (i.e., enumerated in the Heat Orchestration Template's
- environment file), the 'OS::Neutron::Port' Resource's
+ environment file), the ``OS::Neutron::Port`` Resource's
- * property 'fixed_ips' map property 'ip_address' **MUST** be used
- * property 'fixed_ips' map property 'subnet'/'subnet_id'
- **MUST NOT** be used
+ * property ``fixed_ips`` map property ``ip_address`` **MUST** be used
+ * property ``fixed_ips`` map property ``subnet``/``subnet_id``
+ **MUST NOT** be used
Property: network
^^^^^^^^^^^^^^^^^^
-The Resource 'OS::Neutron::Port' property 'network' determines what network
+The Resource ``OS::Neutron::Port`` property ``network`` determines what network
the port is attached to.
-
.. req::
:id: R-18008
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
- property 'network' parameter **MUST** be declared as type: 'string'.
+ The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``
+ property ``network`` parameter **MUST** be declared as type: ``string``.
.. req::
:id: R-62983
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- When the VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
- is attaching to an external network, the 'network' parameter name **MUST**
+ 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), the
+ ``network`` parameter name **MUST**
- - follow the naming convention '{network-role}_net_id' if the Neutron
- network UUID value is used to reference the network
- - follow the naming convention '{network-role}_net_name' if the OpenStack
- network name is used to reference the network.
+ * follow the naming convention ``{network-role}_net_id`` if the Neutron
+ network UUID value is used to reference the network
+ * follow the naming convention ``{network-role}_net_name`` if the
+ OpenStack network name is used to reference the network.
- where '{network-role}' is the network-role of the external network and
- a 'get_param' **MUST** be used as the intrinsic function.
+ where ``{network-role}`` is the network-role of the external network
+ and a ``get_param`` **MUST** be used as the intrinsic function.
.. req::
:id: R-86182
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- When the VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
- is attaching to an internal network, and the internal network is created in a different
- Heat Orchestration Template than the 'OS::Neutron::Port', the 'network'
- parameter name **MUST**
+ 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),
+ and the internal network is created in a
+ different Heat Orchestration Template than the ``OS::Neutron::Port``,
+ the ``network`` parameter name **MUST**
- - follow the naming convention 'int\_{network-role}_net_id' if the Neutron
- 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.
+ * follow the naming convention ``int_{network-role}_net_id`` if the Neutron
+ 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.
- where '{network-role}' is the network-role of the internal network and a 'get_param' **MUST** be used as the intrinsic function.
+ where ``{network-role}`` is the network-role of the internal network and
+ a ``get_param`` **MUST** be used as the intrinsic function.
-In Requirement :need:`R-86182`, the internal network is created in the VNF's
+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.
+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.
.. req::
:id: R-93177
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- When the VNF's Heat Orchestration Template's
- Resource 'OS::Neutron::Port' is attaching to an internal
- network, and the internal network is created in the same Heat
- Orchestration Template than the 'OS::Neutron::Port', the 'network'
- parameter name **MUST** obtain the UUID of the internal network
- by using the intrinsic function 'get_resource' or 'get_attr'
+ 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),
+ and the internal network is created in the
+ same Heat Orchestration Template as the ``OS::Neutron::Port``,
+ the ``network`` property value **MUST** obtain the UUID
+ of the internal network by using the intrinsic function
+ ``get_resource``
and referencing the Resource ID of the internal network.
.. req::
:id: R-29872
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server'
- property 'network' parameter **MUST NOT** be enumerated in the Heat
- Orchestration Template's Environment File.
+ The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
+ property ``network``
+ parameter **MUST NOT** be enumerated in the Heat Orchestration
+ Template's Environment File.
The parameter values for external networks are provided by ONAP
to the VNF's Heat Orchestration Template at orchestration time.
@@ -272,6 +282,7 @@ at orchestration time.
description: Neutron name for the external {network-role} network
+
*Example Parameter Definition of Internal Networks in an Incremental Module*
.. code-block:: yaml
@@ -289,51 +300,65 @@ at orchestration time.
Property: fixed_ips, Map Property: ip_address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The resource 'OS::Neutron::Port' property 'fixed_ips'
-map property 'ip_address'
+The resource ``OS::Neutron::Port`` property ``fixed_ips``
+map property ``ip_address``
is used to assign one IPv4 or IPv6
addresses to port.
-One 'OS::Neutron::Port' resource may assign one or more
+One ``OS::Neutron::Port`` resource may assign one or more
IPv4 and/or IPv6 addresses.
-
.. req::
:id: R-34037
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's resource 'OS::Neutron::Port'
- property 'fixed_ips' map property 'ip_address' parameter **MUST**
- be declared as either type 'string' or type 'comma_delimited_list'.
+ The VNF's Heat Orchestration Template's
+ resource ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ **MUST** be declared as either type ``string`` or type
+ ``comma_delimited_list``.
.. req::
:id: R-40971
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an external network, 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}'
+ ``OS::Neutron::Port`` is attaching to an external network (per the
+ 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,
+ the parameter name **MUST** follow the
+ naming convention
- where
+ * ``{vm-type}_{network-role}_ip_{index}``
- - '{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
+ 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
.. req::
:id: R-39841
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
- property 'fixed_ips' map property 'ip_address' parameter
- '{vm-type}_{network-role}_ip_{index}' **MUST NOT** be enumerated in the
+ The VNF's Heat Orchestration Template's Resource
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_{network-role}_ip_{index}``
+ **MUST NOT** be enumerated in the
VNF's Heat Orchestration Template's Environment File.
ONAP's SDN-Controller assigns the IP Address and ONAP provides
@@ -347,36 +372,47 @@ the value at orchestration to the Heat Orchestration Template.
{vm-type}_{network-role}_ip_{index}:
type: string
- description: Fixed IPv4 assignment for {vm-type} VM {index} on the{network-role} network
-
+ description: Fixed IPv4 assignment for {vm-type} VM {index} on the {network-role} network
.. req::
:id: R-04697
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- When the VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
- is attaching to an external network, and an IPv4 address is assigned using
- the property 'fixed_ips' map property 'ip_address' and the parameter type
- is defined as a comma_delimited_list, the parameter name **MUST** follow the
+ 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),
+ and an IPv4 address is assigned
+ using the property ``fixed_ips``
+ map property ``ip_address`` and the parameter type is defined as a
+ ``comma_delimited_list``,
+ the parameter name **MUST** follow the
naming convention
- * '{vm-type}_{network-role}_ips',
+ * ``{vm-type}_{network-role}_ips``
- where
+ where
- * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
- * '{network-role}' is the {network-role} of the external network
+ * ``{vm-type}`` is the {vm-type} associated with the
+ ``OS::Nova::Server``
+ * ``{network-role}`` is the {network-role} of the external
+ network
.. req::
:id: R-98905
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
- property 'fixed_ips' map property 'ip_address' parameter
- '{vm-type}_{network-role}_ips' **MUST NOT** be enumerated in the VNF's
- Heat Orchestration Template's Environment File.
+ The VNF's Heat Orchestration Template's Resource
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_{network-role}_ips``
+ **MUST NOT** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
ONAP's SDN-Controller assigns the IP Address and ONAP provides
the value at orchestration to the Heat Orchestration Template.
@@ -397,31 +433,41 @@ Parameter Definition*
:id: R-71577
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an external network, 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
+ ``OS::Neutron::Port`` is attaching to an external network (per the
+ 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,
+ 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
+ * the value for ``{index}`` must start at zero (0) and increment by one
.. req::
:id: R-87123
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
- parameter '{vm-type}_{network-role}_v6_ip_{index}'
- **MUST NOT** be enumerated in the VNF's Heat Orchestration
- Template's Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_{network-role}_v6_ip_{index}``
+ **MUST NOT** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
ONAP's SDN-Controller assigns the IP Address and ONAP provides
the value at orchestration to the Heat Orchestration Template.
@@ -436,33 +482,44 @@ the value at orchestration to the Heat Orchestration Template.
type: string
description: Fixed IPv6 assignment for {vm-type} VM {index} on the {network-role} network
-
.. req::
:id: R-23503
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an external network, and an IPv6
- address is assigned using the property 'fixed_ips' map property 'ip_address'
- and the parameter type is defined as a comma_delimited_list, the parameter
- name **MUST** follow the naming convention
+ ``OS::Neutron::Port`` is attaching to an external network (per the
+ ONAP definition, see Requirement 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
+ ``comma_delimited_list``,
+ the parameter name **MUST** follow the
+ naming convention
- * '{vm-type}_{network-role}_v6_ips'
+ * ``{vm-type}_{network-role}_v6_ips``
where
- * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
- * '{network-role}' is the {network-role} of the external network
+ * ``{vm-type}`` is the {vm-type} associated with the
+ OS::Nova::Server
+ * ``{network-role}`` is the {network-role} of the external
+ network
.. req::
:id: R-93030
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
- parameter '{vm-type}_{network-role}_v6_ips' **MUST NOT** be enumerated in the
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_{network-role}_v6_ips``
+ **MUST NOT** be enumerated in the
VNF's Heat Orchestration Template's Environment File.
ONAP's SDN-Controller assigns the IP Address and ONAP provides
@@ -484,30 +541,42 @@ Definition*
:id: R-78380
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an internal network, 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
+ ``OS::Neutron::Port`` is attaching to an internal network (per the
+ 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
+ defined as a ``string``,
+ 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
+ * the value for ``{index`` must start at zero (0) and increment by one
.. req::
:id: R-28795
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
- parameter '{vm-type}\_int\_{network-role}\_ip\_{index}' **MUST** be enumerated
- in the VNF's Heat Orchestration Template's Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_int_{network-role}_ip_{index}``
+ **MUST** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
@@ -523,34 +592,45 @@ Heat Orchestration Template's Environment File.
type: string
description: Fixed IPv4 assignment for {vm-type} VM {index} on the int_{network-role} network
-
.. req::
:id: R-85235
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an internal network, and an IPv4
- address is assigned using the property 'fixed_ips' map property 'ip_address'
- and the parameter type is defined as a comma_delimited_list, the parameter
- name **MUST** follow the naming convention
+ ``OS::Neutron::Port`` is attaching to an internal network (per the
+ ONAP definition, see Requirement 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 defined as a
+ ``comma_delimited_list``,
+ the parameter name **MUST** follow the
+ naming convention
- * '{vm-type}\_int\_{network-role}_ips'
+ * ``{vm-type}_int_{network-role}_ips``
where
- * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
- * '{network-role}' is the {network-role} of the internal network
+ * ``{vm-type}`` is the {vm-type} associated with the
+ ``OS::Nova::Server``
+ * ``{network-role}`` is the {network-role} of the internal
+ network
.. req::
:id: R-90206
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
- parameter '{vm-type}\_int\_{network-role}_int_ips' **MUST** be enumerated in
- the VNF's Heat Orchestration Template's Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_int_{network-role}_int_ips``
+ **MUST** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
@@ -569,31 +649,43 @@ Heat Orchestration Template's Environment File.
:id: R-27818
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an internal network, 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
+ ``OS::Neutron::Port`` is attaching to an internal network (per the
+ ONAP definition, see RRequirements 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
+ ``string``,
+ 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
+ * the value for ``{index}`` must start at zero (0) and increment by one
+
.. req::
:id: R-97201
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
- parameter '{vm-type}\_int\_{network-role}\_v6\_ip\_{index}'
- **MUST** be enumerated in the VNF's Heat Orchestration
- Template's Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_int_{network-role}_v6_ip_{index}``
+ **MUST** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
@@ -609,24 +701,31 @@ Heat Orchestration Template's Environment File.
type: string
description: Fixed IPv6 assignment for {vm-type} VM {index} on the int_{network-role} network
-
.. req::
:id: R-29765
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an internal network, and an IPv6
- address is assigned using the property 'fixed_ips' map property 'ip_address'
- and the parameter type is defined as a comma_delimited_list, the parameter
- name **MUST** follow the naming convention
+ ``OS::Neutron::Port`` is attaching to an internal network (per the
+ ONAP definition, see Requirement 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
+ ``comma_delimited_list``,
+ the parameter name **MUST** follow the
+ naming convention
- * '{vm-type}\_int\_{network-role}_v6_ips'
+ * ``{vm-type}_int_{network-role}_v6_ips``
where
- * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
- * '{network-role}' is the {network-role} of the internal network
+ * ``{vm-type}`` is the {vm-type} associated with the
+ ``OS::Nova::Server``
+ * ``{network-role}`` is the {network-role} of the internal
+ network
*Example Internal Network IPv6 Address comma_delimited_list Parameter
Definition*
@@ -644,67 +743,88 @@ Definition*
:id: R-98569
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
- parameter '{vm-type}\_int\_{network-role}_v6_ips' **MUST** be enumerated in
- the VNF's Heat Orchestration Template's Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``ip_address`` parameter
+ ``{vm-type}_int_{network-role}_v6_ips``
+ **MUST** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
Heat Orchestration Template's Environment File.
+.. code-block:: yaml
+
+ parameters:
+
+ {vm-type}_int_{network-role}_v6_ips:
+ type: comma_delimited_list
+ description: Fixed IPv6 assignments for {vm-type} VMs on the int_{network-role} network
.. req::
:id: R-62590
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
+ The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``
+ property ``fixed_ips``
+ map property ``ip_address``
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}_ips
- - {vm-type}_{network-role}_v6_ips
+ * ``{vm-type}_{network-role}_ip_{index}``
+ * ``{vm-type}_{network-role}_ip_v6_{index}``
+ * ``{vm-type}_{network-role}_ips``
+ * ``{vm-type}_{network-role}_v6_ips``
- **MUST NOT** be enumerated in the Heat Orchestration Template's Environment File.
- ONAP provides the IP address assignments at orchestration time.
+
+ **MUST NOT** be enumerated in the Heat Orchestration
+ Template's Environment File. ONAP provides the IP address
+ assignments at orchestration time.
.. req::
:id: R-93496
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
+ The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``
+ property ``fixed_ips``
+ map property ``ip_address``
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}_ips
- - {vm-type}\_int\_{network-role}_v6_ips
+ * ``{vm-type}_int_{network-role}_ip_{index}``
+ * ``{vm-type}_int_{network-role}_ip_v6_{index}``
+ * ``{vm-type}_int_{network-role}_ips``
+ * ``{vm-type}_int_{network-role}_v6_ips``
+
- **MUST** be enumerated in the Heat Orchestration Template's Environment
- File and IP addresses **MUST** be assigned.
+ **MUST** be enumerated in the Heat Orchestration
+ Template's Environment File and IP addresses **MUST** be
+ assigned.
Summary Table
~~~~~~~~~~~~~~~~~
-.. csv-table:: **Table # OS::Neutron::Port Property fixed_ips map property ip_address Parameter Naming Convention**
+.. csv-table:: **Table 4 OS::Neutron::Port Property fixed_ips map property ip_address Parameter Naming Convention**
:header: Resource,Property,Map Property,Network Type,IP Address,Parameter Type,Parameter Name, Environment File
:align: center
:widths: auto
- OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, string, {vm-type}\_{network-role}\_ip\_{index}, NO
- OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, comma\_delimited\_list, {vm-type}\_{network-role}\_ips, NO
- OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, string, {vm-type}\_{network-role}\_v6\_ip\_{index}, NO
- OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, comma\_delimited\_list, {vm-type}\_{network-role}\_v6\_ips, NO
- OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, string, {vm-type}\_int\_{network-role}\_ip\_{index}, YES
- OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_ips, YES
- OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, string, {vm-type}\_int\_{network-role}\_v6\_ip\_{index}, YES
- OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_v6\_ips, YES
+ OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, string, {vm-type}_{network-role}_ip_{index}, NO
+ OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, comma_delimited_list, {vm-type}_{network-role}_ips, NO
+ OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, string, {vm-type}_{network-role}_v6_ip_{index}, NO
+ OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, comma_delimited_list, {vm-type}_{network-role}_v6_ips, NO
+ OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, string, {vm-type}_int_{network-role}_ip_{index}, YES
+ OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, comma_delimited_list, {vm-type}_int_{network-role}_ips, YES
+ OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, string, {vm-type}_int_{network-role}_v6_ip_{index}, YES
+ OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, comma_delimited_list, {vm-type}_int_{network-role}_v6_ips, YES
Examples
@@ -713,8 +833,8 @@ Examples
*Example: comma_delimited_list parameters for IPv4 and IPv6 Address
Assignments to an external network*
-In this example, the '{network-role}' has been defined as 'oam' to represent
-an oam network and the '{vm-type}' has been defined as 'db' for database.
+In this example, the ``{network-role}`` has been defined as ``oam`` to represent
+an oam network and the ``{vm-type}`` has been defined as ``db`` for database.
.. code-block:: yaml
@@ -746,8 +866,8 @@ an oam network and the '{vm-type}' has been defined as 'db' for database.
*Example: string parameters for IPv4 and IPv6 Address Assignments to an
external network*
-In this example, the '{network-role}' has been defined as 'oam' to
-represent an oam network and the '{vm-type}' has been defined as 'db' for
+In this example, the ``{network-role}`` has been defined as ``oam`` to
+represent an oam network and the ``{vm-type}`` has been defined as ``db`` for
database.
.. code-block:: yaml
@@ -783,12 +903,12 @@ database.
- "ip_address": {get_param: db_oam_v6_ip_1}
-*Example: comma_delimited_list parameters for IPv4 and IPv6 Address
+*Example*: comma_delimited_list parameters for IPv4 and IPv6 Address
Assignments to an internal network*
-In this example, the '{network-role}' has been defined as 'ctrl' to
+In this example, the ``{network-role}`` has been defined as ``ctrl`` to
represent an ctrl network internal to the vnf.
-The '{vm-type}' has been defined as 'db' for
+The ``{vm-type}`` has been defined as ``db`` for
database.
.. code-block:: yaml
@@ -824,9 +944,9 @@ database.
*Example: string parameters for IPv4 and IPv6 Address Assignments to an
internal network*
-In this example, the int_{network-role} has been defined as
-int_ctrl to represent a control network internal to the vnf.
-The {vm-type} has been defined as db for database.
+In this example, the ``int_{network-role}`` has been defined as
+``int_ctrl`` to represent a control network internal to the vnf.
+The ``{vm-type}`` has been defined as ``db`` for database.
.. code-block:: yaml
@@ -865,10 +985,10 @@ The {vm-type} has been defined as db for database.
Property: fixed_ips, Map Property: subnet_id
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The resource 'OS::Neutron::Port' property 'fixed_ips' map
-property 'subnet'/'subnet_id' is used when a
+The resource ``OS::Neutron::Port`` property ``fixed_ips`` map
+property ``subnet``/``subnet_id`` is used when a
port is requesting an IP assignment via
-OpenStack's DHCP Service (i.e., Cloud Assigned).
+OpenStack’s DHCP Service (i.e., cloud assigned).
The IP address assignment will be made from the specified subnet.
@@ -881,55 +1001,65 @@ subnet.
If the network (external or internal) that the port is attaching
to contains two or more subnets, specifying the subnet in the
-'fixed_ips' map property 'subnet'/'subnet_id' determines which
+``fixed_ips`` map property ``subnet``/``subnet_id`` determines which
subnet the IP address will be assigned from.
If the network (external or internal) that the port is attaching
to contains two or more subnets, and the subnet is not is not
-specified, OpenStack will randomly(?) determine which subnet
+specified, OpenStack will randomly determine which subnet
the IP address will be assigned from.
-The property fixed_ips is used to assign IPs to a port. The Map Property
-subnet_id specifies the subnet the IP is assigned from.
-
+The property ``fixed_ips`` is used to assign IPs to a port. The Map Property
+``subnet_id`` specifies the subnet the IP is assigned from.
.. req::
:id: R-38236
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- The VNF's Heat Orchestration Template's resource
- 'OS::Neutron::Port' property 'fixed_ips' map property
- 'subnet'/'subnet_id' parameter **MUST** be declared type 'string'.
+ The VNF's Heat Orchestration Template's
+ resource ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``subnet``/``subnet_id`` parameter
+ **MUST** be declared type ``string``.
.. req::
:id: R-62802
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- When the VNF's Heat Orchestration Template's resource
- 'OS::Neutron::Port' is attaching to an external network, and an IPv4
- address is being Cloud Assigned by OpenStack's DHCP Service and the
- external network IPv4 subnet is to be specified using the property
- 'fixed_ips' map property 'subnet'/'subnet_id', the parameter **MUST**
- follow the naming convention
+ 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),
+ and an IPv4 address is being cloud assigned by OpenStack's DHCP Service
+ and the external network IPv4 subnet is to be specified
+ using the property ``fixed_ips``
+ map property ``subnet``/``subnet_id``, the parameter
+ **MUST** follow the naming convention
- * '{network-role}_subnet_id'
+ * ``{network-role}_subnet_id``
where
-
- * '{network-role}' is the network role of the network.
+
+ * ``{network-role}`` is the network role of the network.
.. req::
:id: R-83677
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property
- subnet'/'subnet_id' parameter '{network-role}_subnet_id'
- **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
- Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``subnet``/``subnet_id`` parameter
+ ``{network-role}_subnet_id``
+ **MUST NOT** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
ONAP's SDN-Controller provides the network's subnet's UUID
value at orchestration to the Heat Orchestration Template.
@@ -949,51 +1079,45 @@ value at orchestration to the Heat Orchestration Template.
:id: R-15287
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
- When the VNF's Heat Orchestration Template's resource
- 'OS::Neutron::Port' is attaching to an external network, and an IPv6
- address is being Cloud Assigned by OpenStack's DHCP Service and the
- external network IPv6 subnet is to be specified using the property
- 'fixed_ips' map property 'subnet'/'subnet_id', the parameter **MUST**
- follow the naming convention
-
- * '{network-role}_subnet_v6_id'
+ 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),
+ and an IPv6 address is being cloud assigned by OpenStack's DHCP Service
+ and the external network IPv6 subnet is to be specified
+ using the property ``fixed_ips``
+ map property ``subnet``/``subnet_id``, the parameter
+ **MUST** follow the naming convention
- where
+ * ``{network-role}_v6_subnet_id``
- * '{network-role}' is the network role of the network.
+ where
+
+ * ``{network-role}`` is the network role of the network.
.. req::
:id: R-80829
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property
- subnet'/'subnet_id' parameter '{network-role}_subnet_v6_id'
- **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
- Environment File.
-
-ONAP's SDN-Controller provides the network's subnet's UUID
-value at orchestration to the Heat Orchestration Template.
-
-*Example Parameter Definition*
-
-.. code-block:: yaml
-
- parameters:
-
- {network-role}_v6_subnet_id:
- type: string
- description: Neutron IPv6 subnet UUID for the {network-role} network
-
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``subnet``/``subnet_id`` parameter
+ ``{network-role}_v6_subnet_id``
+ **MUST NOT** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
*Example: One Cloud Assigned IPv4 Address (DHCP) assigned to a network
that has two or more IPv4 subnets*
-In this example, the '{network-role}' has been defined as 'oam' to represent
-an oam network and the '{vm-type}' has been defined as 'lb' for load
-balancer. The Cloud Assigned IP Address uses the OpenStack DHCP service
+In this example, the ``{network-role}`` has been defined as ``oam`` to represent
+an oam network and the ``{vm-type}`` has been defined as ``lb`` for load
+balancer. The cloud assigned IP Address uses the OpenStack DHCP service
to assign IP addresses.
.. code-block:: yaml
@@ -1017,8 +1141,8 @@ to assign IP addresses.
address assigned to a network that has at least one IPv4 subnet and one
IPv6 subnet*
-In this example, the '{network-role}' has been defined as 'oam' to represent
-an oam network and the '{vm-type}' has been defined as 'lb' for load
+In this example, the ``{network-role}`` has been defined as ``oam`` to represent
+an oam network and the ``{vm-type}`` has been defined as ``lb`` for load
balancer.
.. code-block:: yaml
@@ -1042,39 +1166,48 @@ balancer.
- subnet_id: { get_param: oam_subnet_id }
- subnet_id: { get_param: oam_v6_subnet_id }
-
.. req::
:id: R-84123
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When
- - the VNF's Heat Orchestration Template's resource 'OS::Neutron::Port'
- in an Incremental Module is attaching to an internal network
- that is created in the Base Module, AND
- - an IPv4 address is being Cloud Assigned by OpenStack's DHCP Service AND
- - the internal network IPv4 subnet is to be specified using the
- property 'fixed_ips' map property 'subnet'/'subnet_id',
+ * the VNF's Heat Orchestration Template's
+ resource ``OS::Neutron::Port`` in an Incremental Module is attaching
+ to an internal network (per the ONAP definition, see
+ Requirements R-52425 and R-46461)
+ that is created in the Base Module, AND
+ * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND
+ * the internal network IPv4 subnet is to be specified
+ using the property ``fixed_ips`` map property ``subnet``/``subnet_id``,
the parameter **MUST** follow the naming convention
- * 'int\_{network-role}_subnet_id'
+
+ * ``int_{network-role}_subnet_id``
+
where
- * '{network-role}' is the network role of the internal network
- - Note that the parameter **MUST** be defined as an 'output' parameter in
- the base module.
+ * ``{network-role}`` is the network role of the internal network
+
+ Note that the parameter **MUST** be defined as an ``output`` parameter in
+ the base module.
.. req::
:id: R-69634
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property
- subnet'/'subnet_id' parameter 'int\_{network-role}_subnet_id'
- **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
- Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``subnet``/``subnet_id`` parameter
+ ``int_{network-role}_subnet_id``
+ **MUST NOT** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
The assumption is that internal networks are created in the base module.
The Neutron subnet network ID will be passed as an output parameter
@@ -1092,39 +1225,44 @@ input parameter.
type: string
description: Neutron IPv4 subnet UUID for the int_{network-role} network
-
.. req::
:id: R-76160
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
When
- - the VNF's Heat Orchestration Template's resource
- 'OS::Neutron::Port' in an Incremental Module is attaching to an
- internal network that is created in the Base Module, AND
- - an IPv6 address is being Cloud Assigned by OpenStack's DHCP Service AND
- - the internal network IPv6 subnet is to be specified using the property
- 'fixed_ips' map property 'subnet'/'subnet_id',
+ * the VNF's Heat Orchestration Template's
+ resource ``OS::Neutron::Port`` in an Incremental Module is attaching
+ to an internal network (per the ONAP definition, see Requirement TBD)
+ that is created in the Base Module, AND
+ * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND
+ * the internal network IPv6 subnet is to be specified
+ using the property ``fixed_ips`` map property ``subnet``/``subnet_id``,
the parameter **MUST** follow the naming convention
- * 'int\_{network-role}_v6_subnet_id'
- where
- * '{network-role}' is the network role of the internal network
+ ``int_{network-role}_v6_subnet_id``,
+ where ``{network-role}`` is the network role of the internal network.
- - Note that the parameter **MUST** be defined as an 'output' parameter in
- the base module.
+ Note that the parameter **MUST** be defined as an ``output`` parameter in
+ the base module.
.. req::
:id: R-22288
:target: VNF
:keyword: MUST NOT
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'fixed_ips' map property
- 'subnet'/'subnet_id' parameter 'int\_{network-role}_v6_subnet_id'
- **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
- Environment File.
+ ``OS::Neutron::Port`` property ``fixed_ips``
+ map property ``subnet``/``subnet_id`` parameter
+ ``int_{network-role}_v6_subnet_id``
+ **MUST NOT** be enumerated in the
+ VNF's Heat Orchestration Template's Environment File.
+
*Example Parameter Definition*
@@ -1136,11 +1274,10 @@ input parameter.
type: string
description: Neutron subnet UUID for the int_{network-role} network
-
Property: allowed\_address\_pairs, Map Property: ip\_address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The property 'allowed_address_pairs' in the resource 'OS::Neutron::Port'
+The property ``allowed_address_pairs`` in the resource ``OS::Neutron::Port``
allows the user to specify a mac_address and/or ip_address that will
pass through a port regardless of subnet. This enables the use of
protocols, such as VRRP, which allow for a Virtual IP (VIP) address
@@ -1153,26 +1290,29 @@ Note that the management of the VIP IP addresses (i.e. transferring
ownership between active and standby VMs) is the responsibility of
the VNF application.
-
.. req::
:id: R-62300
:target: VNF
:keyword: MUST
+ :validation_mode: static
+ :updated: casablanca
If a VNF has two or more ports that require a Virtual IP Address (VIP),
- a VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port' property
- 'allowed_address_pairs' map property 'ip_address' parameter **MUST** be used.
+ a VNF's Heat Orchestration Template's Resource
+ ``OS::Neutron::Port`` property ``allowed_address_pairs``
+ map property ``ip_address`` parameter
+ **MUST** be used.
-The 'allowed_address_pairs' is an optional property. It is not required.
+The ``allowed_address_pairs`` is an optional property. It is not required.
ONAP automation supports the assignment of VIP addresses
-for external networks. ONAP support the assignment of one IPv4 VIP address
+for external networks. ONAP support the assignment of one IPv4 VIP address
and/or one IPv6 VIP address to a set of ports associated with a
-'{vm-type}' and '{network-role}'.
+``{vm-type}`` and ``{network-role}``.
If a VNF requires more than one IPv4 VIP address
and/or more than one IPv6 VIP address to a set of ports associated with a
-'{vm-type}' and '{network-role}', there are "manual" work-around
+``{vm-type}`` and ``{network-role}``, there are "manual" work-around
procedures that can be utilized.
VIP Assignment, External Networks, Supported by Automation
@@ -1182,9 +1322,8 @@ VIP Assignment, External Networks, Supported by Automation
:id: R-91810
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
If a VNF requires ONAP to assign a Virtual IP (VIP) Address to
ports connected an external network, the port
@@ -1194,9 +1333,8 @@ VIP Assignment, External Networks, Supported by Automation
:id: R-41956
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
If a VNF requires ONAP to assign a Virtual IP (VIP) Address to
ports connected an external network, the port
@@ -1206,9 +1344,8 @@ VIP Assignment, External Networks, Supported by Automation
:id: R-10754
:target: VNF
:keyword: MUST
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
If a VNF has two or more ports that
attach to an external network that require a Virtual IP Address (VIP),
@@ -1221,50 +1358,53 @@ VIP Assignment, External Networks, Supported by Automation
:id: R-98748
:target: VNF
:keyword: MUST
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'allowed_address_pairs'
- map property 'ip_address' parameter
- **MUST** be declared as type 'string'.
+ ``OS::Neutron::Port`` property ``allowed_address_pairs``
+ map property ``ip_address`` parameter
+ **MUST** be declared as type ``string``.
.. req::
:id: R-41492
:target: VNF
:keyword: MUST
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an external network,
- and an IPv4 Virtual IP (VIP) address is assigned via ONAP automation
- using the property 'allowed_address_pairs' map property 'ip_address' and
- the parameter name **MUST** follow the naming convention
+ ``OS::Neutron::Port`` is attaching to an external network (per the
+ ONAP definition, see Requirement R-57424),
+ and an IPv4 Virtual IP (VIP)
+ address is assigned via ONAP automation
+ using the property ``allowed_address_pairs``
+ map property ``ip_address`` and
+ the parameter name **MUST** follow the
+ naming convention
- * '{vm-type}_{network-role}_floating_ip'
+ * ``{vm-type}_{network-role}_floating_ip``
where
- * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
- * '{network-role}' is the {network-role} of the external network
-
- And the parameter **MUST** be declared as type 'string'.
+ * ``{vm-type}`` is the {vm-type} associated with the
+ OS::Nova::Server
+ * ``{network-role}`` is the {network-role} of the external
+ network
+
+ And the parameter **MUST** be declared as type ``string``.
.. req::
:id: R-83412
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'allowed_address_pairs'
- map property 'ip_address' parameter
- '{vm-type}_{network-role}_floating_ip'
+ ``OS::Neutron::Port`` property ``allowed_address_pairs``
+ map property ``ip_address`` parameter
+ ``{vm-type}_{network-role}_floating_ip``
**MUST NOT** be enumerated in the
VNF's Heat Orchestration Template's Environment File.
@@ -1282,37 +1422,41 @@ VIP Assignment, External Networks, Supported by Automation
:id: R-35735
:target: VNF
:keyword: MUST
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
When the VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' is attaching to an external network,
- and an IPv6 Virtual IP (VIP) address is assigned via ONAP automation
- using the property 'allowed_address_pairs' map property 'ip_address',
- the parameter name **MUST** follow the naming convention
+ ``OS::Neutron::Port`` is attaching to an external network (per the
+ ONAP definition, see Requirement R-57424),
+ and an IPv6 Virtual IP (VIP)
+ address is assigned via ONAP automation
+ using the property ``allowed_address_pairs``
+ map property ``ip_address``,
+ the parameter name **MUST** follow the
+ naming convention
- * '{vm-type}_{network-role}_v6_floating_ip'
+ * ``{vm-type}_{network-role}_v6_floating_ip``
where
- * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
- * '{network-role}' is the {network-role} of the external network
+ * ``{vm-type}`` is the {vm-type} associated with the
+ OS::Nova::Server
+ * ``{network-role}`` is the {network-role} of the external
+ network
- And the parameter **MUST** be declared as type 'string'.
+ And the parameter **MUST** be declared as type ``string``.
.. req::
:id: R-83418
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
The VNF's Heat Orchestration Template's Resource
- 'OS::Neutron::Port' property 'allowed_address_pairs'
- map property 'ip_address' parameter
- '{vm-type}_{network-role}_floating_v6_ip'
+ ``OS::Neutron::Port`` property ``allowed_address_pairs``
+ map property ``ip_address`` parameter
+ ``{vm-type}_{network-role}_floating_v6_ip``
**MUST NOT** be enumerated in the
VNF's Heat Orchestration Template's Environment File.
@@ -1332,31 +1476,29 @@ addresses that are mapped to specific VM ports. In that case, the
individual VMs are not even aware of the public IPs, and all assignment
of public IPs to VMs is via OpenStack commands. ONAP does not support
Neutron-style Floating IPs. That is, ONAP does not support the
-resources 'OS::Neutron::FloatingIP'
-and 'OS::Neutron::FloatingIPAssociation'.
+resources ``OS::Neutron::FloatingIP``
+and ``OS::Neutron::FloatingIPAssociation``.
.. req::
:id: R-05257
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration Template's **MUST NOT**
- contain the Resource 'OS::Neutron::FloatingIP'.
+ contain the Resource ``OS::Neutron::FloatingIP``.
.. req::
:id: R-76449
:target: VNF
:keyword: MUST NOT
- :test: no test found
- :test_case: no test found
- :test_file: no test found
+ :validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration Template's **MUST NOT**
- contain the Resource 'OS::Neutron::FloatingIPAssociation'.
+ contain the Resource ``OS::Neutron::FloatingIPAssociation``.
The Floating IP functions as a NAT. They are allocated within
Openstack, and always "terminate" within the Openstack infrastructure.
@@ -1367,10 +1509,10 @@ port. The VM never sees or knows about the Openstack Floating IP.
The process to use is:
- User allocates a floating IP from the Openstack pool.
- - User 'attaches' that floating IP to one of the VM ports.
+ - User ‘attaches’ that floating IP to one of the VM ports.
If there is a high-availability VNF that wants to "float" the IP to a
-different VM, it requires a Neutron command to request Openstack to 'attach'
+different VM, it requires a Neutron command to request Openstack to ‘attach’
the floating IP to a different VM port.
The pool of such addresses is managed by Openstack infrastructure.
Users cannot create new ones, they can only choose from those in the pool.
@@ -1392,7 +1534,7 @@ additional IPs.
Floating IPs are not used in ONAP due to the NAT-ting nature of the IPs,
the inability to reserve such IPs for specific use, the need to manage them
via Openstack commands (i.e. a HA VNF would require direct access to
-Openstack to 'float' such an IP from one VM to another).
+Openstack to ‘float’ such an IP from one VM to another).
*Example:*
@@ -1427,16 +1569,15 @@ an oam network and the {vm-type} has been defined as db for database.
allowed_address_pairs: [ { "ip_address": {get_param:
db_oam_floating_ip}}]
-
VIP Assignment, External Networks, Additional Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The parameter {'vm-type}_{network-role}_floating_ip' allows for only one
-allowed address pair IPv4 address per '{vm-type}' and '{network-role}'
+The parameter ``{vm-type}_{network-role}_floating_ip`` allows for only one
+allowed address pair IPv4 address per ``{vm-type}`` and ``{network-role}``
combination.
-The parameter '{vm-type}_{network-role}_floating_v6_ip' allows for only one
-allowed address pair IPv6 address per '{vm-type}' and '{network-role}'
+The parameter ``{vm-type}_{network-role}_floating_v6_ip`` allows for only one
+allowed address pair IPv6 address per ``{vm-type}`` and ``{network-role}``
combination.
If there is a need for multiple allowed address pair IPs for a given
@@ -1446,10 +1587,10 @@ options.
**Option One**
If there is a need for multiple allowed address pair IPs for a given
-'{vm-type}' and '{network-role}' combination within a VNF, then the
-parameter names defined for the Property 'fixed_ips' Map Property
-'ip_address' should be used or the Property 'allowed_address_pairs'
-Map Property 'ip_address'. The
+``{vm-type}`` and ``{network-role}`` combination within a VNF, then the
+parameter names defined for the Property ``fixed_ips`` Map Property
+``ip_address`` should be used or the Property ``allowed_address_pairs``
+Map Property ``ip_address``. The
parameter names are provided in the table below.
.. csv-table:: **Table 5 OS::Neutron::Port Property allowed_address_pairs map property ip_address Parameter Naming Convention**
@@ -1548,7 +1689,7 @@ the CDL and then the VIPs as shown in the examples above.
**Option Two**
If there is a need for multiple allowed address pair IPs for a given
-'{vm-type}' and '{network-role}' combination within a VNF, then the
+``{vm-type}`` and ``{network-role}`` combination within a VNF, then the
parameter names defined for the table below can be used.
**Resource OS::Neutron::Port**
@@ -1567,7 +1708,7 @@ Table 6: Multiple allowed_address_pairs Option 2A
If there is a need for multiple allowed address pair IPs for a given
-'{vm-type}' and '{network-role}' combination within a VNF and the need to
+``{vm-type}`` and ``{network-role}`` combination within a VNF and the need to
differentiate the VIPs for different traffic types (e.g., 911 VIP,
fail-over VIP), then the parameter names defined for the table below can
be used.
@@ -1590,7 +1731,7 @@ Internal Networks
~~~~~~~~~~~~~~~~~~~~~~~
ONAP defines an internal network in relation to
-the VNF and not with regard to the Network Cloud site. Internal
+the VNF and not with regard to the cloud site. Internal
networks may also be referred to as "intra-VNF" networks or "private"
networks. An internal network only connects VMs in a single VNF. It
must not connect to other VNFs or an external (to the cloud) gateway or an
@@ -1598,34 +1739,36 @@ external (to the cloud) router.
ONAP internal networks should be created in the base module.
-As previously mentioned,
-ports that connect to an internal network are assigned IP addresses
-via one of two methods
+As previously mentioned, ports that connect to an internal network are assigned
+IP addresses via one of two methods
* Method 1: Cloud assigned by OpenStack's DHCP Service
* Method 2: Statically assigned. That is, predetermined by the VNF designer
and are specified in the VNF's Heat Orchestration Template's
Environment File
-If Cloud assigned IP addressing is being used, output statements
+If cloud assigned IP addressing is being used, output statements
are created in the base module.
If static assigned IP addressing is being used, the IP addresses
are defined in the environment file.
- * {vm-type}_int_{network-role}_floating_ip
- * {vm-type}_int_{network-role}_floating_v6_ip
+ * ``{vm-type}_int_{network-role}_floating_ip``
+ * ``{vm-type}_int_{network-role}_floating_v6_ip``
+
+ * ``{vm-type}_int_{network-role}_vip_{index}``
+ * ``{vm-type}_int_{network-role}_vips``
+ * ``{vm-type}_int_{network-role}_v6_vip_{index}``
+ * ``{vm-type}_int_{network-role}_v6_vips``
+
+
+ * ``{vm-type}_int_{network-role}_{vip_type}_vip``
+ * ``{vm-type}_int_{network-role}_{vip_type}_vips``
+ * ``{vm-type}_int_{network-role}_{vip_type}_v6_vip``
+ * ``{vm-type}_int_{network-role}_{vip_type}_v6_vips``
- * {vm-type}_int_{network-role}_vip_{index}
- * {vm-type}_int_{network-role}_vips
- * {vm-type}_int_{network-role}_v6_vip_{index}
- * {vm-type}_int_{network-role}_v6_vips
- * {vm-type}_int_{network-role}_{vip_type}_vip
- * {vm-type}_int_{network-role}_{vip_type}_vips
- * {vm-type}_int_{network-role}_{vip_type}_v6_vip
- * {vm-type}_int_{network-role}_{vip_type}_v6_vips
*Example Parameter Definition*
@@ -1640,14 +1783,19 @@ are defined in the environment file.
type: string
description: VIP for {vm-type} VMs on the int_{network-role} network
+
+
allowed_address_pair IP Addresses Required in more than one module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If the IP address {vm-type}_{network-role}_floating_ip and/or
-{vm-type}_{network-role}_floating_v6_ip must be used in more than module in the
-VNF, the parameter values must be defined as output values in the base
-module with output names: {vm-type}_{network-role}_shared_vip or
-{vm-type}_{network-role}_v6_shared_vip
+If the IP address ``{vm-type}_{network-role}_floating_ip`` and/or
+``{vm-type}_{network-role}_floating_v6_ip`` must be used in more than module
+in the
+VNF, the parameter values must be defined as output values in the base module
+with
+output names: ``{vm-type}_{network-role}_shared_vip`` or
+``{vm-type}_{network-role}_v6_shared_vip``.
+
.. code-block:: yaml
@@ -1662,7 +1810,7 @@ module with output names: {vm-type}_{network-role}_shared_vip or
The output parameters must be defined as input parameter in the
incremental modules that require the IP addresses. When defining the
-allowed_address_pairs: in the OS::Neutron::Port, it should be as
+``allowed_address_pairs`` in the ``OS::Neutron::Port``, it should be as
follows:
.. code-block:: yaml
@@ -1674,54 +1822,56 @@ follows:
Reserve Port Concept
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A "Reserve Port" is an OS::Neutron::Port that fixed_ips, ip_address
+A "Reserve Port" is an ``OS::Neutron::Port`` that ``fixed_ips``, ip_address
property is assigned one or more IP addresses that are used as Virtual
IP (VIP) Addresses (i.e., allowed_address_pairs) on other ports.
A "Reserve Port" is never attached to a Virtual Machine
-(OS::Nova::Server). The reserve port ensures that the intended
-allowed_address_pair IP address is not inadvertently assigned as a
-fixed_ips to a OS::Neutron::Port that is attached OS::Nova::Server and
+(``OS::Nova::Server``). The reserve port ensures that the intended
+``allowed_address_pair`` IP address is not inadvertently assigned as a
+fixed_ips to a ``OS::Neutron::Port`` that is attached ``OS::Nova::Server`` and
thus causing routing issues.
A VNF may have one or more "Reserve Ports". A reserve port maybe created
in the base module or an incremental module. If created in the base
module, parameters may be defined in the outputs: section of the base
template so the IP Address assigned to the reserve port maybe assigned
-to the allowed_address_pair property of an OS::Neutron::Port in one or
+to the allowed_address_pair property of an ``OS::Neutron::Port`` in one or
more incremental modules.
The parameter name of the IP address used in the "Reserve Port" depends
-on the allowed_address_pair "option" utilized by the VNF.
+on the ``allowed_address_pair`` "option" utilized by the VNF.
When creating a Reserve Port, if only one allowed_address_pair is configured
on a port, then the parameter name depends upon the IP addresses type
(IPv4 or IPv6) and network type (internal or external).
The valid parameter names are:
- * {vm-type}_{network-role}_floating_ip
- * {vm-type}_{network-role}_floating_v6_ip
- * {vm-type}_int_{network-role}_floating_ip
- * {vm-type}_int_{network-role}_floating_v6_ip
+ * ``{vm-type}_{network-role}_floating_ip``
+ * ``{vm-type}_{network-role}_floating_v6_ip``
+ * ``{vm-type}_int_{network-role}_floating_ip``
+ * ``{vm-type}_int_{network-role}_floating_v6_ip``
When creating a Reserve Port, if more than one (e.g., multiple)
-allowed_address_pair is configured on a port, then the parameter name depends
+``allowed_address_pair`` is configured on a port, then the parameter name
+depends
upon the IP addresses type (IPv4 or IPv6) and network type
(internal or external) and the option being used. The valid parameter
names are:
- * {vm-type}_{network-role}_ip_{index}
- * {vm-type}_{network-role}_ips
- * {vm-type}_{network-role}_v6_ip_{index}
- * {vm-type}_{network-role}_v6_ips
- * {vm-type}_{network-role}_vip_{index}
- * {vm-type}_{network-role}_vips
- * {vm-type}_{network-role}_v6_vip_{index}
- * {vm-type}_{network-role}_v6_vips
- * {vm-type}_{network-role}_{vip-type}_vip
- * {vm-type}_{network-role}_v6_{vip-type}_vip
- * {vm-type}_{network-role}_{vip-type}_vips
- * {vm-type}_{network-role}_v6_{vip-type}_vips
+ * ``{vm-type}_{network-role}_ip_{index}``
+ * ``{vm-type}_{network-role}_ips``
+ * ``{vm-type}_{network-role}_v6_ip_{index}``
+ * ``{vm-type}_{network-role}_v6_ips``
+ * ``{vm-type}_{network-role}_vip_{index}``
+ * ``{vm-type}_{network-role}_vips``
+ * ``{vm-type}_{network-role}_v6_vip_{index}``
+ * ``{vm-type}_{network-role}_v6_vips``
+ * ``{vm-type}_{network-role}_{vip-type}_vip``
+ * ``{vm-type}_{network-role}_v6_{vip-type}_vip``
+ * ``{vm-type}_{network-role}_{vip-type}_vips``
+ * ``{vm-type}_{network-role}_v6_{vip-type}_vips``
+
*Example IPv4 Reserve Port Definition: one allowed_address_pair
configured on a port*
@@ -1746,4 +1896,3 @@ configured on a port*
network: { get_param: {network-role}_net_id }
fixed_ips:
- ip_address : { get_param: {vm-type}_{network-role}_floating_v6_ip }
-