summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters.rst65
-rw-r--r--docs/data/needs.json24
2 files changed, 52 insertions, 37 deletions
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 a3492ac..274418e 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
@@ -121,8 +121,10 @@ 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 ``vf_module_id``.
+ 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``.
.. req::
:id: R-82134
@@ -154,10 +156,12 @@ Template at orchestration time.
:validation_mode: static
:updated: casablanca
- A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
- ``metadata`` map value parameter ``vf_module_id`` **MUST NOT**
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
+ ``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``
+ **MUST NOT**
be enumerated in the Heat Orchestration Template's environment file.
+
.. req::
:id: R-86237
:target: VNF
@@ -209,9 +213,10 @@ Template at orchestration time.
:validation_mode: static
:updated: casablanca
- A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
- ``metadata`` map value parameter ``vnf_name`` **MUST**
- be declared as type: ``string``.
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+ property ``metadata`` key/value pair ``vnf_name`` parameter **MUST**
+ be declared as ``vnf_name`` and the parameter **MUST** be defined as
+ type: ``string``.
.. req::
:id: R-44318
@@ -277,9 +282,10 @@ part of the orchestration process.
:keyword: SHOULD
:updated: casablanca
- A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
- **SHOULD**
- contain the ``metadata`` map value parameter ``vf_module_name``.
+ 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``.
.. req::
:id: R-39067
@@ -301,9 +307,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**
- have parameter constraints defined.
+ 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** have parameter constraints defined.
.. req::
:id: R-80374
@@ -515,8 +522,10 @@ vf_module_index
:keyword: MAY
:updated: casablanca
- A VNF's Heat Orchestration Template's ``OS::Nova::Server Resource`` **MAY**
- contain the metadata map value parameter ``vf_module_index``.
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server``
+ resource property ``metadata`` **MAY**
+ contain the key/value pair ``vf_module_index``
+ and the value **MUST** be obtained via a ``get_param``.
.. req::
:id: R-54340
@@ -536,8 +545,9 @@ 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 NOT**
+
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+ property ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**
have parameter constraints defined.
.. req::
@@ -547,8 +557,10 @@ 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 NOT**
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+ property
+ ``metadata`` key/value pair ``vf_module_index`` parameter
+ ``vf_module_index`` **MUST NOT**
be enumerated in the Heat Orchestration Template's environment file.
.. req::
@@ -685,8 +697,10 @@ 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 NOT**
+
+ A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+ property ``metadata`` key/value pair ``workload_context``
+ parameter ``workload_context`` **MUST NOT**
be enumerated in the Heat Orchestration Template's environment file.
.. req::
@@ -696,10 +710,11 @@ workload_context
:validation_mode: static
:updated: casablanca
- If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource
- ``metadata`` map value parameter ``workload_context`` is passed into a
- Nested YAML
- file, the parameter name ``workload_context`` **MUST NOT** change.
+ If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
+ property ``metadata`` key/value pair ``workload_context``
+ is passed into a Nested YAML
+ file, the key/value pair name ``workload_context`` **MUST NOT** change.
+
The 'workload\_context' parameter value will be chosen by the Service Model
Distribution context client in VID and will be supplied to the
diff --git a/docs/data/needs.json b/docs/data/needs.json
index 4dc831b..c926298 100644
--- a/docs/data/needs.json
+++ b/docs/data/needs.json
@@ -1,5 +1,5 @@
{
- "created": "2018-10-08T21:19:15.296533",
+ "created": "2018-10-09T20:59:28.811244",
"current_version": "casablanca",
"project": "",
"versions": {
@@ -21858,7 +21858,7 @@
"needs_amount": 750
},
"casablanca": {
- "created": "2018-10-08T21:19:15.296381",
+ "created": "2018-10-09T20:59:28.811227",
"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.",
@@ -22575,7 +22575,7 @@
"validation_mode": ""
},
"R-02691": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``workload_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 ``metadata`` key/value pair ``workload_context``\nparameter ``workload_context`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
"full_title": "",
"hide_links": "",
"id": "R-02691",
@@ -23631,7 +23631,7 @@
"validation_mode": ""
},
"R-09811": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vf_module_index`` **MUST NOT**\nhave parameter constraints defined.",
+ "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**\nhave parameter constraints defined.",
"full_title": "",
"hide_links": "",
"id": "R-09811",
@@ -24863,7 +24863,7 @@
"validation_mode": ""
},
"R-15480": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vf_module_name`` **MUST NOT**\nhave parameter constraints defined.",
+ "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name``\n**MUST NOT** have parameter constraints defined.",
"full_title": "",
"hide_links": "",
"id": "R-15480",
@@ -30046,7 +30046,7 @@
"validation_mode": ""
},
"R-37039": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vf_module_index`` **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 ``vf_module_index`` parameter\n``vf_module_index`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
"full_title": "",
"hide_links": "",
"id": "R-37039",
@@ -33101,7 +33101,7 @@
"validation_mode": "static"
},
"R-50816": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server Resource`` **MAY**\ncontain the metadata map value parameter ``vf_module_index``.",
+ "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MAY**\ncontain the key/value pair ``vf_module_index``\nand the value **MUST** be obtained via a ``get_param``.",
"full_title": "",
"hide_links": "",
"id": "R-50816",
@@ -35234,7 +35234,7 @@
"validation_mode": "static"
},
"R-62428": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vnf_name`` **MUST**\nbe declared as type: ``string``.",
+ "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name`` parameter **MUST**\nbe declared as ``vnf_name`` and the parameter **MUST** be defined as\ntype: ``string``.",
"full_title": "",
"hide_links": "",
"id": "R-62428",
@@ -36402,7 +36402,7 @@
"validation_mode": ""
},
"R-68023": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n**SHOULD**\ncontain the ``metadata`` map value parameter ``vf_module_name``.",
+ "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **SHOULD**\ncontain the key/value pair ``vf_module_name`` and the value **MUST**\nbe obtained via a ``get_param``.",
"full_title": "",
"hide_links": "",
"id": "R-68023",
@@ -37255,7 +37255,7 @@
"validation_mode": "static"
},
"R-71493": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource **MUST**\ncontain the ``metadata`` map value parameter ``vf_module_id``.",
+ "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.",
"full_title": "",
"hide_links": "",
"id": "R-71493",
@@ -37455,7 +37455,7 @@
"validation_mode": "static"
},
"R-72871": {
- "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``vf_module_id`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
+ "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``\n**MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.",
"full_title": "",
"hide_links": "",
"id": "R-72871",
@@ -37965,7 +37965,7 @@
"validation_mode": "static"
},
"R-75202": {
- "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` Resource\n``metadata`` map value parameter ``workload_context`` is passed into a\nNested YAML\nfile, the parameter name ``workload_context`` **MUST NOT** change.",
+ "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nis passed into a Nested YAML\nfile, the key/value pair name ``workload_context`` **MUST NOT** change.",
"full_title": "",
"hide_links": "",
"id": "R-75202",