[VNFRQTS] updated 9 res in heat section 05/70205/1
authorweinstock, alan <aw2574@att.com>
Wed, 10 Oct 2018 20:54:50 +0000 (20:54 +0000)
committerweinstock, alan <aw2574@att.com>
Wed, 10 Oct 2018 20:54:50 +0000 (20:54 +0000)
Change-Id: Ic8a9b05b37349cf0b7b30b27a8e5abf97234d6ba
Issue-ID: VNFRQTS-466
Signed-off-by: weinstock, alan <aw2574@att.com>
docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst
docs/data/needs.json

index 964288b..0fe1286 100644 (file)
@@ -45,7 +45,8 @@ Template at orchestration time.
 
     A VNF's Heat Orchestration Template's ``OS::Nova::Server``
     resource property ``metadata`` **MUST**
-    contain the  key/value pair ``vnf_id``.
+    contain the  key/value pair ``vnf_id``
+    and the value **MUST** be obtained via a ``get_param``.
 
 .. req::
     :id: R-07507
@@ -205,8 +206,9 @@ Template at orchestration time.
     :validation_mode: static
     :updated: casablanca
 
-    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource **MUST**
-    contain the ``metadata`` map value parameter ``vnf_name``.
+    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
+    ``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the
+    value **MUST** be obtained via a ``get_param``.
 
 .. req::
     :id: R-62428
@@ -323,8 +325,10 @@ part of the orchestration process.
     :validation_mode: static
     :updated: casablanca
 
-    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
-    ``metadata`` map value parameter ``vf_module_name`` **MUST NOT**
+
+    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+    property ``metadata`` key/value pair ``vf_module_name`` 
+    parameter ``vf_module_name`` **MUST NOT**
     be enumerated in the Heat Orchestration Template's environment file.
 
 .. req::
@@ -424,9 +428,10 @@ Defining the ``vm_role`` as the ``{vm-type}`` is a recommended convention
     :validation_mode: static
     :updated: casablanca
 
-    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
-    ``metadata`` map value parameter ``vm_role`` value **MUST**
-    only contain alphanumeric characters and underscores '_'.
+    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+    property ``metadata`` key/value pair ``vm_role`` value **MUST**
+    only contain alphanumeric characters and underscores (i.e., '_').
+
 
 .. req::
     :id: R-70757
@@ -435,9 +440,11 @@ Defining the ``vm_role`` as the ``{vm-type}`` is a recommended convention
     :validation_mode: static
     :updated: casablanca
 
-    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
-    ``metadata`` map value parameter ``vm_role`` is passed into a Nested YAML
-    file, the parameter name ``vm_role`` **MUST NOT** change.
+    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+    property ``metadata`` key/value pair ``vm_role`` is passed into a Nested
+    YAML
+    file, the key/value pair name ``vm_role`` **MUST NOT** change.
+
 
 *Example 'vm_role' Parameter Definition*
 
@@ -541,9 +548,12 @@ vf_module_index
     :validation_mode: static
     :updated: casablanca
 
-    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
-    ``metadata`` map value parameter ``vf_module_index`` **MUST**
-    be declared as type: ``number``.
+    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+    property
+    ``metadata`` key/value pair ``vf_module_index`` parameter **MUST**
+    be declared as ``vf_module_index`` and the parameter **MUST** be
+    defined as type: ``number``.
+
 
 .. req::
     :id: R-09811
@@ -682,9 +692,11 @@ workload_context
     :validation_mode: static
     :updated: casablanca
 
-    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
-    ``metadata`` map value parameter ``workload_context`` **MUST**
-    be declared as type: ``string``.
+    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+    property ``metadata`` key/value pair ``workload_context`` 
+    parameter **MUST**
+    be declared as ``workload_context`` and the parameter **MUST**
+    be defined as type: ``string``.
 
 .. req::
     :id: R-34055
@@ -779,9 +791,10 @@ environment_context
     :validation_mode: static
     :updated: casablanca
 
-    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
-    ``metadata`` map value parameter ``environment_context`` **MUST**
-    be declared as type: ``string``.
+    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+    property ``metadata`` key/value pair ``environment_context`` 
+    parameter **MUST** be declared as ``environment_context`` and the
+    parameter type **MUST** be defined as type: ``string``.
 
 .. req::
     :id: R-56183
@@ -802,8 +815,9 @@ environment_context
     :validation_mode: static
     :updated: casablanca
 
-    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
-    ``metadata`` map value parameter ``environment_context`` **MUST NOT**
+    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+    property 
+    ``metadata`` key/value pair ``environment_context`` **MUST NOT**
     be enumerated in the Heat Orchestration Template's environment file.
 
 .. req::
index 81a1b94..146cd29 100644 (file)
@@ -1,5 +1,5 @@
 {
-    "created": "2018-10-09T20:59:28.811244",
+    "created": "2018-10-10T20:48:45.405167",
     "current_version": "casablanca",
     "project": "",
     "versions": {
             "needs_amount": 750
         },
         "casablanca": {
-            "created": "2018-10-09T20:59:28.811227",
+            "created": "2018-10-10T20:48:45.405167",
             "needs": {
                 "R-00011": {
                     "description": "A VNF's Heat Orchestration Template's parameter defined\nin a nested YAML file\n**MUST NOT** have a parameter constraint defined.",
                     "validation_mode": ""
                 },
                 "R-13194": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``environment_context`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``environment_context`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-13194",
                     "validation_mode": ""
                 },
                 "R-20308": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``environment_context`` **MUST**\nbe declared as type: ``string``.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``environment_context``\nparameter **MUST** be declared as ``environment_context`` and the\nparameter type **MUST** be defined as type: ``string``.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-20308",
                     "validation_mode": "static"
                 },
                 "R-37437": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the  key/value pair ``vnf_id``.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the  key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-37437",
                     "validation_mode": ""
                 },
                 "R-54340": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vf_module_index`` **MUST**\nbe declared as type: ``number``.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_index`` parameter **MUST**\nbe declared as ``vf_module_index`` and the parameter **MUST** be\ndefined as type: ``number``.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-54340",
                     "validation_mode": ""
                 },
                 "R-70757": {
-                    "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vm_role`` is passed into a Nested YAML\nfile, the parameter name ``vm_role`` **MUST NOT** change.",
+                    "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` is passed into a Nested\nYAML\nfile, the key/value pair name ``vm_role`` **MUST NOT** change.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-70757",
                     "validation_mode": ""
                 },
                 "R-72483": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource **MUST**\ncontain the ``metadata`` map value parameter ``vnf_name``.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-72483",
                     "validation_mode": ""
                 },
                 "R-74978": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``workload_context`` **MUST**\nbe declared as type: ``string``.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter **MUST**\nbe declared as ``workload_context`` and the parameter **MUST**\nbe defined as type: ``string``.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-74978",
                     "validation_mode": ""
                 },
                 "R-80374": {
-                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vf_module_name`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_name``\nparameter ``vf_module_name`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-80374",
                     "validation_mode": "static"
                 },
                 "R-86476": {
-                    "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores '_'.",
+                    "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-86476",
             "needs_amount": 761
         }
     }
-}
+}
\ No newline at end of file