VNFRQTS - Fixing typos in Monitoring 29/68429/1
authorLovett, Trevor (tl2972) <tl2972@att.com>
Fri, 21 Sep 2018 14:03:24 +0000 (09:03 -0500)
committerLovett, Trevor (tl2972) <tl2972@att.com>
Fri, 21 Sep 2018 14:04:39 +0000 (09:04 -0500)
Change-Id: Ie5d332a8d04961aeacd5d9ec326141d33eaf02ed
Issue-ID: VNFRQTS-446
Signed-off-by: Lovett, Trevor (tl2972) <tl2972@att.com>
docs/Chapter7/Monitoring-And-Management.rst
docs/Data_Model_For_Event_Records.png
docs/data/needs.json

index f4b5fb2..f3043a7 100755 (executable)
@@ -132,7 +132,7 @@ sender and other identifying characteristics related to the domain and event.
    :keyword: MUST
 
    The VNF **MUST** produce VES events that include the following mandatory
-   fields in the common event header
+   fields in the common event header.
 
     * ``domain`` - the event domain enumeration
     * ``eventId`` - the event key unique to the event source
@@ -454,7 +454,7 @@ xNF Telemetry using Google Protocol Buffers
    The xNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model
    depicted in Figure 3 to support real-time performance management (PM) data.
    In this model the VES events are streamed as binary-encoded GBPs over via
-   TCP sockets
+   TCP sockets.
 
 |image2|
 
@@ -570,14 +570,15 @@ Google Protocol Buffers (GPB)
    :validation_mode: in_service
 
    The xNF, when leveraging Google Protocol Buffers for events, **MUST**
-   serialize the events using native Google Protocol Buffers (GPB) where:
-
-      * keys are represented as integers pointing to the system resources for
-        the xNF being monitored
-      * values correspond to integers or strings that identify the operational
-        state of the VNF resource, such a statistics counters and the state of
-        an xNF resource.
-      * required Google Protocol Buffers (GPB) metadata is provided in the
+   serialize the events using native Google Protocol Buffers (GPB) according
+   to the following guidelines:
+
+      * The keys are represented as integers pointing to the system resources
+        for the xNF being monitored
+      * The values correspond to integers or strings that identify the
+        operational state of the VNF resource, such a statistics counters and
+        the state of an xNF resource.
+      * The required Google Protocol Buffers (GPB) metadata is provided in the
         form of .proto files.
 
 .. req::
@@ -587,15 +588,15 @@ Google Protocol Buffers (GPB)
    :introduced: casablanca
    :validation_mode: static
 
-    The xNF providers **MUST** provide to the Service Provider the additional
-    following artifacts to support the delivery of high-volume xNF telemetry to
-    DCAE via GPB over TLS/TCP:
+   The xNF providers **MUST** provide the Service Provider the following
+   artifacts to support the delivery of high-volume xNF telemetry to
+   DCAE via GPB over TLS/TCP:
 
-      * a valid VES Event .proto definition file, to be used validate and
+      * A valid VES Event .proto definition file, to be used validate and
         decode an event
-      * a valid high volume measurement .proto definition file, to be used for
+      * A valid high volume measurement .proto definition file, to be used for
         processing high volume events
-      * a supporting PM content metadata file to be used by analytics
+      * A supporting PM content metadata file to be used by analytics
         applications to process high volume measurement events
 
 Reporting Frequency
