From d1f93f4febdd5b34e96b954dd11e635bc0ee8041 Mon Sep 17 00:00:00 2001 From: "Lovett, Trevor" Date: Thu, 2 Jul 2020 11:19:00 -0500 Subject: Requirement ID Generation and RST Validation The new check.py script will now perform a variety of actions to simplify updates and ensure specific practices are followed for each update. The script has been integrated with tox and will run whenever the documentation is created. It can also be ran separately by just invoking python check.py. The script will perform a variety of automatic updates where possible, and provide a warning where auto-updates are not possible. The expecation is that all warnings are addressed before submitting for review, but given it is a new feature warnings do not block validation at this time. Here is a summary of the warnings and updates: Warnings: - Requirement missing required attributes - Invalid values for attributes - Invalid section header usage in any file - :keyword: and requirement mismatch Auto Updates: - Assigning :id: on new requirements where an ID missing - Adding :introduced: attribute on new requirements - Adding/correcting :updated: attribute on changed requirements Issue-ID: VNFRQTS-896 Signed-off-by: Lovett, Trevor Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642 --- docs/Chapter5/Heat/General Guidelines for Heat.rst | 6 +- docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst | 10 +- docs/Chapter5/Heat/ONAP Heat High Availability.rst | 2 +- docs/Chapter5/Heat/ONAP Heat Networking.rst | 32 +++-- .../ONAP Heat Orchestration Template Format.rst | 86 ++++++------ .../ONAP Heat Orchestration Templates Overview.rst | 55 ++++---- ...Heat Post Orchestration & VNF Configuration.rst | 2 +- .../Contrail Resource Parameters.rst | 154 ++++++++++----------- .../Neutron Parameters.rst | 94 ++++++------- .../Nova Metadata Parameters.rst | 90 ++++++------ .../Nova Parameters.rst | 56 ++++---- .../ONAP Output Parameter Names.rst | 22 +-- .../Resource IDs.rst | 80 +++++------ .../Resource Property.rst | 8 +- ...ted Naming Convention for Common Parameters.rst | 16 +-- .../{network-role}.rst | 22 +-- .../{vm-type}.rst | 12 +- .../ONAP Heat Support of Environment Files.rst | 4 +- .../Heat/ONAP Heat Template Constructs.rst | 18 ++- docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst | 20 +-- 20 files changed, 404 insertions(+), 385 deletions(-) (limited to 'docs/Chapter5/Heat') diff --git a/docs/Chapter5/Heat/General Guidelines for Heat.rst b/docs/Chapter5/Heat/General Guidelines for Heat.rst index bacf6fa..d1e21db 100644 --- a/docs/Chapter5/Heat/General Guidelines for Heat.rst +++ b/docs/Chapter5/Heat/General Guidelines for Heat.rst @@ -5,13 +5,13 @@ .. _General Guidelines for Heat: General Guidelines for Heat ----------------------------- +--------------------------- This section contains general Heat Orchestration Template guidelines and requirements. Heat Template Compliance -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^ The Heat Orchestration Template requirements with RFC 2119 keywords **MUST** and **MUST NOT** can be validated against a set of Heat @@ -29,7 +29,7 @@ please see the validation scripts YAML Format -^^^^^^^^^^^^^^ +^^^^^^^^^^^ .. req:: :id: R-95303 diff --git a/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst b/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst index cf02974..eefdfad 100644 --- a/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst +++ b/docs/Chapter5/Heat/ONAP Heat Cinder Volumes.rst @@ -5,7 +5,7 @@ .. _ONAP Heat Cinder Volumes: ONAP Heat Cinder Volumes ----------------------------- +------------------------ Cinder Volumes are created with the heat resource OS::Cinder::Volume. @@ -64,8 +64,8 @@ Parameters. :id: R-270358 :target: VNF :keyword: MUST - :validation_mode: static :introduced: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Cinder Volume Template **MUST** contain either @@ -78,7 +78,7 @@ Parameters. an ``OS::Cinder::Volume`` resource Optional Property availability_zone -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. req:: :id: R-25190 @@ -97,7 +97,7 @@ same as the ``OS::Nova::Server`` property ``availability_zone`` (i.e., ``availability_zone_{index}``). Optional Property volume_type -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ OpenStack supports multiple volume types. If the ``OS::Cinder::Volume`` optional property ``volume_type`` is not specified, the OpenStack default @@ -106,7 +106,7 @@ is used and the value **MUST** be enumerated in the environment file. There are no requirements on the parameter naming convention. Cinder Volume Examples -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^ *Examples: Volume Template* diff --git a/docs/Chapter5/Heat/ONAP Heat High Availability.rst b/docs/Chapter5/Heat/ONAP Heat High Availability.rst index 3269656..520f6f4 100644 --- a/docs/Chapter5/Heat/ONAP Heat High Availability.rst +++ b/docs/Chapter5/Heat/ONAP Heat High Availability.rst @@ -5,7 +5,7 @@ .. _ONAP Heat High Availability: ONAP Heat High Availability ------------------------------- +--------------------------- VNF/VM parameters may include availability zone IDs for VNFs that require high availability. diff --git a/docs/Chapter5/Heat/ONAP Heat Networking.rst b/docs/Chapter5/Heat/ONAP Heat Networking.rst index 6ca87e2..df1874a 100644 --- a/docs/Chapter5/Heat/ONAP Heat Networking.rst +++ b/docs/Chapter5/Heat/ONAP Heat Networking.rst @@ -5,12 +5,12 @@ .. _ONAP Heat Networking: ONAP Heat Networking ------------------------ +-------------------- ONAP defines two types of networks: External Networks and Internal Networks. External Networks -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^ An ONAP external network is created by using VID or by invoking SO directly to instantiate the network. @@ -41,8 +41,8 @@ An external network may be designed to perform :id: R-16968 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Templates **MUST NOT** include heat resources to create an ONAP external network. @@ -64,8 +64,8 @@ An external network may be designed to perform :id: R-57424 :target: VNF :keyword: MAY - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's port connected to an ONAP external network **MAY** use the port for the purpose of @@ -79,8 +79,8 @@ An external network may be designed to perform :id: R-99794 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none An ONAP external network **MUST** have one subnet. An external network **MAY** have more than one subnet. @@ -92,7 +92,7 @@ external networks. :ref:`ONAP Heat Resource ID and Parameter Naming Convention` provides additional details. Internal Networks -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^ An ONAP internal network is created by the VNF's Heat Orchestration Template. That is, the VNF's Heat Orchestration Template contains the heat resources to @@ -128,8 +128,8 @@ operational complications. :id: R-35666 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static If a VNF has an ONAP internal network, the VNF's Heat Orchestration Template **MUST** include the heat resources to create the @@ -146,18 +146,28 @@ operational complications. :id: R-52425 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's port connected to an ONAP internal network **MUST** use the port for the purpose of reaching VMs in the same VNF. +.. req:: + :id: R-41542 + :target: VNF + :keyword: MUST + :introduced: guilin + :validation_mode: none + + A VNF's port connected to fdfsafd ONAP internal network **MUST** + use the port for the purpose of reaching VMs in the same VNF. + .. req:: :id: R-46461 :target: VNF :keyword: MUST NOT - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's port connected to an ONAP internal network **MUST NOT** use the port @@ -169,8 +179,8 @@ operational complications. :id: R-16241 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's ONAP internal network **MUST** have one subnet. A VNF's ONAP internal network **MAY** have more than one subnet. @@ -189,8 +199,8 @@ operational complications. :id: R-22688 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When a VNF's Heat Orchestration Template creates an ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst index 8cb92fd..1947f62 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst @@ -5,15 +5,15 @@ .. _ONAP Heat Orchestration Template Format: ONAP Heat Orchestration Template Format ------------------------------------------------- +--------------------------------------- As stated above, Heat Orchestration templates must be defined in YAML. .. req:: :id: R-92635 + :target: VNF :keyword: MUST - :validation_mode: static :introduced: casablanca - :target: VNF + :validation_mode: static A VNF's Heat Orchestration Template **MUST** be compliant with the OpenStack Template Guide. @@ -22,7 +22,7 @@ The OpenStack Template Guide is defined at https://docs.openstack.org/heat/latest/template_guide/index.html#top. Heat Orchestration Template Structure -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Heat Orchestration template structure follows the following format, as defined by OpenStack at @@ -52,13 +52,13 @@ https://docs.openstack.org/developer/heat/template_guide/hot_spec.html. heat_template_version -~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-27078 - :keyword: MUST :target: VNF + :keyword: MUST :validation_mode: static A VNF's Heat Orchestration template **MUST** contain the @@ -68,33 +68,33 @@ The section ``heat_template_version:`` must be set to a date that is supported by the OpenStack environment. description -~~~~~~~~~~~~ +~~~~~~~~~~~ .. req:: :id: R-39402 + :target: VNF :keyword: MUST :validation_mode: static - :target: VNF A VNF's Heat Orchestration Template **MUST** contain the section ``description:``. parameter_groups -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~ A VNF Heat Orchestration template may contain the section "parameter_groups:". parameters -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~ .. req:: :id: R-35414 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF Heat Orchestration's template **MUST** contain the section ``parameters:`` with at least one @@ -137,8 +137,8 @@ attributes (e.g., type, label) defined as nested elements. :id: R-90279 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF Heat Orchestration's template's parameter **MUST** be used @@ -163,7 +163,7 @@ That is, the parameter associated with the property ``availability_zone`` maybe declared but not used in a resource. -+++++++++++++ +++++++++++++ The name of the parameter. @@ -195,8 +195,8 @@ type :id: R-11441 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's parameter type **MUST** be one of the following values: @@ -208,7 +208,7 @@ type * ``boolean`` label -++++++ ++++++ .. req:: @@ -221,7 +221,7 @@ label contain the attribute ``label:``. description -+++++++++++++ ++++++++++++ .. req:: @@ -238,13 +238,13 @@ attribute that provides a description of the parameter. ONAP implementation requires this attribute. default -++++++++ ++++++++ .. req:: :id: R-90526 :target: VNF - :keyword: MUST + :keyword: MUST NOT :validation_mode: static A VNF Heat Orchestration Template parameter declaration **MUST NOT** @@ -254,8 +254,8 @@ default :id: R-26124 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none If a VNF Heat Orchestration Template parameter has a default value, it **MUST** be enumerated in the environment file. @@ -265,7 +265,7 @@ attribute that declares the default value of the parameter. ONAP implementation prohibits the use of this attribute. hidden -+++++++ +++++++ .. req:: @@ -283,7 +283,7 @@ information about a stack created from the template. This attribute can be used to hide passwords specified as parameters. constraints -++++++++++++ ++++++++++++ The parameter attribute ``constraints:`` is an OpenStack optional attribute that defines a list of constraints to apply to the parameter. @@ -293,8 +293,8 @@ that defines a list of constraints to apply to the parameter. :id: R-88863 :target: VNF :keyword: MAY - :validation_mode: none :updated: dublin + :validation_mode: none A VNF's Heat Orchestration Template's parameter defined in a non-nested YAML file as type @@ -344,8 +344,8 @@ that defines a list of constraints to apply to the parameter. :id: R-00011 :target: VNF :keyword: SHOULD NOT - :validation_mode: static :updated: dublin + :validation_mode: static A VNF's Heat Orchestration Template's parameter defined in a nested YAML file @@ -424,7 +424,7 @@ Alternatively, the following YAML list notation can be used - ... immutable -++++++++++++ ++++++++++ .. req:: @@ -441,12 +441,12 @@ stack update fails if ``immutable`` is set to ``true`` and the parameter value is changed. This attribute ``immutable`` defaults to ``false``. tags -++++++++++++ +++++ .. req:: :id: R-225891 - :keyword: MAY :target: VNF + :keyword: MAY :introduced: el alto A VNF's Heat Orchestration Template parameter declaration @@ -456,7 +456,7 @@ tags .. _resources: resources -~~~~~~~~~~~~ +~~~~~~~~~ .. req:: :id: R-23663 @@ -478,8 +478,8 @@ a resource. :id: R-23664 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration template's incremental module and volume module **MUST** @@ -535,7 +535,7 @@ separate block in the resources section with the following syntax. resource ID -+++++++++++++ ++++++++++++ .. req:: :id: R-75141 @@ -564,7 +564,7 @@ Heat Orchestration Template and not unique across all Heat Orchestration Templates the compose the VNF. type -+++++ +++++ The resource attribute ``type`` is an OpenStack required attribute that defines the resource type, such as ``OS::Nova::Server`` or @@ -593,7 +593,7 @@ Orchestration Template Nested YAML file. **MUST NOT** reference a HTTP-based Nested YAML file. properties -+++++++++++++ +++++++++++ The resource attribute ``properties`` is an OpenStack optional attribute that provides a list of resource-specific properties. The property value can @@ -605,8 +605,8 @@ be provided in place, or via a function :id: R-10834 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: el alto + :validation_mode: static A VNF's Heat Orchestration Template resource attribute ``property:`` **MUST NOT** use more than two levels of nested ``get_param`` intrinsic @@ -627,7 +627,7 @@ be provided in place, or via a function metadata -++++++++++ +++++++++ The resource attribute ``metadata`` is an OpenStack optional attribute. @@ -635,14 +635,14 @@ The resource attribute ``metadata`` is an OpenStack optional attribute. :id: R-67386 :target: VNF :keyword: MAY - :validation_mode: static :introduced: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource **MAY** declare the attribute ``metadata``. depends_on -+++++++++++ +++++++++++ The resource attribute ``depends_on`` is an OpenStack optional attribute. See `Section `__ 9.7 for additional details. @@ -656,7 +656,7 @@ See `Section _netmask, string, CIDR -^^^^^^^^^^^^^^^^^^ +^^^^ .. csv-table:: **Table 9: Suggested Naming Convention for Common Parameters: CIDR** :header: Parameter Name,Parameter Type,Notes @@ -36,7 +36,7 @@ CIDR int__v6_subnet__cidr, string, Default Gateway -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^ .. csv-table:: **Table 10: Suggested Naming Convention for Common Parameters: Default Gateway** :header: Parameter Name,Parameter Type,Notes @@ -47,7 +47,7 @@ Default Gateway {network-role}_v6_subnet__default_gateway, string, DCAE Collector IP Address -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: **Table 11: Suggested Naming Convention for Common Parameters: DCAE Collector Address** :header: Parameter Name,Parameter Type,Notes @@ -58,7 +58,7 @@ DCAE Collector IP Address dcae_collector_v6_ip_, string, NTP Server IP Address -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: **Table 12: Suggested Naming Convention for Common Parameters: NTP Server IP Address** :header: Parameter Name,Parameter Type,Notes @@ -69,7 +69,7 @@ NTP Server IP Address ntp_v6_ip_, string, DNS -^^^^^^^^^^^^^^^^^^ +^^^ .. csv-table:: **Table 13: Suggested Naming Convention for Common Parameters: DCAE Collector Address** :header: Parameter Name,Parameter Type,Notes @@ -80,7 +80,7 @@ DNS dns_{network-role}_v6_ip_, string, Security Group -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^ .. csv-table:: **Table 14: Suggested Naming Convention for Common Parameters: Security Group** :header: Parameter Name,Parameter Type,Notes 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 ade9d7f..6aa5111 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 @@ -3,14 +3,14 @@ .. Copyright 2017 AT&T Intellectual Property. All rights reserved. {network-role} ------------------------------ +-------------- .. req:: :id: R-69014 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none When a VNF's port connects to an ONAP internal network or ONAP external network, @@ -24,8 +24,8 @@ :id: R-05201 :target: VNF :keyword: MUST - :validation_mode: none :updated: dublin + :validation_mode: none When a VNF connects to two or more unique networks, each network **MUST** be assigned a unique ``{network-role}`` @@ -36,8 +36,8 @@ :id: R-21330 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's Heat Orchestration Template's Resource property parameter that is associated with an ONAP @@ -48,8 +48,8 @@ :id: R-11168 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's Heat Orchestration Template's Resource ID that is associated with an ONAP external network **MUST** include the ``{network-role}`` as part @@ -59,8 +59,8 @@ :id: R-84322 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's Heat Orchestration Template's Resource property parameter that is associated with an ONAP internal network (per the ONAP definition, see @@ -75,8 +75,8 @@ :id: R-96983 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's Heat Orchestration Template's Resource ID that is associated with an ONAP internal network (per the ONAP definition, see Requirements @@ -88,8 +88,8 @@ :id: R-26506 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: dublin + :validation_mode: static A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain only alphanumeric characters and/or underscores '_' and @@ -105,8 +105,8 @@ :id: R-00977 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``{network-role}`` **MUST NOT** be a substring of ``{vm-type}``. @@ -119,8 +119,8 @@ For example, if a VNF has a '{vm-type}' of 'oam' and a :id: R-58424 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none A VNF's Heat Orchestration Template's use of ``{network-role}`` in all Resource property parameter names **MUST** be the same case. @@ -129,8 +129,8 @@ For example, if a VNF has a '{vm-type}' of 'oam' and a :id: R-21511 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none A VNF's Heat Orchestration Template's use of ``{network-role}`` in all Resource IDs **MUST** be the same case. 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 97dd43e..ddfb351 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 @@ -4,15 +4,15 @@ {vm-type} ------------------ +--------- .. req:: :id: R-01455 :target: VNF :keyword: MUST - :validation_mode: static :updated: dublin + :validation_mode: static When a VNF's Heat Orchestration Template creates a Virtual Machine (i.e., ``OS::Nova::Server``), @@ -68,8 +68,8 @@ found in later sections of this document. :id: R-98407 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only alphanumeric characters and/or underscores '_' and **MUST NOT** @@ -80,8 +80,8 @@ found in later sections of this document. :id: R-48067 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a substring @@ -95,8 +95,8 @@ to produce erroneous error messages. :id: R-32394 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource property parameter names **MUST** be the same case. @@ -105,8 +105,8 @@ to produce erroneous error messages. :id: R-46839 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource IDs **MUST** be the same case. 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 eadccae..8292cd9 100644 --- a/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst +++ b/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst @@ -5,15 +5,15 @@ .. _ONAP Heat Support of Environment Files: ONAP Heat Support of Environment Files ------------------------------------------ +-------------------------------------- .. req:: :id: R-599443 :target: VNF :keyword: MUST - :validation_mode: static :introduced: dublin + :validation_mode: static A parameter enumerated in a VNF's Heat Orchestration Template's environment file **MUST** be declared diff --git a/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst b/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst index a45491c..389b7b7 100644 --- a/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst +++ b/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst @@ -5,7 +5,7 @@ .. _ONAP Heat Heat Template Constructs: ONAP Heat Heat Template Constructs --------------------------------------- +---------------------------------- .. _Nested Heat Templates: @@ -59,6 +59,7 @@ have a unique name in the scope of the VNF. .. req:: :id: R-60011 + :target: VNF :keyword: MUST :updated: casablanca :validation_mode: static @@ -75,7 +76,8 @@ the second level of nested heat. .. req:: :id: R-17528 - :keyword: MUST + :target: VNF + :keyword: MUST NOT :updated: frankfurt :validation_mode: static @@ -86,6 +88,7 @@ the second level of nested heat. .. req:: :id: R-708564 + :target: VNF :keyword: MUST NOT :introduced: dublin :validation_mode: static @@ -145,6 +148,7 @@ cause issues for other ONAP applications/features. .. req:: :id: R-11041 + :target: VNF :keyword: MUST :updated: casablanca :validation_mode: static @@ -155,6 +159,7 @@ cause issues for other ONAP applications/features. .. req:: :id: R-90022 + :target: VNF :keyword: MAY :updated: casablanca @@ -163,6 +168,7 @@ cause issues for other ONAP applications/features. .. req:: :id: R-04344 + :target: VNF :keyword: MAY :updated: casablanca @@ -305,8 +311,8 @@ OS::Heat::ResourceGroup Property count :id: R-50011 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Heat::ResourceGroup`` property ``count`` **MUST** be enumerated in the VNF's @@ -624,8 +630,8 @@ following limitations: :id: R-76718 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static If a VNF's Heat Orchestration Template uses the intrinsic function ``get_file``, the ``get_file`` target **MUST** be referenced in @@ -639,8 +645,8 @@ See requirement R-511776. :id: R-41888 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template intrinsic function ``get_file`` **MUST NOT** utilize URL-based file retrieval. @@ -703,10 +709,10 @@ automatically assign a public/private key pair. .. req:: :id: R-100380 + :target: VNF :keyword: SHOULD :introduced: dublin :validation_mode: none - :target: VNF If a VNF requires the use of an SSH key created by OpenStack, the VNF Heat Orchestration Template **SHOULD** create the ``OS::Nova::Keypair`` diff --git a/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst b/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst index c5fa914..1477139 100644 --- a/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst +++ b/docs/Chapter5/Heat/ONAP Heat VNF Modularity.rst @@ -5,7 +5,7 @@ .. _ONAP Heat VNF Modularity: ONAP Heat VNF Modularity ---------------------------- +------------------------ ONAP supports a modular Heat Orchestration Template design pattern, referred to as *VNF Modularity.* With this approach, a single VNF **MAY** be @@ -54,8 +54,8 @@ A VNF module (base, incremental, cinder) **MAY** support nested templates. :id: R-610010 :target: VNF :keyword: MAY - :validation_mode: none :introduced: el alto + :validation_mode: none A VNF's Heat Orchestration Template's Base Module **MAY** declare zero, one, or more than one ``OS::Nova::Server`` resource. A ``OS::Nova::Server`` @@ -84,8 +84,8 @@ A VNF module (base, incremental, cinder) **MAY** support nested templates. :id: R-610020 :target: VNF :keyword: MAY - :validation_mode: none :introduced: el alto + :validation_mode: none If a VNF's Heat Orchestration Template's Base Module contains two or more ``OS::Nova::Server`` resources (created in the base module itself and/or @@ -108,8 +108,8 @@ A VNF module (base, incremental, cinder) **MAY** support nested templates. :id: R-610030 :target: VNF :keyword: MUST - :validation_mode: static :introduced: el alto + :validation_mode: static A VNF's Heat Orchestration Template's Incremental Module **MUST** declare one or more ``OS::Nova::Server`` resources. A ``OS::Nova::Server`` @@ -120,8 +120,8 @@ A VNF module (base, incremental, cinder) **MAY** support nested templates. :id: R-610040 :target: VNF :keyword: MAY - :validation_mode: none :introduced: el alto + :validation_mode: none If a VNF's Heat Orchestration Template's Incremental Module contains two or more ``OS::Nova::Server`` resources, the ``OS::Nova::Server`` resources @@ -143,8 +143,8 @@ A VNF module (base, incremental, cinder) **MAY** support nested templates. :id: R-610050 :target: VNF :keyword: MAY - :validation_mode: none :introduced: el alto + :validation_mode: none The same ``{vm-type}`` for a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource (as defined in R-01455) **MAY** exist in @@ -161,8 +161,8 @@ Incremental Module. :id: R-61001 :target: VNF :keyword: MUST - :validation_mode: none :updated: dublin + :validation_mode: none A shared Heat Orchestration Template resource is a resource that **MUST** be defined in the base module and will be referenced by one or @@ -201,7 +201,7 @@ template must correspond 1:1 with a base template or add-on module template. Suggested Patterns for Modular VNFs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ There are numerous variations of VNF modularity. Below are two suggested usage patterns. @@ -244,7 +244,7 @@ which might be appropriate for smaller VNFs that do not have any scaling options. Modularity Rules -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^ There are some rules to follow when building modular VNF templates: @@ -303,7 +303,7 @@ There are some rules to follow when building modular VNF templates: name in the add-on module VNF Modularity Examples -^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^ *Example: Base Module creates SecurityGroup* -- cgit 1.2.3-korg