diff options
| author |   Lovett, Trevor <trevor.lovett@att.com> | 2020-07-02 11:19:00 -0500 |
|---|---|---|
| committer | Lovett, Trevor <trevor.lovett@att.com> | 2020-07-12 18:17:41 -0500 |
| commit | d1f93f4febdd5b34e96b954dd11e635bc0ee8041 (patch) | |
| tree | 899f326fa7ed5ecd05e8dcaf535e7c3ddd99d3e9 /docs/Chapter5 | |
| parent | cbbd1db5dfe2035d56901575218380c32216da92 (diff) | |
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 <trevor.lovett@att.com>
Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642
Diffstat (limited to 'docs/Chapter5')
25 files changed, 417 insertions, 398 deletions
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. <param name> -+++++++++++++ +++++++++++++ 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 <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-resources-dependencies>`__ 9.7 for additional details. @@ -656,7 +656,7 @@ See `Section <https://docs.openstack.org/developer/heat/template_guide/hot_spec. attribute ``depends_on:``. update_policy -++++++++++++++ ++++++++++++++ .. req:: @@ -668,7 +668,7 @@ update_policy attribute ``update_policy:``. deletion_policy -+++++++++++++++++++ ++++++++++++++++ .. req:: @@ -689,7 +689,7 @@ The default policy is to delete the physical resource when deleting a resource from the stack. external_id -++++++++++++ ++++++++++++ .. req:: @@ -711,12 +711,12 @@ heat when stack is deleted. condition -+++++++++++ ++++++++++ The resource attribute ``condition`` is an OpenStack optional attribute. outputs -~~~~~~~~~ +~~~~~~~ .. req:: @@ -734,7 +734,7 @@ See :ref:`Output Parameters` and :ref:`ONAP Output Parameter Names` for additional details. Environment File Format -^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^ A VNF's Heat Orchestration Template's environment file is a yaml text file. (https://docs.openstack.org/developer/heat/template_guide/environment.html) @@ -744,8 +744,8 @@ A VNF's Heat Orchestration Template's environment file is a yaml text file. :id: R-86285 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration template **MUST** have a corresponding environment file. @@ -760,8 +760,8 @@ the mandatory parameter section. :id: R-03324 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration template's Environment File **MUST** contain the ``parameters:`` section. diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst index 144235d..e0e985b 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst @@ -5,7 +5,7 @@ .. _ONAP Heat Orchestration Templates Overview: ONAP Heat Orchestration Templates Overview ------------------------------------------------ +------------------------------------------ ONAP supports a modular Heat Orchestration Template design pattern, referred to as *VNF Modularity.* @@ -13,7 +13,7 @@ referred to as *VNF Modularity.* .. _heat_onap_vnf_modularity_overview: ONAP VNF Modularity Overview -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. req:: @@ -131,8 +131,8 @@ on another instance (e.g., during a fail over activity). :id: R-11200 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Cinder Volume Module, when it exists, **MUST** be 1:1 with a Base module or Incremental module. @@ -144,8 +144,8 @@ Module. :id: R-38474 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Base Module **MUST** have a corresponding Environment File. @@ -153,8 +153,8 @@ Module. :id: R-81725 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Incremental Module **MUST** have a corresponding Environment File @@ -162,8 +162,8 @@ Module. :id: R-53433 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Cinder Volume Module **MUST** have a corresponding environment file @@ -172,7 +172,7 @@ This overview is provided to set the stage and help clarify the concepts that will be introduced. Nested Heat Orchestration Templates Overview -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ONAP supports nested Heat Orchestration Templates per OpenStack specifications. @@ -209,7 +209,7 @@ dynamically (via OS::Heat::ResourceGroup). See :ref:`Nested Heat Templates` for additional details. ONAP Heat Orchestration Template Filenames -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In order to enable ONAP to understand the relationship between Heat files, the following Heat file naming convention must be utilized. @@ -263,8 +263,8 @@ Base Modules :id: R-81339 :target: VNF :keyword: MUST - :validation_mode: static :updated: el alto + :validation_mode: static A VNF Heat Orchestration Template's Base Module file name **MUST** include case insensitive 'base' in the filename and @@ -301,8 +301,8 @@ Incremental Modules :id: R-87247 :target: VNF :keyword: MUST - :validation_mode: static :updated: el alto + :validation_mode: static VNF Heat Orchestration Template's Incremental Module file name **MUST** contain only alphanumeric characters and underscores @@ -337,8 +337,8 @@ Cinder Volume Modules :id: R-82732 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF Heat Orchestration Template's Cinder Volume Module **MUST** be named identical to the base or incremental module it is supporting with @@ -347,10 +347,11 @@ Cinder Volume Modules .. req:: :id: R-589037 + :target: VNF :keyword: MUST - :validation_mode: static :introduced: dublin :updated: el alto + :validation_mode: static A VNF Heat Orchestration Template's Cinder Volume Module ``resources:`` section @@ -366,8 +367,8 @@ Cinder Volume Modules :id: R-31141 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static VNF Heat Orchestration Template's Cinder Volume Module's Environment File **MUST** be named identical to the VNF Heat Orchestration Template's @@ -381,8 +382,8 @@ Nested Heat file :id: R-76057 :target: VNF :keyword: MUST - :validation_mode: static :updated: el alto + :validation_mode: static VNF Heat Orchestration Template's Nested YAML file name **MUST** contain only alphanumeric characters and underscores '_' and @@ -416,7 +417,7 @@ corresponding environment files, per OpenStack specifications. .. _Output Parameters: Output Parameters -^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^ The output parameters are parameters defined in the output section of a Heat Orchestration Template. The ONAP output parameters are subdivided @@ -429,7 +430,7 @@ into three categories: 3. ONAP Predefined Output Parameters. ONAP Base Module Output Parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ONAP Base Module Output Parameters are declared in the ``outputs:`` section of the VNF's Heat Orchestration Template's Base Module. A Base Module Output @@ -445,8 +446,8 @@ other VNFs. :id: R-52753 :target: VNF :keyword: MUST - :validation_mode: none :updated: dublin + :validation_mode: none VNF's Heat Orchestration Template's Base Module's output parameter's name and type **MUST** match the VNF's Heat Orchestration Template's @@ -456,8 +457,8 @@ other VNFs. :id: R-22608 :target: VNF :keyword: SHOULD NOT - :validation_mode: static :updated: dublin + :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, @@ -474,8 +475,8 @@ ONAP Volume Module Output Parameters :id: R-89913 :target: VNF :keyword: MUST - :validation_mode: static :updated: dublin + :validation_mode: static A VNF's Heat Orchestration Template's Cinder Volume Module Output Parameter(s) @@ -491,8 +492,8 @@ template is associated with. :id: R-07443 :target: VNF :keyword: MUST - :validation_mode: static :updated: dublin + :validation_mode: static A VNF's Heat Orchestration Templates' Cinder Volume Module Output Parameter's name and type **MUST** match the input parameter name and type @@ -502,8 +503,8 @@ template is associated with. :id: R-20547 :target: VNF :keyword: SHOULD NOT - :validation_mode: static :updated: dublin + :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 @@ -513,7 +514,7 @@ Additional details on ONAP Base Module Output Parameters are provided in :ref:`ONAP Output Parameter Names` and :ref:`ONAP Heat Cinder Volumes`. ONAP Predefined Output Parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ONAP will look for a small set of pre-defined Heat output parameters to capture resource attributes for inventory in ONAP. These output parameters @@ -522,7 +523,7 @@ parameters are optional and are specified in :ref:`OAM Management IP Addresses`. Support of heat stack update -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ONAP does not support the use of heat stack-update command for scaling (growth/de-growth). @@ -550,7 +551,7 @@ It is important to note that ONAP only supports heat stack-update for image upgrades. Scope of a Heat Orchestration Template -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. req:: @@ -581,6 +582,7 @@ ONAP VNF On-Boarding .. req:: :id: R-511776 + :target: VNF :keyword: MUST :introduced: dublin :validation_mode: static @@ -610,9 +612,10 @@ The VNF's Heat Orchestration Template's ZIP file **MAY** include .. req:: :id: R-348813 - :keyword: MUST - :validation_mode: static + :target: VNF HEAT PACKAGE + :keyword: MUST NOT :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include a binary image file. diff --git a/docs/Chapter5/Heat/ONAP Heat Post Orchestration & VNF Configuration.rst b/docs/Chapter5/Heat/ONAP Heat Post Orchestration & VNF Configuration.rst index f36dcfa..099beeb 100644 --- a/docs/Chapter5/Heat/ONAP Heat Post Orchestration & VNF Configuration.rst +++ b/docs/Chapter5/Heat/ONAP Heat Post Orchestration & VNF Configuration.rst @@ -5,7 +5,7 @@ .. _ONAP Heat Post Orchestration & VNF Configuration: ONAP Heat Post Orchestration & VNF Configuration --------------------------------------------------- +------------------------------------------------ Heat templates should contain a minimum amount of post-orchestration configuration data. For instance, *do not* embed complex user-data diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst index b3ea7e0..cf1cc3b 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters.rst @@ -22,8 +22,8 @@ ONAP External Networks :id: R-02164 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When a VNF's Heat Orchestration Template's Contrail resource ``OS::ContrailV2::InstanceIp`` and/or @@ -42,8 +42,8 @@ ONAP External Networks :id: R-92193 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Contrail resource ``OS::ContrailV2::InstanceIp`` and/or @@ -94,8 +94,8 @@ Interface Route Table Prefixes for Contrail InterfaceRoute Table :id: R-28222 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static If a VNF's Heat Orchestration Template ``OS::ContrailV2::InterfaceRouteTable`` resource @@ -109,8 +109,8 @@ Interface Route Table Prefixes for Contrail InterfaceRoute Table :id: R-19756 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static If a VNF's Heat Orchestration Template ``OS::ContrailV2::InterfaceRouteTable`` resource @@ -123,8 +123,8 @@ Interface Route Table Prefixes for Contrail InterfaceRoute Table :id: R-76682 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static If a VNF's Heat Orchestration Template ``OS::ContrailV2::InterfaceRouteTable`` resource @@ -237,10 +237,10 @@ property ``ip_address`` parameter. .. req:: :id: R-100000 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -251,11 +251,11 @@ property ``ip_address`` parameter. .. req:: :id: R-100010 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -279,10 +279,10 @@ property ``ip_address`` parameter. .. req:: :id: R-100020 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -308,11 +308,11 @@ the value at orchestration to the Heat Orchestration Template. .. req:: :id: R-100030 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -338,10 +338,10 @@ the value at orchestration to the Heat Orchestration Template. .. req:: :id: R-100040 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -368,11 +368,11 @@ Parameter Definition* .. req:: :id: R-100050 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -398,10 +398,10 @@ Parameter Definition* .. req:: :id: R-100060 + :target: VNF :keyword: MUST NOT - :validation_mode: static :introduced: dublin - :target: VNF + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -427,11 +427,11 @@ the value at orchestration to the Heat Orchestration Template. .. req:: :id: R-100070 + :target: VNF :keyword: MUST - :validation_mode: static :introduced: dublin - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -457,10 +457,10 @@ the value at orchestration to the Heat Orchestration Template. .. req:: :id: R-100080 + :target: VNF :keyword: MUST NOT - :validation_mode: static :introduced: dublin - :target: VNF + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -487,11 +487,11 @@ Definition* .. req:: :id: R-100090 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -518,10 +518,10 @@ Definition* .. req:: :id: R-100100 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -548,11 +548,11 @@ Heat Orchestration Template's Environment File. .. req:: :id: R-100110 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -577,10 +577,10 @@ Heat Orchestration Template's Environment File. .. req:: :id: R-100120 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -608,11 +608,11 @@ Parameter Definition* .. req:: :id: R-100130 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an @@ -638,10 +638,10 @@ Parameter Definition* .. req:: :id: R-100140 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -668,11 +668,11 @@ Heat Orchestration Template's Environment File. .. req:: :id: R-100150 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address to an @@ -697,10 +697,10 @@ Heat Orchestration Template's Environment File. .. req:: :id: R-100160 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address`` @@ -728,11 +728,11 @@ Definition* .. req:: :id: R-100170 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin :updated: frankfurt + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` @@ -753,11 +753,11 @@ Definition* .. req:: :id: R-100180 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` @@ -838,10 +838,10 @@ The property ``subnet_uuid`` specifies the subnet the IP is assigned from. .. req:: :id: R-100190 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` @@ -851,11 +851,11 @@ The property ``subnet_uuid`` specifies the subnet the IP is assigned from. .. req:: :id: R-100200 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -877,10 +877,10 @@ of a given network. .. req:: :id: R-100210 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` @@ -905,11 +905,11 @@ value at orchestration to the Heat Orchestration Template. .. req:: :id: R-100220 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::InstanceIp`` is assigning an IP address @@ -932,10 +932,10 @@ of a given network. .. req:: :id: R-100230 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` @@ -960,11 +960,11 @@ value at orchestration to the Heat Orchestration Template. .. req:: :id: R-100240 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When @@ -992,10 +992,10 @@ value at orchestration to the Heat Orchestration Template. .. req:: :id: R-100250 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` @@ -1025,11 +1025,11 @@ input parameter. .. req:: :id: R-100260 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When @@ -1055,10 +1055,10 @@ input parameter. .. req:: :id: R-100270 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid`` @@ -1125,11 +1125,11 @@ ONAP External Networks .. req:: :id: R-100280 - :keyword: MUST NOT - :validation_mode: static :target: VNF + :keyword: MUST NOT :introduced: dublin :updated: frankfurt + :validation_mode: static If a VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` @@ -1144,7 +1144,7 @@ ONAP External Networks ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` - + parameter **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. @@ -1152,11 +1152,11 @@ ONAP External Networks .. req:: :id: R-100310 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an ONAP external @@ -1173,7 +1173,7 @@ ONAP External Networks ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` - + parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_floating_ip`` @@ -1201,11 +1201,11 @@ ONAP External Networks .. req:: :id: R-100330 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an ONAP @@ -1223,7 +1223,7 @@ ONAP External Networks ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``, ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix`` - + parameter name **MUST** follow the naming convention * ``{vm-type}_{network-role}_floating_v6_ip`` @@ -1250,11 +1250,11 @@ ONAP External Networks .. req:: :id: R-100350 - :keyword: MUST NOT - :introduced: dublin - :validation_mode: static :target: VNF + :keyword: MUST + :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an @@ -1299,11 +1299,11 @@ ONAP Internal Networks .. req:: :id: R-100360 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an @@ -1350,11 +1350,11 @@ ONAP Internal Networks .. req:: :id: R-100370 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` is attaching to an 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 bf4aa8d..4fced5a 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 @@ -10,7 +10,7 @@ The resource OS::Neutron::Port is for managing Neutron ports. (See https://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Neutron::Port) Introduction -^^^^^^^^^^^^^ +^^^^^^^^^^^^ Four properties of the resource ``OS::Neutron::Port`` must follow the ONAP naming convention. The four properties are: @@ -73,8 +73,8 @@ or **MUST** have statically assigned IP addresses. :id: R-45602 :target: VNF :keyword: MUST NOT - :validation_mode: none :updated: casablanca + :validation_mode: none If a VNF's Port is attached to a network (internal or external) and the port's IP addresses are cloud assigned by OpenStack's DHCP @@ -100,8 +100,8 @@ or **MUST** have statically assigned IP addresses. :id: R-48880 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none If a VNF's Port is attached to an ONAP external network (per the ONAP definition, see Requirement R-57424 and R-16968) and the port's @@ -128,8 +128,8 @@ or **MUST** have statically assigned IP addresses. :id: R-70964 :target: VNF :keyword: MUST NOT - :validation_mode: none :updated: frankfurt + :validation_mode: none If a VNF's Port is attached to an ONAP internal network (per the ONAP definition, see Requirements R-52425 and R-46461 and R-35666) @@ -146,8 +146,8 @@ or **MUST** have statically assigned IP addresses. :id: R-681859 :target: VNF :keyword: MUST - :validation_mode: static :introduced: dublin + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's @@ -174,8 +174,8 @@ the port is attached to. :id: R-18008 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``network`` parameter **MUST** be declared as type: ``string``. @@ -184,8 +184,8 @@ the port is attached to. :id: R-62983 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP external network (per the @@ -204,8 +204,8 @@ the port is attached to. :id: R-86182 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` @@ -250,8 +250,8 @@ and the ONAP internal network is :id: R-29872 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``network`` @@ -311,8 +311,8 @@ IPv4 and/or IPv6 addresses. :id: R-34037 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -324,8 +324,8 @@ IPv4 and/or IPv6 addresses. :id: R-40971 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP external network (per the @@ -349,8 +349,8 @@ IPv4 and/or IPv6 addresses. :id: R-39841 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -376,8 +376,8 @@ the value at orchestration to the Heat Orchestration Template. :id: R-04697 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP external network (per the @@ -402,8 +402,8 @@ the value at orchestration to the Heat Orchestration Template. :id: R-98905 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -431,8 +431,8 @@ Parameter Definition* :id: R-71577 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP external network (per the @@ -457,8 +457,8 @@ Parameter Definition* :id: R-87123 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -484,8 +484,8 @@ the value at orchestration to the Heat Orchestration Template. :id: R-23503 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP external network (per the @@ -510,8 +510,8 @@ the value at orchestration to the Heat Orchestration Template. :id: R-93030 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -539,8 +539,8 @@ Definition* :id: R-78380 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP internal network (per the @@ -566,8 +566,8 @@ Definition* :id: R-28795 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -594,8 +594,8 @@ Heat Orchestration Template's Environment File. :id: R-85235 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP internal network (per the @@ -620,8 +620,8 @@ Heat Orchestration Template's Environment File. :id: R-90206 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -647,8 +647,8 @@ Heat Orchestration Template's Environment File. :id: R-27818 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP internal network (per the @@ -674,8 +674,8 @@ Heat Orchestration Template's Environment File. :id: R-97201 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -702,8 +702,8 @@ Heat Orchestration Template's Environment File. :id: R-29765 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP internal network (per the @@ -740,8 +740,8 @@ Definition* :id: R-98569 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -766,8 +766,8 @@ Heat Orchestration Template's Environment File. :id: R-62590 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: frankfurt + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -788,8 +788,8 @@ Heat Orchestration Template's Environment File. :id: R-93496 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -1014,8 +1014,8 @@ The property ``fixed_ips`` is used to assign IPs to a port. The Map Property :id: R-38236 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -1026,8 +1026,8 @@ The property ``fixed_ips`` is used to assign IPs to a port. The Map Property :id: R-62802 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching @@ -1053,8 +1053,8 @@ of a given network. :id: R-83677 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource @@ -1082,8 +1082,8 @@ value at orchestration to the Heat Orchestration Template. :id: R-15287 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching @@ -1108,8 +1108,8 @@ of a given network. :id: R-80829 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -1176,8 +1176,8 @@ represent an oam network and the ``{vm-type}`` has been defined as :id: R-84123 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When @@ -1205,8 +1205,8 @@ represent an oam network and the ``{vm-type}`` has been defined as :id: R-69634 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -1236,8 +1236,8 @@ input parameter. :id: R-76160 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When @@ -1263,8 +1263,8 @@ input parameter. :id: R-22288 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` @@ -1358,8 +1358,8 @@ VIP Assignment, ONAP External Networks :id: R-83412 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: frankfurt + :validation_mode: static If a VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an ONAP external network (per the @@ -1374,8 +1374,8 @@ VIP Assignment, ONAP External Networks :id: R-41492 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an ONAP external network @@ -1412,8 +1412,8 @@ VIP Assignment, ONAP External Networks :id: R-35735 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an ONAP external network @@ -1450,9 +1450,9 @@ VIP Assignment, ONAP External Networks :id: R-41493 :target: VNF :keyword: MUST - :validation_mode: static :introduced: dublin :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` is attaching to an ONAP external network @@ -1531,8 +1531,8 @@ and ``OS::Neutron::FloatingIPAssociation``. :id: R-05257 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIP``. @@ -1541,8 +1541,8 @@ and ``OS::Neutron::FloatingIPAssociation``. :id: R-76449 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's **MUST NOT** contain the Resource ``OS::Neutron::FloatingIPAssociation``. @@ -1623,11 +1623,11 @@ VIP Assignment, ONAP Internal Networks .. req:: :id: R-717227 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP internal network (per the @@ -1670,11 +1670,11 @@ VIP Assignment, ONAP Internal Networks .. req:: :id: R-805572 + :target: VNF :keyword: MUST :introduced: dublin - :validation_mode: static - :target: VNF :updated: frankfurt + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` is attaching to an ONAP internal network (per the 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 69b9e03..d3c0284 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 @@ -5,7 +5,7 @@ .. _Nova Server - Metadata Parameters: Resource: OS::Nova::Server Metadata Parameters --------------------------------------------------------------------------------- +---------------------------------------------- The ``OS::Nova::Server`` resource property ``metadata`` is an optional OpenStack property. @@ -29,7 +29,7 @@ The sections that follow provides the requirements associated with each OS::Nova::Server, metadata, environment_context, string, **MUST**, ONAP vnf_id -^^^^^^^^^ +^^^^^^ The ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_id`` is an ONAP generated UUID that identifies the VNF. The value @@ -40,8 +40,8 @@ Template at orchestration time. :id: R-37437 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MUST** @@ -52,8 +52,8 @@ Template at orchestration time. :id: R-07507 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -65,8 +65,8 @@ Template at orchestration time. :id: R-55218 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -77,8 +77,8 @@ Template at orchestration time. :id: R-20856 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -96,7 +96,7 @@ Template at orchestration time. description: Unique ID for this VNF instance vf_module_id -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^ The OS::Nova::Server Resource ``metadata`` map value parameter ``vf_module_id`` is an ONAP generated UUID that identifies the VF Module (e.g., Heat @@ -108,8 +108,8 @@ Template at orchestration time. :id: R-71493 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MUST** @@ -120,8 +120,8 @@ Template at orchestration time. :id: R-82134 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` parameter **MUST** @@ -132,8 +132,8 @@ Template at orchestration time. :id: R-98374 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id`` @@ -144,8 +144,8 @@ Template at orchestration time. :id: R-72871 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id`` @@ -164,7 +164,7 @@ Template at orchestration time. vnf_name -^^^^^^^^^ +^^^^^^^^ The ``OS::Nova::Server`` Resource ``metadata`` map value parameter ``vnf_name`` is the ONAP (SDN-C) generated alphanumeric name of the deployed VNF instance. @@ -176,8 +176,8 @@ Template at orchestration time. :id: R-72483 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the @@ -187,8 +187,8 @@ Template at orchestration time. :id: R-62428 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` parameter **MUST** @@ -199,8 +199,8 @@ Template at orchestration time. :id: R-44318 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` @@ -211,8 +211,8 @@ Template at orchestration time. :id: R-36542 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vnf_name`` parameter @@ -231,7 +231,7 @@ Template at orchestration time. description: Unique name for this VNF instance vf_module_name -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^ The ``OS::Nova::Server`` Resource ``metadata`` map value parameter ``vf_module_name`` @@ -245,9 +245,9 @@ part of the orchestration process. .. req:: :id: R-100400 + :target: VNF :keyword: SHOULD :introduced: dublin - :target: VNF A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property metadata **SHOULD** contain the key/value pair ``vf_module_name``. @@ -255,10 +255,10 @@ part of the orchestration process. .. req:: :id: R-68023 - :keyword: MUST - :validation_mode: static :target: VNF + :keyword: MUST :updated: dublin + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_name`` @@ -269,8 +269,8 @@ part of the orchestration process. :id: R-39067 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -282,8 +282,8 @@ part of the orchestration process. :id: R-15480 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -294,8 +294,8 @@ part of the orchestration process. :id: R-80374 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource @@ -315,7 +315,7 @@ part of the orchestration process. description: Unique name for this VNF Module instance vm_role -^^^^^^^^^ +^^^^^^^ The ``OS::Nova::Server`` Resource ``metadata`` map value parameter ``vm_role`` is a ``metadata`` tag that describes the role of the Virtual Machine. @@ -338,8 +338,8 @@ is a ``metadata`` tag that describes the role of the Virtual Machine. :id: R-95430 :target: VNF :keyword: MAY - :validation_mode: none :updated: dublin + :validation_mode: none If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -354,8 +354,8 @@ is a ``metadata`` tag that describes the role of the Virtual Machine. :id: R-67597 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` parameter ``vm_role`` @@ -368,8 +368,8 @@ Defining the ``vm_role`` as the ``{vm-type}`` is a recommended convention :id: R-86476 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vm_role`` value **MUST** @@ -415,7 +415,7 @@ and retrieved via 'get_param'* vm_role: { get_param: vm_role } Example vnf_id, vf_module_id, vnf_name, vf_module_name, vm_role -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The example below depicts part of a Heat Orchestration Template that uses the five of the ``OS::Nova::Server`` resource @@ -457,14 +457,14 @@ section. The ``{vm-type}`` has been defined as ``lb`` for load balancer. vm_role: lb vf_module_index -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^ .. req:: :id: R-100410 + :target: VNF :keyword: MAY :introduced: dublin - :target: VNF A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` **MAY** @@ -473,10 +473,10 @@ vf_module_index .. req:: :id: R-50816 - :keyword: MUST :target: VNF - :validation_mode: static + :keyword: MUST :updated: dublin + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` @@ -487,8 +487,8 @@ vf_module_index :id: R-54340 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -501,8 +501,8 @@ vf_module_index :id: R-09811 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource @@ -513,8 +513,8 @@ vf_module_index :id: R-37039 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property @@ -526,8 +526,8 @@ vf_module_index :id: R-55306 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``vf_module_index`` **MUST NOT** @@ -567,8 +567,8 @@ R-46461 and R-35666). An example is provided below. :id: R-55307 :target: VNF :keyword: MUST NOT - :validation_mode: static :introduced: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's parameter ``vf_module_index`` **MUST NOT** be used for indexing an: @@ -645,7 +645,7 @@ YAML File fixed_ips: [ { "ip_address": {get_param: [ oam_vm_int_ctrl_ips, { get_param: vf_module_index} ]}}] workload_context -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^ .. req:: :id: R-47061 @@ -661,8 +661,8 @@ workload_context :id: R-74978 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``workload_context`` @@ -674,8 +674,8 @@ workload_context :id: R-34055 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``workload_context`` @@ -686,8 +686,8 @@ workload_context :id: R-02691 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource @@ -731,7 +731,7 @@ Heat Orchestration Template by ONAP at orchestration time. workload_context: {get_param: workload_context} environment_context -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ .. req:: :id: R-88536 @@ -747,8 +747,8 @@ environment_context :id: R-20308 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata`` key/value pair ``environment_context`` @@ -759,8 +759,8 @@ environment_context :id: R-56183 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property ``metadata``key/value pair ``environment_context`` @@ -771,8 +771,8 @@ environment_context :id: R-13194 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property 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 1f11d02..c3ac3f0 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 @@ -4,7 +4,7 @@ Resource: OS::Nova::Server - Parameters ------------------------------------------------------------------------ +--------------------------------------- The OS::Nova::Server resource manages the running virtual machine (VM) instance within an OpenStack cloud. (See @@ -28,9 +28,9 @@ Requirement R-01455 defines how the ``{vm-type]`` is defined. :id: R-304011 :target: VNF :keyword: MUST - :validation_mode: static :introduced: casablanca :updated: el alto + :validation_mode: static A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's @@ -75,8 +75,8 @@ Property: image :id: R-901331 :target: VNF :keyword: MUST - :validation_mode: static :introduced: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``image`` value **MUST** be be obtained via a ``get_param``. @@ -85,8 +85,8 @@ Property: image :id: R-71152 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -96,8 +96,8 @@ Property: image :id: R-58670 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -108,8 +108,8 @@ Property: image :id: R-91125 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -120,8 +120,8 @@ Property: image :id: R-57282 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** have a unique parameter name for the ``OS::Nova::Server`` property @@ -139,15 +139,15 @@ Property: image .. _Property flavor: Property: flavor -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^ .. req:: :id: R-481670 :target: VNF :keyword: MUST - :validation_mode: static :introduced: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``flavor`` value **MUST** be be obtained via a ``get_param``. @@ -156,8 +156,8 @@ Property: flavor :id: R-50436 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -167,8 +167,8 @@ Property: flavor :id: R-45188 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property ``flavor`` parameter name **MUST** follow the naming convention @@ -178,8 +178,8 @@ Property: flavor :id: R-69431 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -190,8 +190,8 @@ Property: flavor :id: R-40499 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** have a unique parameter name for the ``OS::Nova::Server`` property @@ -207,15 +207,15 @@ Property: flavor description: {vm-type} flavor Property: Name -^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^ .. req:: :id: R-663631 :target: VNF :keyword: MUST - :validation_mode: static :introduced: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` value **MUST** be be obtained via a ``get_param``. @@ -224,8 +224,8 @@ Property: Name :id: R-51430 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -236,8 +236,8 @@ Property: Name :id: R-54171 :target: VNF :keyword: MUST - :validation_mode: static :updated: dublin + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``string``, @@ -252,8 +252,8 @@ Property: Name :id: R-87817 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``name`` parameter is defined as a ``comma_delimited_list``, @@ -264,8 +264,8 @@ Property: Name :id: R-22838 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -348,7 +348,7 @@ In this example, the {vm-type} has been defined as "lb" for load balancer. ... Contrail Issue with Values for OS::Nova::Server Property Name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: @@ -374,8 +374,8 @@ Property: availability_zone :id: R-98450 :target: VNF :keyword: MUST - :validation_mode: static :updated: el alto + :validation_mode: static A VNF's Heat Orchestration Template's base module or incremental module resource ``OS::Nova::Server`` @@ -392,8 +392,8 @@ Property: availability_zone :id: R-23311 :target: VNF :keyword: MUST - :validation_mode: static :updated: el alto + :validation_mode: static The VNF's Heat Orchestration Template's base module or incremental module resource ``OS::Nova::Server`` property @@ -406,8 +406,8 @@ not support it. :id: R-59568 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property @@ -420,8 +420,8 @@ not support it. :id: R-256790 :target: VNF :keyword: MAY - :validation_mode: none :introduced: el alto + :validation_mode: none A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` property ``availability_zone`` parameter name **MAY** change when @@ -454,7 +454,7 @@ for the OS::Nova::Server resource property availability_zone. resources in the Heat Orchestration Template. Example -^^^^^^^^^^^ +^^^^^^^ The example below depicts part of a Heat Orchestration Template that uses the four ``OS::Nova::Server`` properties discussed in this section. @@ -549,7 +549,7 @@ a string for ``oam``. . . . Boot Options -^^^^^^^^^^^^^^^ +^^^^^^^^^^^^ .. req:: @@ -566,8 +566,8 @@ Boot Options :id: R-83706 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none When a VNF's Heat Orchestration Template's Virtual Machine (i.e., ``OS::Nova::Server`` resource) boots from an image, the @@ -581,8 +581,8 @@ the 'image' property are detailed in `Property: image`_ :id: R-69588 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none When a VNF's Heat Orchestration Template's Virtual Machine (i.e., ``OS::Nova::Server`` Resource) boots from Cinder Volume, the diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst index 3e6563c..bfac21a 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst @@ -5,13 +5,13 @@ .. _ONAP Output Parameter Names: ONAP Output Parameter Names -------------------------------------------------------------- +--------------------------- ONAP defines three types of Output Parameters as detailed in :ref:`Output Parameters`. ONAP Base Module Output Parameters: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ONAP Base Module Output Parameters do not have an explicit naming convention. @@ -20,28 +20,28 @@ convention. :id: R-97726 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none A VNF's Heat Orchestration Template's Base Module Output Parameter names **MUST** contain ``{vm-type}`` and/or ``{network-role}`` when appropriate. ONAP Volume Template Output Parameters: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. req:: :id: R-88524 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none A VNF's Heat Orchestration Template's Volume Template Output Parameter names **MUST** contain ``{vm-type}`` when appropriate. Predefined Output Parameters -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ONAP currently defines one predefined output parameter the OAM Management IP Addresses. @@ -49,7 +49,7 @@ Management IP Addresses. .. _OAM Management IP Addresses: OAM Management IP Addresses -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ A VNF may have a management interface for application controllers to interact with and configure the VNF. Typically, this will be via a @@ -73,8 +73,8 @@ or may be a single IP address assigned to one VM. :id: R-18683 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static If a VNF has one IPv4 OAM Management IP Address and the IP Address needs to be inventoried in ONAP's A&AI @@ -86,8 +86,8 @@ or may be a single IP address assigned to one VM. :id: R-94669 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static If a VNF has one IPv6 OAM Management IP Address and the IP Address needs to be inventoried in ONAP's A&AI @@ -103,8 +103,8 @@ The OAM Management IP Address maybe assigned either via :id: R-56287 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none If the VNF's OAM Management IP Address is assigned by ONAP SDN-C and assigned in the VNF's Heat Orchestration Template's via a heat resource @@ -166,8 +166,8 @@ oam_management_v4_address* :id: R-48987 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none If the VNF's OAM Management IP Address is cloud assigned and and the OAM IP Address is required to be inventoried in ONAP A&AI, 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 d7922b3..9c3f186 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 @@ -23,8 +23,8 @@ Heat Orchestration Template resources are described in :ref:`resources`. :id: R-54517 :target: VNF :keyword: MUST - :validation_mode: none :updated: casablanca + :validation_mode: none When a VNF's Heat Orchestration Template's resource is associated with a single ``{vm-type}``, the Resource ID **MUST** contain the @@ -34,8 +34,8 @@ Heat Orchestration Template resources are described in :ref:`resources`. :id: R-96482 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none When a VNF's Heat Orchestration Template's resource is associated with a single ONAP external network, the Resource ID **MUST** contain the @@ -45,8 +45,8 @@ Heat Orchestration Template resources are described in :ref:`resources`. :id: R-98138 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none When a VNF's Heat Orchestration Template's resource is associated with a single ONAP internal network (per the ONAP definition, see @@ -58,8 +58,8 @@ Heat Orchestration Template resources are described in :ref:`resources`. :id: R-82115 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none When a VNF's Heat Orchestration Template's resource is associated with a single ``{vm-type}`` @@ -83,8 +83,8 @@ Heat Orchestration Template resources are described in :ref:`resources`. :id: R-82551 :target: VNF :keyword: MUST - :validation_mode: none :updated: frankfurt + :validation_mode: none When a VNF's Heat Orchestration Template's resource is associated with a single ``{vm-type}`` and a single ONAP internal network (per the ONAP @@ -107,8 +107,8 @@ Heat Orchestration Template resources are described in :ref:`resources`. :id: R-67793 :target: VNF :keyword: MUST NOT - :validation_mode: none :updated: frankfurt + :validation_mode: none When a VNF's Heat Orchestration Template's resource is associated with more than one ``{vm-type}`` and/or more than one ONAP internal network @@ -136,8 +136,8 @@ Heat Orchestration Template resources are described in :ref:`resources`. :id: R-11690 :target: VNF :keyword: MUST - :validation_mode: static :updated: dublin + :validation_mode: static When a VNF's Heat Orchestration Template's Resource ID contains an ``{index}``, the ``{index}`` is a numeric value that **MUST** start at @@ -159,7 +159,7 @@ have mandatory or suggested naming conventions. They are provided in the following sections. OS::Cinder::Volume -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~ .. req:: :id: R-87004 @@ -181,7 +181,7 @@ OS::Cinder::Volume * ``{index}`` starts at zero and increments by one (as described in R-11690) OS::Cinder::VolumeAttachment -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-86497 @@ -203,14 +203,14 @@ OS::Cinder::VolumeAttachment * ``{index}`` starts at zero and increments by one (as described in R-11690) OS::Heat::CloudConfig -~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-04747 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::Heat::CloudConfig`` Resource ID **MUST** contain the ``{vm-type}``. @@ -239,8 +239,8 @@ OS::Heat::MultipartMime :id: R-30804 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::Heat::MultipartMime`` @@ -268,7 +268,7 @@ OS::Heat::MultipartMime * ``RMM`` signifies that it is the Resource Multipart Mime OS::Heat::ResourceGroup -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ There is no mandatory naming convention for the resource 'OS::Heat::ResourceGroup'. @@ -281,8 +281,8 @@ OS::Heat::SoftwareConfig :id: R-08975 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig`` Resource ID **MUST** contain the ``{vm-type}``. @@ -310,8 +310,8 @@ OS::Neutron::Net :id: R-25720 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net`` Resource ID **MUST** use the naming convention @@ -325,15 +325,15 @@ OS::Neutron::Net Heat Orchestration Template. OS::Neutron::Port -~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~ .. req:: :id: R-20453 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is attaching to an ONAP external network (per the ONAP definition, @@ -365,8 +365,8 @@ OS::Neutron::Port :id: R-26351 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is attaching to an ONAP internal network @@ -398,8 +398,8 @@ OS::Neutron::Port :id: R-27469 :target: VNF :keyword: SHOULD - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is creating a *Reserve Port* with an IPv4 address, the @@ -423,8 +423,8 @@ OS::Neutron::Port :id: R-68520 :target: VNF :keyword: SHOULD - :validation_mode: none :updated: frankfurt + :validation_mode: none A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` that is creating a *Reserve Port* with an IPv6 address, the @@ -636,8 +636,8 @@ OS::Nova::Server :id: R-29751 :target: VNF :keyword: MUST - :validation_mode: static :updated: dublin + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` Resource ID @@ -679,7 +679,7 @@ OS::Nova::ServerGroup * ``{vm-type}_servergroup`` Contrail Heat Resources Resource ID Naming Convention -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Some Contrail Heat Resources Resource IDs have mandatory or suggested naming conventions. They are provided @@ -687,14 +687,14 @@ in the following sections. OS::ContrailV2::InstanceIp -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-53310 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource @@ -736,8 +736,8 @@ OS::ContrailV2::InstanceIp :id: R-46128 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` Resource ID @@ -778,8 +778,8 @@ OS::ContrailV2::InstanceIp :id: R-62187 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` Resource ID @@ -820,8 +820,8 @@ OS::ContrailV2::InstanceIp :id: R-87563 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp`` Resource ID @@ -865,8 +865,8 @@ OS::ContrailV2::InterfaceRouteTable :id: R-81214 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InterfaceRouteTable`` @@ -892,14 +892,14 @@ OS::ContrailV2::InterfaceRouteTable * ``RIRT`` signifies that it is the Resource Interface Route Table OS::ContrailV2::NetworkIpam -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-30753 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::NetworkIpam`` @@ -933,8 +933,8 @@ OS::ContrailV2::PortTuple :id: R-20065 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::PortTuple`` @@ -957,14 +957,14 @@ OS::ContrailV2::PortTuple * ``RPT`` signifies that it is the Resource Port Tuple OS::ContrailV2::ServiceHealthCheck -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-76014 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceHealthCheck`` @@ -991,14 +991,14 @@ OS::ContrailV2::ServiceHealthCheck * ``RIGHT`` is used if the Service Health Check is on the right interface OS::ContrailV2::ServiceTemplate -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-16437 :target: VNF :keyword: MUST - :validation_mode: static :updated: casablanca + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate`` @@ -1025,14 +1025,14 @@ OS::ContrailV2::ServiceTemplate (as described in R-11690). OS::ContrailV2::VirtualMachineInterface -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-96253 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` Resource ID @@ -1065,8 +1065,8 @@ OS::ContrailV2::VirtualMachineInterface :id: R-50468 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualMachineInterface`` Resource ID @@ -1096,14 +1096,14 @@ OS::ContrailV2::VirtualMachineInterface OS::ContrailV2::VirtualNetwork -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-99110 :target: VNF :keyword: MUST - :validation_mode: static :updated: frankfurt + :validation_mode: static A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** 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 7da6c9e..40a0c15 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 @@ -3,7 +3,7 @@ .. Copyright 2017 AT&T Intellectual Property. All rights reserved. Resource Property "name" ----------------------------- +------------------------ The parameter naming convention of the property ``name`` for the resource ``OS::Nova::Server`` has been defined in @@ -18,8 +18,8 @@ some resources do not support the property. :id: R-85734 :target: VNF :keyword: MUST - :validation_mode: static :updated: dublin + :validation_mode: static If a VNF's Heat Orchestration Template contains the property ``name`` for a non ``OS::Nova::Server`` resource, the intrinsic function @@ -47,8 +47,8 @@ construct a unique value. :id: R-99812 :target: VNF :keyword: MUST NOT - :validation_mode: static :updated: casablanca + :validation_mode: static A value for VNF's Heat Orchestration Template's property ``name`` for a non ``OS::Nova::Server`` resource **MUST NOT** be declared @@ -109,7 +109,7 @@ construct a unique value. . . . . Contrail Issue with Values for the Property Name -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. req:: diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst index 416b1f0..b03bd53 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Suggested Naming Convention for Common Parameters.rst @@ -3,14 +3,14 @@ .. Copyright 2017 AT&T Intellectual Property. All rights reserved. Suggested Naming Convention for Common Parameters ----------------------------------------------------------------------------------------------------------- +------------------------------------------------- Many VNFs use the parameters in the table below are used in user_data. The table below provides a suggested naming convention for these common parameters. Netmask -^^^^^^^^^^^^^^^^^^ +^^^^^^^ .. csv-table:: **Table 8: Suggested Naming Convention for Common Parameters: Netmask** :header: Parameter Name,Parameter Type,Notes @@ -23,7 +23,7 @@ Netmask int_{network-role}_v6_subnet_<index>_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_<network-role>_v6_subnet_<index>_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_<index>_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_<index>, 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_<index>, 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_<index>, 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* diff --git a/docs/Chapter5/Tosca/ONAP HPA Requirements.rst b/docs/Chapter5/Tosca/ONAP HPA Requirements.rst index d73bc6f..c99c3e2 100644 --- a/docs/Chapter5/Tosca/ONAP HPA Requirements.rst +++ b/docs/Chapter5/Tosca/ONAP HPA Requirements.rst @@ -14,7 +14,7 @@ HPA Requirements ------------------ +---------------- 1. SR-IOV Passthrought diff --git a/docs/Chapter5/Tosca/ONAP NFV Tosca.rst b/docs/Chapter5/Tosca/ONAP NFV Tosca.rst index 527b00f..93b6c3b 100644 --- a/docs/Chapter5/Tosca/ONAP NFV Tosca.rst +++ b/docs/Chapter5/Tosca/ONAP NFV Tosca.rst @@ -222,7 +222,7 @@ Definition Artifact -~~~~~~~~~~ +~~~~~~~~ Note: currently not supported. diff --git a/docs/Chapter5/Tosca/ONAP Tosca Overview.rst b/docs/Chapter5/Tosca/ONAP Tosca Overview.rst index 892e502..0603da6 100644 --- a/docs/Chapter5/Tosca/ONAP Tosca Overview.rst +++ b/docs/Chapter5/Tosca/ONAP Tosca Overview.rst @@ -70,7 +70,7 @@ protocol, which supports multiple TOSCA template yaml files, and also supports self-defined node or other extensions. TOSCA Introduction -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ TOSCA defines a Meta model for defining IT services. This Meta model defines both the structure of a service as well as how to manage it. A diff --git a/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst b/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst index ca5e677..8dadc3b 100644 --- a/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst +++ b/docs/Chapter5/Tosca/ONAP Tosca PNF Descriptor.rst @@ -32,7 +32,7 @@ General Data Types -^^^^^^^^^^^^^^ +^^^^^^^^^^ .. req:: :id: R-484843 @@ -63,7 +63,7 @@ No artifact type is currently supported in ONAP. Capability Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^ .. req:: :id: R-177937 @@ -78,11 +78,11 @@ Capability Types Requirements Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ Relationship Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ .. req:: :id: R-64064 @@ -97,13 +97,13 @@ Relationship Types Interface Types -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^ No interface type is currently supported in ONAP. Node Types -^^^^^^^^^^^^^^ +^^^^^^^^^^ .. req:: :id: R-535009 @@ -123,13 +123,13 @@ Node Types Group Types -^^^^^^^^^^^^^^ +^^^^^^^^^^^ No group type is currently supported in ONAP. Policy Types -^^^^^^^^^^^^^^ +^^^^^^^^^^^^ .. req:: :id: R-596064 diff --git a/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst b/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst index c5172ad..eb7b3ba 100644 --- a/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst +++ b/docs/Chapter5/Tosca/ONAP VNF or PNF CSAR Package.rst @@ -14,7 +14,7 @@ VNF or PNF CSAR Package ------------------------- +----------------------- CSAR Overview ^^^^^^^^^^^^^ @@ -238,7 +238,7 @@ VNF or PNF Package Contents VNF or PNF Package Authenticity and Integrity -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ VNF or PNF CSAR package shall support a method for authenticity and integrity assurance. According to ETSI SOL004 the onboarding package shall be secured. |