From 0b5c5dd678fe592b952da66f1547fc77fe3490d6 Mon Sep 17 00:00:00 2001 From: Hagop Bozawglanian Date: Fri, 17 May 2019 20:24:25 +0000 Subject: VNFRQTS - Fixing Metadata for release Issue-ID: VNFRQTS-621 Change-Id: I269f9edd99e34fffb7916ee5ad63fdf35503bc14 Signed-off-by: Hagop Bozawglanian --- .../Heat/ONAP Heat Orchestration Template Format.rst | 4 ++-- .../Heat/ONAP Heat Orchestration Templates Overview.rst | 12 ++++++++++-- .../Neutron Parameters.rst | 13 +++++++------ .../Nova Metadata Parameters.rst | 8 ++++---- .../Nova Parameters.rst | 5 +++-- .../Resource IDs.rst | 4 ++-- .../Resource Property.rst | 2 +- .../{network-role}.rst | 4 ++-- .../{vm-type}.rst | 2 +- .../Heat/ONAP Heat Support of Environment Files.rst | 2 +- docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst | 3 +-- 11 files changed, 34 insertions(+), 25 deletions(-) (limited to 'docs/Chapter5/Heat') diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst index 68d2325..a0c1edc 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst @@ -280,7 +280,7 @@ that defines a list of constraints to apply to the parameter. :target: VNF :keyword: MAY :validation_mode: static - :updated: casablanca + :updated: dublin A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type @@ -331,7 +331,7 @@ that defines a list of constraints to apply to the parameter. :target: VNF :keyword: SHOULD NOT :validation_mode: static - :updated: casablanca + :updated: dublin A VNF's Heat Orchestration Template's parameter defined in a nested YAML file diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst index 3511d06..a550ffe 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst @@ -98,6 +98,7 @@ after initial VNF deployment to add capacity. :id: R-46119 :target: VNF :keyword: MAY + :updated: dublin A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` **MAY** be defined in a Base Module. @@ -106,6 +107,7 @@ after initial VNF deployment to add capacity. :id: R-90748 :target: VNF :keyword: MAY + :updated: dublin A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` **MAY** be defined in an Incremental Module. @@ -114,6 +116,7 @@ after initial VNF deployment to add capacity. :id: R-03251 :target: VNF :keyword: MAY + :updated: dublin A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume`` **MAY** be defined in a Cinder Volume Module. @@ -440,6 +443,7 @@ other VNFs. :target: VNF :keyword: MUST :validation_mode: none + :updated: dublin VNF's Heat Orchestration Template's Base Module's output parameter's name and type **MUST** match the VNF's Heat Orchestration Template's @@ -450,6 +454,7 @@ other VNFs. :target: VNF :keyword: SHOULD NOT :validation_mode: static + :updated: dublin When a VNF's Heat Orchestration Template's Base Module's output parameter is declared as an input parameter in an Incremental Module, @@ -467,7 +472,7 @@ ONAP Volume Module Output Parameters :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin A VNF's Heat Orchestration Template's Cinder Volume Module Output Parameter(s) @@ -484,7 +489,7 @@ template is associated with. :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin A VNF's Heat Orchestration Templates' Cinder Volume Module Output Parameter's name and type **MUST** match the input parameter name and type @@ -495,6 +500,7 @@ template is associated with. :target: VNF :keyword: SHOULD NOT :validation_mode: static + :updated: dublin When an ONAP Volume Module Output Parameter is declared as an input parameter in a base or an incremental module Heat Orchestration @@ -573,6 +579,7 @@ ONAP VNF On-Boarding .. req:: :id: R-511776 :keyword: MUST + :introduced: dublin :validation_mode: static When a VNF's Heat Orchestration Template is ready @@ -602,6 +609,7 @@ The VNF's Heat Orchestration Template's ZIP file **MAY** include :id: R-348813 :keyword: MUST :validation_mode: static + :introduced: dublin The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include a binary image file. 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 cfd6052..30549e7 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 @@ -142,6 +142,7 @@ or **MUST** have statically assigned IP addresses. :target: VNF :keyword: MUST :validation_mode: static + :introduced: dublin A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's @@ -319,7 +320,7 @@ IPv4 and/or IPv6 addresses. :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the @@ -426,7 +427,7 @@ Parameter Definition* :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an external network (per the @@ -534,7 +535,7 @@ Definition* :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the @@ -642,7 +643,7 @@ Heat Orchestration Template's Environment File. :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an internal network (per the @@ -1614,7 +1615,7 @@ VIP Assignment, Internal Networks .. req:: :id: R-717227 :keyword: MUST - :updated: dublin + :introduced: dublin :validation_mode: static :target: VNF @@ -1660,7 +1661,7 @@ VIP Assignment, Internal Networks .. req:: :id: R-805572 :keyword: MUST - :updated: dublin + :introduced: dublin :validation_mode: static :target: VNF 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 5e461df..cf5f7e1 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 @@ -246,7 +246,7 @@ part of the orchestration process. .. req:: :id: R-100400 :keyword: SHOULD - :introduced: 2019-1 + :introduced: dublin :target: VNF A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource @@ -258,7 +258,7 @@ part of the orchestration process. :keyword: MUST :validation_mode: static :target: VNF - :updated: 2019-1 + :updated: dublin A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` @@ -463,7 +463,7 @@ vf_module_index .. req:: :id: R-100410 :keyword: MAY - :introduced: 2019-1 + :introduced: dublin :target: VNF A VNF's Heat Orchestration Template's ``OS::Nova::Server`` @@ -476,7 +476,7 @@ vf_module_index :keyword: MUST :target: VNF :validation_mode: static - :updated: 2019-1 + :updated: dublin A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` 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 4cbf3f5..826049f 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 @@ -30,6 +30,7 @@ Requirement R-01455 defines how the ``{vm-type]`` is defined. :keyword: MUST :validation_mode: static :introduced: casablanca + :updated: dublin A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's @@ -235,7 +236,7 @@ Property: Name :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``string``, @@ -373,7 +374,7 @@ Property: availability_zone :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``availability_zone`` parameter name 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 4c05a95..0cc7794 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 @@ -127,7 +127,7 @@ Heat Orchestration Template resources are described in :ref:`resources`. :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin When a VNF's Heat Orchestration Template's Resource ID contains an ``{index}``, the ``{index}`` is a numeric value that **MUST** start at @@ -578,7 +578,7 @@ OS::Nova::Keypair :id: R-65516 :target: VNF :keyword: SHOULD - :updated: casablanca + :updated: dublin A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to all Virtual Machines in the VNF, the Resource ID **SHOULD** use the naming 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 ca9585f..7da6c9e 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 @@ -19,7 +19,7 @@ some resources do not support the property. :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin If a VNF's Heat Orchestration Template contains the property ``name`` for a non ``OS::Nova::Server`` resource, the intrinsic function diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst index 498d79f..150f794 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst @@ -10,7 +10,7 @@ :target: VNF :keyword: MUST :validation_mode: none - :updated: casablanca + :updated: dublin When a VNF's port connects to an internal network or external network, a network role, referred to @@ -24,7 +24,7 @@ :target: VNF :keyword: MUST :validation_mode: none - :updated: casablanca + :updated: dublin When a VNF connects to two or more unique networks, each network **MUST** be assigned a unique ``{network-role}`` diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst index 88339a7..97dd43e 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}.rst @@ -12,7 +12,7 @@ :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :updated: dublin When a VNF's Heat Orchestration Template creates a Virtual Machine (i.e., ``OS::Nova::Server``), diff --git a/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst b/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst index 02a6905..eadccae 100644 --- a/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst +++ b/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst @@ -13,7 +13,7 @@ ONAP Heat Support of Environment Files :target: VNF :keyword: MUST :validation_mode: static - :updated: casablanca + :introduced: dublin A parameter enumerated in a VNF's Heat Orchestration Template's environment file **MUST** be declared diff --git a/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst b/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst index 6a665b3..a33d109 100644 --- a/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst +++ b/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst @@ -59,8 +59,7 @@ Incremental Module. :target: VNF :keyword: MUST :validation_mode: none - :updated: casablanca - + :updated: dublin A shared Heat Orchestration Template resource is a resource that **MUST** be defined in the base module and will be referenced by one or -- cgit 1.2.3-korg