VNFRQTS - Documentation Package changes

Change-Id: Id195476951829dca943ebd96667140e31bed1086
Issue-ID: VNFRQTS-591
Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com>

diff --git a/docs/Chapter3/index.rst b/docs/Chapter3/index.rst
index 208519b..12de543 100644 (file)
--- a/docs/Chapter3/index.rst
+++ b/docs/Chapter3/index.rst
@@ -47,6 +47,15 @@ Introduction
 |                     | Descriptor, etc.), but the :target: metadata would    |
 |                     | stay at the package level.                            |
 +---------------------+-------------------------------------------------------+
+| {VNF|PNF|VNF or PNF}| VNFs and PNFs are expected to provide human readable  |
+| DOCUMENTATION       | documentation. This may come in the form of URLs or   |
+| PACKAGE             | pdfs. This documentation may vary by VNF or PNF.      |
+|                     | The structure of the documentation is intended for    |
+|                     | human consumption and is not highly structured for    |
+|                     | machine ingestion. The human readable documentation   |
+|                     | may be provided through the RFP/acquisition process.  |
++---------------------+-------------------------------------------------------+
+
 - Chapter 4 contains the xNF requirements involving the design and
   development of xNFs. These requirements help VNFs/PNFs operate
   efficiently within a cloud environment. Requirements cover design,
@@ -62,6 +71,7 @@ Introduction
       instantiating virtual resources in an OpenStack environment.  At this
       time the HEAT files will be passed to the Service provider as a data
       element within the TOSCA onboarding package.
+
 - Chapter 6 details the requirements specific to an implementation.
   The current implementations documented are OpenStack and Azure.
 - Chapter 7 provides the comprehensive set of requirements for xNFs to

diff --git a/docs/Chapter4/Resiliency.rst b/docs/Chapter4/Resiliency.rst
index a61bd01..dbe41ff 100644 (file)
--- a/docs/Chapter4/Resiliency.rst
+++ b/docs/Chapter4/Resiliency.rst
@@ -556,7 +556,7 @@ Monitoring & Dashboard Requirements
     :keyword: MUST
 
     The VNF **MUST** provide a method of metrics gathering for each
-    layer's performance to identify/document variances in the allocations so
+    layer's performance to identify variances in the allocations so
     they can be addressed.
 
 .. req::

diff --git a/docs/Chapter4/Security.rst b/docs/Chapter4/Security.rst
index 25b767e..018193e 100644 (file)
--- a/docs/Chapter4/Security.rst
+++ b/docs/Chapter4/Security.rst
@@ -126,7 +126,7 @@ the product's lifecycle.
     :id: R-99771
     :target: VNF
     :keyword: MUST
-    :updated: casablanca
+    :updated: dublin
 
     The VNF **MUST** have all code (e.g., QCOW2) and configuration files
     (e.g., HEAT template, Ansible playbook, script) hardened, or with

diff --git a/docs/Chapter5/Tosca.rst b/docs/Chapter5/Tosca.rst
index a694ae7..dfaaa7b 100644 (file)
--- a/docs/Chapter5/Tosca.rst
+++ b/docs/Chapter5/Tosca.rst
@@ -412,8 +412,9 @@ General
     :target: VNF
     :keyword: MUST
     :introduced: casablanca
+    :updated: dublin
 
-    The VNFD **MUST** comply with ETSI GS NFV-SOL001 document endorsing
+    The VNFD **MUST** comply with ETSI GS NFV-SOL001 specification endorsing
     the above mentioned NFV Profile and maintaining the gaps with the
     requirements specified in ETSI GS NFV-IFA011 standard.
 

diff --git a/docs/Chapter7/Configuration-Management.rst b/docs/Chapter7/Configuration-Management.rst
index 332352f..1e2ec72 100755 (executable)
--- a/docs/Chapter7/Configuration-Management.rst
+++ b/docs/Chapter7/Configuration-Management.rst
@@ -836,7 +836,7 @@ conform, and those where applicable, that suppliers need to use.
     :keyword: MUST
 
     The xNF **MUST** conform its YANG model to RFC 6087,
-    "Guidelines for Authors and Reviewers of YANG Data Model Documents".
+    "Guidelines for Authors and Reviewers of YANG Data Model specification".
 
 .. req::
     :id: R-33955

diff --git a/docs/Chapter7/Monitoring-And-Management.rst b/docs/Chapter7/Monitoring-And-Management.rst
index cc78f74..a576a91 100755 (executable)
--- a/docs/Chapter7/Monitoring-And-Management.rst
+++ b/docs/Chapter7/Monitoring-And-Management.rst
@@ -400,9 +400,10 @@ minimizing changes to data delivery.
    :impacts: dcae
    :validation_mode: in_service
    :introduced: casablanca
+   :updated: dublin
 
    The xNF **MUST** deliver event records to ONAP using the common transport
-   mechanisms and protocols defined in this document.
+   mechanisms and protocols defined in this specification.
 
 The term 'Event Record' is used throughout this document to represent various
 forms of telemetry or instrumentation made available by the xNFs

diff --git a/docs/Chapter7/VNF-On-boarding-and-package-management.rst b/docs/Chapter7/VNF-On-boarding-and-package-management.rst
index e725d17..7a79f50 100755 (executable)
--- a/docs/Chapter7/VNF-On-boarding-and-package-management.rst
+++ b/docs/Chapter7/VNF-On-boarding-and-package-management.rst
@@ -50,10 +50,11 @@ Resource Description
 
 .. req::
     :id: R-69565
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation describing xNF
+    The xNF Documentation Package **MUST** describe the xNF
     Management APIs, which must include information and tools for ONAP to
     deploy and configure (initially and ongoing) the xNF application(s)
     (e.g., NETCONF APIs) which includes a description of configurable
