From 44429ec0842517a7622a0c8a473a975a414bd2bc Mon Sep 17 00:00:00 2001 From: "weinstock, alan" Date: Tue, 18 Dec 2018 15:31:30 +0000 Subject: [VNFRQTS] updated 6 req in the heat section Change-Id: If170a116c8a974f0112f499c9fce8f31cf135cc1 Issue-ID: VNFRQTS-515 Signed-off-by: weinstock, alan --- .../ONAP Heat Orchestration Template Format.rst | 9 ++++---- .../ONAP Heat Orchestration Templates Overview.rst | 8 ++++---- .../Nova Parameters.rst | 5 +++-- .../Resource IDs.rst | 4 ++-- docs/data/needs.json | 24 +++++++++++----------- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst index d9b70f0..745edc2 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst @@ -278,14 +278,13 @@ that defines a list of constraints to apply to the parameter. .. req:: :id: R-88863 :target: VNF - :keyword: MUST + :keyword: MAY :validation_mode: static :updated: casablanca A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type - ``number`` **MUST** have a parameter constraint of ``range`` or - ``allowed_values`` defined. + ``number`` **MAY** have a parameter constraint defined. .. req:: :id: R-40518 @@ -330,13 +329,13 @@ that defines a list of constraints to apply to the parameter. .. req:: :id: R-00011 :target: VNF - :keyword: MUST NOT + :keyword: SHOULD NOT :validation_mode: static :updated: casablanca A VNF's Heat Orchestration Template's parameter defined in a nested YAML file - **MUST NOT** have a parameter constraint defined. + **SHOULD NOT** have a parameter constraint defined. The constraints block of a parameter definition defines additional validation constraints that apply to the value of the parameter. diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst index 41be142..014255a 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst @@ -447,12 +447,12 @@ other VNFs. .. req:: :id: R-22608 :target: VNF - :keyword: MUST NOT + :keyword: SHOULD NOT :validation_mode: static When a VNF's Heat Orchestration Template's Base Module's output parameter is declared as an input parameter in an Incremental Module, - the parameter attribute ``constraints:`` **MUST NOT** be declared. + the parameter attribute ``constraints:`` **SHOULD NOT** be declared. Additional details on ONAP Base Module Output Parameters are provided in :ref:`ONAP Output Parameter Names` and ONAP VNF Modularity. @@ -492,12 +492,12 @@ template is associated with. .. req:: :id: R-20547 :target: VNF - :keyword: MUST NOT + :keyword: SHOULD NOT :validation_mode: static When an ONAP Volume Module Output Parameter is declared as an input parameter in a base or an incremental module Heat Orchestration - Template, parameter constraints **MUST NOT** be declared. + Template, parameter constraints **SHOULD NOT** be declared. Additional details on ONAP Base Module Output Parameters are provided in :ref:`ONAP Output Parameter Names` and :ref:`ONAP Heat Cinder Volumes`. 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 b59dabd..26ce470 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 @@ -44,7 +44,8 @@ Requirement R-82481 defines how the ``{vm-type}`` is used. **MUST** contain the identical ``{vm-type}`` and **MUST** follow the naming conventions defined - in R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in + in R-58670, R-45188, R-54171, R- + , and R-29751. And the ``{index}`` in the ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match the ``{vm-type_index}`` defined in the ``OS::Nova::Server`` property ``port`` @@ -244,7 +245,7 @@ Property: Name the parameter name **MUST** follow the naming convention ``{vm-type}_name_{index}``, where ``{index}`` is a numeric value that **MUST** start at - zero in a VNF Orchestration Template and increments by one. + zero in a VNF's Heat Orchestration Template and **MUST** increment by one. .. req:: :id: R-87817 diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst index eaf3e51..8e2af23 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs.rst @@ -261,7 +261,7 @@ OS::Heat::ResourceGroup ~~~~~~~~~~~~~~~~~~~~~~~~ There is only a mandatory naming convention for a 'OS::Heat::ResourceGroup' -that is is creating sub-interfaces. +that is creating sub-interfaces. .. req:: :id: R-64197 @@ -946,7 +946,7 @@ OS::ContrailV2::ServiceTemplate * ``{vm-type}`` is the vm-type * ``RST`` signifies that it is the Resource Service Template - * ``{index}`` is is the index + * ``{index}`` is the index OS::ContrailV2::VirtualMachineInterface ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/data/needs.json b/docs/data/needs.json index 2817109..77a1aff 100644 --- a/docs/data/needs.json +++ b/docs/data/needs.json @@ -1,5 +1,5 @@ { - "created": "2018-12-17T18:45:56.649188", + "created": "2018-12-18T15:29:21.631864", "current_version": "dublin", "project": "", "versions": { @@ -45910,10 +45910,10 @@ "needs_amount": 789 }, "dublin": { - "created": "2018-12-17T18:45:56.649167", + "created": "2018-12-18T15:29:21.631843", "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.", + "description": "A VNF's Heat Orchestration Template's parameter defined\nin a nested YAML file\n**SHOULD NOT** have a parameter constraint defined.", "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", @@ -45922,7 +45922,7 @@ "introduced": "", "is_need": true, "is_part": false, - "keyword": "MUST NOT", + "keyword": "SHOULD NOT", "links": [], "notes": "", "parts": {}, @@ -49106,7 +49106,7 @@ "validation_mode": "" }, "R-14447": { - "description": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RST_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RST`` signifies that it is the Resource Service Template\n* ``{index}`` is is the index", + "description": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RST_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RST`` signifies that it is the Resource Service Template\n* ``{index}`` is the index", "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", @@ -50571,7 +50571,7 @@ "validation_mode": "static" }, "R-20547": { - "description": "When an ONAP Volume Module Output Parameter is declared as an input\nparameter in a base or an incremental module Heat Orchestration\nTemplate, parameter constraints **MUST NOT** be declared.", + "description": "When an ONAP Volume Module Output Parameter is declared as an input\nparameter in a base or an incremental module Heat Orchestration\nTemplate, parameter constraints **SHOULD NOT** be declared.", "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", @@ -50580,7 +50580,7 @@ "introduced": "", "is_need": true, "is_part": false, - "keyword": "MUST NOT", + "keyword": "SHOULD NOT", "links": [], "notes": "", "parts": {}, @@ -51150,7 +51150,7 @@ "validation_mode": "" }, "R-22608": { - "description": "When a VNF's Heat Orchestration Template's Base Module's output\nparameter is declared as an input parameter in an Incremental Module,\nthe parameter attribute ``constraints:`` **MUST NOT** be declared.", + "description": "When a VNF's Heat Orchestration Template's Base Module's output\nparameter is declared as an input parameter in an Incremental Module,\nthe parameter attribute ``constraints:`` **SHOULD NOT** be declared.", "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", @@ -51159,7 +51159,7 @@ "introduced": "", "is_need": true, "is_part": false, - "keyword": "MUST NOT", + "keyword": "SHOULD NOT", "links": [], "notes": "", "parts": {}, @@ -59581,7 +59581,7 @@ "validation_mode": "static" }, "R-54171": { - "description": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_name_{index}``, where ``{index}`` is a numeric\nvalue that **MUST** start at\nzero in a VNF Orchestration Template and increments by one.", + "description": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_name_{index}``, where ``{index}`` is a numeric\nvalue that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", @@ -68070,7 +68070,7 @@ "validation_mode": "static" }, "R-88863": { - "description": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as type\n``number`` **MUST** have a parameter constraint of ``range`` or\n``allowed_values`` defined.", + "description": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as type\n``number`` **MAY** have a parameter constraint defined.", "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", @@ -68079,7 +68079,7 @@ "introduced": "", "is_need": true, "is_part": false, - "keyword": "MUST", + "keyword": "MAY", "links": [], "notes": "", "parts": {}, -- cgit 1.2.3-korg