summaryrefslogtreecommitdiffstats
path: root/docs/Chapter7/VNF-On-boarding-and-package-management.rst
diff options
context:
space:
mode:
authorLovett, Trevor <trevor.lovett@att.com>2020-07-02 11:19:00 -0500
committerLovett, Trevor <trevor.lovett@att.com>2020-07-12 18:17:41 -0500
commitd1f93f4febdd5b34e96b954dd11e635bc0ee8041 (patch)
tree899f326fa7ed5ecd05e8dcaf535e7c3ddd99d3e9 /docs/Chapter7/VNF-On-boarding-and-package-management.rst
parentcbbd1db5dfe2035d56901575218380c32216da92 (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/Chapter7/VNF-On-boarding-and-package-management.rst')
-rwxr-xr-xdocs/Chapter7/VNF-On-boarding-and-package-management.rst32
1 files changed, 16 insertions, 16 deletions
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.