@@ -62,39 +63,43 @@ Resource Description
 
 .. req::
     :id: R-00156
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation describing xNF
+    The xNF Documentation Package **MUST** describe the xNF
     Management APIs, which must include information and tools for
     ONAP to monitor the health of the xNF (conditions that require
     healing and/or scaling responses).
 
 .. req::
     :id: R-00068
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation which includes
+    The xNF Documentation Package **MUST** include
     a description of parameters that can be monitored for the xNF
     and event records (status, fault, flow, session, call, control
     plane, etc.) generated by the xNF after instantiation.
 
 .. req::
     :id: R-12678
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation which includes a
+    The xNF Documentation Package **MUST** include a
     description of runtime lifecycle events and related actions (e.g.,
     control responses, tests) which can be performed for the xNF.
 
 .. req::
     :id: R-84366
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation describing
+    The xNF Documentation Package **MUST** describe the
     xNF Functional APIs that are utilized to build network and
     application services. This document describes the externally exposed
     functional inputs and outputs for the xNF, including interface
@@ -102,10 +107,11 @@ Resource Description
 
 .. req::
     :id: R-36280
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF provider **MUST** provide documentation describing
+    The xNF Documentation Package **MUST** describe the
     xNF Functional Capabilities that are utilized to operationalize the
     xNF and compose complex services.
 
@@ -130,11 +136,12 @@ Resource Description
 
 .. req::
    :id: R-384337
-   :target: VNF
+   :target: VNF DOCUMENTATION PACKAGE
    :keyword: MUST
    :introduced: casablanca
+   :updated: dublin
 
-   The VNF documentation **MUST** contain a list of the files within the VNF
+   The VNF Documentation Package **MUST** contain a list of the files within the VNF
    package that are static during the VNF's runtime.
 
 .. req::
@@ -269,31 +276,34 @@ Resource Control Loop
 
 .. req::
     :id: R-22888
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF provider **MUST** provide documentation for the xNF
+    The xNF Documentation Package **MUST** provide the xNF
     Policy Description to manage the xNF runtime lifecycle. The document
     must include a description of how the policies (conditions and actions)
     are implemented in the xNF.
 
 .. req::
     :id: R-01556
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation describing the
+    The xNF Documentation Package **MUST** describe the
     fault, performance, capacity events/alarms and other event records
     that are made available by the xNF.
 
 .. req::
     :id: R-16875
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation which must include
-    a unique identification string for the specific xNF, a description of
-    the problem that caused the error, and steps or procedures to perform
+    The xNF Documentation Package **MUST** include documentation which must
+    include a unique identification string for the specific xNF, a description
+    of the problem that caused the error, and steps or procedures to perform
     Root Cause Analysis and resolve the issue.
 
 .. req::
@@ -317,10 +327,11 @@ Resource Control Loop
 
 .. req::
     :id: R-01478
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation describing all
+    The xNF Documentation Package **MUST** describe all
     parameters that are available to monitor the xNF after instantiation
     (includes all counters, OIDs, PM data, KPIs, etc.) that must be
     collected for reporting purposes.
@@ -364,10 +375,11 @@ Resource Control Loop
 
 .. req::
     :id: R-53598
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation to, when relevant,
+    The xNF Documentation Package **MUST**, when relevant,
     provide a threshold crossing alert point for each KPI and describe the
     significance of the threshold crossing.
 
@@ -382,10 +394,11 @@ Resource Control Loop
 
 .. req::
     :id: R-22680
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation that describes
+    The xNF Documentation Package **MUST** describe
     any requirements for the monitoring component of tools for Network
     Cloud automation and management to provide these records to components
     of the xNF.
@@ -401,19 +414,21 @@ Resource Control Loop
 
 .. req::
     :id: R-56815
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation describing
+    The xNF Documentation Package **MUST** describe
     supported xNF scaling capabilities and capacity limits (e.g., number
     of users, bandwidth, throughput, concurrent calls).
 
 .. req::
     :id: R-48596
-    :target: XNF
+    :target: XNF DOCUMENTATION PACKAGE
     :keyword: MUST
+    :updated: dublin
 
-    The xNF Package **MUST** include documentation describing
+    The xNF Documentation Package **MUST** describe
     the characteristics for the xNF reliability and high availability.
 
 
@@ -495,11 +510,11 @@ Testing
 
 .. req::
     :id: R-43958
-    :target: VNF
+    :target: VNF DOCUMENTATION PACKAGE
     :keyword: MUST
-    :updated: casablanca
+    :updated: dublin
 
-    The VNF Package **MUST** include documentation describing
+    The VNF Documentation Package **MUST** describe
     the tests that were conducted by the VNF provider and the test results.
 
 .. req::
@@ -605,7 +620,7 @@ Licensing Requirements
 
     The xNF provider **MUST** support the metadata about
     licenses (and their applicable entitlements) as defined in this
-    document for xNF software, and any license keys required to authorize
+    specification for xNF software, and any license keys required to authorize
     use of the xNF software.  This metadata will be used to facilitate
     onboarding the xNF into the ONAP environment and automating processes
     for putting the licenses into use and managing the full lifecycle of