summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention
diff options
context:
space:
mode:
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/Neutron Parameters.rst39
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst40
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst8
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst2
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property.rst2
5 files changed, 46 insertions, 45 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 f0d2212..948f8aa 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
@@ -20,8 +20,8 @@ naming convention. The four properties are:
3. fixed_ips, subnet
* Note that earlier versions of this document mentioned the property
- fixed_ips, subnet_id. This property has been removed from the document since
- it has been deprecated.
+ fixed_ips, subnet_id. This property has been removed from the document
+ since it has been deprecated.
See https://github.com/openstack/heat/blob/stable/ocata/heat/engine/resources/openstack/neutron/port.py
4. allowed_address_pairs, ip_address
@@ -833,8 +833,9 @@ 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
@@ -1044,7 +1045,7 @@ The property ``fixed_ips`` is used to assign IPs to a port. The Map Property
* ``{network-role}_subnet_id``
where
-
+
* ``{network-role}`` is the network role of the network.
.. req::
@@ -1091,12 +1092,12 @@ value at orchestration to the Heat Orchestration Template.
and the external network IPv6 subnet is to be specified
using the property ``fixed_ips``
map property ``subnet``, the parameter
- **MUST** follow the naming convention
+ **MUST** follow the naming convention
* ``{network-role}_v6_subnet_id``
- where
-
+ where
+
* ``{network-role}`` is the network role of the network.
.. req::
@@ -1116,10 +1117,10 @@ value at orchestration to the Heat Orchestration Template.
*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
-to assign IP addresses.
+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
@@ -1142,9 +1143,9 @@ 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
-balancer.
+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
@@ -1186,7 +1187,7 @@ balancer.
using the property ``fixed_ips`` map property ``subnet``,
the parameter **MUST** follow the naming convention
-
+
* ``int_{network-role}_subnet_id``
where
@@ -1237,7 +1238,7 @@ input parameter.
* 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
+ to an internal network (per the ONAP definition, see Requirements
R-52425 and R-46461)
that is created in the Base Module, AND
* an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND
@@ -1393,7 +1394,7 @@ VIP Assignment, External Networks, Supported by Automation
OS::Nova::Server
* ``{network-role}`` is the {network-role} of the external
network
-
+
And the parameter **MUST** be declared as type ``string``.
.. req::
@@ -1433,7 +1434,7 @@ VIP Assignment, External Networks, Supported by Automation
and an IPv6 Virtual IP (VIP)
address is assigned via ONAP automation
using the property ``allowed_address_pairs``
- map property ``ip_address``,
+ map property ``ip_address``,
the parameter name **MUST** follow the
naming convention
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst
index 0fe1286..7055e6e 100644
--- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst
@@ -7,8 +7,8 @@
Resource: OS::Nova::Server - Metadata Parameters
--------------------------------------------------------------------------------
-The ``OS::Nova::Server`` resource property ``metadata`` is an optional OpenStack
-property.
+The ``OS::Nova::Server`` resource property ``metadata`` is an optional
+OpenStack property.
Table 2 summarizes the mandatory and optional ``metadata`` supported by ONAP.
The sections that follow provides the requirements associated with each
``metadata`` parameter.
@@ -93,7 +93,7 @@ Template at orchestration time.
:updated: casablanca
If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property
+ property
``metadata`` key/value pair ``vnf_id`` is passed into a Nested YAML
file, the key/value pair name ``vnf_id`` **MUST NOT** change.
@@ -123,7 +123,7 @@ Template at orchestration time.
:validation_mode: static
:updated: casablanca
- A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
property ``metadata`` **MUST**
contain the key/value pair ``vf_module_id``
and the value MUST be obtained via a ``get_param``.
@@ -230,7 +230,7 @@ Template at orchestration time.
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property ``metadata`` key/value pair ``vnf_name``
+ property ``metadata`` key/value pair ``vnf_name``
parameter ``vnf_name`` **MUST NOT**
have parameter constraints defined.
@@ -255,7 +255,7 @@ Template at orchestration time.
If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property
+ property
``metadata`` key/value pair ``vnf_name`` is passed into a Nested YAML
file, the key/value pair name ``vnf_name`` **MUST NOT** change.
@@ -272,7 +272,7 @@ Template at orchestration time.
vf_module_name
^^^^^^^^^^^^^^^^^^
-The ``OS::Nova::Server`` Resource ``metadata`` map value parameter
+The ``OS::Nova::Server`` Resource ``metadata`` map value parameter
``vf_module_name``
is the deployment name of the heat stack created (e.g., ``<STACK_NAME>``)
from the
@@ -288,7 +288,7 @@ part of the orchestration process.
:keyword: SHOULD
:updated: casablanca
- A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
property ``metadata`` **SHOULD**
contain the key/value pair ``vf_module_name`` and the value **MUST**
be obtained via a ``get_param``.
@@ -301,7 +301,7 @@ part of the orchestration process.
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property
+ property
``metadata`` key/value pair ``vf_module_name`` parameter **MUST** be
declared as ``vf_module_name`` and the parameter **MUST**
be defined as type: ``string``.
@@ -314,7 +314,7 @@ part of the orchestration process.
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property
+ property
``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name``
**MUST NOT** have parameter constraints defined.
@@ -327,7 +327,7 @@ part of the orchestration process.
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property ``metadata`` key/value pair ``vf_module_name``
+ property ``metadata`` key/value pair ``vf_module_name``
parameter ``vf_module_name`` **MUST NOT**
be enumerated in the Heat Orchestration Template's environment file.
@@ -369,7 +369,7 @@ available for use by other ONAP components and/or north bound systems.
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
``metadata`` **MAY**
- contain the key/value pair ``vm_role`` and the value **MUST** be
+ contain the key/value pair ``vm_role`` and the value **MUST** be
obtained either via
- ``get_param``
@@ -384,8 +384,8 @@ available for use by other ONAP components and/or north bound systems.
If a VNF's Heat Orchestration Template's ``OS::Nova::Server``
resource property
- ``metadata`` key/value pair ``vm_role`` value is obtained via
- ``get_param``, the parameter **MUST** be declared as ``vm_role``
+ ``metadata`` key/value pair ``vm_role`` value is obtained via
+ ``get_param``, the parameter **MUST** be declared as ``vm_role``
and the parameter **MUST** be defined as type: ``string``.
.. req::
@@ -693,7 +693,7 @@ workload_context
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property ``metadata`` key/value pair ``workload_context``
+ property ``metadata`` key/value pair ``workload_context``
parameter **MUST**
be declared as ``workload_context`` and the parameter **MUST**
be defined as type: ``string``.
@@ -706,7 +706,7 @@ workload_context
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property ``metadata`` key/value pair ``workload_context``
+ property ``metadata`` key/value pair ``workload_context``
parameter ``workload_context`` **MUST NOT**
have parameter constraints defined.
@@ -719,7 +719,7 @@ workload_context
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property ``metadata`` key/value pair ``workload_context``
+ property ``metadata`` key/value pair ``workload_context``
parameter ``workload_context`` **MUST NOT**
be enumerated in the Heat Orchestration Template's environment file.
@@ -731,7 +731,7 @@ workload_context
:updated: casablanca
If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property ``metadata`` key/value pair ``workload_context``
+ property ``metadata`` key/value pair ``workload_context``
is passed into a Nested YAML
file, the key/value pair name ``workload_context`` **MUST NOT** change.
@@ -792,7 +792,7 @@ environment_context
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property ``metadata`` key/value pair ``environment_context``
+ property ``metadata`` key/value pair ``environment_context``
parameter **MUST** be declared as ``environment_context`` and the
parameter type **MUST** be defined as type: ``string``.
@@ -816,7 +816,7 @@ environment_context
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
- property
+ property
``metadata`` key/value pair ``environment_context`` **MUST NOT**
be enumerated in the Heat Orchestration Template's environment file.
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 47cbc17..5f16802 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
@@ -28,9 +28,9 @@ Requirement R-82481 defines how the ``{vm-type}`` is used.
.. req::
:id: R-304011
- :target: VNF
- :keyword: MUST
- :validation_mode: static
+ :target: VNF
+ :keyword: MUST
+ :validation_mode: static
:updated: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's
@@ -39,7 +39,7 @@ Requirement R-82481 defines how the ``{vm-type}`` is used.
* property ``image`` parameter name
* property ``flavor`` parameter name
* property ``name`` parameter name
-
+
**MUST** contain the identical ``{vm-type}``
and **MUST** follow the naming conventions defined
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst
index 48596ec..98f5119 100644
--- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst
@@ -171,7 +171,7 @@ oam_management_v4_address*
If the VNF's OAM Management IP Address is cloud assigned and
and the OAM IP Address is required to be inventoried in ONAP A&AI,
- then the parameter **MUST** be obtained by the
+ then the parameter **MUST** be obtained by the
resource ``OS::Neutron::Port``
attribute ``ip_address``.
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property.rst
index b6c7c3b..3109754 100644
--- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property.rst
@@ -6,7 +6,7 @@ Resource Property "name"
----------------------------
The parameter naming convention of the property ``name`` for the resource
-``OS::Nova::Server`` has been defined in
+``OS::Nova::Server`` has been defined in
:ref:`Nova Server - Metadata Parameters`.
This section provides specifies how the property ``name`` for non