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 | |
| 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')
47 files changed, 1065 insertions, 1054 deletions
diff --git a/docs/Chapter4/Devops.rst b/docs/Chapter4/Devops.rst index 40ac9a5..b2f8d26 100644 --- a/docs/Chapter4/Devops.rst +++ b/docs/Chapter4/Devops.rst @@ -14,7 +14,7 @@ VNF Devops ---------------------- +---------- This section includes guidelines for VNF providers to ensure that a Network Cloud Service Provider’s operations personnel have a common and diff --git a/docs/Chapter4/Modularity.rst b/docs/Chapter4/Modularity.rst index 5493276..7360cdb 100644 --- a/docs/Chapter4/Modularity.rst +++ b/docs/Chapter4/Modularity.rst @@ -73,7 +73,7 @@ This overview is provided to set the stage and help clarify the concepts that will be introduced. ONAP VNF Modularity -^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ ONAP supports a modular Heat Orchestration Template design pattern, referred to as *VNF Modularity.* With this approach, a single VNF may be @@ -137,7 +137,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. @@ -180,7 +180,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: diff --git a/docs/Chapter4/Resiliency.rst b/docs/Chapter4/Resiliency.rst index 60f9c79..5127f56 100644 --- a/docs/Chapter4/Resiliency.rst +++ b/docs/Chapter4/Resiliency.rst @@ -14,7 +14,7 @@ VNF Resiliency -------------------------- +-------------- The VNF is responsible for meeting its resiliency goals and must factor in expected availability of the targeted virtualization environment. @@ -32,7 +32,7 @@ the overall guidelines for designing VNFs to meet resiliency goals. Below are more detailed resiliency requirements for VNFs. All Layer Redundancy -^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^ Design the VNF to be resilient to the failures of the underlying virtualized infrastructure (Network Cloud). VNF design considerations @@ -122,7 +122,7 @@ All Layer Redundancy Requirements and evacuate for rollback or back out mechanism. Minimize Cross Data-Center Traffic -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid performance-sapping data center-to-data center replication delay by applying techniques such as caching and persistent transaction paths @@ -143,7 +143,7 @@ Minimize Cross Data-Center Traffic Requirements across multiple data centers to avoid cross data center traffic. Application Resilient Error Handling -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Ensure an application communicating with a downstream peer is equipped to intelligently handle all error conditions. Make sure code can handle @@ -259,7 +259,7 @@ Application Resilient Error Handling Requirements location can take over traffic and process service requests. System Resource Optimization -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Ensure an application is using appropriate system resources for the task at hand; for example, do not use network or IO operations inside @@ -364,7 +364,7 @@ System Resource Optimization Requirements to not prevent use of these assets by other entities. Application Configuration Management -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Leverage configuration management audit capability to drive conformity to develop gold configurations for technologies like Java, Python, etc. @@ -400,7 +400,7 @@ Application Configuration Management Requirements to be bounced so that the VNF availability is not effected. Intelligent Transaction Distribution & Management -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Leverage Intelligent Load Balancing and redundant components (hardware and modules) for all transactions, such that at any point in the @@ -445,7 +445,7 @@ Intelligent Transaction Distribution & Management Requirements is able to control its load against the VNF. Deployment Optimization -^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^ Reduce opportunity for failure, by human or by machine, through smarter deployment practices and automation. This can include rolling code @@ -537,7 +537,7 @@ Deployment Optimization Requirements not met. Monitoring & Dashboard -^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^ Promote dashboarding as a tool to monitor and support the general operational health of a system. It is critical to the support of the @@ -626,7 +626,7 @@ Monitoring & Dashboard Requirements development of the VNF. Virtual Function - Container Recovery Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ As part of life cycle management, for Cloud environment, VNFs need to support a set of basic recovery capabilities to maintain the health diff --git a/docs/Chapter4/Security.rst b/docs/Chapter4/Security.rst index ba033f7..3782e58 100644 --- a/docs/Chapter4/Security.rst +++ b/docs/Chapter4/Security.rst @@ -14,7 +14,7 @@ VNF Security ----------------------- +------------ The objective of this section is to provide the key security requirements that need to be met by VNFs. The security requirements are @@ -48,7 +48,7 @@ following sections: requirements associated with data protection. VNF General Security Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section provides details on the VNF general security requirements on various security areas such as user access control, network security, @@ -316,7 +316,7 @@ the product's lifecycle. are secure. All non-compliances with the benchmarks MUST be documented. VNF Identity and Access Management Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following security requirements for logging, identity, and access management need to be met by the solution in a virtual environment: @@ -542,7 +542,7 @@ Identity and Access Management Requirements VNF API Security Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section covers API security requirements when these are used by the VNFs. Key security areas covered in API security are Access Control, @@ -601,7 +601,7 @@ API Requirements should be tested for spoofed MIME types. VNF Security Analytics Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section covers VNF security analytics requirements that are mostly applicable to security monitoring. The VNF Security Analytics cover the @@ -1015,7 +1015,7 @@ Security Analytics Requirements elevated privileges. VNF Data Protection Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section covers VNF data protection requirements that are mostly applicable to security monitoring. @@ -1143,7 +1143,7 @@ Data Protection Requirements VNF Cryptography Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section covers VNF cryptography requirements that are mostly applicable to encryption or protocol meethods. 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. diff --git a/docs/Chapter7/Configuration-Management.rst b/docs/Chapter7/Configuration-Management.rst index b7d8336..6c358c7 100755 --- a/docs/Chapter7/Configuration-Management.rst +++ b/docs/Chapter7/Configuration-Management.rst @@ -25,7 +25,7 @@ A VNF or PNF shall support at least one of communication protocols as specified :keyword: MUST :introduced: frankfurt - The VNF or PNF MUST support configuration management including + The VNF or PNF **MUST** support configuration management including life cycle management (LCM) using at least one of the following protocols a)NETCONF/YANG, b)Ansible and c)Chef. @@ -37,7 +37,7 @@ The selection of which API to use for LCM operations for a given PNF/VNF type is The requirements for supporting of SDN-C/APPC LCM API for LCM operations are documented in section 7.3.1. Controller Interactions With VNF or PNF -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section is not applicable to LCM operations using CDS self-service API. APPC/SDN-C expose a northbound API to clients (such as SO) in order for @@ -67,7 +67,7 @@ parameter data can be either xml (for NETCONF) or JSON (for Ansible, Chef, or REST). Configuration Commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~ ``Configure``: The APPC/SDN-C client is requesting that a post-instantiation configuration be applied to the target VNF or PNF. After the Configure @@ -165,7 +165,7 @@ configuration update) is audited against the running configuration on the VNF The VNF or PNF **MUST** support APPC ``Audit`` command. Lifecycle Management Related Commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **The following commands are needed to support various lifecycle management flows where the VNF may need to be removed for service.** @@ -318,7 +318,7 @@ UpgradePostCheck failed). HealthCheck and Failure Related Commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``HealthCheck`` The APPC/SDN-C client is requesting a health check over the entire scope of the VNF or PNF. The VNF or PNF must be 100% healthy, ready to @@ -352,7 +352,7 @@ automated fashion. The VNF or PNF **MUST** support APPC/SDN-C ``HealthCheck`` command. Notes On Command Support Using APPC/SDN-C Southbound Protocols -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ APPC/SDN-C are designed to support a standard set of protocols in order to communicate with the VNF or PNF instance. The supported protocols are @@ -381,7 +381,7 @@ Additional details can be found in the the `ONAP SDNC project <https://onap.readthedocs.io/en/latest/submodules/sdnc/oam.git/docs/index.html>`_. NETCONF Standards and Capabilities -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ APPC/SDN-C and their Adapters utilize device YANG model and NETCONF APIs to make the required changes in the VNF or PNF state and @@ -393,7 +393,7 @@ VNF or PNF Configuration via NETCONF Requirements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Configuration Management -+++++++++++++++++++++++++++ +++++++++++++++++++++++++ .. req:: @@ -415,7 +415,7 @@ Configuration Management by supplied YANG models for the embedded NETCONF server. NETCONF Server Requirements -++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ .. req:: @@ -1034,7 +1034,7 @@ NETCONF RFCs. LCM Operations via NETCONF -++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++ .. req:: :id: R-246519 @@ -1042,7 +1042,7 @@ LCM Operations via NETCONF :keyword: MAY :introduced: frankfurt - As alternative to Ansible, Chef or REST, a VNF or PNF MAY support YANG models + As alternative to Ansible, Chef or REST, a VNF or PNF **MAY** support YANG models allowing execution of standard controller LCM operations including HealthCheck. Note: To support vendor YANG models for LCM operations, the controller is responsible for performing VNF/PNF specific translation of north-bound API requests into one or more @@ -1107,7 +1107,7 @@ or unhealthy response: Chef Standards and Capabilities -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. container:: note @@ -1137,7 +1137,7 @@ VNF or PNF Configuration via Chef Requirements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Chef Client Requirements -+++++++++++++++++++++++++ +++++++++++++++++++++++++ .. req:: @@ -1180,7 +1180,7 @@ Chef Client Requirements push jobs client >= 2.0. Chef Roles/Requirements -++++++++++++++++++++++++++ ++++++++++++++++++++++++ .. req:: :id: R-27310 @@ -1358,7 +1358,7 @@ action request against a Chef managed VNF or PNF. .. _ansible_playbook_requirements: Ansible Standards and Capabilities -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ONAP will support configuration of VNFs or PNFs via Ansible subject to the requirements and guidelines defined in this section. @@ -1375,7 +1375,7 @@ VNF or PNF Configuration via Ansible Requirements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Ansible Client Requirements -+++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ .. req:: @@ -1436,7 +1436,7 @@ Ansible Client Requirements .. req:: :id: R-92866 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :updated: dublin @@ -1506,7 +1506,7 @@ Ansible Client Requirements .. req:: :id: R-94567 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: casablanca :updated: guilin @@ -1517,7 +1517,7 @@ Ansible Client Requirements .. req:: :id: R-67124 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: casablanca :updated: guilin @@ -1529,7 +1529,7 @@ Ansible Client Requirements .. req:: :id: R-24482 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: casablanca :updated: guilin @@ -1540,7 +1540,7 @@ Ansible Client Requirements VM(s) as needed. Ansible Playbook Requirements -+++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++ An Ansible playbook is a collection of tasks that is executed on the Ansible server (local host) and/or the target VM (s) in order to @@ -1548,7 +1548,7 @@ complete the desired action. .. req:: :id: R-49396 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :updated: guilin @@ -1559,7 +1559,7 @@ complete the desired action. .. req:: :id: R-33280 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST NOT :updated: guilin @@ -1568,8 +1568,8 @@ complete the desired action. .. req:: :id: R-195620 + :target: VNF or PNF PROVIDER :keyword: SHOULD - :target: VNF or PNF Provider :introduced: guilin The VNF or PNF Provider's Ansible playbooks **SHOULD** compare the version(s) @@ -1580,8 +1580,8 @@ complete the desired action. .. req:: :id: R-918136 + :target: VNF or PNF PROVIDER :keyword: MUST NOT - :target: VNF or PNF Provider :introduced: guilin The VNF or PNF Provider's Ansible playbooks **MUST NOT** fail due to @@ -1590,8 +1590,8 @@ complete the desired action. .. req:: :id: R-444446 + :target: VNF or PNF PROVIDER :keyword: SHOULD - :target: VNF or PNF Provider :introduced: guilin The VNF or PNF Provider's Ansible playbooks **SHOULD** issue log messages @@ -1605,7 +1605,7 @@ complete the desired action. .. req:: :id: R-48698 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :updated: guilin @@ -1633,7 +1633,7 @@ will be considered to have failed. .. req:: :id: R-43253 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :updated: guilin @@ -1647,7 +1647,7 @@ will be considered to have failed. .. req:: :id: R-50252 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :updated: guilin @@ -1662,7 +1662,7 @@ will be considered to have failed. .. req:: :id: R-51442 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: SHOULD :updated: guilin @@ -1679,7 +1679,7 @@ will be considered to have failed. .. req:: :id: R-58301 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: SHOULD NOT :updated: dublin @@ -1699,7 +1699,7 @@ will be considered to have failed. .. req:: :id: R-02651 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: SHOULD :updated: guilin @@ -1711,7 +1711,7 @@ will be considered to have failed. .. req:: :id: R-43353 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :updated: guilin @@ -1838,7 +1838,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-24189 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: casablanca :updated: guilin @@ -1849,10 +1849,10 @@ performs a full VNF or PNF health check. .. req:: :id: R-49911 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST - :updated: guilin :introduced: casablanca + :updated: guilin The VNF or PNF Provider **MUST** assign a new point release to the updated Ansible playbook set. The functionality of a new playbook set must be @@ -1860,7 +1860,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-42333 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt :updated: guilin @@ -1878,7 +1878,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-39003 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt :updated: guilin @@ -1889,7 +1889,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-46823 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt @@ -1903,7 +1903,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-83092 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt :updated: guilin @@ -1914,7 +1914,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-09209 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt :updated: guilin @@ -1926,7 +1926,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-56988 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt @@ -1937,7 +1937,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-20988 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt :updated: guilin @@ -1950,18 +1950,18 @@ performs a full VNF or PNF health check. .. req:: :id: R-53245 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST NOT :introduced: frankfurt :updated: guilin - The VNF or PNF Provider's Ansible playbooks **MUST** require + The VNF or PNF Provider's Ansible playbooks **MUST NOT** require passwords or secrets to be passed in clear text in the command line or Rest API request to run the playbook. .. req:: :id: R-78640 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: SHOULD :introduced: frankfurt :updated: guilin @@ -1973,8 +1973,8 @@ performs a full VNF or PNF health check. .. req:: :id: R-88786 - :target: VNF or PNF Provider - :keyword: MUST + :target: VNF or PNF PROVIDER + :keyword: SHOULD :introduced: frankfurt :updated: guilin @@ -1985,7 +1985,7 @@ performs a full VNF or PNF health check. .. req:: :id: R-88002 - :target: VNF or PNF Provider + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: frankfurt @@ -1996,7 +1996,7 @@ performs a full VNF or PNF health check. into the central repository for distribution. Ansible API Usage -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~ This section outlines the workflow that APPC/SDN-C invokes when it receives an action request against an Ansible managed VNF or PNF. @@ -2021,7 +2021,7 @@ it receives an action request against an Ansible managed VNF or PNF. Support of APPC/SDN-C Commands And Southbound Protocols -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following table summarizes the commands and possible protocols selected. Note that the HealthCheck can also be supported via REST. diff --git a/docs/Chapter7/Monitoring-And-Management.rst b/docs/Chapter7/Monitoring-And-Management.rst index 8cbbf31..9144850 100755 --- a/docs/Chapter7/Monitoring-And-Management.rst +++ b/docs/Chapter7/Monitoring-And-Management.rst @@ -86,10 +86,10 @@ ONAP. :id: R-332680 :target: VNF or PNF :keyword: SHOULD - :impacts: dcae - :validation_mode: in_service :introduced: casablanca :updated: guilin + :validation_mode: in_service + :impacts: dcae The VNF or PNF producing VES events **SHOULD** deliver syslog messages that meet the criteria in R-209104 to the VES Event Listener using the @@ -110,8 +110,8 @@ ONAP. :keyword: MAY :introduced: casablanca :updated: guilin - :impacts: DCAE :validation_mode: in_service + :impacts: DCAE The VNF or PNF **MAY** leverage ONAP's High Volume VNF Event Streaming (HV-VES) when there is a need to deliver large volumes of real-time @@ -124,8 +124,8 @@ ONAP. :target: VNF or PNF PROVIDER :keyword: MUST :introduced: guilin - :impacts: DCAE :validation_mode: none + :impacts: DCAE VNF or PNF Provider **MUST** have agreement with the Service Provider before utilizing the HV-VES option for monitoring as this option does not fully @@ -136,9 +136,9 @@ ONAP. :target: VNF or PNF :keyword: MAY :introduced: casablanca - :impacts: dcae, dmaap - :validation_mode: in_service :updated: guilin + :validation_mode: in_service + :impacts: dcae, dmaap The VNF or PNF **MAY** leverage a bulk VNF or PNF telemetry transmission mechanism in instances where other transmission @@ -195,9 +195,9 @@ Event Definition and Registration :target: VNF or PNF PROVIDER :keyword: MUST :introduced: casablanca + :updated: guilin :validation_mode: static :impacts: dcae - :updated: guilin If the VNF or PNF is using VES, then the VNF or PNF Provider **MUST** provide a YAML file formatted in adherence with the @@ -235,11 +235,11 @@ Event Definition and Registration .. req:: :id: R-123044 :target: VNF or PNF PROVIDER - :keyword: MUST + :keyword: MAY :introduced: casablanca + :updated: dublin :validation_mode: in_service :impacts: dcae - :updated: dublin The VNF or PNF Provider **MAY** require that specific events, identified by their ``eventName``, require that certain fields, which are optional in the @@ -270,11 +270,11 @@ Event Formatting and Usage .. req:: :id: R-528866 :target: VNF or PNF + :keyword: MUST :introduced: casablanca + :updated: guilin :validation_mode: in_service :impacts: dcae - :keyword: MUST - :updated: guilin The VES events produced by the VNF or PNF **MUST** conform to the schema and other formatting requirements specified in the relevant VES Event Listener @@ -283,11 +283,11 @@ Event Formatting and Usage .. req:: :id: R-283988 :target: VNF or PNF + :keyword: MUST NOT :introduced: casablanca :updated: guilin :validation_mode: in_service :impacts: dcae - :keyword: MUST NOT A VNF or PNF producing VES events **MUST NOT** send information through extensible structures if the event specification has explicitly defined @@ -296,11 +296,11 @@ Event Formatting and Usage .. req:: :id: R-470963 :target: VNF or PNF + :keyword: SHOULD :introduced: casablanca :updated: guilin :validation_mode: in_service :impacts: dcae - :keyword: SHOULD A VNF or PNF producing VES events **SHOULD** leverage camel case to separate words and acronyms used as keys that will be sent through extensible @@ -540,7 +540,7 @@ unavailable or unhealthy, the NF must adhere to these requirements. restrictions in place for the operation. Security -~~~~~~~~~~ +~~~~~~~~ .. req:: :id: R-68165 @@ -573,8 +573,8 @@ Bulk Performance Measurement :target: VNF or PNF :keyword: SHOULD :introduced: casablanca - :impacts: dcae, dmaap :updated: dublin + :impacts: dcae, dmaap The VNF or PNF **SHOULD** support FileReady VES event for event-driven bulk transfer of monitoring data. @@ -584,8 +584,8 @@ Bulk Performance Measurement :target: VNF or PNF :keyword: SHOULD :introduced: casablanca - :impacts: dcae, dmaap :updated: dublin + :impacts: dcae, dmaap The VNF or PNF **SHOULD** support File transferring protocol, such as FTPES or SFTP, when supporting the event-driven bulk transfer of monitoring data. @@ -595,8 +595,8 @@ Bulk Performance Measurement :target: VNF or PNF :keyword: SHOULD :introduced: casablanca + :updated: guilin :impacts: dcae, dmaap - :updated: guilin The VNF or PNF **SHOULD** support the data schema defined in 3GPP TS 32.435 or 3GPP TS 28.532, when supporting the event-driven bulk transfer of monitoring data. diff --git a/docs/Chapter7/PNF-Plug-and-Play.rst b/docs/Chapter7/PNF-Plug-and-Play.rst index a77416f..7215bd0 100644 --- a/docs/Chapter7/PNF-Plug-and-Play.rst +++ b/docs/Chapter7/PNF-Plug-and-Play.rst @@ -14,10 +14,10 @@ PNF Plug and Play ------------------------- +----------------- PNF Plug and Play -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^ The following are the requirements related to PNF Plug and Play. @@ -36,7 +36,7 @@ The following are the requirements related to PNF Plug and Play. :target: PNF :keyword: SHOULD :introduced: casablanca - :updated: El Alto + :updated: el alto The following VES Events **SHOULD** be supported by the PNF: pnfRegistration VES Event, HVol VES Event, and Fault VES Event. These are onboarded via @@ -164,7 +164,7 @@ The following are the requirements related to PNF Plug and Play. .. req:: :id: R-284934 :target: PNF - :keyword: MUST + :keyword: MAY :introduced: casablanca If the PNF encounters an error authenticating, reaching the ONAP DCAE VES diff --git a/docs/Chapter7/VNF-On-boarding-and-package-management.rst b/docs/Chapter7/VNF-On-boarding-and-package-management.rst index 739f232..8b87f79 100755 --- a/docs/Chapter7/VNF-On-boarding-and-package-management.rst +++ b/docs/Chapter7/VNF-On-boarding-and-package-management.rst @@ -17,7 +17,7 @@ VNF and PNF On-boarding and package management ---------------------------------------------- Design Definition -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^ The ONAP Design Time Framework provides the ability to design NFV resources including VNFs, Services, and products. The VNF provider must @@ -35,11 +35,11 @@ and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization (NFV), Management and Orchestration, VNF Packaging Specification. Resource Description -^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^ .. req:: :id: R-66070 - :target: VNF Package + :target: VNF HEAT PACKAGE :keyword: MUST :updated: dublin @@ -126,13 +126,13 @@ Resource Description .. req:: :id: R-22346 - :target: VNF or PNF PACKAGE + :target: VNF or PNF PROVIDER :keyword: MUST :introduced: casablanca - :updated: el alto + :updated: guilin :validation_mode: static - The VNF or PNF package **MUST** provide :ref:`VES Event Registration <ves_event_registration_3_2>` + The VNF or PNF Provider **MUST** provide :ref:`VES Event Registration <ves_event_registration_3_2>` for all VES events provided by that VNF or PNF. .. req:: @@ -150,8 +150,8 @@ Resource Description :target: VNF or PNF PROVIDER :keyword: MUST :updated: frankfurt - :impacts: DCAE,Documentation,Integration,SDC :validation_mode: static + :impacts: DCAE,Documentation,Integration,SDC The VNF or PNF PROVIDER **MUST** provide :ref:`FM_meta_data` to support the analysis of fault events delivered to DCAE. The metadata must be @@ -159,7 +159,7 @@ Resource Description supported by that VNF or PNF at onboarding time. The metadata must follow the VES Event Listener Specifications for Fault domain and VES Event Registration Specifications for YAML registration file format. - + .. req:: :id: R-816745 @@ -167,8 +167,8 @@ Resource Description :keyword: MUST :introduced: dublin :updated: frankfurt - :impacts: DCAE,Documentation,Integration,SDC :validation_mode: static + :impacts: DCAE,Documentation,Integration,SDC THe VNF or PNF PROVIDER **MUST** provide PM Meta Data (:ref:`PM_Dictionary`) to support the analysis of PM data delivered to DCAE. @@ -177,7 +177,7 @@ Resource Description which contain the format and content required. Resource Configuration -^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^ .. req:: @@ -192,7 +192,7 @@ Resource Configuration Configuration Management via NETCONF/YANG -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: :id: R-30278 @@ -204,7 +204,7 @@ Configuration Management via NETCONF/YANG as a foundation for creating the YANG model for configuration. Configuration Management via Chef -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. req:: @@ -277,7 +277,7 @@ Configuration Management via Ansible (e.g., customer provisioning data). Resource Control Loop -^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^ .. req:: @@ -448,7 +448,7 @@ Resource Control Loop Compute, Network, and Storage Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. req:: @@ -521,7 +521,7 @@ Compute, Network, and Storage Requirements Testing -^^^^^^^^^^ +^^^^^^^ .. req:: :id: R-43958 @@ -554,7 +554,7 @@ Testing necessary simulators. Licensing Requirements -^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^ ONAP can support external licensing management solution (e.g. vendor specific) in addition to its own licensing management solution. If licensing management solution is provided by ONAP, then ONAP operators build the VNF License using SDC during onboarding. diff --git a/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst b/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst index e78ce5c..35c6ef4 100644 --- a/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst +++ b/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst @@ -14,13 +14,13 @@ Ansible JSON Key Value Description -------------------------------------------------------------- +---------------------------------- The following provides the key value pairs that must be contained in the JSON file supporting APPC/SDN-C Ansible action. Table B1. Ansible JSON File key value description -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: **TOSCA Definition** :file: Ansible JSON File Key Value Description.csv diff --git a/docs/Chapter8/Ansible-Playbook-Examples.rst b/docs/Chapter8/Ansible-Playbook-Examples.rst index ce57fd1..e60c063 100644 --- a/docs/Chapter8/Ansible-Playbook-Examples.rst +++ b/docs/Chapter8/Ansible-Playbook-Examples.rst @@ -14,7 +14,7 @@ Ansible Playbook Examples ------------------------------------------------ +------------------------- The following sections contain examples of Ansible playbooks which follow the guidelines. @@ -24,7 +24,7 @@ to: :doc:`APPC Ansible Adapter <../../../../appc/deployment.git/docs/APPC Ansibl Guidelines for Playbooks to properly integrate with APPC/SDN-C -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **NOTE**: To support concurrent requests to multiple playbooks, targeting VNF instances of same or different type, VNF files dynamically created by playbooks @@ -278,7 +278,7 @@ files: playbook take precedence over any defaults stored in Ansible Server. Ansible Playbooks – Notes On Artifacts Required to Run Playbooks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Inventory hosts file: should be VNF instance specific. @@ -664,7 +664,7 @@ can be found under ONAP (onap.org). Ansible Inventory Hosts File – Supported Formats -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Supported inventory hosts file examples, built from this NodeList model, extracted from A&AI by APPC/SDN-C and passed to the Ansible @@ -784,7 +784,7 @@ With VNFC names and IP addresses, template inventory names setting Ansible Server – On-boarding Ansible Playbooks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once playbooks are developed following these guidelines, playbooks need to be on-boarded onto Development Ansible Server(s), and placed under (git) code diff --git a/docs/Chapter8/Chef-JSON-Key-Value-Description.rst b/docs/Chapter8/Chef-JSON-Key-Value-Description.rst index 400473d..19e0a4b 100644 --- a/docs/Chapter8/Chef-JSON-Key-Value-Description.rst +++ b/docs/Chapter8/Chef-JSON-Key-Value-Description.rst @@ -14,13 +14,13 @@ Chef JSON Key Value Description -------------------------------------- +------------------------------- The following provides the key value pairs that must be contained in the JSON file supporting Chef action. Table A1. Chef JSON File key value description -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------+--------------------------+---------+----------------------+ | **Field Name** | **Description** | **Type**| **Comment** | @@ -145,7 +145,7 @@ b. If a VNF action involves multiple endpoints (VMs) of a VNF, ONAP will The following table describes the JSON dictionary to post in Callback. Table A2. JSON Dictionary to Post in Callback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------+----------------------------+---------+-----------------------+ | **Key** | **Description** | **Type**| **Comment** | diff --git a/docs/Chapter8/TOSCA-model.rst b/docs/Chapter8/TOSCA-model.rst index 64ebbf0..66a902f 100644 --- a/docs/Chapter8/TOSCA-model.rst +++ b/docs/Chapter8/TOSCA-model.rst @@ -17,7 +17,7 @@ TOSCA model ----------- Table D1. ONAP Resource DM TOSCA/YAML constructs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Standard TOSCA/YAML definitions agreed by VNF SDK Modeling team to be used by VNF vendors to create a standard VNF descriptor. @@ -84,7 +84,7 @@ ETSI GS NFV-SOL001 stable draft for VNF-D. Table D2. TOSCA CSAR structure -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section defines the requirements around the CSAR structure. diff --git a/docs/Chapter8/VES_Registration_3_2.rst b/docs/Chapter8/VES_Registration_3_2.rst index 91899ce..1362a49 100644 --- a/docs/Chapter8/VES_Registration_3_2.rst +++ b/docs/Chapter8/VES_Registration_3_2.rst @@ -97,7 +97,7 @@ events in a way that can be compiled or interpreted by applications across a Service Provider's infrastructure. Relation to the Common Event Format -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The Common Event Format described in the VES Event Listener service specification defines the structure of VES events including optional @@ -123,7 +123,7 @@ value (e.g., ``MINOR``), or to a subset of the possible enumerated values allowed by the Common Event Format (e.g., ``MINOR`` or ``NORMAL``). Relation to Service Design and Creation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Event registration for a VNF (or other event source) is provided to the Service Provider's Service Creation and Design Environment (e.g., SDC) @@ -548,7 +548,7 @@ Examples: HeartbeatAction -++++++++++++++++ ++++++++++++++++ The ``heartbeatAction`` keyword is provided on the ``event`` objectName for heartbeat events only. It provides design time guidance to the service @@ -628,7 +628,7 @@ Examples: } Presence -+++++++++ +++++++++ The ``presence`` keyword may be defined as 'required' or 'optional'. If not provided, the element is assumed to be 'optional'. @@ -649,7 +649,7 @@ Examples: # by omitting a presence definition, the element is assumed to be optional Range -+++++++ ++++++ The ``range`` keyword applies to fields (i.e., simpleTypes); indicates the value of the field is a number within a specified range of values from @@ -675,7 +675,7 @@ Examples: fieldname: { range: [ 0, 3.14 ] } Structure -++++++++++ ++++++++++ The ``structure`` keyword indicates that the element is a complexType (i.e., an object) and is followed by curly braces containing that @@ -699,7 +699,7 @@ Example: } Units -+++++++ ++++++ The ``units`` qualifier may be applied to values provided in VES Common Event Format extensible field structures. The 'units' qualifier @@ -720,7 +720,7 @@ Example: } Value -+++++++ ++++++ The ``value`` keyword applies to fields (i.e., simpleTypes); indicates a single value or an enumeration of possible values. If not provided, it @@ -823,7 +823,7 @@ preceding event definitions. For example: ... Rules Syntax and Semantics -++++++++++++++++++++++++++++ +++++++++++++++++++++++++++ The YAML ``rules`` document begins with the keyword ``rules`` followed by a colon and square brackets. Each rule is then defined within the square @@ -850,7 +850,7 @@ Notes: microservices and alerts may be specified. Simple Triggers -++++++++++++++++ ++++++++++++++++ The trigger is based on the named ``conditions`` asserted in the action qualifiers within the event definitions earlier in the YAML file. The @@ -892,7 +892,7 @@ the action on). Future versions of this document may provide more clarity. Time Based Qualifiers -+++++++++++++++++++++++ ++++++++++++++++++++++ Time based rules may be established by following any named condition with a colon and curly braces. The time based rule is placed in the @@ -918,7 +918,7 @@ minutes AND condition C is in effect. .. _PM_Dictionary: PM Dictionary -~~~~~~~~~~~~~~ +~~~~~~~~~~~~~ The Performance Management (PM) Dictionary is used by analytics applications to interpret and process perf3gpp measurement information @@ -1556,7 +1556,7 @@ indent-style YAML formats .. _FM_meta_data: FM Meta Data -~~~~~~~~~~~~~ +~~~~~~~~~~~~ FM Meta Data enables vendors to provide meta information about FM events using a set of standard keywords. FM Meta Data is conveyed in the YAML @@ -1578,7 +1578,7 @@ Successive keywords must be separated by commas. These conventions will make machine processing of FM Meta Data Keywords easier to perform. Alarm Meta Data Keywords -++++++++++++++++++++++++++++ +++++++++++++++++++++++++ The following is a list of standard Alarm Meta Data Keywords. Note: the keywords are in CAPS so they can be easily found within the YAML @@ -1648,7 +1648,7 @@ comments. R / O refers to recommended / optional. +------------+---------+-----------------------------------------------------+ Fault Meta Data Keywords -+++++++++++++++++++++++++ +++++++++++++++++++++++++ The following is a list of standard Fault Meta Data Keywords. Note: the keywords are in CAPS so they can be easily found within the YAML @@ -1683,7 +1683,7 @@ comments. R / O refers to recommended / optional. +------------------------+---------+------------------------------------------+ FM Meta Data Example -+++++++++++++++++++++ +++++++++++++++++++++ The following is a snippet of a fault event registration showing use of the FM Meta Data keywords. Note: it is recommended the information be @@ -1804,7 +1804,7 @@ breaks that interrupt this single file; they were added to make it easier to rapidly find examples of different types of events. Fault -~~~~~~ +~~~~~ .. code-block:: yaml @@ -1892,7 +1892,7 @@ Fault } Heartbeat -~~~~~~~~~~ +~~~~~~~~~ .. code-block:: yaml @@ -1934,7 +1934,7 @@ Heartbeat Measurements -~~~~~~~~~~~~~ +~~~~~~~~~~~~ .. code-block:: yaml @@ -2653,7 +2653,7 @@ Mobile Flow Sip Signaling -~~~~~~~~~~~~~~ +~~~~~~~~~~~~~ .. code-block:: yaml @@ -2721,7 +2721,7 @@ Sip Signaling Voice Quality -~~~~~~~~~~~~~~ +~~~~~~~~~~~~~ .. code-block:: yaml @@ -2819,7 +2819,7 @@ Voice Quality Rules -~~~~~~ +~~~~~ .. code-block:: yaml @@ -2840,7 +2840,7 @@ Rules Appendix: Historical Change Log -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For the latest changes, see the Change Block just before the Table of Contents. diff --git a/docs/Chapter8/VNF-License-Information-Guidelines.rst b/docs/Chapter8/VNF-License-Information-Guidelines.rst index 94815f0..4df9cbd 100644 --- a/docs/Chapter8/VNF-License-Information-Guidelines.rst +++ b/docs/Chapter8/VNF-License-Information-Guidelines.rst @@ -71,7 +71,7 @@ One or more entitlements can be defined; each one consists of the following fields: Table C2. Required Fields for Entitlements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---------------+-----------------------------------+-------------+-----------+ | **Field Name**| **Description** |**Data Type**| **Type** | @@ -136,7 +136,7 @@ License Keys are not required. Optionally, one or more license keys can be defined; each one consists of the following fields: Table C3. Required Fields for License Keys -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---------------+-----------------------------------+--------------+----------+ | **Field Name**| **Description** | **Data Type**| **Type** | @@ -214,7 +214,7 @@ example: - use is allowed in Canada Table C4. Required Fields for Location -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------+--------------------------------+--------------+----------+ | **Field Name** | **Description** | **Data Type**| **Type** | @@ -262,7 +262,7 @@ Limit on the length of time the software may be used. For example: - entitlement valid from 15 May 2018 thru 30 June 2020 Table C5. Required Fields for Time -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------+-------------------------------+--------------+-----------+ | **Field Name** | **Description** | **Data Type**| **Type** | @@ -325,7 +325,7 @@ Limits based on how the software is used. For example: - use is limited by software release Table C6. Required Fields for Usage -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------+-------------------------------+---------------+----------+ | **Field Name** | **Description** | **Data Type** | **Type** | @@ -374,7 +374,7 @@ make use of the software. For example: - allowed to be used only for government entities Table C7. Required Fields for Entity -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------+--------------------------------+--------------+----------+ | **Field Name** | **Description** |**Data Type** | **Type** | @@ -429,7 +429,7 @@ any aggregation function (e.g., peak or average users), and aggregation interval (day, month, quarter, year, etc.). Table C8. Required Fields for Amount -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------+---------------------------------+-------------+----------+ | **Field Name** | **Description** |**Data Type**| **Type** | diff --git a/docs/Chapter8/ves7_1spec.rst b/docs/Chapter8/ves7_1spec.rst index 2c8b933..331f599 100644 --- a/docs/Chapter8/ves7_1spec.rst +++ b/docs/Chapter8/ves7_1spec.rst @@ -106,7 +106,7 @@ are required, what field values may be sent, and any special handling that should be performed on those eventNames. Naming Standards for eventName -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To prevent naming collisions, eventNames sent as part of the commonEventHeader, should conform to the following naming convention @@ -313,7 +313,7 @@ Registration specification and in particular the aggregationRole, castTo and isHomogeneous keywords. Syslogs -~~~~~~~~ +~~~~~~~ Syslog’s can be classified as either Control or Session/Traffic. They differ by message content and expected volume: @@ -439,7 +439,7 @@ Use of Collector FQDNs and/or IP Address Versioning -~~~~~~~~~~~ +~~~~~~~~~~ Three types of version numbers supported by this specification: @@ -469,7 +469,7 @@ Three types of version numbers supported by this specification: to the field descriptions) will increment only the minor number. Field Block Versions -+++++++++++++++++++++ +++++++++++++++++++++ A summary of the latest field block version enums as of this version of the API spec is provided below: @@ -539,7 +539,7 @@ Because the credentials are merely encoded but not encrypted, HTTPS (rather than HTTP) should be used. HTTPS will also encrypt and protect event contents. Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ Sample Request ++++++++++++++ @@ -576,7 +576,7 @@ Sample Request Sample Success Response -++++++++++++++++++++++++ ++++++++++++++++++++++++ .. code-block:: http @@ -587,7 +587,7 @@ Sample Success Response Mutual TLS Certificate Authentication -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When using Certificate Authentication, the event source must initialize the HTTPS connection with TLS 1.2 or higher and execute mutual authentication @@ -619,7 +619,7 @@ The resource structure is provided below:: The {Port} above is typically 8443. Common Event Format -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ A JSON schema describing the Common Event Format is provided below and is reproduced in the tables that follow. @@ -651,10 +651,10 @@ Note on extensible fields: capitalized. Common Event Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~ Datatype: arrayOfJsonObject -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ The arrayOfJsonObject datatype provides an array of json objects, each of which is describ ed by name, schema and other meta-information. It @@ -667,7 +667,7 @@ consists of the following fields: +---------------------+------------------+----------+----------------------+ Datatype: arrayOfNamedHashMap -++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++ The arrayOfNamedHashMap datatype provides an array of hashMaps, each of which is associated with a descriptive name. It consists of the @@ -680,7 +680,7 @@ following fields: +---------------------+------------------+-----------+-----------------------+ Datatype: event -++++++++++++++++ ++++++++++++++++ The event datatype consists of the following fields which constitute the ‘root level’ of the common event format: @@ -732,7 +732,7 @@ The event datatype consists of the following fields which constitute the +--------------+--------------+-----------+-----------------------------------+ Datatype: eventList -++++++++++++++++++++ ++++++++++++++++++++ The eventList datatype consists of the following fields: @@ -743,7 +743,7 @@ The eventList datatype consists of the following fields: +-------------+-------------+----------+-------------------+ Datatype: hashMap -+++++++++++++++++++ ++++++++++++++++++ The hashMap datatype is an ‘associative array’, which is an unordered collection of key-value pairs of the form "key": "value", where each key @@ -782,7 +782,7 @@ the schema: +--------------+--------------+-----------+----------------------------------+ Datatype: jsonObjectInstance -+++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++ The jsonObjectInstance datatype provides meta-information about an instance of a jsonObject along with the actual object instance: @@ -809,7 +809,7 @@ instance of a jsonObject along with the actual object instance: +----------------+------------+----------+-----------------------------------+ Datatype: key -+++++++++++++++ ++++++++++++++ The key datatype is a tuple which provides the name of a key along with its value and relative order; it consists of the following fields: @@ -826,7 +826,7 @@ its value and relative order; it consists of the following fields: +----------+---------+-----------+-------------------------------------------+ Datatype: namedHashMap -++++++++++++++++++++++++ +++++++++++++++++++++++ The namedHashMap datatype is a hashMap which is associated with and described by a name; it consists of the following fields: @@ -841,7 +841,7 @@ described by a name; it consists of the following fields: +---------+---------+-----------+--------------------------------------------+ Datatype: requestError -+++++++++++++++++++++++ +++++++++++++++++++++++ The requestError datatype defines the standard request error data structure: @@ -871,7 +871,7 @@ structure: +-----------+--------+-----------+-------------------------------------------+ Datatype: vendorNfNameFields -+++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++ The vendorNfNameFields provides vendor, nf and nfModule identifying information: @@ -892,7 +892,7 @@ Common Event Header Data Types ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Datatype: commonEventHeader -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ The commonEventHeader datatype consists of the following fields common to all events: @@ -1054,10 +1054,10 @@ for efficient internal processing of events received by the VES Event Listener. Technology Independent Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ‘Fault’ Domain Datatypes -+++++++++++++++++++++++++ +++++++++++++++++++++++++ Datatype: faultFields ********************* @@ -1130,7 +1130,7 @@ The faultFields datatype consists of the following fields: +-----------------+---------+-----------+-------------------------------------+ Heartbeat’ Domain Datatypes -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Datatype: heartbeatFields ************************* @@ -1154,7 +1154,7 @@ specific to heartbeat events; it consists of the following fields: +---------------+---------+-----------+---------------------------------------+ ‘Measurements’ Domain Datatypes -++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++ Note: NFs are required to report exactly one Measurement event per period per sourceName. @@ -1175,7 +1175,7 @@ measurementInterval: +------------------+-----------+----------+--------------------------------+ Datatype: cpuUsage -******************* +****************** The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: @@ -1245,7 +1245,7 @@ consists of the following fields: +------------+--------+-----------+-------------------------------------------+ Datatype: diskUsage -******************** +******************* The diskUsage datatype defines the usage of a disk and consists of the following fields: @@ -1509,7 +1509,7 @@ following fields: +-------------+-------+----------+--------------------------------------------+ Datatype: filesystemUsage -*************************** +************************* The filesystemUsage datatype consists of the following fields: @@ -1538,7 +1538,7 @@ The filesystemUsage datatype consists of the following fields: +-------------+--------+-----------+------------------------------------------+ Datatype: hugePages -******************** +******************* The hugePages datatype provides metrics on system hugePages; it consists of the following fields: @@ -1562,7 +1562,7 @@ of the following fields: +--------------------+--------+----------+------------------------------------+ Datatype: ipmi (Intelligent Platform Management Interface) -*********************************************************** +********************************************************** The ipmi datatype provides intelligent platform management interface metrics; it consists of the following fields: @@ -1617,7 +1617,7 @@ metrics; it consists of the following fields: +-------------+---------------------+-----------+-----------------------------+ Datatype: ipmiBaseboardTemperature -************************************ +********************************** The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: @@ -1634,7 +1634,7 @@ which describe ipmi baseboard temperature metrics: +-------------+--------+-----------+------------------------------------------+ Datatype: ipmiBaseboardVoltageRegulator -***************************************** +*************************************** The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: @@ -1650,7 +1650,7 @@ fields which describe ipmi baseboard voltage regulator metrics: +--------------------+-------+----------+-------------------------------------+ Datatype: ipmiBattery -********************** +********************* The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: @@ -1666,7 +1666,7 @@ ipmi battery metrics: +---------------------+--------+----------+------------------------------+ Datatype: ipmiFan -******************** +***************** The ipmiFan datatype consists of the following fields which describe ipmi fan metrics: @@ -1680,7 +1680,7 @@ ipmi fan metrics: +--------------+-------+----------+-------------------------------------------+ Datatype: ipmiGlobalAggregateTemperatureMargin -*********************************************** +********************************************** The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: @@ -1701,7 +1701,7 @@ following fields: +-------------+-------+----------+--------------------------------------------+ Datatype: ipmiHsbp -******************* +****************** The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: @@ -1717,7 +1717,7 @@ consists of the following fields: +------------+-------+----------+---------------------------------------------+ Datatype: ipmiNic -****************** +***************** The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: @@ -1733,7 +1733,7 @@ consists of the following fields: +------------+-------+----------+---------------------------------------------+ Datatype: ipmiPowerSupply -************************** +************************* The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: @@ -1762,7 +1762,7 @@ consists of the following fields: +-----------+-------+----------+----------------------------------------------+ Datatype: ipmiProcessor -************************ +*********************** The ipmiProcessor datatype provides ipmi processor metrics; it consists of the following fields: @@ -1790,7 +1790,7 @@ of the following fields: +------------+------------------+-----------+---------------------------------+ Datatype: latencyBucketMeasure -******************************* +****************************** The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket: @@ -1812,7 +1812,7 @@ describe the number of counts falling within a defined latency bucket: +-----------+-------+----------+----------------------------------------------+ Datatype: load -**************** +************** The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg; it consists of the following fields: @@ -1837,7 +1837,7 @@ obtained using /proc/loadavg; it consists of the following fields: +----------+-------+----------+-----------------------------------------------+ Datatype: machineCheckException -******************************** +******************************* The machineCheckException datatype describes machine check exceptions; it consists of the following fields: @@ -1874,7 +1874,7 @@ it consists of the following fields: +-------------+-------+----------+--------------------------------------------+ Datatype: measurementFields -**************************** +*************************** The measurementFields datatype consists of the following fields: @@ -1978,7 +1978,7 @@ The measurementFields datatype consists of the following fields: +-------------+--------------+----------+-------------------------------------+ Datatype: memoryUsage -********************** +********************* The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: @@ -2049,7 +2049,7 @@ and consists of the following fields: +-----------+-------+----------+----------------------------------------------+ Datatype: nicPerformance -************************* +************************ The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual @@ -2230,7 +2230,7 @@ network interface card: +----------------+-------+----------+-----------------------------------------+ Datatype: processorDimmAggregateThermalMargin -********************************************** +********************************************* The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module @@ -2250,7 +2250,7 @@ aggregate thermal margin metrics; it consists of the following fields: +-----------------+-------+----------+----------------------------------------+ Datatype: processStats -*********************** +********************** The processStats datatype provides metrics on system processes; it consists of the following fields: @@ -2285,10 +2285,10 @@ consists of the following fields: +-----------+-------+----------+----------------------------------------------+ ‘Notification’ Domain Datatypes -++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++ Datatype: notificationFields -****************************** +**************************** The notificationFields datatype consists of the following fields: @@ -2358,10 +2358,10 @@ in 3GPP TS 28.550. The array contains the following key value pairs: Other notificationFields are not used for fileReady. ‘Other’ Domain Datatypes -+++++++++++++++++++++++++ +++++++++++++++++++++++++ Datatype: otherFields -********************** +********************* The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration; it consists @@ -2385,10 +2385,10 @@ of the following fields: +-------------+-------------+----------+--------------------------------------+ ‘perf3gpp’ Domain Datatypes -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Datatype: measDataCollection -***************************** +**************************** The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format; it consists of the following @@ -2422,7 +2422,7 @@ fields: +----------------+---------+----------+---------------------------------------+ Datatype: measInfo -******************** +****************** The measInfo datatype provides measurement information; it consists of the following fields: @@ -2446,7 +2446,7 @@ the following fields: +-------+--------------------------+----------+-------------------------------+ Datatype: measInfoIdInteger -**************************** +*************************** The measInfoIdInteger datatype provides an integer measurement group identifier; it consists of the following fields: @@ -2458,7 +2458,7 @@ identifier; it consists of the following fields: +---------------+---------+----------+--------------------------------------+ Datatype: measInfoIdString -*************************** +************************** The measInfoIdString datatype provides a string measurement group identifier; it consists of the following fields: @@ -2470,7 +2470,7 @@ identifier; it consists of the following fields: +---------------+-----------+----------+--------------------------------------+ Datatype: measResultInteger -**************************** +*************************** The measResultInteger datatype provides an integer 3GPP PM measurement result; it consists of the following fields: @@ -2484,7 +2484,7 @@ result; it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measResultNull -************************* +************************ The measResultNull datatype provides a null 3GPP PM measurement result; it consists of the following fields: @@ -2498,7 +2498,7 @@ it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measResultNumber -*************************** +************************** The measResultNumber datatype provides a number 3GPP PM measurement result; it consists of the following fields: @@ -2512,7 +2512,7 @@ result; it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measResultString -*************************** +************************** The measResultString datatype provides a string 3GPP PM measurement result; it consists of the following fields: @@ -2526,7 +2526,7 @@ result; it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measTypesInteger -*************************** +************************** The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results; it consists of the @@ -2540,7 +2540,7 @@ following fields: +----------+--------+----------+----------------------------------------------+ Datatype: measTypesString -************************** +************************* The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results; it consists of the @@ -2554,7 +2554,7 @@ following fields: +----------+-------+----------+-----------------------------------------------+ Datatype: measValues -********************* +******************** The measValues datatype provides 3GPP measurement values; it consists of the following fields: @@ -2583,7 +2583,7 @@ the following fields: +---------+----------------------------------+----------+---------------------+ Datatype: perf3gppFields -************************* +************************ The perf3gppFields datatype defines fields for 3GPP PM format events, based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the @@ -2604,10 +2604,10 @@ fields: +--------------+-----------+----------+---------------------------------------+ ‘pnfRegistration’ Domain Datatypes -++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++ Datatype: pnfRegistrationFields -******************************** +******************************* The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain @@ -2662,10 +2662,10 @@ enumeration; it consists of the following fields: +-----------------+--------+----------+---------------------------------------+ ‘State Change’ Domain Datatypes -++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++ Datatype: stateChangeFields -***************************** +*************************** The stateChangeFields datatype consists of the following fields: @@ -2690,10 +2690,10 @@ The stateChangeFields datatype consists of the following fields: +--------------+--------+----------+------------------------------------------+ ‘Syslog’ Domain Datatypes -++++++++++++++++++++++++++ ++++++++++++++++++++++++++ Datatype: syslogFields -*********************** +********************** The syslogFields datatype consists of the following fields: @@ -2852,10 +2852,10 @@ https://tools.ietf.org/html/rfc5424#section-6 https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml ‘Threshold Crossing Alert’ Domain Datatypes -++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++ Datatype: counter -****************** +***************** The counter datatype consists of the following fields: @@ -2872,7 +2872,7 @@ The counter datatype consists of the following fields: +------------+--------+----------+--------------------------------------------+ Datatype: thresholdCrossingAlertFields -**************************************** +************************************** The thresholdCrossingAlertFields datatype consists of the following fields: @@ -2940,10 +2940,10 @@ Technology Specific Datatypes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Mobile Flow’ Domain Datatypes -++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++ Datatype: gtpPerFlowMetrics -**************************** +*************************** The gtpPerFlowMetrics datatype consists of the following fields: @@ -3146,7 +3146,7 @@ The gtpPerFlowMetrics datatype consists of the following fields: +---------------+--------+----------+-----------------------------------------+ Datatype: mobileFlowFields -*************************** +************************** The mobileFlowFields datatype consists of the following fields: @@ -3259,7 +3259,7 @@ The mobileFlowFields datatype consists of the following fields: +++++++++++++++++++++++++++++++ Datatype: sipSignalingFields -***************************** +**************************** The sipSignalingFields datatype communicates information about sip signaling messages, parameters and signaling state; it consists of the @@ -3300,10 +3300,10 @@ following fields: +--------------+-----------+----------+---------------------------------------+ ‘Voice Quality’ Domain Datatypes -+++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++ Datatype: endOfCallVqmSummaries -********************************* +******************************* The endOfCallVqmSummaries datatype provides end of call voice quality metrics; it consists of the following fields: @@ -3412,7 +3412,7 @@ metrics; it consists of the following fields: +--------------+-------+----------+-------------------------------------------+ Datatype: voiceQualityFields -***************************** +**************************** The voiceQualityFields datatype provides statistics related to customer facing voice products; consists of the following fields: @@ -3451,10 +3451,10 @@ facing voice products; consists of the following fields: +--------------+-------------+----------+-------------------------------------+ Exceptions -^^^^^^^^^^^ +^^^^^^^^^^ RESTful Web Services Exceptions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RESTful services generate and send exceptions to clients in response to invocation errors. Exceptions send HTTP status codes (specified later in @@ -3497,7 +3497,7 @@ exceptions may be defined: service exceptions and policy exceptions. +-----------+---------------+-------------+-----------------------------------+ Service Exceptions -~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~ When a service is not able to process a request, and retrying the request with the same information will also result in a failure, and @@ -3536,7 +3536,7 @@ Service Exceptions Table - Service Exceptions Policy Exceptions -~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~ When a service is not able to complete because the request fails to meet a policy criteria, then the service will issue a fault using the @@ -3586,10 +3586,10 @@ RESTful Web Services Definition ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ REST Operation Overview -~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ REST Operation Summary -+++++++++++++++++++++++ +++++++++++++++++++++++ +---------------------+---------+------------------------------------------+ | **Operation Action**| **HTTP**| Resource URL relative to {ServerRoot}\ | @@ -3692,10 +3692,10 @@ In a future version of the specification, a 1 megabyte limit will become a mandatory requirement. Operation: publishAnyEvent -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~ Functional Behavior -+++++++++++++++++++++ ++++++++++++++++++++ Allows authorized clients to publish any single event to the VES event listener. @@ -3710,7 +3710,7 @@ listener. messages Call Flow -++++++++++ ++++++++++ .. seqdiag:: :caption: ``publishAnyEvent`` Call Flow @@ -3725,7 +3725,7 @@ Call Flow } Input Parameters -+++++++++++++++++ +++++++++++++++++ Header Fields (note: all parameter names shall be treated as case-insensitive): @@ -3781,7 +3781,7 @@ Body Fields: +--------------+--------------+--------------+-------------------------------+ Output Parameters -++++++++++++++++++ ++++++++++++++++++ Header fields: @@ -3817,7 +3817,7 @@ Body Fields (for error responses): +--------------+--------------+----------------+------------------------------+ HTTP Status Codes -++++++++++++++++++ ++++++++++++++++++ +-----+--------------+--------------------------------------------------------+ | Code| Reason Phrase| Description | @@ -3851,10 +3851,10 @@ HTTP Status Codes +-----+--------------+--------------------------------------------------------+ Sample Request and Response -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Sample Request -*************** +************** .. code-block:: http @@ -3902,7 +3902,7 @@ Sample Request Sample Success Response -************************ +*********************** .. code-block:: http @@ -3912,10 +3912,10 @@ Sample Success Response X-LatestVersion: 7.1.1 Sample Error Responses -************************ +********************** Sample Policy Exception -"""""""""""""""""""""""" +""""""""""""""""""""""" .. code-block:: http @@ -3938,7 +3938,7 @@ Sample Policy Exception Sample Service Exception -""""""""""""""""""""""""" +"""""""""""""""""""""""" .. code-block:: http @@ -3964,7 +3964,7 @@ Sample Service Exception } Operation: publishEventBatch -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Functional Behavior +++++++++++++++++++ @@ -3982,7 +3982,7 @@ listener. messages Call Flow -+++++++++++ ++++++++++ .. seqdiag:: :caption: ``publishEventBatch`` Call Flow @@ -3997,7 +3997,7 @@ Call Flow } Input Parameters -+++++++++++++++++ +++++++++++++++++ Header Fields (note: all parameter names shall be treated as case-insensitive): @@ -4053,7 +4053,7 @@ Body Fields: +--------------+--------------+--------------+-------------------------------+ Output Parameters -+++++++++++++++++++ ++++++++++++++++++ Header fields: @@ -4123,10 +4123,10 @@ HTTP Status Codes +-----+--------------+--------------------------------------------------------+ Sample Request and Response -+++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Sample Request -**************** +************** .. code-block:: http @@ -4203,7 +4203,7 @@ Sample Request } Sample Success Response -************************* +*********************** .. code-block:: http @@ -4213,10 +4213,10 @@ Sample Success Response X-LatestVersion: 7.1.1 Sample Error Responses -************************ +********************** Sample Policy Exception -"""""""""""""""""""""""" +""""""""""""""""""""""" .. code-block:: http @@ -4240,7 +4240,7 @@ Sample Policy Exception Sample Service Exception -""""""""""""""""""""""""" +"""""""""""""""""""""""" .. code-block:: http @@ -4267,7 +4267,7 @@ Sample Service Exception Terminology -^^^^^^^^^^^^ +^^^^^^^^^^^ Terminology used in this document is summarized below: @@ -4433,7 +4433,7 @@ It is a stand-alone executable that is loosely-coupled, granular, re-usable, and responsible for a single capability. Appendix: Historical Change Log -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For the latest changes, see the Change Block just before the Table of Contents. diff --git a/docs/Chapter8/ves_5_4_1/VESEventListener.rst b/docs/Chapter8/ves_5_4_1/VESEventListener.rst index d027910..97c3b33 100644 --- a/docs/Chapter8/ves_5_4_1/VESEventListener.rst +++ b/docs/Chapter8/ves_5_4_1/VESEventListener.rst @@ -5,14 +5,13 @@ .. _ves_event_listener_5_4_1: -=================================== Service: *VES Event Listener 5.4.1* -=================================== +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. contents:: Table of Contents Introduction -============ +^^^^^^^^^^^^ This document describes the RESTful interface for the VES (Virtual function Event Streaming) Event Listener. The VES Event Listener is capable of receiving @@ -34,7 +33,7 @@ Format. In future, additional documents may describe other transports which make use of persistent TCP connections for high volumes of streaming events. Event Registration ------------------- +^^^^^^^^^^^^^^^^^^ All events must be compliant with the common event format, but specific events identified by their eventNames, may require that certain fields, which are @@ -48,7 +47,7 @@ what field values may be sent, and any special handling that should be performed on those eventNames. Naming Standards for eventName ------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To prevent naming collisions, eventNames sent as part of the commonEventHeader, should conform to the following naming convention designed @@ -100,7 +99,7 @@ service and resource onboarding to the ONAP Service Design and Creation environment (i.e., SDC). Support for Protocols Other Than HTTPS --------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This API specification describes an HTTPS RESTful interface using the JSON content-type. @@ -111,7 +110,7 @@ format over an RPC protocol to be defined. Both would leverage the JSON schema provided in this document. Versioning ----------- +^^^^^^^^^^ Three types of version numbers supported by this specification: @@ -138,7 +137,7 @@ Three types of version numbers supported by this specification: minor number. Security --------- +^^^^^^^^ Event sources must identify themselves to the VES Event Listener. @@ -226,7 +225,7 @@ A JSON schema describing the Common Event Format is provided below and is reproduced in the tables that follow. Common Event Datatypes ----------------------- +^^^^^^^^^^^^^^^^^^^^^^ Common Event Datatypes ~~~~~~~~~~~~~~~~~~~~~~ @@ -391,7 +390,7 @@ information: +----------------+----------+-------------+---------------------------------------------------------------+ 'Common Event Header'Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Datatype: commonEventHeader ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -448,10 +447,10 @@ enrichment process necessary for efficient internal processing of events received by the VES Event Listener: Technology Independent Datatypes --------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 'Fault'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ Datatype: faultFields ^^^^^^^^^^^^^^^^^^^^^ @@ -481,7 +480,7 @@ The faultFields datatype consists of the following fields: +-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ 'Heartbeat'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ Datatype: heartbeatFields ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -837,7 +836,7 @@ card: +------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ 'Other'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ Datatype: otherFields ^^^^^^^^^^^^^^^^^^^^^ @@ -859,7 +858,7 @@ following fields: +-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ 'State Change'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Datatype: stateChangeFields ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -881,7 +880,7 @@ The stateChangeFields datatype consists of the following fields: +----------------------------+-------------+-------------+----------------------------------------------------------------------------+ 'Syslog'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~ Datatype: syslogFields ^^^^^^^^^^^^^^^^^^^^^^ @@ -1011,7 +1010,7 @@ Example of syslogSData: ; except '=', SP, ']', %d34 (") 'Threshold Crossing Alert'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Datatype: counter ^^^^^^^^^^^^^^^^^ @@ -1073,7 +1072,7 @@ fields: +-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ Technology Specific Datatypes ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 'Mobile Flow' Domain Datatypes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1383,7 +1382,7 @@ Exceptions ========== RESTful Web Services Exceptions -------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RESTful services generate and send exceptions to clients in response to invocation errors. Exceptions send HTTP status codes (specified later in @@ -1410,7 +1409,7 @@ exceptions may be defined: service exceptions and policy exceptions. +------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Service Exceptions ------------------- +^^^^^^^^^^^^^^^^^^ When a service is not able to process a request, and retrying the request with the same information will also result in a failure, and the @@ -1440,7 +1439,7 @@ Listener API are defined below. Table - Service Exceptions Policy Exceptions ------------------ +^^^^^^^^^^^^^^^^^ When a service is not able to complete because the request fails to meet a policy criteria, then the service will issue a fault using the policy @@ -1479,10 +1478,10 @@ RESTful Web Services Definition =============================== REST Operation Overview ------------------------ +^^^^^^^^^^^^^^^^^^^^^^^ REST Operation Summary -~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------+------------+----------------------------------------------------------------------------+ | **Operation Action** | **HTTP** | **Resource URL relative to {ServerRoot}, which is defined in section 3** | @@ -1507,7 +1506,7 @@ without modification (e.g., unmodified v1 clients would not be able to use v2 without error). Buffering of Events -~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~ {ServerRoot} is defined in section 3 of this document, which defines the REST resource URL. One or more FQDNs may be provisioned in an event @@ -1537,7 +1536,7 @@ discard events in a first-in, first-out (FIFO) manner (i.e., discard oldest events first). Operation: publishAnyEvent --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Functional Behavior ~~~~~~~~~~~~~~~~~~~ @@ -1730,7 +1729,7 @@ Sample Service Exception } Operation: publishEventBatch ----------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Functional Behavior ~~~~~~~~~~~~~~~~~~~ diff --git a/docs/Chapter8/ves_7_2/ves_event_listener_7_2.rst b/docs/Chapter8/ves_7_2/ves_event_listener_7_2.rst index 21b1e79..3d52528 100644 --- a/docs/Chapter8/ves_7_2/ves_event_listener_7_2.rst +++ b/docs/Chapter8/ves_7_2/ves_event_listener_7_2.rst @@ -199,7 +199,7 @@ the API spec is provided below: .. _ves_common_event_format_7_2: Common Event Format -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ A JSON schema describing the Common Event Format is provided below and is reproduced in the tables that follow. @@ -231,10 +231,10 @@ Note on extensible fields: capitalized. Common Event Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~ Datatype: arrayOfJsonObject -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ The arrayOfJsonObject datatype provides an array of json objects, each of which is describ ed by name, schema and other meta-information. It @@ -247,7 +247,7 @@ consists of the following fields: +---------------------+------------------+----------+----------------------+ Datatype: arrayOfNamedHashMap -++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++ The arrayOfNamedHashMap datatype provides an array of hashMaps, each of which is associated with a descriptive name. It consists of the @@ -260,7 +260,7 @@ following fields: +---------------------+------------------+-----------+-----------------------+ Datatype: event -++++++++++++++++ ++++++++++++++++ The event datatype consists of the following fields which constitute the ‘root level’ of the common event format: @@ -315,7 +315,7 @@ The event datatype consists of the following fields which constitute the +--------------+--------------+-----------+-----------------------------------+ Datatype: eventList -++++++++++++++++++++ ++++++++++++++++++++ The eventList datatype consists of the following fields: @@ -326,7 +326,7 @@ The eventList datatype consists of the following fields: +-------------+-------------+----------+-------------------+ Datatype: hashMap -+++++++++++++++++++ ++++++++++++++++++ The hashMap datatype is an ‘associative array’, which is an unordered collection of key-value pairs of the form "key": "value", where each key @@ -365,7 +365,7 @@ the schema: +--------------+--------------+-----------+----------------------------------+ Datatype: jsonObjectInstance -+++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++ The jsonObjectInstance datatype provides meta-information about an instance of a jsonObject along with the actual object instance: @@ -392,7 +392,7 @@ instance of a jsonObject along with the actual object instance: +----------------+------------+----------+-----------------------------------+ Datatype: key -+++++++++++++++ ++++++++++++++ The key datatype is a tuple which provides the name of a key along with its value and relative order; it consists of the following fields: @@ -409,7 +409,7 @@ its value and relative order; it consists of the following fields: +----------+---------+-----------+-------------------------------------------+ Datatype: namedHashMap -++++++++++++++++++++++++ +++++++++++++++++++++++ The namedHashMap datatype is a hashMap which is associated with and described by a name; it consists of the following fields: @@ -424,7 +424,7 @@ described by a name; it consists of the following fields: +---------+---------+-----------+--------------------------------------------+ Datatype: requestError -+++++++++++++++++++++++ +++++++++++++++++++++++ The requestError datatype defines the standard request error data structure: @@ -454,7 +454,7 @@ structure: +-----------+--------+-----------+-------------------------------------------+ Datatype: vendorNfNameFields -+++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++ The vendorNfNameFields provides vendor, nf and nfModule identifying information: @@ -477,7 +477,7 @@ Common Event Header Data Types .. _ves_common_event_header_7_2: Datatype: commonEventHeader -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ The commonEventHeader datatype consists of the following fields common to all events: @@ -843,10 +843,10 @@ Rules: Technology Independent Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ‘Fault’ Domain Datatypes -+++++++++++++++++++++++++ +++++++++++++++++++++++++ Datatype: faultFields ********************* @@ -919,7 +919,7 @@ The faultFields datatype consists of the following fields: +-----------------+---------+-----------+-------------------------------------+ Heartbeat’ Domain Datatypes -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Datatype: heartbeatFields ************************* @@ -943,7 +943,7 @@ specific to heartbeat events; it consists of the following fields: +---------------+---------+-----------+---------------------------------------+ ‘Measurements’ Domain Datatypes -++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++ Note: NFs are required to report exactly one Measurement event per period per sourceName. @@ -964,7 +964,7 @@ measurementInterval: +------------------+-----------+----------+--------------------------------+ Datatype: cpuUsage -******************* +****************** The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: @@ -1034,7 +1034,7 @@ consists of the following fields: +------------+--------+-----------+-------------------------------------------+ Datatype: diskUsage -******************** +******************* The diskUsage datatype defines the usage of a disk and consists of the following fields: @@ -1298,7 +1298,7 @@ following fields: +-------------+-------+----------+--------------------------------------------+ Datatype: filesystemUsage -*************************** +************************* The filesystemUsage datatype consists of the following fields: @@ -1327,7 +1327,7 @@ The filesystemUsage datatype consists of the following fields: +-------------+--------+-----------+------------------------------------------+ Datatype: hugePages -******************** +******************* The hugePages datatype provides metrics on system hugePages; it consists of the following fields: @@ -1351,7 +1351,7 @@ of the following fields: +--------------------+--------+----------+------------------------------------+ Datatype: ipmi (Intelligent Platform Management Interface) -*********************************************************** +********************************************************** The ipmi datatype provides intelligent platform management interface metrics; it consists of the following fields: @@ -1406,7 +1406,7 @@ metrics; it consists of the following fields: +-------------+---------------------+-----------+-----------------------------+ Datatype: ipmiBaseboardTemperature -************************************ +********************************** The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: @@ -1423,7 +1423,7 @@ which describe ipmi baseboard temperature metrics: +-------------+--------+-----------+------------------------------------------+ Datatype: ipmiBaseboardVoltageRegulator -***************************************** +*************************************** The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: @@ -1439,7 +1439,7 @@ fields which describe ipmi baseboard voltage regulator metrics: +--------------------+-------+----------+-------------------------------------+ Datatype: ipmiBattery -********************** +********************* The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: @@ -1455,7 +1455,7 @@ ipmi battery metrics: +---------------------+--------+----------+------------------------------+ Datatype: ipmiFan -******************** +***************** The ipmiFan datatype consists of the following fields which describe ipmi fan metrics: @@ -1469,7 +1469,7 @@ ipmi fan metrics: +--------------+-------+----------+-------------------------------------------+ Datatype: ipmiGlobalAggregateTemperatureMargin -*********************************************** +********************************************** The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: @@ -1490,7 +1490,7 @@ following fields: +-------------+-------+----------+--------------------------------------------+ Datatype: ipmiHsbp -******************* +****************** The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: @@ -1506,7 +1506,7 @@ consists of the following fields: +------------+-------+----------+---------------------------------------------+ Datatype: ipmiNic -****************** +***************** The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: @@ -1522,7 +1522,7 @@ consists of the following fields: +------------+-------+----------+---------------------------------------------+ Datatype: ipmiPowerSupply -************************** +************************* The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: @@ -1551,7 +1551,7 @@ consists of the following fields: +-----------+-------+----------+----------------------------------------------+ Datatype: ipmiProcessor -************************ +*********************** The ipmiProcessor datatype provides ipmi processor metrics; it consists of the following fields: @@ -1579,7 +1579,7 @@ of the following fields: +------------+------------------+-----------+---------------------------------+ Datatype: latencyBucketMeasure -******************************* +****************************** The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket: @@ -1601,7 +1601,7 @@ describe the number of counts falling within a defined latency bucket: +-----------+-------+----------+----------------------------------------------+ Datatype: load -**************** +************** The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg; it consists of the following fields: @@ -1626,7 +1626,7 @@ obtained using /proc/loadavg; it consists of the following fields: +----------+-------+----------+-----------------------------------------------+ Datatype: machineCheckException -******************************** +******************************* The machineCheckException datatype describes machine check exceptions; it consists of the following fields: @@ -1663,7 +1663,7 @@ it consists of the following fields: +-------------+-------+----------+--------------------------------------------+ Datatype: measurementFields -**************************** +*************************** The ``measurementFields`` datatype consists of the following fields: @@ -1790,7 +1790,7 @@ information, please see the VES Event Registration specification and in particular the ``aggregationRole``, ``castTo``, and ``isHomogeneous`` keywords. Datatype: memoryUsage -********************** +********************* The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: @@ -1861,7 +1861,7 @@ and consists of the following fields: +-----------+-------+----------+----------------------------------------------+ Datatype: nicPerformance -************************* +************************ The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual @@ -2042,7 +2042,7 @@ network interface card: +----------------+-------+----------+-----------------------------------------+ Datatype: processorDimmAggregateThermalMargin -********************************************** +********************************************* The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module @@ -2062,7 +2062,7 @@ aggregate thermal margin metrics; it consists of the following fields: +-----------------+-------+----------+----------------------------------------+ Datatype: processStats -*********************** +********************** The processStats datatype provides metrics on system processes; it consists of the following fields: @@ -2097,10 +2097,10 @@ consists of the following fields: +-----------+-------+----------+----------------------------------------------+ ‘Notification’ Domain Datatypes -++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++ Datatype: notificationFields -****************************** +**************************** The notificationFields datatype consists of the following fields: @@ -2170,10 +2170,10 @@ in 3GPP TS 28.550. The array contains the following key value pairs: Other notificationFields are not used for fileReady. ‘Other’ Domain Datatypes -+++++++++++++++++++++++++ +++++++++++++++++++++++++ Datatype: otherFields -********************** +********************* The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration; it consists @@ -2197,10 +2197,10 @@ of the following fields: +-------------+-------------+----------+--------------------------------------+ ‘perf3gpp’ Domain Datatypes -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Datatype: measDataCollection -***************************** +**************************** The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format; it consists of the following @@ -2234,7 +2234,7 @@ fields: +----------------+---------+----------+---------------------------------------+ Datatype: measInfo -******************** +****************** The measInfo datatype provides measurement information; it consists of the following fields: @@ -2258,7 +2258,7 @@ the following fields: +-------+--------------------------+----------+-------------------------------+ Datatype: measInfoIdInteger -**************************** +*************************** The measInfoIdInteger datatype provides an integer measurement group identifier; it consists of the following fields: @@ -2270,7 +2270,7 @@ identifier; it consists of the following fields: +---------------+---------+----------+--------------------------------------+ Datatype: measInfoIdString -*************************** +************************** The measInfoIdString datatype provides a string measurement group identifier; it consists of the following fields: @@ -2282,7 +2282,7 @@ identifier; it consists of the following fields: +---------------+-----------+----------+--------------------------------------+ Datatype: measResultInteger -**************************** +*************************** The measResultInteger datatype provides an integer 3GPP PM measurement result; it consists of the following fields: @@ -2296,7 +2296,7 @@ result; it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measResultNull -************************* +************************ The measResultNull datatype provides a null 3GPP PM measurement result; it consists of the following fields: @@ -2310,7 +2310,7 @@ it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measResultNumber -*************************** +************************** The measResultNumber datatype provides a number 3GPP PM measurement result; it consists of the following fields: @@ -2324,7 +2324,7 @@ result; it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measResultString -*************************** +************************** The measResultString datatype provides a string 3GPP PM measurement result; it consists of the following fields: @@ -2338,7 +2338,7 @@ result; it consists of the following fields: +----------+-----------+-------------+------------------------------------+ Datatype: measTypesInteger -*************************** +************************** The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results; it consists of the @@ -2352,7 +2352,7 @@ following fields: +----------+--------+----------+----------------------------------------------+ Datatype: measTypesString -************************** +************************* The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results; it consists of the @@ -2366,7 +2366,7 @@ following fields: +----------+-------+----------+-----------------------------------------------+ Datatype: measValues -********************* +******************** The measValues datatype provides 3GPP measurement values; it consists of the following fields: @@ -2395,7 +2395,7 @@ the following fields: +---------+----------------------------------+----------+---------------------+ Datatype: perf3gppFields -************************* +************************ The perf3gppFields datatype defines fields for 3GPP PM format events, based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the @@ -2416,10 +2416,10 @@ fields: +--------------+-----------+----------+---------------------------------------+ ‘pnfRegistration’ Domain Datatypes -++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++ Datatype: pnfRegistrationFields -******************************** +******************************* The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain @@ -2474,10 +2474,10 @@ enumeration; it consists of the following fields: +-----------------+--------+----------+---------------------------------------+ ‘State Change’ Domain Datatypes -++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++ Datatype: stateChangeFields -***************************** +*************************** The stateChangeFields datatype consists of the following fields: @@ -2502,10 +2502,10 @@ The stateChangeFields datatype consists of the following fields: +--------------+--------+----------+------------------------------------------+ ‘StndDefined’ Domain Datatypes -++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++ Datatype: stndDefinedFields -***************************** +*************************** The stndDefinedFields datatype consists of the following fields: @@ -2526,7 +2526,7 @@ The stndDefinedFields datatype consists of the following fields: +--------------+--------+----------+------------------------------------------+ Additional rules, when using stndDefined domain -************************************************ +*********************************************** Following rules shall be followed, when using the StndDefined domain: @@ -2544,10 +2544,10 @@ then each and every event within eventBatch must have exactly the same VES.commonEventHeader.stndDefinedNamespace set. ‘Syslog’ Domain Datatypes -++++++++++++++++++++++++++ ++++++++++++++++++++++++++ Datatype: syslogFields -*********************** +********************** The syslogFields datatype consists of the following fields: @@ -2706,10 +2706,10 @@ https://tools.ietf.org/html/rfc5424#section-6 https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml ‘Threshold Crossing Alert’ Domain Datatypes -++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++ Datatype: counter -****************** +***************** The counter datatype consists of the following fields: @@ -2726,7 +2726,7 @@ The counter datatype consists of the following fields: +------------+--------+----------+--------------------------------------------+ Datatype: thresholdCrossingAlertFields -**************************************** +************************************** The thresholdCrossingAlertFields datatype consists of the following fields: @@ -2794,10 +2794,10 @@ Technology Specific Datatypes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Mobile Flow’ Domain Datatypes -++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++ Datatype: gtpPerFlowMetrics -**************************** +*************************** The gtpPerFlowMetrics datatype consists of the following fields: @@ -3000,7 +3000,7 @@ The gtpPerFlowMetrics datatype consists of the following fields: +---------------+--------+----------+-----------------------------------------+ Datatype: mobileFlowFields -*************************** +************************** The mobileFlowFields datatype consists of the following fields: @@ -3113,7 +3113,7 @@ The mobileFlowFields datatype consists of the following fields: +++++++++++++++++++++++++++++++ Datatype: sipSignalingFields -***************************** +**************************** The sipSignalingFields datatype communicates information about sip signaling messages, parameters and signaling state; it consists of the @@ -3154,10 +3154,10 @@ following fields: +--------------+-----------+----------+---------------------------------------+ ‘Voice Quality’ Domain Datatypes -+++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++ Datatype: endOfCallVqmSummaries -********************************* +******************************* The endOfCallVqmSummaries datatype provides end of call voice quality metrics; it consists of the following fields: @@ -3266,7 +3266,7 @@ metrics; it consists of the following fields: +--------------+-------+----------+-------------------------------------------+ Datatype: voiceQualityFields -***************************** +**************************** The voiceQualityFields datatype provides statistics related to customer facing voice products; consists of the following fields: @@ -3568,10 +3568,10 @@ Listener API are defined below. Table - Policy Exceptions REST Operation Overview -~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ REST Operation Summary -+++++++++++++++++++++++ +++++++++++++++++++++++ +---------------------+---------+------------------------------------------+ | **Operation Action**| **HTTP**| Resource URL relative to {ServerRoot}\ | @@ -3625,10 +3625,10 @@ In a future version of the specification, a 1 megabyte limit will become a mandatory requirement. Operation: publishAnyEvent -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~ Functional Behavior -+++++++++++++++++++++ ++++++++++++++++++++ Allows authorized clients to publish any single event to the VES event listener. @@ -3643,7 +3643,7 @@ listener. messages Call Flow -++++++++++ ++++++++++ .. seqdiag:: :caption: ``publishAnyEvent`` Call Flow @@ -3658,7 +3658,7 @@ Call Flow } Input Parameters -+++++++++++++++++ +++++++++++++++++ Header Fields (note: all parameter names shall be treated as case-insensitive): @@ -3715,7 +3715,7 @@ Body Fields: +--------------+--------------+--------------+-------------------------------+ Output Parameters -++++++++++++++++++ ++++++++++++++++++ Header fields: @@ -3751,7 +3751,7 @@ Body Fields (for error responses): +--------------+--------------+----------------+------------------------------+ HTTP Status Codes -++++++++++++++++++ ++++++++++++++++++ +-----+--------------+--------------------------------------------------------+ | Code| Reason Phrase| Description | @@ -3787,10 +3787,10 @@ HTTP Status Codes +-----+--------------+--------------------------------------------------------+ Sample Request and Response -++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Sample Request -*************** +************** .. code-block:: http @@ -3838,7 +3838,7 @@ Sample Request Sample Success Response -************************ +*********************** .. code-block:: http @@ -3848,10 +3848,10 @@ Sample Success Response X-LatestVersion: 7.2 Sample Error Responses -************************ +********************** Sample Policy Exception -"""""""""""""""""""""""" +""""""""""""""""""""""" .. code-block:: http @@ -3874,7 +3874,7 @@ Sample Policy Exception Sample Service Exception -""""""""""""""""""""""""" +"""""""""""""""""""""""" .. code-block:: http @@ -3900,7 +3900,7 @@ Sample Service Exception } Operation: publishEventBatch -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Functional Behavior +++++++++++++++++++ @@ -3922,7 +3922,7 @@ acknowledgement from the VES Event Listener is for the ``publishEventBatch`` and not individual events within the ``publishEventBatch``. Call Flow -+++++++++++ ++++++++++ .. seqdiag:: :caption: ``publishEventBatch`` Call Flow @@ -3937,7 +3937,7 @@ Call Flow } Input Parameters -+++++++++++++++++ +++++++++++++++++ Header Fields (note: all parameter names shall be treated as case-insensitive): @@ -3996,7 +3996,7 @@ Body Fields: +--------------+--------------+--------------+-------------------------------+ Output Parameters -+++++++++++++++++++ ++++++++++++++++++ Header fields: @@ -4066,10 +4066,10 @@ HTTP Status Codes +-----+--------------+--------------------------------------------------------+ Sample Request and Response -+++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++ Sample Request -**************** +************** .. code-block:: http @@ -4146,7 +4146,7 @@ Sample Request } Sample Success Response -************************* +*********************** .. code-block:: http @@ -4156,10 +4156,10 @@ Sample Success Response X-LatestVersion: 7.2 Sample Error Responses -************************ +********************** Sample Policy Exception -"""""""""""""""""""""""" +""""""""""""""""""""""" .. code-block:: http @@ -4183,7 +4183,7 @@ Sample Policy Exception Sample Service Exception -""""""""""""""""""""""""" +"""""""""""""""""""""""" .. code-block:: http @@ -4210,7 +4210,7 @@ Sample Service Exception Terminology -^^^^^^^^^^^^ +^^^^^^^^^^^ Terminology used in this document is summarized below: @@ -4369,7 +4369,7 @@ It is a stand-alone executable that is loosely-coupled, granular, re-usable, and responsible for a single capability. Appendix: Historical Change Log -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For the latest changes, see the Change Block just before the Table of Contents. diff --git a/docs/changes-by-section-casablanca.rst b/docs/changes-by-section-casablanca.rst index 76dfb86..713321e 100644 --- a/docs/changes-by-section-casablanca.rst +++ b/docs/changes-by-section-casablanca.rst @@ -14,7 +14,7 @@ Requirement Changes Introduced in Casablanca -======================================================== +-------------------------------------------- This document summarizes the requirement changes by section that were introduced between the Beijing release and @@ -25,7 +25,7 @@ navigate to the :depth: 2 Summary of Changes ------------------- +^^^^^^^^^^^^^^^^^^ * **Requirements Added:** 102 * **Requirements Changed:** 232 @@ -33,7 +33,7 @@ Summary of Changes Configuration Management > Ansible Standards and Capabilities > xNF Configuration via Ansible Requirements > Ansible Client Requirements ----------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -175,7 +175,7 @@ Requirements Changed Configuration Management > Ansible Standards and Capabilities > xNF Configuration via Ansible Requirements > Ansible Playbook Requirements ------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -312,7 +312,7 @@ Requirements Changed Configuration Management > Chef Standards and Capabilities > xNF Configuration via Chef Requirements > Chef Roles/Requirements ------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -332,7 +332,7 @@ Requirements Changed Configuration Management > Controller Interactions With xNF > Configuration Commands ------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -382,7 +382,7 @@ Requirements Changed Configuration Management > Controller Interactions With xNF > HealthCheck and Failure Related Commands ------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -397,7 +397,7 @@ Requirements Changed Configuration Management > Controller Interactions With xNF > Lifecycle Management Related Commands ---------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -481,7 +481,7 @@ Requirements Changed Configuration Management > NETCONF Standards and Capabilities > xNF Configuration via NETCONF Requirements > NETCONF Server Requirements ----------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -576,7 +576,7 @@ Requirements Changed Contrail Resource Parameters > Contrail Network Parameters > External Networks ------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -599,7 +599,7 @@ Requirements Changed Heat > Cinder Volumes ---------------------- +^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -617,7 +617,7 @@ Requirements Removed Heat > Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > metadata --------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -633,7 +633,7 @@ Requirements Removed Heat > Heat Template Constructs > Heat Files Support (get_file) ---------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -649,7 +649,7 @@ Requirements Removed Heat > Heat Template Constructs > Nested Heat Template Requirements -------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -665,7 +665,7 @@ Requirements Removed Heat > Networking > External Networks -------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -682,7 +682,7 @@ Requirements Removed Heat > Networking > Internal Networks -------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -700,7 +700,7 @@ Requirements Removed Heat > ONAP Resource ID and Parameter Naming Convention > Contrail Resource Parameters > Contrail Network Parameters > External Networks ----------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -717,7 +717,7 @@ Requirements Removed Heat > ONAP Resource ID and Parameter Naming Convention > Resource: OS::Nova::Server – Metadata Parameters > vm_role --------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -740,7 +740,7 @@ Requirements Removed Heat > ONAP Support of Environment Files ----------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -772,7 +772,7 @@ Requirements Removed Monitoring & Management > Data Structure Specification of the Event Record --------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -823,7 +823,7 @@ Requirements Added Monitoring & Management > Event Records - Data Structure Description > Common Event Header ------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -856,7 +856,7 @@ Requirements Added Monitoring & Management > Event Records - Data Structure Description > Miscellaneous ------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -893,7 +893,7 @@ Requirements Added Monitoring & Management > Monitoring & Management Requirements > Asynchronous and Synchronous Data Delivery ------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -909,7 +909,7 @@ Requirements Added Monitoring & Management > Monitoring & Management Requirements > Bulk Performance Measurement ---------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -941,7 +941,7 @@ Requirements Added Monitoring & Management > Monitoring & Management Requirements > Google Protocol Buffers (GPB) ----------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -982,7 +982,7 @@ Requirements Added Monitoring & Management > Monitoring & Management Requirements > JSON ---------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1001,7 +1001,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Reporting Frequency ------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1017,7 +1017,7 @@ Requirements Added Monitoring & Management > Monitoring & Management Requirements > VNF telemetry via standardized interface ---------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1046,7 +1046,7 @@ Requirements Removed Monitoring & Management > Transports and Protocols Supporting Resource Interfaces ---------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1079,7 +1079,7 @@ Requirements Added Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > Bulk Telemetry Transmission ---------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1096,7 +1096,7 @@ Requirements Added Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > xNF Telemetry using Google Protocol Buffers -------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1114,7 +1114,7 @@ Requirements Added Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > xNF Telemetry using VES/JSON Model ----------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1132,7 +1132,7 @@ Requirements Added ONAP Heat Cinder Volumes ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1155,7 +1155,7 @@ Requirements Added ONAP Heat Heat Template Constructs > Heat Files Support (get_file) ------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1203,7 +1203,7 @@ Requirements Changed ONAP Heat Heat Template Constructs > Nested Heat Templates > Nested Heat Template Requirements ----------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1220,7 +1220,7 @@ Requirements Added ONAP Heat Networking > External Networks ----------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1236,7 +1236,7 @@ Requirements Changed ONAP Heat Networking > Internal Networks ----------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1269,7 +1269,7 @@ Requirements Changed ONAP Heat Orchestration Template Format ---------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1285,7 +1285,7 @@ Requirements Added ONAP Heat Orchestration Template Format > Environment File Format ------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1317,7 +1317,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters --------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1343,7 +1343,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters > constraints ----------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1406,7 +1406,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters > default ------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1422,7 +1422,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters > type ---------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1444,7 +1444,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources -------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1460,7 +1460,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > deletion_policy -------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1476,7 +1476,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > external_id ---------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1492,7 +1492,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > metadata ------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1508,7 +1508,7 @@ Requirements Added ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > properties --------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1525,7 +1525,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Base Modules ------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1554,7 +1554,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Cinder Volume Modules ---------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1580,7 +1580,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Incremental Modules -------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1597,7 +1597,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Nested Heat file ----------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1614,7 +1614,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP VNF Modularity Overview -------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1679,7 +1679,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > Output Parameters > ONAP Volume Module Output Parameters ------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1709,7 +1709,7 @@ Requirements Changed ONAP Heat VNF Modularity ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1739,7 +1739,7 @@ Requirements Changed ONAP Output Parameter Names > Predefined Output Parameters > OAM Management IP Addresses ----------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1790,7 +1790,7 @@ Requirements Changed ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Capability Types ----------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1830,7 +1830,7 @@ Requirements Added ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Data Types ----------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1858,7 +1858,7 @@ Requirements Added ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > General -------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1942,7 +1942,7 @@ Requirements Added ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Interface Types ---------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1960,7 +1960,7 @@ Requirements Added ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Relationship Types ------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1986,7 +1986,7 @@ Requirements Added ONAP TOSCA VNFD Requirements > VNF CSAR Package > VNF Package Contents ----------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2053,7 +2053,7 @@ Requirements Added ONAP TOSCA VNFD Requirements > VNF CSAR Package > VNF Package Structure and Format ----------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2082,7 +2082,7 @@ Requirements Added PNF Plug and Play > PNF Plug and Play -------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2333,7 +2333,7 @@ Requirements Added Resource IDs ------------- +^^^^^^^^^^^^ Requirements Changed @@ -2403,7 +2403,7 @@ Requirements Changed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::VirtualNetwork ------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2433,7 +2433,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::Net ----------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2456,7 +2456,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Introduction > Items to Note ------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2504,7 +2504,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address > VIP Assignment, External Networks, Supported by Automation ------------------------------------------------------------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2564,7 +2564,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: fixed_ips, Map Property: ip_address ----------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2878,7 +2878,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: fixed_ips, Map Property: subnet ------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3036,7 +3036,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: network ------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3107,7 +3107,7 @@ Requirements Changed Resource: OS::Nova::Server - Parameters ---------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -3132,7 +3132,7 @@ Requirements Added Resource: OS::Nova::Server - Parameters > Property: Name --------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -3184,7 +3184,7 @@ Requirements Changed Resource: OS::Nova::Server - Parameters > Property: Name > Contrail Issue with Values for OS::Nova::Server Property Name ------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3205,7 +3205,7 @@ Requirements Changed Resource: OS::Nova::Server - Parameters > Property: availability_zone ---------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3235,7 +3235,7 @@ Requirements Changed Resource: OS::Nova::Server - Parameters > Property: flavor ----------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -3251,7 +3251,7 @@ Requirements Added Resource: OS::Nova::Server - Parameters > Property: image ---------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -3267,7 +3267,7 @@ Requirements Added Resource: OS::Nova::Server Metadata Parameters > environment_context --------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3305,7 +3305,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > vf_module_id -------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3364,7 +3364,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > vf_module_index ----------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3434,7 +3434,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > vf_module_name ---------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3493,7 +3493,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > vm_role --------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3553,7 +3553,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > vnf_id -------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3612,7 +3612,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > vnf_name ---------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3669,7 +3669,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > workload_context ------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3718,7 +3718,7 @@ Requirements Changed VNF On-boarding and package management > Resource Description -------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -3742,7 +3742,7 @@ Requirements Added VNF On-boarding and package management > Testing ------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3758,7 +3758,7 @@ Requirements Changed VNF Resiliency > Virtual Function - Container Recovery Requirements -------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -3780,7 +3780,7 @@ Requirements Added VNF Security > VNF API Security Requirements --------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3898,7 +3898,7 @@ Requirements Removed VNF Security > VNF Cryptography Requirements --------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -3944,7 +3944,7 @@ Requirements Changed VNF Security > VNF Data Protection Requirements ------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -4054,7 +4054,7 @@ Requirements Removed VNF Security > VNF General Security Requirements ------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -4382,7 +4382,7 @@ Requirements Removed VNF Security > VNF Identity and Access Management Requirements --------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -4763,7 +4763,7 @@ Requirements Removed VNF Security > VNF Security Analytics Requirements --------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -5004,7 +5004,7 @@ Requirements Removed {network-role} --------------- +^^^^^^^^^^^^^^ Requirements Changed @@ -5041,7 +5041,7 @@ Requirements Changed {vm-type} ---------- +^^^^^^^^^ Requirements Changed diff --git a/docs/changes-by-section-dublin.rst b/docs/changes-by-section-dublin.rst index ad700c3..5ec9124 100644 --- a/docs/changes-by-section-dublin.rst +++ b/docs/changes-by-section-dublin.rst @@ -14,7 +14,7 @@ Requirement Changes Introduced in Dublin -======================================================== +---------------------------------------- This document summarizes the requirement changes by section that were introduced between the Casablanca release and @@ -25,7 +25,7 @@ navigate to the :depth: 2 Summary of Changes ------------------- +^^^^^^^^^^^^^^^^^^ * **Requirements Added:** 64 * **Requirements Changed:** 275 @@ -33,8 +33,7 @@ Summary of Changes Configuration Management > Ansible Standards and Capabilities > VNF or PNF Configuration via Ansible Requirements > Ansible Client Requirements ------------------------------------------------------------------------------------------------------------------------------------------------ - +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed ~~~~~~~~~~~~~~~~~~~~ @@ -180,8 +179,7 @@ Requirements Changed Configuration Management > Ansible Standards and Capabilities > VNF or PNF Configuration via Ansible Requirements > Ansible Playbook Requirements -------------------------------------------------------------------------------------------------------------------------------------------------- - +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed ~~~~~~~~~~~~~~~~~~~~ @@ -341,7 +339,7 @@ Requirements Changed Configuration Management > Chef Standards and Capabilities > VNF or PNF Configuration via Chef Requirements > Chef Client Requirements --------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -384,7 +382,7 @@ Requirements Changed Configuration Management > Chef Standards and Capabilities > VNF or PNF Configuration via Chef Requirements > Chef Roles/Requirements -------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -501,7 +499,7 @@ Requirements Changed Configuration Management > Controller Interactions With VNF or PNF > Configuration Commands -------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -551,7 +549,7 @@ Requirements Changed Configuration Management > Controller Interactions With VNF or PNF > HealthCheck and Failure Related Commands -------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -566,7 +564,7 @@ Requirements Changed Configuration Management > Controller Interactions With VNF or PNF > Lifecycle Management Related Commands ----------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -646,7 +644,7 @@ Requirements Changed Configuration Management > NETCONF Standards and Capabilities > VNF or PNF Configuration via NETCONF Requirements > Configuration Management --------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -670,7 +668,7 @@ Requirements Changed Configuration Management > NETCONF Standards and Capabilities > VNF or PNF Configuration via NETCONF Requirements > NETCONF Server Requirements ------------------------------------------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1227,7 +1225,7 @@ Requirements Changed Configuration Management > NETCONF Standards and Capabilities > xNF Configuration via NETCONF Requirements > NETCONF Server Requirements ----------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -1244,7 +1242,7 @@ Requirements Removed Configuration Management > VNF or PNF REST APIs > REST APIs ------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1266,7 +1264,7 @@ Requirements Changed Contrail Resource Parameters > OS::ContrailV2::VirtualMachineInterface Property virtual_machine_interface_allowed_address_pairs > External Networks ---------------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1407,7 +1405,7 @@ Requirements Added Contrail Resource Parameters > OS::ContrailV2::VirtualMachineInterface Property virtual_machine_interface_allowed_address_pairs > Internal Networks ---------------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1510,7 +1508,7 @@ Requirements Added Contrail Resource Parameters > Resource OS::ContrailV2::InstanceIp > Resource OS::ContrailV2::InstanceIp Property instance_ip_address -------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1865,7 +1863,7 @@ Requirements Added Contrail Resource Parameters > Resource OS::ContrailV2::InstanceIp > Resource OS::ContrailV2::InstanceIp Property subnet_uuid ------------------------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2023,7 +2021,7 @@ Requirements Added Monitoring & Management > Data Structure Specification of the Event Record --------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2074,7 +2072,7 @@ Requirements Changed Monitoring & Management > Event Records - Data Structure Description > Common Event Header ------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2107,7 +2105,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Addressing and Delivery Protocol -------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2197,7 +2195,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Asynchronous and Synchronous Data Delivery ------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2295,7 +2293,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Bulk Performance Measurement ---------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2341,7 +2339,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Google Protocol Buffers (GPB) ----------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2382,7 +2380,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > JSON ---------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2401,7 +2399,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Reporting Frequency ------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2449,7 +2447,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Security -------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2520,7 +2518,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > VNF telemetry via standardized interface ---------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2536,7 +2534,7 @@ Requirements Changed Monitoring & Management > Transports and Protocols Supporting Resource Interfaces ---------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2569,7 +2567,7 @@ Requirements Changed Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > Bulk Telemetry Transmission ---------------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -2586,7 +2584,7 @@ Requirements Changed Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > VNF or PNF Telemetry using Google Protocol Buffers --------------------------------------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -2604,7 +2602,7 @@ Requirements Changed Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > VNF or PNF Telemetry using VES/JSON Model ------------------------------------------------------------------------------------------------------------------------------ + Requirements Changed @@ -2622,7 +2620,7 @@ Requirements Changed ONAP Heat Heat Template Constructs > Heat Files Support (get_file) ------------------------------------------------------------------- + Requirements Removed @@ -2641,7 +2639,7 @@ Requirements Removed ONAP Heat Heat Template Constructs > Key Pairs ----------------------------------------------- + Requirements Added @@ -2661,7 +2659,7 @@ Requirements Added ONAP Heat Heat Template Constructs > Nested Heat Templates > Nested Heat Template Requirements ----------------------------------------------------------------------------------------------- + Requirements Added @@ -2729,7 +2727,7 @@ Requirements Removed ONAP Heat Networking > External Networks ----------------------------------------- + Requirements Removed @@ -2746,7 +2744,7 @@ Requirements Removed ONAP Heat Networking > Internal Networks ----------------------------------------- + Requirements Changed @@ -2828,7 +2826,7 @@ Requirements Removed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters > constraints ----------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -2854,7 +2852,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > properties --------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -2884,7 +2882,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Base Modules ------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -2914,7 +2912,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Cinder Volume Modules ---------------------------------------------------------------------------------------------------------------- + Requirements Added @@ -2937,7 +2935,7 @@ Requirements Added ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Incremental Modules -------------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -2954,7 +2952,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Nested Heat file ----------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -2971,7 +2969,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP VNF Modularity Overview -------------------------------------------------------------------------- + Requirements Changed @@ -3015,7 +3013,7 @@ Requirements Removed ONAP Heat Orchestration Templates Overview > ONAP VNF On-Boarding ------------------------------------------------------------------ + Requirements Added @@ -3042,7 +3040,7 @@ Requirements Added ONAP Heat Orchestration Templates Overview > Output Parameters > ONAP Base Module Output Parameters ---------------------------------------------------------------------------------------------------- + Requirements Changed @@ -3068,7 +3066,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > Output Parameters > ONAP Volume Module Output Parameters ------------------------------------------------------------------------------------------------------ + Requirements Changed @@ -3104,7 +3102,7 @@ Requirements Changed ONAP Heat Support of Environment Files --------------------------------------- + Requirements Added @@ -3123,7 +3121,7 @@ Requirements Added ONAP Heat VNF Modularity ------------------------- + Requirements Changed @@ -3153,7 +3151,7 @@ Requirements Changed ONAP TOSCA VNFD Requirements > VNF CSAR Package > VNF Package Contents ----------------------------------------------------------------------- + Requirements Removed @@ -3177,7 +3175,7 @@ Requirements Removed ONAP TOSCA VNFD or PNFD Requirements > TOSCA PNF Descriptor > Capability Types ------------------------------------------------------------------------------- + Requirements Added @@ -3195,7 +3193,7 @@ Requirements Added ONAP TOSCA VNFD or PNFD Requirements > TOSCA PNF Descriptor > Data Types ------------------------------------------------------------------------- + Requirements Added @@ -3223,7 +3221,7 @@ Requirements Added ONAP TOSCA VNFD or PNFD Requirements > TOSCA PNF Descriptor > General ---------------------------------------------------------------------- + Requirements Added @@ -3240,7 +3238,7 @@ Requirements Added ONAP TOSCA VNFD or PNFD Requirements > TOSCA PNF Descriptor > Node Types ------------------------------------------------------------------------- + Requirements Added @@ -3262,7 +3260,7 @@ Requirements Added ONAP TOSCA VNFD or PNFD Requirements > TOSCA PNF Descriptor > Policy Types --------------------------------------------------------------------------- + Requirements Added @@ -3280,7 +3278,7 @@ Requirements Added ONAP TOSCA VNFD or PNFD Requirements > TOSCA PNF Descriptor > Relationship Types --------------------------------------------------------------------------------- + Requirements Added @@ -3298,7 +3296,7 @@ Requirements Added ONAP TOSCA VNFD or PNFD Requirements > TOSCA VNF Descriptor > General ---------------------------------------------------------------------- + Requirements Changed @@ -3315,7 +3313,7 @@ Requirements Changed ONAP TOSCA VNFD or PNFD Requirements > VNF or PNF CSAR Package > VNF Package Contents -------------------------------------------------------------------------------------- + Requirements Added @@ -3439,7 +3437,7 @@ Requirements Changed ONAP TOSCA VNFD or PNFD Requirements > VNF or PNF CSAR Package > VNF Package Structure and Format -------------------------------------------------------------------------------------------------- + Requirements Added @@ -3478,7 +3476,7 @@ Requirements Changed ONAP TOSCA VNFD or PNFD Requirements > VNF or PNF CSAR Package > VNF or PNF Package Authenticity and Integrity --------------------------------------------------------------------------------------------------------------- + Requirements Added @@ -3517,7 +3515,7 @@ Requirements Added PNF Plug and Play > PNF Plug and Play -------------------------------------- + Requirements Changed @@ -3549,7 +3547,7 @@ Requirements Changed Resource IDs ------------- + Requirements Changed @@ -3574,7 +3572,7 @@ Requirements Changed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::InstanceIp -------------------------------------------------------------------------------------------------- + Requirements Changed @@ -3789,7 +3787,7 @@ Requirements Removed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::ServiceTemplate ------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -3815,7 +3813,7 @@ Requirements Changed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::VirtualMachineInterface --------------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -3907,7 +3905,7 @@ Requirements Removed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::VirtualNetwork ------------------------------------------------------------------------------------------------------ + Requirements Changed @@ -3931,7 +3929,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Cinder::Volume ------------------------------------------------------------------------------------------- + Requirements Changed @@ -3957,7 +3955,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Cinder::VolumeAttachment ----------------------------------------------------------------------------------------------------- + Requirements Changed @@ -3983,7 +3981,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Heat::ResourceGroup ------------------------------------------------------------------------------------------------ + Requirements Removed @@ -4010,7 +4008,7 @@ Requirements Removed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::Port ------------------------------------------------------------------------------------------ + Requirements Changed @@ -4118,7 +4116,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::Subnet -------------------------------------------------------------------------------------------- + Requirements Changed @@ -4143,7 +4141,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Nova::Keypair ------------------------------------------------------------------------------------------ + Requirements Changed @@ -4183,7 +4181,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Nova::Server ----------------------------------------------------------------------------------------- + Requirements Changed @@ -4209,7 +4207,7 @@ Requirements Changed Resource Property “name” ------------------------- + Requirements Changed @@ -4246,7 +4244,7 @@ Requirements Removed Resource: OS::Neutron::Port - Parameters > Introduction > Items to Note ------------------------------------------------------------------------ + Requirements Added @@ -4309,7 +4307,7 @@ Requirements Removed Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address ----------------------------------------------------------------------------------------------------- + Requirements Removed @@ -4328,7 +4326,7 @@ Requirements Removed Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address > VIP Assignment, External Networks ----------------------------------------------------------------------------------------------------------------------------------------- + Requirements Added @@ -4426,7 +4424,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address > VIP Assignment, External Networks, Supported by Automation ------------------------------------------------------------------------------------------------------------------------------------------------------------------ + Requirements Removed @@ -4486,7 +4484,7 @@ Requirements Removed Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address > VIP Assignment, Internal Networks ----------------------------------------------------------------------------------------------------------------------------------------- + Requirements Added @@ -4581,7 +4579,7 @@ Requirements Added Resource: OS::Neutron::Port - Parameters > Property: fixed_ips, Map Property: ip_address ----------------------------------------------------------------------------------------- + Requirements Changed @@ -4685,7 +4683,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: network ------------------------------------------------------------- + Requirements Changed @@ -4732,7 +4730,7 @@ Requirements Removed Resource: OS::Nova::Server - Parameters ---------------------------------------- + Requirements Changed @@ -4763,7 +4761,7 @@ Requirements Changed Resource: OS::Nova::Server - Parameters > Property: Name --------------------------------------------------------- + Requirements Changed @@ -4809,7 +4807,7 @@ Requirements Removed Resource: OS::Nova::Server - Parameters > Property: availability_zone ---------------------------------------------------------------------- + Requirements Changed @@ -4832,7 +4830,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > environment_context --------------------------------------------------------------------- + Requirements Removed @@ -4850,7 +4848,7 @@ Requirements Removed Resource: OS::Nova::Server Metadata Parameters > vf_module_id -------------------------------------------------------------- + Requirements Removed @@ -4869,7 +4867,7 @@ Requirements Removed Resource: OS::Nova::Server Metadata Parameters > vf_module_index ----------------------------------------------------------------- + Requirements Added @@ -4914,7 +4912,7 @@ Requirements Removed Resource: OS::Nova::Server Metadata Parameters > vf_module_name ---------------------------------------------------------------- + Requirements Added @@ -4958,7 +4956,7 @@ Requirements Removed Resource: OS::Nova::Server Metadata Parameters > vm_role --------------------------------------------------------- + Requirements Changed @@ -4994,7 +4992,7 @@ Requirements Removed Resource: OS::Nova::Server Metadata Parameters > vnf_id -------------------------------------------------------- + Requirements Removed @@ -5012,7 +5010,7 @@ Requirements Removed Resource: OS::Nova::Server Metadata Parameters > vnf_name ---------------------------------------------------------- + Requirements Removed @@ -5030,7 +5028,7 @@ Requirements Removed Resource: OS::Nova::Server Metadata Parameters > workload_context ------------------------------------------------------------------ + Requirements Removed @@ -5048,7 +5046,7 @@ Requirements Removed VNF On-boarding and package management > Compute, Network, and Storage Requirements ------------------------------------------------------------------------------------ + Requirements Changed @@ -5083,7 +5081,7 @@ Requirements Changed VNF On-boarding and package management > Licensing Requirements ---------------------------------------------------------------- + Requirements Changed @@ -5163,7 +5161,7 @@ Requirements Changed VNF On-boarding and package management > Resource Configuration ---------------------------------------------------------------- + Requirements Changed @@ -5184,7 +5182,7 @@ Requirements Changed VNF On-boarding and package management > Resource Configuration > Configuration Management via Ansible ------------------------------------------------------------------------------------------------------- + Requirements Changed @@ -5229,7 +5227,7 @@ Requirements Changed VNF On-boarding and package management > Resource Configuration > Configuration Management via Chef ---------------------------------------------------------------------------------------------------- + Requirements Changed @@ -5258,7 +5256,7 @@ Requirements Changed VNF On-boarding and package management > Resource Configuration > Configuration Management via NETCONF/YANG ------------------------------------------------------------------------------------------------------------ + Requirements Changed @@ -5274,7 +5272,7 @@ Requirements Changed VNF On-boarding and package management > Resource Control Loop --------------------------------------------------------------- + Requirements Changed @@ -5454,7 +5452,7 @@ Requirements Removed VNF On-boarding and package management > Resource Description -------------------------------------------------------------- + Requirements Added @@ -5596,7 +5594,7 @@ Requirements Removed VNF On-boarding and package management > Testing ------------------------------------------------- + Requirements Changed @@ -5631,7 +5629,7 @@ Requirements Changed VNF Resiliency > Monitoring & Dashboard ---------------------------------------- + Requirements Changed @@ -5648,7 +5646,7 @@ Requirements Changed {network-role} --------------- + Requirements Changed @@ -5692,7 +5690,7 @@ Requirements Changed {vm-type} ---------- + Requirements Changed diff --git a/docs/changes-by-section-el-alto.rst b/docs/changes-by-section-el-alto.rst index a088598..4112047 100644 --- a/docs/changes-by-section-el-alto.rst +++ b/docs/changes-by-section-el-alto.rst @@ -14,7 +14,7 @@ Requirement Changes Introduced in El Alto -======================================================== +----------------------------------------- This document summarizes the requirement changes by section that were introduced between the Dublin release and @@ -25,7 +25,7 @@ navigate to the :depth: 2 Summary of Changes ------------------- +^^^^^^^^^^^^^^^^^^ * **Requirements Added:** 9 * **Requirements Changed:** 21 @@ -33,7 +33,7 @@ Summary of Changes Monitoring & Management > Data Structure Specification of the Event Record --------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -75,7 +75,7 @@ Requirements Changed Monitoring & Management > Monitoring & Management Requirements > Security -------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -151,7 +151,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > properties --------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -181,7 +181,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Base Modules ------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -211,7 +211,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Cinder Volume Modules ---------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -234,7 +234,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Incremental Modules -------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -251,7 +251,7 @@ Requirements Changed ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Nested Heat file ----------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -268,7 +268,7 @@ Requirements Changed ONAP Heat VNF Modularity ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -349,7 +349,7 @@ Requirements Added PNF Plug and Play > PNF Plug and Play -------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -378,7 +378,7 @@ Requirements Removed Resource: OS::Nova::Server - Parameters ---------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -409,7 +409,7 @@ Requirements Changed Resource: OS::Nova::Server - Parameters > Property: availability_zone ---------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -455,7 +455,7 @@ Requirements Changed VNF On-boarding and package management > Resource Control Loop --------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -472,7 +472,7 @@ Requirements Changed VNF On-boarding and package management > Resource Description -------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -488,7 +488,7 @@ Requirements Changed VNF Security > VNF Cryptography Requirements --------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -504,7 +504,7 @@ Requirements Changed VNF Security > VNF General Security Requirements ------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -530,7 +530,7 @@ Requirements Changed VNF Security > VNF Identity and Access Management Requirements --------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -547,7 +547,7 @@ Requirements Removed VNF Security > VNF Security Analytics Requirements --------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Removed @@ -565,7 +565,7 @@ Requirements Removed VNF or PNF CSAR Package > VNF Package Contents ----------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -583,7 +583,7 @@ Requirements Changed VNF or PNF CSAR Package > VNF or PNF Package Authenticity and Integrity ------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed diff --git a/docs/changes-by-section-frankfurt.rst b/docs/changes-by-section-frankfurt.rst index 90e6281..f0348a5 100644 --- a/docs/changes-by-section-frankfurt.rst +++ b/docs/changes-by-section-frankfurt.rst @@ -14,7 +14,7 @@ Requirement Changes Introduced in Frankfurt -======================================================== +------------------------------------------- This document summarizes the requirement changes by section that were introduced between the El Alto release and @@ -25,7 +25,7 @@ navigate to the :depth: 2 Summary of Changes ------------------- +^^^^^^^^^^^^^^^^^^ * **Requirements Added:** 22 * **Requirements Changed:** 129 @@ -33,7 +33,7 @@ Summary of Changes Configuration Management ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -50,7 +50,7 @@ Requirements Added Configuration Management > Ansible Standards and Capabilities > VNF or PNF Configuration via Ansible Requirements > Ansible Client Requirements ------------------------------------------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -68,7 +68,7 @@ Requirements Changed Configuration Management > Ansible Standards and Capabilities > VNF or PNF Configuration via Ansible Requirements > Ansible Playbook Requirements -------------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -229,7 +229,7 @@ Requirements Changed Configuration Management > NETCONF Standards and Capabilities > VNF or PNF Configuration via NETCONF Requirements > LCM Operations via NETCONF ----------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -248,7 +248,7 @@ Requirements Added Configuration Management > NETCONF Standards and Capabilities > VNF or PNF Configuration via NETCONF Requirements > NETCONF Server Requirements ------------------------------------------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -266,7 +266,7 @@ Requirements Changed Contrail Resource Parameters > Contrail Network Parameters > ONAP External Networks ------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -303,7 +303,7 @@ Requirements Changed Contrail Resource Parameters > OS::ContrailV2::VirtualMachineInterface Property virtual_machine_interface_allowed_address_pairs > ONAP External Networks --------------------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -445,7 +445,7 @@ Requirements Changed Contrail Resource Parameters > OS::ContrailV2::VirtualMachineInterface Property virtual_machine_interface_allowed_address_pairs > ONAP Internal Networks --------------------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -548,7 +548,7 @@ Requirements Changed Contrail Resource Parameters > Resource OS::ContrailV2::InstanceIp > Resource OS::ContrailV2::InstanceIp Property instance_ip_address -------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -797,7 +797,7 @@ Requirements Changed Contrail Resource Parameters > Resource OS::ContrailV2::InstanceIp > Resource OS::ContrailV2::InstanceIp Property subnet_uuid ------------------------------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -899,7 +899,7 @@ Requirements Changed Monitoring & Management > Data Structure Specification of the Event Record --------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -919,7 +919,7 @@ Requirements Changed ONAP Heat Heat Template Constructs > Nested Heat Templates > Nested Heat Template Requirements ----------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -937,7 +937,7 @@ Requirements Changed ONAP Heat Networking > External Networks ----------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -985,7 +985,7 @@ Requirements Changed ONAP Heat Networking > Internal Networks ----------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1081,7 +1081,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters --------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1122,7 +1122,7 @@ Requirements Changed ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources -------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -1152,7 +1152,7 @@ Requirements Changed Resource IDs ------------- +^^^^^^^^^^^^ Requirements Changed @@ -1251,7 +1251,7 @@ Requirements Changed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::InstanceIp -------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1419,7 +1419,7 @@ Requirements Changed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::NetworkIpam --------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1440,7 +1440,7 @@ Requirements Changed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::VirtualMachineInterface --------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1510,7 +1510,7 @@ Requirements Changed Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::VirtualNetwork ------------------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1535,7 +1535,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::Net ----------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1559,7 +1559,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::Port ------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1673,7 +1673,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::SecurityGroup --------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1796,7 +1796,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::Subnet -------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1823,7 +1823,7 @@ Requirements Changed Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Nova::Keypair ------------------------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1865,7 +1865,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Introduction > Items to Note ------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -1925,7 +1925,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address > VIP Assignment, ONAP External Networks ---------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2019,7 +2019,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address > VIP Assignment, ONAP Internal Networks ---------------------------------------------------------------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2114,7 +2114,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: fixed_ips, Map Property: ip_address ----------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2354,7 +2354,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: fixed_ips, Map Property: subnet ------------------------------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2456,7 +2456,7 @@ Requirements Changed Resource: OS::Neutron::Port - Parameters > Property: network ------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2502,7 +2502,7 @@ Requirements Changed Resource: OS::Nova::Server Metadata Parameters > vf_module_index ----------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2530,7 +2530,7 @@ Requirements Added VNF Security > VNF General Security Requirements ------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2657,7 +2657,7 @@ Requirements Removed VNF Security > VNF Identity and Access Management Requirements --------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2828,7 +2828,7 @@ Requirements Removed VNF and PNF On-boarding and package management > Resource Configuration ------------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2845,7 +2845,7 @@ Requirements Changed VNF or PNF CSAR Package > VNF or PNF Package Contents ------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Added @@ -2968,7 +2968,7 @@ Requirements Changed VNF or PNF CSAR Package > VNF or PNF Package Structure and Format ------------------------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirements Changed @@ -2995,7 +2995,7 @@ Requirements Changed {network-role} --------------- +^^^^^^^^^^^^^^ Requirements Changed diff --git a/docs/conf.py b/docs/conf.py index a52242d..1a9f9ce 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,11 +25,6 @@ needs_extra_options = { "updated": directives.unchanged, "impacts": directives.unchanged, "validation_mode": directives.unchanged, - "validated_by": directives.unchanged, - "test": directives.unchanged, - "test_case": directives.unchanged, - "test_file": directives.unchanged, - "notes": directives.unchanged, } needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+" |