diff options
author | Lovett, Trevor <trevor.lovett@att.com> | 2020-07-02 11:19:00 -0500 |
---|---|---|
committer | Lovett, Trevor <trevor.lovett@att.com> | 2020-07-12 18:17:41 -0500 |
commit | d1f93f4febdd5b34e96b954dd11e635bc0ee8041 (patch) | |
tree | 899f326fa7ed5ecd05e8dcaf535e7c3ddd99d3e9 /docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst | |
parent | cbbd1db5dfe2035d56901575218380c32216da92 (diff) |
Requirement ID Generation and RST Validation
The new check.py script will now perform a variety of
actions to simplify updates and ensure specific
practices are followed for each update.
The script has been integrated with tox and
will run whenever the documentation is created.
It can also be ran separately by just invoking
python check.py.
The script will perform a variety of automatic
updates where possible, and provide a warning
where auto-updates are not possible.
The expecation is that all warnings are addressed
before submitting for review, but given it is a
new feature warnings do not block validation at
this time.
Here is a summary of the warnings and updates:
Warnings:
- Requirement missing required attributes
- Invalid values for attributes
- Invalid section header usage in any file
- :keyword: and requirement mismatch
Auto Updates:
- Assigning :id: on new requirements where an ID missing
- Adding :introduced: attribute on new requirements
- Adding/correcting :updated: attribute on changed requirements
Issue-ID: VNFRQTS-896
Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642
Diffstat (limited to 'docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst')
-rw-r--r-- | docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names.rst | 22 |
1 files changed, 11 insertions, 11 deletions
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, |