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

4 files changed, 21 insertions, 21 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.