index 0d42770..2c4abbd 100644 (file)
Binary files a/docs/Data_Model_For_Event_Records.png and b/docs/Data_Model_For_Event_Records.png differ
index 875fbd2..fdef144 100644 (file)
@@ -1,5 +1,5 @@
 {
-    "created": "2018-09-20T12:49:06.895999",
+    "created": "2018-09-21T09:04:14.699000",
     "current_version": "casablanca",
     "project": "",
     "versions": {
             "needs_amount": 750
         },
         "casablanca": {
-            "created": "2018-09-20T12:49:06.895999",
+            "created": "2018-09-21T09:04:14.699000",
             "needs": {
                 "R-00011": {
                     "description": "A VNF's Heat Orchestration Template's parameter defined\nin a nested YAML file\n**MUST NOT** have a parameter constraint defined.",
                     "validation_mode": "static"
                 },
                 "R-257367": {
-                    "description": "The xNF, when leveraging Google Protocol Buffers for events, **MUST**\nserialize the events using native Google Protocol Buffers (GPB) where:\n\n   * keys are represented as integers pointing to the system resources for\n     the xNF being monitored\n   * values correspond to integers or strings that identify the operational\n     state of the VNF resource, such a statistics counters and the state of\n     an xNF resource.\n   * required Google Protocol Buffers (GPB) metadata is provided in the\n     form of .proto files.",
+                    "description": "The xNF, when leveraging Google Protocol Buffers for events, **MUST**\nserialize the events using native Google Protocol Buffers (GPB) according\nto the following guidelines:\n\n   * The keys are represented as integers pointing to the system resources\n     for the xNF being monitored\n   * The values correspond to integers or strings that identify the\n     operational state of the VNF resource, such a statistics counters and\n     the state of an xNF resource.\n   * The required Google Protocol Buffers (GPB) metadata is provided in the\n     form of .proto files.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-257367",
                     "validation_mode": ""
                 },
                 "R-528866": {
-                    "description": "The VNF **MUST** produce VES events that include the following mandatory\nfields in the common event header\n\n * ``domain`` - the event domain enumeration\n * ``eventId`` - the event key unique to the event source\n * ``eventName`` - the unique event name\n * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated\n   with the event\n * ``priority`` - the processing priority enumeration\n * ``reportingEntityName`` - name of the entity reporting the event or\n   detecting a problem in another xNF\n * ``sequence`` - the ordering of events communicated by an event source\n * ``sourceName`` - name of the entity experiencing the event issue, which\n   may be detected and reported by a separate reporting entity\n * ``startEpochMicrosec`` - the earliest unix time (aka epoch time)\n   associated with the event\n * ``version`` - the version of the event header\n * ``vesEventListenerVersion`` - Version of the VES event listener API spec\n   that this event is compliant with",
+                    "description": "The VNF **MUST** produce VES events that include the following mandatory\nfields in the common event header.\n\n * ``domain`` - the event domain enumeration\n * ``eventId`` - the event key unique to the event source\n * ``eventName`` - the unique event name\n * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated\n   with the event\n * ``priority`` - the processing priority enumeration\n * ``reportingEntityName`` - name of the entity reporting the event or\n   detecting a problem in another xNF\n * ``sequence`` - the ordering of events communicated by an event source\n * ``sourceName`` - name of the entity experiencing the event issue, which\n   may be detected and reported by a separate reporting entity\n * ``startEpochMicrosec`` - the earliest unix time (aka epoch time)\n   associated with the event\n * ``version`` - the version of the event header\n * ``vesEventListenerVersion`` - Version of the VES event listener API spec\n   that this event is compliant with",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-528866",
                     "validation_mode": ""
                 },
                 "R-697654": {
-                    "description": "The xNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model\ndepicted in Figure 3 to support real-time performance management (PM) data.\nIn this model the VES events are streamed as binary-encoded GBPs over via\nTCP sockets",
+                    "description": "The xNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model\ndepicted in Figure 3 to support real-time performance management (PM) data.\nIn this model the VES events are streamed as binary-encoded GBPs over via\nTCP sockets.",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-697654",
                     "validation_mode": "static"
                 },
                 "R-978752": {
-                    "description": " The xNF providers **MUST** provide to the Service Provider the additional\n following artifacts to support the delivery of high-volume xNF telemetry to\n DCAE via GPB over TLS/TCP:\n\n   * a valid VES Event .proto definition file, to be used validate and\n     decode an event\n   * a valid high volume measurement .proto definition file, to be used for\n     processing high volume events\n   * a supporting PM content metadata file to be used by analytics\n     applications to process high volume measurement events",
+                    "description": "The xNF providers **MUST** provide the Service Provider the following\nartifacts to support the delivery of high-volume xNF telemetry to\nDCAE via GPB over TLS/TCP:\n\n   * A valid VES Event .proto definition file, to be used validate and\n     decode an event\n   * A valid high volume measurement .proto definition file, to be used for\n     processing high volume events\n   * A supporting PM content metadata file to be used by analytics\n     applications to process high volume measurement events",
                     "full_title": "",
                     "hide_links": "",
                     "id": "R-978752",