summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Chapter5')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst2
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst19
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst14
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters.rst8
-rw-r--r--docs/Chapter5/Tosca.rst2
5 files changed, 39 insertions, 6 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst b/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst
index 6ce2cad..4f2861f 100644
--- a/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst
@@ -66,7 +66,7 @@ Parameters.
:target: VNF
:keyword: MUST
:validation_mode: static
- :updated: casablanca
+ :introduced: casablanca
A VNF's Heat Orchestration Template's Cinder Volume Template **MUST**
contain either
diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst
index bf810b7..edc3b34 100644
--- a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst
@@ -12,6 +12,7 @@ As stated above, Heat Orchestration templates must be defined in YAML.
:id: R-92635
:keyword: MUST
:validation_mode: static
+ :introduced: casablanca
A VNF's Heat Orchestration Template **MUST** be compliant with the
OpenStack Template Guide.
@@ -130,6 +131,7 @@ attributes (e.g., type, label) defined as nested elements.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF Heat Orchestration's template's parameter **MUST** be used
in a resource with the exception of the parameters for the
@@ -139,6 +141,7 @@ attributes (e.g., type, label) defined as nested elements.
:id: R-91273
:target: VNF
:keyword: MAY NOT
+ :updated: casablanca
A VNF Heat Orchestration's template's parameter for the
``OS::Nova::Server`` resource property ``availability_zone``
@@ -181,6 +184,7 @@ type
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration Template's parameter type **MUST** be one of
the following values:
@@ -238,6 +242,7 @@ default
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
If a VNF Heat Orchestration Template parameter has a default value,
it **MUST** be enumerated in the environment file.
@@ -275,6 +280,7 @@ that defines a list of constraints to apply to the parameter.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration Template's parameter defined
in a non-nested YAML file as type
@@ -285,6 +291,7 @@ that defines a list of constraints to apply to the parameter.
:id: R-40518
:target: VNF
:keyword: MAY
+ :updated: casablanca
A VNF's Heat Orchestration Template's parameter defined
in a non-nested YAML file as type
@@ -294,6 +301,7 @@ that defines a list of constraints to apply to the parameter.
:id: R-96227
:target: VNF
:keyword: MAY
+ :updated: casablanca
A VNF's Heat Orchestration Template's parameter defined
in a non-nested YAML file as type
@@ -303,6 +311,7 @@ that defines a list of constraints to apply to the parameter.
:id: R-79817
:target: VNF
:keyword: MAY
+ :updated: casablanca
A VNF's Heat Orchestration Template's parameter defined
in a non-nested YAML file as
@@ -312,6 +321,7 @@ that defines a list of constraints to apply to the parameter.
:id: R-06613
:target: VNF
:keyword: MAY
+ :updated: casablanca
A VNF's Heat Orchestration Template's parameter defined
in a non-nested YAML file as type
@@ -322,6 +332,7 @@ that defines a list of constraints to apply to the parameter.
:target: VNF
:keyword: MUST NOT
:validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration Template's parameter defined
in a nested YAML file
@@ -448,6 +459,7 @@ resources
:id: R-40551
:target: VNF
:keyword: MAY
+ :updated: casablanca
A VNF's Heat Orchestration Template's Nested YAML files **MAY**
(or **MAY NOT**) contain the section ``resources:``.
@@ -554,6 +566,7 @@ be provided in place, or via a function
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
If a VNF's Heat Orchestration Template resource attribute
``property:`` uses a nested ``get_param``, the nested
@@ -569,6 +582,7 @@ The resource attribute ``metadata`` is an OpenStack optional attribute.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :introduced: casablanca
A VNF's Heat Orchestration Template's Resource **MAY** declare the
attribute ``metadata``.
@@ -607,6 +621,7 @@ deletion_policy
:id: R-43740
:target: VNF
:keyword: MAY
+ :updated: casablanca
VNF's Heat Orchestration Template's Resource **MAY** declare the
attribute ``deletion_policy:``.
@@ -627,6 +642,7 @@ external_id
:id: R-78569
:target: VNF
:keyword: MAY
+ :updated: casablanca
VNF's Heat Orchestration Template's Resource **MAY** declare the
attribute ``external_id:``.
@@ -675,6 +691,7 @@ A VNF's Heat Orchestration Template's environment file is a yaml text file.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration template **MUST** have a
corresponding environment file.
@@ -690,6 +707,7 @@ the mandatory parameter section.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration template's Environment File **MUST**
contain the ``parameters:`` section.
@@ -698,6 +716,7 @@ the mandatory parameter section.
:id: R-68198
:target: VNF
:keyword: MAY
+ :updated: casablanca
A VNF's Heat Orchestration template's Environment File's
``parameters:`` section **MAY** (or **MAY NOT**) enumerate parameters.
diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
index 2d59cb2..acc9ef3 100644
--- a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
@@ -34,6 +34,7 @@ deployed incrementally to create the complete VNF.
:id: R-33132
:target: VNF
:keyword: MAY
+ :updated: casablanca
A VNF's Heat Orchestration Template **MAY** be
1.) Base Module Heat Orchestration Template (also referred to as a
@@ -47,6 +48,7 @@ deployed incrementally to create the complete VNF.
:id: R-37028
:target: VNF
:keyword: MUST
+ :updated: casablanca
A VNF **MUST** be composed of one Base Module
@@ -61,6 +63,7 @@ deployed incrementally to create the complete VNF.
:id: R-20974
:target: VNF
:keyword: MUST
+ :updated: casablanca
At orchestration time, the VNF's Base Module **MUST**
be deployed first, prior to any incremental modules.
@@ -134,6 +137,7 @@ on another instance (e.g., during a failover activity).
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Cinder Volume Module, when it exists, **MUST** be 1:1
with a Base module or Incremental module.
@@ -146,6 +150,7 @@ Module.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Base Module **MUST** have a corresponding Environment File.
@@ -154,6 +159,7 @@ Module.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Incremental Module **MUST** have a corresponding Environment File
@@ -162,6 +168,7 @@ Module.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Cinder Volume Module **MUST** have a corresponding environment file
@@ -262,6 +269,7 @@ Base Modules
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF Heat Orchestration Template's Base Module file name **MUST** include
case insensitive 'base' in the filename and
@@ -298,6 +306,7 @@ Incremental Modules
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
VNF Heat Orchestration Template's Incremental Module file name
**MUST** contain only alphanumeric characters and underscores
@@ -333,6 +342,7 @@ Cinder Volume Modules
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF Heat Orchestration Template's Cinder Volume Module **MUST**
be named identical to the base or incremental module it is supporting with
@@ -343,6 +353,7 @@ Cinder Volume Modules
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
VNF Heat Orchestration Template's Cinder Volume Module's Environment File
**MUST** be named identical to the VNF Heat Orchestration Template's
@@ -357,6 +368,7 @@ Nested Heat file
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
VNF Heat Orchestration Template's Nested YAML file name **MUST** contain
only alphanumeric characters and underscores '_' and
@@ -455,6 +467,7 @@ ONAP Volume Module Output Parameters
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration Template's Cinder Volume Module Output
Parameter(s)
@@ -472,6 +485,7 @@ template is associated with.
:target: VNF
:keyword: MUST
:validation_mode: static
+ :updated: casablanca
A VNF's Heat Orchestration Templates' Cinder Volume Module Output
Parameter's name and type **MUST** match the input parameter name and type
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 5f16802..b5501fd 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
@@ -31,7 +31,7 @@ Requirement R-82481 defines how the ``{vm-type}`` is used.
:target: VNF
:keyword: MUST
:validation_mode: static
- :updated: casablanca
+ :introduced: casablanca
A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's
@@ -70,7 +70,7 @@ Property: image
:target: VNF
:keyword: MUST
:validation_mode: static
- :updated: casablanca
+ :introduced: casablanca
The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
property ``image`` value **MUST** be be obtained via a ``get_param``.
@@ -141,7 +141,7 @@ Property: flavor
:target: VNF
:keyword: MUST
:validation_mode: static
- :updated: casablanca
+ :introduced: casablanca
The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
property ``flavor`` value **MUST** be be obtained via a ``get_param``.
@@ -209,7 +209,7 @@ Property: Name
:target: VNF
:keyword: MUST
:validation_mode: static
- :updated: casablanca
+ :introduced: casablanca
The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
property ``name`` value **MUST** be be obtained via a ``get_param``.
diff --git a/docs/Chapter5/Tosca.rst b/docs/Chapter5/Tosca.rst
index 9970dbc..93436a8 100644
--- a/docs/Chapter5/Tosca.rst
+++ b/docs/Chapter5/Tosca.rst
@@ -945,7 +945,7 @@ model as described in YAML 1.1. Pending on Shitao proposal (see
NFVIFA(17)000110 discussion paper)
**[editor note]** new relationship type as suggested in Matt
-presentation. Slide 8. With specific rules of “valid\_target\_type”
+presentation. Slide 8. With specific rules of "valid\_target\_type"
+---------------------------+--------------------------------------+
| **Shorthand Name** | VirtualStorage |